你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	支持的认知服务终结点（例如 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	包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - 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

包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - 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 代码单元。 如果应用程序是用支持 Unicode 的语言（例如 Java、JavaScript）编写的，请使用此选项。