Conversational Analysis Authoring - Get Export Status
エクスポート ジョブの状態を取得します。 ジョブが完了すると、プロジェクトのメタデータと資産が返されます。
GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}?api-version=2022-05-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
Endpoint
|
path | True |
string |
サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com). |
job
|
path | True |
string |
ジョブ ID。 |
project
|
path | True |
string |
使用するプロジェクトの名前。 |
api-version
|
query | True |
string |
クライアント API バージョン。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
言語サービス リソースのサブスクリプション キー。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
実行時間の長い操作の状態。 |
|
Other Status Codes |
エラー応答。 |
セキュリティ
Ocp-Apim-Subscription-Key
言語サービス リソースのサブスクリプション キー。
型:
apiKey
/:
header
例
Successful Get Export Status
要求のサンプル
GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000?api-version=2022-05-01
応答のサンプル
{
"resultUrl": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2022-05-01",
"jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000",
"createdDateTime": "2022-04-18T15:23:07Z",
"lastUpdatedDateTime": "2022-04-18T15:23:08Z",
"expirationDateTime": "2022-04-25T15:23:07Z",
"status": "succeeded"
}
定義
名前 | 説明 |
---|---|
Conversational |
エクスポート ジョブの状態を表します。 |
Conversational |
要求の実行中に発生した警告を表します。 |
Error |
error オブジェクト。 |
Error |
人間が判読できるエラー コード。 |
Error |
エラー応答。 |
Inner |
人間が判読できるエラー コード。 |
Inner |
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。 |
Job |
ジョブの状態。 |
ConversationalAnalysisAuthoringExportProjectJobState
エクスポート ジョブの状態を表します。
名前 | 型 | 説明 |
---|---|---|
createdDateTime |
string |
ジョブの作成日時。 |
errors |
Error[] |
ジョブの実行中に発生したエラー。 |
expirationDateTime |
string |
ジョブの有効期限の日付時刻。 |
jobId |
string |
ジョブ ID。 |
lastUpdatedDateTime |
string |
ジョブが更新された最後の日付時刻。 |
resultUrl |
string |
エクスポートされたプロジェクトをダウンロードするために使用する URL。 |
status |
ジョブの状態。 |
|
warnings |
ジョブの実行中に発生した警告。 |
ConversationalAnalysisAuthoringWarning
要求の実行中に発生した警告を表します。
名前 | 型 | 説明 |
---|---|---|
code |
string |
警告コード。 |
message |
string |
警告メッセージ。 |
Error
error オブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
サーバー定義のエラー コードのセットの 1 つ。 |
|
details |
Error[] |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。 |
|
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 オブジェクト。 |
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 |
サーバー定義のエラー コードのセットの 1 つ。 |
|
details |
object |
エラーの詳細。 |
innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラー ターゲット。 |
JobStatus
ジョブの状態。
名前 | 型 | 説明 |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |