Miscellaneous Operations - Get Resource Info

Riferimento

Service:: Azure AI Services

API Version:: 2024-02-29-preview

Restituisce informazioni sulla risorsa corrente.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Endpoint del servizio Document Intelligence.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	ResourceDetails	La richiesta ha avuto esito positivo.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

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

Nome	Descrizione
https://cognitiveservices.azure.com/.default

Esempio

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

Definizioni

Nome	Descrizione
CustomDocumentModelsDetails	Dettagli sui modelli di documento personalizzati.
Error	Oggetto error.
ErrorResponse	Oggetto risposta errore.
InnerError	Oggetto contenente informazioni più specifiche sull'errore.
QuotaDetails	Quota usata, limite e successiva reimpostazione data/ora.
ResourceDetails	Informazioni generali sulla risorsa corrente.

CustomDocumentModelsDetails

Dettagli sui modelli di documento personalizzati.

Nome	Tipo	Descrizione
count	integer	Numero di modelli di documento personalizzati nella risorsa corrente.
limit	integer	Numero massimo di modelli di documento personalizzati supportati nella risorsa corrente.

Error

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto risposta errore.

Nome	Tipo	Descrizione
error	Error	Informazioni sull'errore.

InnerError

Oggetto contenente informazioni più specifiche sull'errore.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
innererror	InnerError	Errore interno.
message	string	Rappresentazione leggibile dell'errore.

QuotaDetails

Quota usata, limite e successiva reimpostazione data/ora.

Nome	Tipo	Descrizione
quota	integer	Limite della quota di risorse.
quotaResetDateTime	string	Data/ora in cui verrà reimpostata l'utilizzo della quota di risorse.
used	integer	Quantità della quota di risorsa usata.

ResourceDetails

Informazioni generali sulla risorsa corrente.

Nome	Tipo	Descrizione
customDocumentModels	CustomDocumentModelsDetails	Dettagli sui modelli di documento personalizzati.
customNeuralDocumentModelBuilds	QuotaDetails	Quota usata, limite e successiva reimpostazione data/ora.

Share via