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

Conversational Analysis Authoring - Export

服务:

Azure AI Services

API 版本:

2023-04-01

触发作业以导出项目的数据。

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

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string
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	要使用的导出项目文件的格式。
trainedModelLabel	query		string	要导出的已训练模型标签。 如果 trainedModelLabel 为 null，则默认行为是导出当前工作副本。

响应

名称	类型	说明
202 Accepted		已接受请求进行处理，但尚未完成处理。 标头 Operation-Location: string
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: accessCode
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 URL: https://login.microsoftonline.com/common/oauth2/token

作用域

名称	说明
https://cognitiveservices.azure.com/.default

示例

Successful Export Project

示例请求

HTTP

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

示例响应

状态代码:

202

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

定义

名称	说明
Error	错误对象。
ErrorCode	人工可读错误代码。
ErrorResponse	错误响应。
ExportedProjectFormat	要使用的导出项目文件的格式。
InnerErrorCode	人工可读错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
StringIndexType

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一个 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

名称	类型	说明
Utf16CodeUnit	string	偏移量和长度值将对应于 UTF-16 代码单元。 如果应用程序是用支持 Unicode 的语言（例如 Java、JavaScript）编写的，请使用此选项。