Document Models - Compose Model

Service:

Azure AI Services

API Version:

2022-08-31

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

POST {endpoint}/formrecognizer/documentModels:compose?api-version=2022-08-31

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	ApiVersion	Versión de API solicitada.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

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 pone en cola correctamente. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Error encontrado.

Seguridad

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Ejemplos

ComposeDocumentModel

Sample Request

HTTP

POST {endpoint}/formrecognizer/documentModels:compose?api-version=2022-08-31

{
  "modelId": "{composedModelId}",
  "description": "{composedModelDescription}",
  "componentModels": [
    {
      "modelId": "{modelId1}"
    },
    {
      "modelId": "{modelId2}"
    }
  ]
}

Sample Response

Status code:

202

Operation-Location: {endpoint}/formrecognizer/operations/{operationId}?api-version=2022-08-31

Definiciones

Nombre	Description
ApiVersion	Versión de LA API.
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	Información de error.
ErrorResponse	Objeto de respuesta de error.
InnerError	Error detallado.

ApiVersion

Versión de LA API.

Nombre	Tipo	Description
2022-08-31	string

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

Información de error.

Nombre	Tipo	Description
code	string	Código de error.
details	Error[]	Lista de errores detallados.
innererror	InnerError	Error detallado.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto de respuesta de error.

Nombre	Tipo	Description
error	Error	Información de error.

InnerError

Error detallado.

Nombre	Tipo	Description
code	string	Código de error.
innererror	InnerError	Error detallado.
message	string	Mensaje de error.