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 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	Document Intelligence 服務端點。
api-version	query	True	string	用於此作業的 API 版本。

回應

名稱	類型	Description
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

名稱	Description
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"
  }
}

定義

名稱	Description
CustomDocumentModelsDetails	自訂檔案模型的詳細數據。
Error	error 物件。
ErrorResponse	錯誤回應物件。
InnerError	物件，包含錯誤的詳細資訊。
QuotaDetails	已使用配額、限制和下一次重設日期/時間。
ResourceDetails	關於目前資源的一般資訊。

CustomDocumentModelsDetails

自訂檔案模型的詳細數據。

名稱	類型	Description
count	integer	目前資源中的自定義檔模型數目。
limit	integer	目前資源支援的最大自定義檔模型數目。

Error

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	InnerError	物件，包含比目前對象有關錯誤更具體的資訊。
message	string	人類可讀取的錯誤表示法。
target	string	錯誤的目標。

ErrorResponse

錯誤回應物件。

名稱	類型	Description
error	Error	錯誤資訊。

InnerError

物件，包含錯誤的詳細資訊。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	InnerError	內部錯誤。
message	string	人類可讀取的錯誤表示法。

QuotaDetails

已使用配額、限制和下一次重設日期/時間。

名稱	類型	Description
quota	integer	資源配額限制。
quotaResetDateTime	string	將會重設資源配額使用量的日期/時間。
used	integer	使用的資源配額數量。

ResourceDetails

關於目前資源的一般資訊。

名稱	類型	Description
customDocumentModels	CustomDocumentModelsDetails	自訂檔案模型的詳細數據。
customNeuralDocumentModelBuilds	QuotaDetails	已使用配額、限制和下一次重設日期/時間。

共用方式為