Miscellaneous Operations - Get Resource Info

Referência

Service:: Azure AI Services

API Version:: 2024-02-29-preview

Devolver informações sobre o recurso atual.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	O ponto final de serviço do Document Intelligence.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	ResourceDetails	O pedido foi efetuada com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

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

Exemplos

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

Definições

Name	Description
CustomDocumentModelsDetails	Detalhes sobre modelos de documentos personalizados.
Error	O objeto de erro.
ErrorResponse	Objeto de resposta de erro.
InnerError	Um objeto que contém informações mais específicas sobre o erro.
QuotaDetails	Quota utilizada, limite e próxima data/hora de reposição.
ResourceDetails	Informações gerais sobre o recurso atual.

CustomDocumentModelsDetails

Detalhes sobre modelos de documentos personalizados.

Name	Tipo	Description
count	integer	Número de modelos de documentos personalizados no recurso atual.
limit	integer	Número máximo de modelos de documentos personalizados suportados no recurso atual.

Error

O objeto de erro.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma série de detalhes sobre erros específicos que levaram a este erro comunicado.
innererror	InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O destino do erro.

ErrorResponse

Objeto de resposta de erro.

Name	Tipo	Description
error	Error	Informações de erro.

InnerError

Um objeto que contém informações mais específicas sobre o erro.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
innererror	InnerError	Erro interno.
message	string	Uma representação legível por humanos do erro.

QuotaDetails

Quota utilizada, limite e próxima data/hora de reposição.

Name	Tipo	Description
quota	integer	Limite de quota de recursos.
quotaResetDateTime	string	Data/hora em que a utilização da quota de recursos será reposta.
used	integer	Quantidade da quota de recursos utilizada.

ResourceDetails

Informações gerais sobre o recurso atual.

Name	Tipo	Description
customDocumentModels	CustomDocumentModelsDetails	Detalhes sobre modelos de documentos personalizados.
customNeuralDocumentModelBuilds	QuotaDetails	Quota utilizada, limite e próxima data/hora de reposição.

Partilhar via