Conversational Analysis Authoring - Export

Usługa:

Cognitive Services - Language

Wersja interfejsu API:

2022-05-01

Wyzwala zadanie eksportowania danych projektu.

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

Z parametrami opcjonalnymi:

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:export?format={format}&stringIndexType=Utf16CodeUnit&assetKind={assetKind}&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.
stringIndexType	query	True	StringIndexType	Określa metodę używaną do interpretowania przesunięcia ciągów. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets.
assetKind	query		string	Rodzaj zasobu do wyeksportowania.
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.

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.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Klucz subskrypcji zasobu usługi językowej.

Typ: apiKey
W: header

Przykłady

Successful Export Project

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

202

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

Definicje

Nazwa	Opis
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.
StringIndexType	Określa metodę używaną do interpretowania przesunięcia ciągów. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets.

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.

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.