Miscellaneous Operations - Get Resource Info

Referência

Service:: Azure AI Services

API Version:: 2024-02-29-preview

Retornar informações sobre o recurso atual.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	O ponto de extremidade do serviço do Document Intelligence.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	ResourceDetails	A solicitação foi bem-sucedida.
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

Nome	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

Nome	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	Cota usada, limite e próxima data/hora de redefinição.
ResourceDetails	Informações gerais sobre o recurso atual.

CustomDocumentModelsDetails

Detalhes sobre modelos de documentos personalizados.

Nome	Tipo	Description
count	integer	Número de modelos de documento personalizados no recurso atual.
limit	integer	Número máximo de modelos de documentos personalizados com suporte no recurso atual.

Error

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
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 pelo homem do erro.
target	string	O destino do erro.

ErrorResponse

Objeto de resposta de erro.

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

InnerError

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

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	InnerError	Erro interno.
message	string	Uma representação legível pelo homem do erro.

QuotaDetails

Cota usada, limite e próxima data/hora de redefinição.

Nome	Tipo	Description
quota	integer	Limite de cota de recursos.
quotaResetDateTime	string	Data/hora em que o uso da cota de recursos será redefinido.
used	integer	Quantidade da cota de recursos usada.

ResourceDetails

Informações gerais sobre o recurso atual.

Nome	Tipo	Description
customDocumentModels	CustomDocumentModelsDetails	Detalhes sobre modelos de documentos personalizados.
customNeuralDocumentModelBuilds	QuotaDetails	Cota usada, limite e próxima data/hora de redefinição.

Compartilhar via