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

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

包含有关错误的更具体信息的对象。 根据 Microsoft One 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	string	偏移量和长度值将对应于 UTF-16 代码单位。 如果应用程序是使用支持 Unicode 的语言编写的，例如 Java、JavaScript，请使用此选项。