Document Models - Compose Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

Crea un nuevo modelo de documento a partir de los tipos de documento de los modelos de documento existentes.

POST {endpoint}/documentintelligence/documentModels:compose?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.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
componentModels	True	ComponentDocumentModelDetails[]	Lista de modelos de documentos de componentes que se van a componer.
modelId	True	string	Nombre único del modelo de documento.
description		string	Descripción del modelo de documento.
tags		object	Lista de atributos de etiqueta clave-valor asociados al modelo de documento.

Respuestas

Nombre	Tipo	Description
202 Accepted		La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. Headers Operation-Location: string Retry-After: integer
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

Compose Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:compose?api-version=2024-02-29-preview

{
  "modelId": "composedModel",
  "description": "Composed model description",
  "componentModels": [
    {
      "modelId": "model1"
    },
    {
      "modelId": "model2"
    }
  ]
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-02-29-preview

Definiciones

Nombre	Description
ComponentDocumentModelDetails	Componente de un modelo de documento compuesto.
ComposeDocumentModelRequest	Cuerpo de la solicitud para crear un modelo de documento compuesto a partir de modelos de documentos componentes.
Error	Objeto de error.
ErrorResponse	Objeto de respuesta de error.
InnerError	Objeto que contiene información más específica sobre el error.

ComponentDocumentModelDetails

Componente de un modelo de documento compuesto.

Nombre	Tipo	Description
modelId	string	Nombre único del modelo de documento.

ComposeDocumentModelRequest

Cuerpo de la solicitud para crear un modelo de documento compuesto a partir de modelos de documentos componentes.

Nombre	Tipo	Description
componentModels	ComponentDocumentModelDetails[]	Lista de modelos de documentos de componentes que se van a componer.
description	string	Descripción del modelo de documento.
modelId	string	Nombre único del modelo de documento.
tags	object	Lista de atributos de etiqueta clave-valor asociados al modelo de documento.

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.