Miscellaneous Operations - Get Resource Info

Referencia

Service:: Azure AI Services

API Version:: 2024-02-29-preview

Devuelve información sobre el recurso actual.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Punto de conexión del servicio Document Intelligence.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	ResourceDetails	La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Respuesta de error inesperada.

Seguridad

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

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

Ejemplos

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

Definiciones

Nombre	Description
CustomDocumentModelsDetails	Detalles relacionados con los modelos de documentos personalizados.
Error	Objeto de error.
ErrorResponse	Objeto de respuesta de error.
InnerError	Objeto que contiene información más específica sobre el error.
QuotaDetails	Cuota usada, límite y siguiente restablecimiento de fecha y hora.
ResourceDetails	Información general sobre el recurso actual.

CustomDocumentModelsDetails

Detalles relacionados con los modelos de documentos personalizados.

Nombre	Tipo	Description
count	integer	Número de modelos de documento personalizados en el recurso actual.
limit	integer	Número máximo de modelos de documentos personalizados admitidos en el recurso actual.

Error

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de los conjuntos de códigos de error definidos por el servidor.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

ErrorResponse

Objeto de respuesta de error.

Nombre	Tipo	Description
error	Error	Información de error.

InnerError

Objeto que contiene información más específica sobre el error.

Nombre	Tipo	Description
code	string	Uno de los conjuntos de códigos de error definidos por el servidor.
innererror	InnerError	Error interno.
message	string	Representación legible del error.

QuotaDetails

Cuota usada, límite y siguiente restablecimiento de fecha y hora.

Nombre	Tipo	Description
quota	integer	Límite de cuota de recursos.
quotaResetDateTime	string	Fecha y hora en que se restablecerá el uso de la cuota de recursos.
used	integer	Cantidad de la cuota de recursos usada.

ResourceDetails

Información general sobre el recurso actual.

Nombre	Tipo	Description
customDocumentModels	CustomDocumentModelsDetails	Detalles relacionados con los modelos de documentos personalizados.
customNeuralDocumentModelBuilds	QuotaDetails	Cuota usada, límite y siguiente restablecimiento de fecha y hora.

Compartir a través de