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 do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string uri	O ponto de extremidade do serviço de Inteligência de Documentos.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	DocumentIntelligenceResourceDetails	O pedido foi bem-sucedido.
Other Status Codes	DocumentIntelligenceErrorResponse	Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

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

Âmbitos

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

Exemplos

Get Resource Details

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	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.

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.

DocumentIntelligenceError

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
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 por humanos do erro.
target	string	O alvo do erro.

DocumentIntelligenceErrorResponse

Objeto de resposta de erro.

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

DocumentIntelligenceInnerError

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

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

DocumentIntelligenceResourceDetails

Informações gerais sobre o recurso atual.

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

Partilhar via