Miscellaneous Operations - Get Resource Info

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-07-31-preview

Zwraca informacje o bieżącym zasobie.

GET {endpoint}/documentintelligence/info?api-version=2024-07-31-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string uri	Punkt końcowy usługi Analizy dokumentów.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ResourceDetails	Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Get Resource Details

Przykładowe żądanie

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/info?api-version=2024-07-31-preview

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
CustomDocumentModelsDetails	Szczegóły dotyczące niestandardowych modeli dokumentów.
Error	Obiekt błędu.
ErrorResponse	Błąd obiektu odpowiedzi.
InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie.
ResourceDetails	Ogólne informacje dotyczące bieżącego zasobu.

CustomDocumentModelsDetails

Szczegóły dotyczące niestandardowych modeli dokumentów.

Nazwa	Typ	Opis
count	integer	Liczba niestandardowych modeli dokumentów w bieżącym zasobie.
limit	integer	Maksymalna liczba niestandardowych modeli dokumentów obsługiwanych w bieżącym zasobie.

Error

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorResponse

Błąd obiektu odpowiedzi.

Nazwa	Typ	Opis
error	Error	Informacje o błędzie.

InnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	InnerError	Błąd wewnętrzny.
message	string	Czytelna dla człowieka reprezentacja błędu.

ResourceDetails

Ogólne informacje dotyczące bieżącego zasobu.

Nazwa	Typ	Opis
customDocumentModels	CustomDocumentModelsDetails	Szczegóły dotyczące niestandardowych modeli dokumentów.