Question Answering Projects - Get Export Status

サービス:

Azure AI Services

API バージョン:

2021-10-01

エクスポート ジョブの状態を取得します。ジョブが完了すると、プロジェクトメタデータとアセットが返されます。

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/export/jobs/{jobId}?api-version=2021-10-01

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com).
jobId	path	True	string	ジョブ ID。
projectName	path	True	string maxLength: 100	使用するプロジェクトの名前。
api-version	query	True	string	クライアント API のバージョン。

要求ヘッダー

名前	必須	型	説明
Ocp-Apim-Subscription-Key	True	string

応答

名前	型	説明
200 OK	ExportJobState	ジョブの状態、プロジェクト メタデータ、および資産をエクスポートします。
Other Status Codes	ErrorResponse	エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

例

Successful query

要求のサンプル

HTTP

GET {Endpoint}/language/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2021-10-01

応答のサンプル

状態コード:

200

{
  "errors": [],
  "createdDateTime": "2021-05-01T17:21:14Z",
  "expirationDateTime": "2021-05-01T17:21:14Z",
  "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a",
  "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
  "status": "succeeded",
  "resultUrl": "https://<resource-endpoint>/language/proj1/export/job1/result"
}

定義

名前	説明
Error	エラー オブジェクト。
ErrorCode	人間が判読できるエラー コード。
ErrorResponse	エラー応答。
ExportJobState	ジョブの状態、プロジェクト メタデータ、および資産をエクスポートします。
InnerErrorCode	人間が判読できるエラー コード。
InnerErrorModel	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
jobStatus	ジョブの状態。

Error

Object

エラー オブジェクト。

名前	型	説明
code	ErrorCode	サーバー定義の一連のエラー コードの 1 つ。
details	Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

ErrorCode

列挙

人間が判読できるエラー コード。

値	説明
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

エラー応答。

名前	型	説明
error	Error	エラー オブジェクト。

ExportJobState

Object

ジョブの状態、プロジェクト メタデータ、および資産をエクスポートします。

名前	型	説明
createdDateTime	string (date-time)
errors	Error[]	エラー オブジェクト。
expirationDateTime	string (date-time)
jobId	string
lastUpdatedDateTime	string (date-time)
resultUrl	string	エクスポート ジョブの結果をダウンロードするための URL。
status	jobStatus	ジョブの状態。

InnerErrorCode

列挙

人間が判読できるエラー コード。

値	説明
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

名前	型	説明
code	InnerErrorCode	サーバー定義の一連のエラー コードの 1 つ。
details	object	エラーの詳細。
innererror	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーメッセージ。
target	string	エラーターゲット。

jobStatus

列挙

ジョブの状態。

値	説明
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded