Text Analysis Authoring - Get Load Snapshot Status
スナップショットを読み込むための状態を取得します。
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}?api-version=2023-04-01URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Endpoint
|
path | True |
string |
サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com). |
|
job
|
path | True |
string |
ジョブ ID。 |
|
project
|
path | True |
string |
使用するプロジェクトの名前。 |
|
trained
|
path | True |
string |
トレーニング済みのモデル ラベル。 |
|
api-version
|
query | True |
string |
クライアント API バージョン。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
実行時間の長い操作の詳細。 |
|
| Other Status Codes |
エラー応答。 |
セキュリティ
AADToken
これらは Azure Active Directory OAuth2 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタム ロールを使用して、任意のユーザー、グループ、またはサービス プリンシパルにアクセス権 Azure Mapsを付与できます。
シナリオを実装するには、 認証の概念を表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。
メモ
- このセキュリティ定義では、 ヘッダーを使用して、
x-ms-client-idアプリケーションがアクセスを要求しているリソースAzure Maps示す必要があります。 これは、 Maps 管理 API から取得できます。
Authorization URLは、Azure パブリック クラウド インスタンスに固有です。 ソブリン クラウドには、一意の承認 URL と Azure Active Directory 構成があります。
* Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。
* Azure Maps Web SDK を使用すると、複数のユース ケースに対してアプリケーションを構成ベースで設定できます。
- 現在、Azure Active Directory v1.0 または v2.0 は職場、学校、ゲストをサポートしていますが、個人用アカウントはサポートしていません。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| 名前 | 説明 |
|---|---|
| https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
言語サービス リソースのサブスクリプション キー。
Type:
apiKey
In:
header
例
Successful Get Load Snapshot Status
Sample Request
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models/model1/load-snapshot/jobs/8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000?api-version=2023-04-01
Sample Response
{
"jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000",
"createdDateTime": "2022-04-18T15:44:44Z",
"lastUpdatedDateTime": "2022-04-18T15:45:48Z",
"expirationDateTime": "2022-04-25T15:44:44Z",
"status": "running"
}定義
| 名前 | 説明 |
|---|---|
| Error |
error オブジェクト。 |
|
Error |
人間が判読できるエラー コード。 |
|
Error |
エラー応答。 |
|
Inner |
人間が判読できるエラー コード。 |
|
Inner |
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。 |
|
Job |
ジョブの状態。 |
|
Text |
スナップショット ジョブの読み込みの状態を表します。 |
|
Text |
要求の実行中に発生した警告を表します。 |
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 |
TextAnalysisAuthoringLoadSnapshotJobState
スナップショット ジョブの読み込みの状態を表します。
| 名前 | 型 | 説明 |
|---|---|---|
| createdDateTime |
string |
ジョブの作成日時。 |
| errors |
Error[] |
ジョブの実行中に発生したエラー。 |
| expirationDateTime |
string |
ジョブの有効期限の日付時刻。 |
| jobId |
string |
ジョブ ID。 |
| lastUpdatedDateTime |
string |
ジョブが更新された最後の日付時刻。 |
| status |
ジョブの状態。 |
|
| warnings |
ジョブの実行中に発生した警告。 |
TextAnalysisAuthoringWarning
要求の実行中に発生した警告を表します。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
警告コード。 |
| message |
string |
警告メッセージ。 |