Miscellaneous Operations - Get Resource Info

Referenz

Service:: Azure AI Services

API Version:: 2024-02-29-preview

Gibt Informationen zur aktuellen Ressource zurück.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Der Document Intelligence-Dienstendpunkt.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	ResourceDetails	Die Anforderung war erfolgreich.
Other Status Codes	ErrorResponse	Eine unerwartete Fehlerantwort.

Sicherheit

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	Beschreibung
https://cognitiveservices.azure.com/.default

Beispiele

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

Definitionen

Name	Beschreibung
CustomDocumentModelsDetails	Details zu benutzerdefinierten Dokumentmodellen.
Error	Das Fehlerobjekt.
ErrorResponse	Fehlerantwortobjekt.
InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.
QuotaDetails	Verwendetes Kontingent, Limit und Datum/Uhrzeit der nächsten Zurücksetzung.
ResourceDetails	Allgemeine Informationen zur aktuellen Ressource.

CustomDocumentModelsDetails

Details zu benutzerdefinierten Dokumentmodellen.

Name	Typ	Beschreibung
count	integer	Anzahl der benutzerdefinierten Dokumentmodelle in der aktuellen Ressource.
limit	integer	Maximale Anzahl von benutzerdefinierten Dokumentmodellen, die in der aktuellen Ressource unterstützt werden.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Einer von einem serverdefiniertem Satz von Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorResponse

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	Error	Fehlerinformationen.

InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält.

Name	Typ	Beschreibung
code	string	Einer von einem serverdefiniertem Satz von Fehlercodes.
innererror	InnerError	Innerer Fehler.
message	string	Eine lesbare Darstellung des Fehlers.

QuotaDetails

Verwendetes Kontingent, Limit und Datum/Uhrzeit der nächsten Zurücksetzung.

Name	Typ	Beschreibung
quota	integer	Ressourcenkontingentlimit.
quotaResetDateTime	string	Datum/Uhrzeit, zu dem die Ressourcenkontingentnutzung zurückgesetzt wird.
used	integer	Die Menge des verwendeten Ressourcenkontingents.

ResourceDetails

Allgemeine Informationen zur aktuellen Ressource.

Name	Typ	Beschreibung
customDocumentModels	CustomDocumentModelsDetails	Details zu benutzerdefinierten Dokumentmodellen.
customNeuralDocumentModelBuilds	QuotaDetails	Verwendetes Kontingent, Limit und Datum/Uhrzeit der nächsten Zurücksetzung.

Share via