Miscellaneous Operations - Get Resource Info

リファレンス

Service:: Azure AI Services

API Version:: 2024-02-29-preview

現在のリソースに関する情報を返します。

GET {endpoint}/documentintelligence/info?api-version=2024-02-29-preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	ドキュメントインテリジェンスサービスエンドポイント。
api-version	query	True	string	この操作に使用する API バージョン。

応答

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

セキュリティ

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

例

Get Resource Details

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/info?api-version=2024-02-29-preview

Sample Response

Status code:: 200

{
  "customDocumentModels": {
    "count": 2,
    "limit": 13
  },
  "customNeuralDocumentModelBuilds": {
    "used": 1,
    "quota": 10,
    "quotaResetDateTime": "2023-03-01T00:00:00Z"
  }
}

定義

名前	説明
CustomDocumentModelsDetails	カスタムドキュメントモデルに関する詳細。
Error	error オブジェクト。
ErrorResponse	エラー応答オブジェクト。
InnerError	エラーに関するより具体的な情報を含むオブジェクト。
QuotaDetails	クォータの使用、制限、次回のリセット日時。
ResourceDetails	現在のリソースに関する一般的な情報。

CustomDocumentModelsDetails

カスタムドキュメントモデルに関する詳細。

名前	型	説明
count	integer	現在のリソース内のカスタムドキュメントモデルの数。
limit	integer	現在のリソースでサポートされているカスタムドキュメントモデルの最大数。

Error

error オブジェクト。

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

ErrorResponse

エラー応答オブジェクト。

名前	型	説明
error	Error	エラー情報。

InnerError

エラーに関するより具体的な情報を含むオブジェクト。

名前	型	説明
code	string	サーバー定義のエラーコードのセットの 1 つ。
innererror	InnerError	内部エラー。
message	string	エラーの人間が判読できる表現。

QuotaDetails

クォータの使用、制限、次回のリセット日時。

名前	型	説明
quota	integer	リソースクォータの制限。
quotaResetDateTime	string	リソースクォータの使用量がリセットされる日付/時刻。
used	integer	使用されるリソースクォータの量。

ResourceDetails

現在のリソースに関する一般的な情報。

名前	型	説明
customDocumentModels	CustomDocumentModelsDetails	カスタムドキュメントモデルに関する詳細。
customNeuralDocumentModelBuilds	QuotaDetails	クォータの使用、制限、次回のリセット日時。

Share via