Miscellaneous Operations - Get Resource Details

Referenz

Dienst:: Azure AI Services

API-Version:: 2024-11-30

Gibt Informationen zur aktuellen Ressource zurück.

GET {endpoint}/documentintelligence/info?api-version=2024-11-30

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string uri	Der Document Intelligence-Dienstendpunkt.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	DocumentIntelligenceResourceDetails	Die Anforderung ist erfolgreich.
Other Status Codes	DocumentIntelligenceErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

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

Beispiele

Get Resource Details

Beispielanforderung

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/info?api-version=2024-11-30

Beispiel für eine Antwort

Statuscode:: 200

{
  "customDocumentModels": {
    "count": 2,
    "limit": 13
  }
}

Definitionen

Name	Beschreibung
CustomDocumentModelsDetails	Details zu benutzerdefinierten Dokumentmodellen.
DocumentIntelligenceError	Das Fehlerobjekt.
DocumentIntelligenceErrorResponse	Fehlerantwortobjekt.
DocumentIntelligenceInnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.
DocumentIntelligenceResourceDetails	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.

DocumentIntelligenceError

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	DocumentIntelligenceError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	DocumentIntelligenceInnerError	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.

DocumentIntelligenceErrorResponse

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	DocumentIntelligenceError	Fehlerinformationen.

DocumentIntelligenceInnerError

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

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	DocumentIntelligenceInnerError	Innerer Fehler.
message	string	Eine lesbare Darstellung des Fehlers.

DocumentIntelligenceResourceDetails

Allgemeine Informationen zur aktuellen Ressource.

Name	Typ	Beschreibung
customDocumentModels	CustomDocumentModelsDetails	Details zu benutzerdefinierten Dokumentmodellen.

Freigeben über