Text Analysis Authoring - Export

Служба:

Azure AI Services

Версия API:

2022-05-01

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

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

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

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:export?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 maxLength: 100	Имя используемого проекта.
api-version	query	True	string	Версия КЛИЕНТСКОго API.
stringIndexType	query	True	StringIndexType	Задает метод, используемый для интерпретации смещения строк. Дополнительные сведения см. в https://aka.ms/text-analytics-offsets.
assetKind	query		string	Тип ресурса для экспорта.

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

Имя	Обязательно	Тип	Описание
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-text/projects/LoanAgreements/:export?stringIndexType=Utf16CodeUnit&api-version=2022-05-01

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

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

202

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

Определения

Имя	Описание
Error	Объект ошибки.
ErrorCode	Код ошибки, доступный для чтения человеком.
ErrorResponse	Ответ на ошибку.
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

Object

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

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

ErrorCode

Перечисление

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

Значение	Описание
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Ответ на ошибку.

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

InnerErrorCode

Перечисление

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

Значение	Описание
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по 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	Значения смещения и длины будут соответствовать единицам кода UTF-16. Используйте этот параметр, если приложение написано на языке, поддерживающем Юникод, например Java, JavaScript.