Conversational Analysis Authoring - Import

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2022-05-01

Wyzwala zadanie importowania projektu. Jeśli projekt o tej samej nazwie już istnieje, dane tego projektu zostaną zastąpione.

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?api-version=2022-05-01

Z parametrami opcjonalnymi:

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?format={format}&api-version=2022-05-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nazwa projektu do użycia.
api-version	query	True	string	Wersja interfejsu API klienta.
format	query		ExportedProjectFormat	Format wyeksportowanego pliku projektu do użycia.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string	Klucz subskrypcji zasobu usługi językowej.

Treść żądania

Nazwa	Wymagane	Typ	Opis
metadata	True	ConversationalAnalysisAuthoringCreateProjectOptions	Reprezentuje metadane projektu.
projectFileVersion	True	string	Wersja wyeksportowanego pliku.
stringIndexType	True	StringIndexType	Określa metodę używaną do interpretowania przesunięć ciągów. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets.
assets		ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Reprezentuje zasoby projektu.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Wyniki pomyślnego wywołania z nagłówkiem Operation-Location służącym do sprawdzania stanu zadania. Nagłówki operation-location: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Nazwa

Typ

Opis

202 Accepted

Wyniki pomyślnego wywołania z nagłówkiem Operation-Location służącym do sprawdzania stanu zadania.

Nagłówki

operation-location: string

Other Status Codes

ErrorResponse

Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Klucz subskrypcji zasobu usługi językowej.

Typ: apiKey
W: header

Przykłady

Successful Import Project

Przykładowe żądanie

HTTP

POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:import?api-version=2022-05-01


{
  "projectFileVersion": "2022-05-01",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "Conversation",
    "settings": {
      "confidenceThreshold": 0.7
    },
    "projectName": "EmailApp",
    "multilingual": true,
    "description": "Trying out CLU",
    "language": "en-us"
  },
  "assets": {
    "projectKind": "Conversation",
    "intents": [
      {
        "category": "Read"
      },
      {
        "category": "Delete"
      }
    ],
    "entities": [
      {
        "category": "Sender"
      }
    ],
    "utterances": [
      {
        "text": "Open Blake's email",
        "dataset": "Train",
        "intent": "Read",
        "entities": [
          {
            "category": "Sender",
            "offset": 5,
            "length": 5
          }
        ]
      },
      {
        "text": "Delete last email",
        "language": "en-gb",
        "dataset": "Test",
        "intent": "Delete",
        "entities": []
      }
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:: 202

operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

Definicje

Nazwa	Opis
CompositionSetting	Zachowanie, które ma być przestrzegane, gdy składniki jednostki nakładają się na siebie nawzajem.
ConversationalAnalysisAuthoringConversationExportedEntity	Reprezentuje jednostkę ze swoimi składnikami.
ConversationalAnalysisAuthoringConversationExportedIntent	Reprezentuje wyeksportowaną intencję projektu konwersacyjnego.
ConversationalAnalysisAuthoringConversationExportedProjectAssets	Reprezentuje wyeksportowane zasoby projektu konwersacyjnego.
ConversationalAnalysisAuthoringConversationExportedUtterance	Reprezentuje wyeksportowaną wypowiedź dla projektu konwersacyjnego.
ConversationalAnalysisAuthoringCreateProjectOptions	Reprezentuje opcje używane do tworzenia lub aktualizowania projektu.
ConversationalAnalysisAuthoringExportedConversationOrchestration	Definiuje szczegóły aranżacji obiektu docelowego projektu konwersacyjnego.
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions	Reprezentuje opcje aranżacji obiektu docelowego projektu konwersacyjnego.
ConversationalAnalysisAuthoringExportedEntityList	Reprezentuje składnik listy jednostki.
ConversationalAnalysisAuthoringExportedEntityListSynonym	Reprezentuje listę synonimów wewnątrz składnika listy
ConversationalAnalysisAuthoringExportedEntitySublist	Reprezentuje listę podrzędną wewnątrz składnika listy.
ConversationalAnalysisAuthoringExportedLuisOrchestration	Definiuje szczegóły aranżacji obiektu docelowego aplikacji usługi LUIS.
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions	Reprezentuje opcje orkiestracji dla obiektu docelowego aplikacji usługi LUIS.
ConversationalAnalysisAuthoringExportedPrebuiltEntity	Reprezentuje wyeksportowany wstępnie utworzony składnik jednostki
ConversationalAnalysisAuthoringExportedProject	Reprezentuje wyeksportowany projekt.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Definiuje szczegóły aranżacji dla obiektu docelowego projektu odpowiadania na pytania.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Reprezentuje opcje orkiestracji dla obiektu docelowego projektu odpowiedzi na pytania.
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel	Reprezentuje etykietę jednostki dla wypowiedzi.
ConversationalAnalysisAuthoringOrchestrationExportedIntent	Reprezentuje wyeksportowaną intencję projektu aranżacji.
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Reprezentuje zasoby projektu aranżacji.
ConversationalAnalysisAuthoringOrchestrationExportedUtterance	Reprezentuje wypowiedź projektu aranżacji.
ConversationalAnalysisAuthoringProjectSettings	Reprezentuje ustawienia używane do definiowania zachowania projektu.
Error	Obiekt błędu.
ErrorCode	Kod błędu czytelny dla człowieka.
ErrorResponse	Odpowiedź na błąd.
ExportedProjectFormat	Format wyeksportowanego pliku projektu do użycia.
InnerErrorCode	Kod błędu czytelny dla człowieka.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Reprezentuje rodzaj projektu.
StringIndexType	Określa metodę używaną do interpretowania przesunięcia ciągów. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets.

CompositionSetting

Zachowanie, które ma być przestrzegane, gdy składniki jednostki nakładają się na siebie nawzajem.

Nazwa	Typ	Opis
combineComponents	string	Gdy w tekście znajduje się co najmniej dwa składniki i nakładają się na siebie, zakresy składników są scalane ze sobą w jeden zakres łączący wszystkie z nich.
requireExactOverlap	string	Wszystkie składniki muszą nakładać się na dokładnie te same znaki w tekście, aby jednostka zwróciła. Jeśli jeden ze zdefiniowanych składników nie jest zgodny lub przewidywany, jednostka nie zostanie zwrócona.
returnLongestOverlap	string	Gdy w tekście znajduje się co najmniej dwa składniki i nakładają się na siebie, zwracany jest składnik z najdłuższym zestawem znaków.
separateComponents	string	Dopasowanie lub przewidywanie każdego składnika jest zwracane jako oddzielne wystąpienie jednostki.

ConversationalAnalysisAuthoringConversationExportedEntity

Reprezentuje jednostkę ze swoimi składnikami.

Nazwa	Typ	Opis
category	string	Kategoria jednostki.
compositionSetting	CompositionSetting	Zachowanie, które ma być przestrzegane, gdy składniki jednostki nakładają się na siebie nawzajem.
list	ConversationalAnalysisAuthoringExportedEntityList	Składnik listy jednostki.
prebuilts	ConversationalAnalysisAuthoringExportedPrebuiltEntity[]	Wstępnie utworzone składniki jednostek.

ConversationalAnalysisAuthoringConversationExportedIntent

Reprezentuje wyeksportowaną intencję projektu konwersacyjnego.

Nazwa	Typ	Opis
category	string	Kategoria intencji.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Reprezentuje wyeksportowane zasoby projektu konwersacyjnego.

Nazwa	Typ	Opis
entities	ConversationalAnalysisAuthoringConversationExportedEntity[]	Jednostki zdefiniowane w projekcie.
intents	ConversationalAnalysisAuthoringConversationExportedIntent[]	Intencje zdefiniowane w projekcie.
projectKind	string: Conversation	Typ projektu zawierającego zasoby.
utterances	ConversationalAnalysisAuthoringConversationExportedUtterance[]	Wypowiedzi zdefiniowane w projekcie.

ConversationalAnalysisAuthoringConversationExportedUtterance

Reprezentuje wyeksportowaną wypowiedź dla projektu konwersacyjnego.

Nazwa	Typ	Opis
dataset	string	Zestaw danych dla tej wypowiedzi. Dozwolone wartości to "Train" (Trenowanie) i "Test".
entities	ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]	Reprezentuje etykiety jednostek wypowiedzi.
intent	string	Intencja wypowiedzi.
language	string	Reprezentuje język wypowiedzi. Jest to reprezentacja języka BCP-47. Na przykład użyj ciągu "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Wielka Brytania), "es" dla języka hiszpańskiego itp.
text	string	Tekst wypowiedzi.

ConversationalAnalysisAuthoringCreateProjectOptions

Reprezentuje opcje używane do tworzenia lub aktualizowania projektu.

Nazwa	Typ	Opis
description	string	Opis projektu.
language	string	Język projektu. Jest to reprezentacja języka BCP-47. Na przykład użyj ciągu "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Wielka Brytania), "es" dla języka hiszpańskiego itp.
multilingual	boolean	Czy projekt będzie używany w wielu językach, czy nie.
projectKind	ProjectKind	Reprezentuje rodzaj projektu.
projectName	string	Nowa nazwa projektu.
settings	ConversationalAnalysisAuthoringProjectSettings	Ustawienia projektu.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Definiuje szczegóły aranżacji obiektu docelowego projektu konwersacyjnego.

Nazwa	Typ	Opis
deploymentName	string	Nazwa wdrożenia docelowego.
projectName	string	Nazwa projektu docelowego.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Reprezentuje opcje aranżacji obiektu docelowego projektu konwersacyjnego.

Nazwa	Typ	Opis
conversationOrchestration	ConversationalAnalysisAuthoringExportedConversationOrchestration	Szczegóły elementu docelowego projektu konwersacyjnego.
targetProjectKind	string: Conversation	Rodzaj obiektu docelowego używanego w przepływie aranżacji.

ConversationalAnalysisAuthoringExportedEntityList

Reprezentuje składnik listy jednostki.

Nazwa	Typ	Opis
sublists	ConversationalAnalysisAuthoringExportedEntitySublist[]	Pod listami składnika listy.

ConversationalAnalysisAuthoringExportedEntityListSynonym

Reprezentuje listę synonimów wewnątrz składnika listy

Nazwa	Typ	Opis
language	string	Reprezentuje język synonimów. Jest to reprezentacja języka BCP-47. Na przykład użyj ciągu "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Wielka Brytania), "es" dla języka hiszpańskiego itp.
values	string[]	Lista synonimów.

ConversationalAnalysisAuthoringExportedEntitySublist

Reprezentuje listę podrzędną wewnątrz składnika listy.

Nazwa	Typ	Opis
listKey	string	Klucz listy podrzędnej.
synonyms	ConversationalAnalysisAuthoringExportedEntityListSynonym[]	Frazy, które odpowiadają pod liście.

ConversationalAnalysisAuthoringExportedLuisOrchestration

Definiuje szczegóły aranżacji obiektu docelowego aplikacji usługi LUIS.

Nazwa	Typ	Opis
appId	string	Identyfikator aplikacji usługi LUIS.
appVersion	string	Identyfikator wersji docelowej.
slotName	string	Nazwa miejsca docelowego.

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Reprezentuje opcje orkiestracji dla obiektu docelowego aplikacji usługi LUIS.

Nazwa	Typ	Opis
luisOrchestration	ConversationalAnalysisAuthoringExportedLuisOrchestration	Szczegóły obiektu docelowego aplikacji LUIS.
targetProjectKind	string: Luis	Rodzaj obiektu docelowego używanego w przepływie aranżacji.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Reprezentuje wyeksportowany wstępnie utworzony składnik jednostki

Nazwa	Typ	Opis
category	string	Wstępnie utworzona kategoria jednostki.

ConversationalAnalysisAuthoringExportedProject

Reprezentuje wyeksportowany projekt.

Nazwa	Typ	Opis
assets	ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Reprezentuje zasoby projektu.
metadata	ConversationalAnalysisAuthoringCreateProjectOptions	Reprezentuje metadane projektu.
projectFileVersion	string	Wersja wyeksportowanego pliku.
stringIndexType	StringIndexType	Określa metodę używaną do interpretowania przesunięcia ciągów. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Definiuje szczegóły aranżacji dla obiektu docelowego projektu odpowiadania na pytania.

Nazwa	Typ	Opis
projectName	string	Nazwa projektu docelowego.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Reprezentuje opcje orkiestracji dla obiektu docelowego projektu odpowiedzi na pytania.

Nazwa	Typ	Opis
questionAnsweringOrchestration	ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Szczegóły projektu Odpowiedzi na pytania.
targetProjectKind	string: QuestionAnswering	Rodzaj obiektu docelowego używanego w przepływie aranżacji.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Reprezentuje etykietę jednostki dla wypowiedzi.

Nazwa	Typ	Opis
category	string	Kategoria etykiety jednostki.
length	integer	Długość tekstu jednostki.
offset	integer	Pozycja początkowa dla tekstu jednostki.

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Reprezentuje wyeksportowaną intencję projektu aranżacji.

Nazwa	Typ	Opis
category	string	Kategoria intencji.
orchestration	ConversationalAnalysisAuthoringExportedOrchestrationOptions: ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Określa zachowanie tej intencji w przepływie aranżacji.

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Reprezentuje zasoby projektu aranżacji.

Nazwa	Typ	Opis
intents	ConversationalAnalysisAuthoringOrchestrationExportedIntent[]	Reprezentuje intencje projektu.
projectKind	string: Orchestration	Typ projektu zawierającego zasoby.
utterances	ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]	Reprezentuje wypowiedzi projektu.

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Reprezentuje wypowiedź projektu aranżacji.

Nazwa	Typ	Opis
dataset	string	Zestaw danych dla tej wypowiedzi. Dozwolone wartości to "Train" (Trenowanie) i "Test".
intent	string	Intencja wypowiedzi.
language	string	Reprezentuje język wypowiedzi. Jest to reprezentacja języka BCP-47. Na przykład użyj ciągu "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Wielka Brytania), "es" dla języka hiszpańskiego itp.
text	string	Tekst wypowiedzi.

ConversationalAnalysisAuthoringProjectSettings

Reprezentuje ustawienia używane do definiowania zachowania projektu.

Nazwa	Typ	Opis
confidenceThreshold	number	Próg intencji z największą ufnością, przy której przewidywanie zostanie automatycznie zmienione na "Brak".

Error

Obiekt błędu.

Nazwa	Typ	Opis
code	ErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

ExportedProjectFormat

Format wyeksportowanego pliku projektu do użycia.

Nazwa	Typ	Opis
Conversation	string	Określa format projektu konwersacyjnego.
Luis	string	Określa format aplikacji wyeksportowanej z usługi LUIS.

InnerErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	InnerErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	object	Szczegóły błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Komunikat o błędzie.
target	string	Błąd docelowy.

ProjectKind

Reprezentuje rodzaj projektu.

Nazwa	Typ	Opis
Conversation	string	Projekt tworzenia języka naturalnego w aplikacjach, botach i urządzeniach IoT.
Orchestration	string	Projekt umożliwiający łączenie i organizowanie konwersacji, niestandardowe odpowiedzi na pytania i projekty usługi LUIS w jednym projekcie.

StringIndexType

Określa metodę używaną do interpretowania przesunięcia ciągów. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets.

Nazwa	Typ	Opis
Utf16CodeUnit	string	Wartości przesunięcia i długości odpowiadają jednostkom kodu UTF-16. Użyj tej opcji, jeśli aplikacja jest napisana w języku obsługującym kod Unicode, na przykład JavaScript.

Udostępnij za pośrednictwem

Conversational Analysis Authoring - Import

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Przykłady

Successful Import Project

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CompositionSetting

ConversationalAnalysisAuthoringConversationExportedEntity

ConversationalAnalysisAuthoringConversationExportedIntent

ConversationalAnalysisAuthoringConversationExportedProjectAssets

ConversationalAnalysisAuthoringConversationExportedUtterance

ConversationalAnalysisAuthoringCreateProjectOptions

ConversationalAnalysisAuthoringExportedConversationOrchestration

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

ConversationalAnalysisAuthoringExportedEntityList

ConversationalAnalysisAuthoringExportedEntityListSynonym

ConversationalAnalysisAuthoringExportedEntitySublist

ConversationalAnalysisAuthoringExportedLuisOrchestration

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

ConversationalAnalysisAuthoringExportedPrebuiltEntity

ConversationalAnalysisAuthoringExportedProject

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

ConversationalAnalysisAuthoringOrchestrationExportedIntent

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

ConversationalAnalysisAuthoringProjectSettings

Error

ErrorCode

ErrorResponse

ExportedProjectFormat

InnerErrorCode

InnerErrorModel

ProjectKind

StringIndexType

Dodatkowe zasoby