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 參數

名稱	位於	必要	類型	Description
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	要使用的匯出項目檔格式。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string	語言服務資源的訂用帳戶金鑰。

回應

名稱	類型	Description
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

定義

名稱	Description
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

錯誤物件。

名稱	類型	Description
code	ErrorCode	其中一組伺服器定義的錯誤碼。
details	Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	InnerErrorModel	物件，包含比目前對象有關錯誤的更特定資訊。
message	string	人類看得懂的錯誤表示法。
target	string	錯誤的目標。

ErrorCode

人類可讀取的錯誤碼。

名稱	類型	Description
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

錯誤回應。

名稱	類型	Description
error	Error	錯誤物件。

ExportedProjectFormat

要使用的匯出項目檔格式。

名稱	類型	Description
Conversation	string	指定交談專案的格式。
Luis	string	指定從 LUIS 導出的應用程式格式。

InnerErrorCode

人類可讀取的錯誤碼。

名稱	類型	Description
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。

名稱	類型	Description
code	InnerErrorCode	其中一組伺服器定義的錯誤碼。
details	object	錯誤詳細數據。
innererror	InnerErrorModel	物件，包含比目前對象有關錯誤的更特定資訊。
message	string	錯誤訊息。
target	string	錯誤目標。

StringIndexType

指定用來解譯字串位移的方法。 如需詳細資訊，請參閱 https://aka.ms/text-analytics-offsets。

名稱	類型	Description
Utf16CodeUnit	string	位移和長度值會對應至UTF-16程式代碼單位。 如果您的應用程式是以支援 Unicode 的語言撰寫，例如 Java、JavaScript，請使用此選項。