Miscellaneous Operations - Get Resource Details

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-11-30

Retornar informações sobre o recurso atual.

GET {endpoint}/documentintelligence/info?api-version=2024-11-30

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string uri	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	DocumentIntelligenceResourceDetails	A solicitação foi bem-sucedida.
Other Status Codes	DocumentIntelligenceErrorResponse	Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/token

Escopos

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

Exemplos

Get Resource Details

Solicitação de exemplo

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/info?api-version=2024-11-30

Resposta de exemplo

Código de status:: 200

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

Definições

Nome	Description
CustomDocumentModelsDetails	Detalhes sobre modelos de documentos personalizados.
DocumentIntelligenceError	O objeto de erro.
DocumentIntelligenceErrorResponse	Objeto de resposta de erro.
DocumentIntelligenceInnerError	Um objeto que contém informações mais específicas sobre o erro.
DocumentIntelligenceResourceDetails	Informações gerais sobre o recurso atual.

CustomDocumentModelsDetails

Detalhes sobre modelos de documentos personalizados.

Nome	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 com suporte no recurso atual.

DocumentIntelligenceError

O objeto de erro.

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

DocumentIntelligenceErrorResponse

Objeto de resposta de erro.

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

DocumentIntelligenceInnerError

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	DocumentIntelligenceInnerError	Erro interno.
message	string	Uma representação legível pelo ser humano do erro.

DocumentIntelligenceResourceDetails

Informações gerais sobre o recurso atual.

Nome	Tipo	Description
customDocumentModels	CustomDocumentModelsDetails	Detalhes sobre modelos de documentos personalizados.

Compartilhar via