Conversational Analysis Authoring - Export
觸發作業以匯出項目的數據。
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:export?stringIndexType=Utf16CodeUnit&api-version=2023-04-01
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:export?format={format}&stringIndexType=Utf16CodeUnit&assetKind={assetKind}&trainedModelLabel={trainedModelLabel}&api-version=2023-04-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
支援的認知服務端點 (例如 https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
要使用的項目名稱。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
string
|
query | True |
指定用來解譯字串位移的方法。 如需詳細資訊,請參閱 https://aka.ms/text-analytics-offsets。 |
|
asset
|
query |
string |
要導出的資產種類。 |
|
format
|
query |
要使用的匯出項目檔格式。 |
||
trained
|
query |
string |
要導出的定型模型標籤。 如果 trainedModelLabel 為 null,則預設行為是匯出目前的工作複本。 |
回應
名稱 | 類型 | Description |
---|---|---|
202 Accepted |
成功呼叫的結果是用於檢查作業狀態的 Operation-Location 標頭。 標題 operation-location: string |
|
Other Status Codes |
錯誤回應。 |
安全性
AADToken
這些是 Azure Active Directory OAuth2 流程。 與 Azure 角色型存取控制配對時,可用來控制對 REST API 的存取 Azure 地圖服務。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務 資源帳戶或子資源的存取權。 任何使用者、群組或服務主體都可以透過內建角色或由一或多個許可權組成的自定義角色來授與存取權,以 Azure 地圖服務 REST API。
若要實作案例,建議您檢視 驗證概念。 總而言之,此安全性定義提供一個解決方案,可透過能夠針對特定 API 和範圍進行存取控制的物件,將應用程式模型化 () 。
備註
- 此安全性定義需要使用
x-ms-client-id
標頭來指出應用程式要求存取權 Azure 地圖服務 資源。 這可以從 地圖服務管理 API 取得。
Authorization URL
專屬於 Azure 公用雲端實例。 主權雲端具有唯一的授權 URL 和 Azure Active Directory 設定。
* 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 Azure 管理平面設定 Azure 角色型存取控制。
* Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式。
- Azure Active Directory v1.0 或 v2.0 目前支援公司、學校和來賓,但不支持個人帳戶。
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
語言服務資源的訂用帳戶金鑰。
類型:
apiKey
位於:
header
範例
Successful Export Project
範例要求
POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:export?stringIndexType=Utf16CodeUnit&api-version=2023-04-01
範例回覆
operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01
定義
名稱 | Description |
---|---|
Error |
error 物件。 |
Error |
人類可讀取的錯誤碼。 |
Error |
錯誤回應。 |
Exported |
要使用的匯出項目檔格式。 |
Inner |
人類可讀取的錯誤碼。 |
Inner |
物件,包含錯誤的詳細資訊。 根據 Microsoft One API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。 |
String |
指定用來解譯字串位移的方法。 如需詳細資訊,請參閱 https://aka.ms/text-analytics-offsets。 |
Error
error 物件。
名稱 | 類型 | Description |
---|---|---|
code |
其中一組伺服器定義的錯誤碼。 |
|
details |
Error[] |
導致此錯誤之特定錯誤的詳細數據陣列。 |
innererror |
物件,包含比目前對象有關錯誤更具體的資訊。 |
|
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 |
其中一組伺服器定義的錯誤碼。 |
|
details |
object |
錯誤詳細數據。 |
innererror |
物件,包含比目前對象有關錯誤更具體的資訊。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
StringIndexType
指定用來解譯字串位移的方法。 如需詳細資訊,請參閱 https://aka.ms/text-analytics-offsets。
名稱 | 類型 | Description |
---|---|---|
Utf16CodeUnit |
string |
位移和長度值會對應至UTF-16程式代碼單位。 如果您的應用程式是以支援 Unicode 的語言撰寫,例如 Java、JavaScript,請使用此選項。 |