Conversational Analysis Authoring - Export

Служба:

Cognitive Services - Language

Версия API:

2022-05-01

Запускает задание для экспорта данных проекта.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемая конечная точка Cognitive Services (например, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Имя используемого проекта.
api-version	query	True	string	Версия API клиента.
stringIndexType	query	True	StringIndexType	Указывает метод, используемый для интерпретации смещения строк. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets.
assetKind	query		string	Тип экспортируемых ресурсов.
format	query		ExportedProjectFormat	Формат экспортированного файла проекта для использования.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string	Ключ подписки для ресурса языковой службы.

Ответы

Имя	Тип	Описание
202 Accepted		Ответ будет содержать заголовок Operation-Location, используемый для проверки состояния задания. Заголовки operation-location: string
Other Status Codes	ErrorResponse	Ответ об ошибке.

Безопасность

Ocp-Apim-Subscription-Key

Ключ подписки для ресурса языковой службы.

Тип: apiKey
В: header

Примеры

Successful Export Project

Образец запроса

HTTP

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

Пример ответа

Код состояния:

202

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

Определения

Имя	Описание
Error	Объект ошибки.
ErrorCode	Код ошибки, доступный для чтения человеком.
ErrorResponse	Ответ об ошибке.
ExportedProjectFormat	Формат экспортированного файла проекта для использования.
InnerErrorCode	Код ошибки, доступный для чтения человеком.
InnerErrorModel	Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
StringIndexType	Указывает метод, используемый для интерпретации смещения строк. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets.

Error

Объект ошибки.

Имя	Тип	Описание
code	ErrorCode	Один из серверных наборов кодов ошибок.
details	Error[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerErrorModel	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Понятное представление ошибки.
target	string	Целевой объект ошибки.

ErrorCode

Код ошибки, доступный для чтения человеком.

Имя	Тип	Описание
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

Ответ об ошибке.

Имя	Тип	Описание
error	Error	Объект ошибки.

ExportedProjectFormat

Формат экспортированного файла проекта для использования.

Имя	Тип	Описание
Conversation	string	Задает формат для проекта беседы.
Luis	string	Задает формат приложения, экспортированного из LUIS.

InnerErrorCode

Код ошибки, доступный для чтения человеком.

Имя	Тип	Описание
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

Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
code	InnerErrorCode	Один из серверных наборов кодов ошибок.
details	object	Сведения об ошибке.
innererror	InnerErrorModel	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

StringIndexType

Указывает метод, используемый для интерпретации смещения строк. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets.

Имя	Тип	Описание
Utf16CodeUnit	string	Значения смещения и длины будут соответствовать единицам кода UTF-16. Используйте этот параметр, если приложение написано на языке, поддерживающем Юникод, например Java, JavaScript.