Miscellaneous Operations - Get Resource Info
Zwraca informacje o bieżącym zasobie.
GET {endpoint}/documentintelligence/info?api-version=2024-02-29-preview
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
endpoint
|
path | True |
string |
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 |
Żądanie zakończyło się pomyślnie. |
|
Other Status Codes |
Nieoczekiwana odpowiedź na błąd. |
Zabezpieczenia
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
Nazwa | Opis |
---|---|
https://cognitiveservices.azure.com/.default |
Przykłady
Get Resource Details
Sample Request
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/info?api-version=2024-02-29-preview
Sample Response
{
"customDocumentModels": {
"count": 2,
"limit": 13
},
"customNeuralDocumentModelBuilds": {
"used": 1,
"quota": 10,
"quotaResetDateTime": "2023-03-01T00:00:00Z"
}
}
Definicje
Nazwa | Opis |
---|---|
Custom |
Szczegóły dotyczące niestandardowych modeli dokumentów. |
Error |
Obiekt error. |
Error |
Błąd obiektu odpowiedzi. |
Inner |
Obiekt zawierający bardziej szczegółowe informacje o błędzie. |
Quota |
Używany limit przydziału, limit i następna data/godzina resetowania. |
Resource |
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 error.
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 |
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 |
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 |
Błąd wewnętrzny. |
|
message |
string |
Czytelna dla człowieka reprezentacja błędu. |
QuotaDetails
Używany limit przydziału, limit i następna data/godzina resetowania.
Nazwa | Typ | Opis |
---|---|---|
quota |
integer |
Limit przydziału zasobów. |
quotaResetDateTime |
string |
Data/godzina zresetowania użycia przydziału zasobów. |
used |
integer |
Ilość używanego limitu przydziału zasobów. |
ResourceDetails
Ogólne informacje dotyczące bieżącego zasobu.
Nazwa | Typ | Opis |
---|---|---|
customDocumentModels |
Szczegóły dotyczące niestandardowych modeli dokumentów. |
|
customNeuralDocumentModelBuilds |
Używany limit przydziału, limit i następna data/godzina resetowania. |