Text Analysis Authoring - Get Import Status

リファレンス

サービス:: Azure AI Services

API バージョン:: 2023-04-01

インポートの状態を取得します。

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}?api-version=2023-04-01

URI パラメーター

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

応答

名前	型	説明
200 OK	TextAnalysisAuthoringImportProjectJobState	要求は成功しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/token

スコープ

名前	説明
https://cognitiveservices.azure.com/.default

例

Successful Get Import Status

要求のサンプル

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000?api-version=2023-04-01

応答のサンプル

状態コード:: 200

{
  "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000",
  "createdDateTime": "2022-04-18T15:17:20Z",
  "lastUpdatedDateTime": "2022-04-18T15:17:22Z",
  "expirationDateTime": "2022-04-25T15:17:20Z",
  "status": "succeeded"
}

定義

名前	説明
Error	エラーオブジェクト。
ErrorCode	人間が判読できるエラーコード。
ErrorResponse	エラー応答。
InnerErrorCode	人間が判読できるエラーコード。
InnerErrorModel	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus
TextAnalysisAuthoringImportProjectJobState	インポートジョブの状態を表します。
TextAnalysisAuthoringWarning	要求の実行中に発生した警告を表します。

Error

エラーオブジェクト。

名前	型	説明
code	ErrorCode	サーバー定義の一連のエラーコードの 1 つ。
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	エラーオブジェクト。

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	InnerErrorCode	サーバー定義の一連のエラーコードの 1 つ。
details	object	エラーの詳細。
innererror	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーメッセージ。
target	string	エラーターゲット。

JobStatus

名前	型	説明
cancelled	string
cancelling	string
failed	string
notStarted	string
partiallyCompleted	string
running	string
succeeded	string

TextAnalysisAuthoringImportProjectJobState

インポートジョブの状態を表します。

名前	型	説明
createdDateTime	string	ジョブの作成日時。
errors	Error[]	ジョブの実行中に発生したエラー。
expirationDateTime	string	ジョブの有効期限の日時。
jobId	string	ジョブ ID。
lastUpdatedDateTime	string	ジョブが更新された最後の日付。
status	JobStatus	ジョブの状態。
warnings	TextAnalysisAuthoringWarning[]	ジョブの実行中に発生した警告。

TextAnalysisAuthoringWarning

要求の実行中に発生した警告を表します。

名前	型	説明
code	string	警告コード。
message	string	警告メッセージ。

次の方法で共有