Miscellaneous Operations - Get Resource Info

Référence

Service:: Azure AI Services

API Version:: 2024-02-29-preview

Retourne des informations sur la ressource actuelle.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	Point de terminaison du service Document Intelligence.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ResourceDetails	La demande a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

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

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

Exemples

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

Définitions

Nom	Description
CustomDocumentModelsDetails	Détails sur les modèles de documents personnalisés.
Error	Objet d’erreur.
ErrorResponse	Objet de réponse d’erreur.
InnerError	Objet contenant des informations plus spécifiques sur l’erreur.
QuotaDetails	Date/heure de réinitialisation du quota utilisé, limite et prochaine réinitialisation.
ResourceDetails	Informations générales sur la ressource actuelle.

CustomDocumentModelsDetails

Détails sur les modèles de documents personnalisés.

Nom	Type	Description
count	integer	Nombre de modèles de document personnalisés dans la ressource actuelle.
limit	integer	Nombre maximal de modèles de documents personnalisés pris en charge dans la ressource actuelle.

Error

Objet d’erreur.

Nom	Type	Description
code	string	Un des codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

ErrorResponse

Objet de réponse d’erreur.

Nom	Type	Description
error	Error	Informations d’erreur.

InnerError

Objet contenant des informations plus spécifiques sur l’erreur.

Nom	Type	Description
code	string	Un des codes d’erreur définis par le serveur.
innererror	InnerError	Erreur interne.
message	string	Représentation lisible par l’homme de l’erreur.

QuotaDetails

Date/heure de réinitialisation du quota utilisé, limite et prochaine réinitialisation.

Nom	Type	Description
quota	integer	Limite de quota de ressources.
quotaResetDateTime	string	Date/heure à laquelle l’utilisation du quota de ressources sera réinitialisée.
used	integer	Quantité du quota de ressources utilisé.

ResourceDetails

Informations générales sur la ressource actuelle.

Nom	Type	Description
customDocumentModels	CustomDocumentModelsDetails	Détails sur les modèles de documents personnalisés.
customNeuralDocumentModelBuilds	QuotaDetails	Date/heure de réinitialisation du quota utilisé, limite et prochaine réinitialisation.

Partager via