Miscellaneous Operations - Get Resource Info

Reference

Service:: Azure AI Services

API Version:: 2024-02-29-preview

Return information about the current resource.

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	The Document Intelligence service endpoint.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ResourceDetails	The request has succeeded.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

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

Name	Description
https://cognitiveservices.azure.com/.default

Examples

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"
  }
}

Definitions

Name	Description
CustomDocumentModelsDetails	Details regarding custom document models.
Error	The error object.
ErrorResponse	Error response object.
InnerError	An object containing more specific information about the error.
QuotaDetails	Quota used, limit, and next reset date/time.
ResourceDetails	General information regarding the current resource.

CustomDocumentModelsDetails

Details regarding custom document models.

Name	Type	Description
count	integer	Number of custom document models in the current resource.
limit	integer	Maximum number of custom document models supported in the current resource.

Error

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Error[]	An array of details about specific errors that led to this reported error.
innererror	InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

ErrorResponse

Error response object.

Name	Type	Description
error	Error	Error info.

InnerError

An object containing more specific information about the error.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	InnerError	Inner error.
message	string	A human-readable representation of the error.

QuotaDetails

Quota used, limit, and next reset date/time.

Name	Type	Description
quota	integer	Resource quota limit.
quotaResetDateTime	string	Date/time when the resource quota usage will be reset.
used	integer	Amount of the resource quota used.

ResourceDetails

General information regarding the current resource.

Name	Type	Description
customDocumentModels	CustomDocumentModelsDetails	Details regarding custom document models.
customNeuralDocumentModelBuilds	QuotaDetails	Quota used, limit, and next reset date/time.

Share via