Document Models - Compose Model
Cria um novo 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 do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus2.api.cognitive.microsoft.com). |
api-version
|
query | True |
Versão da API pedida. |
Cabeçalho do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Corpo do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
componentModels | True |
Lista de modelos de documentos de componentes a compor. |
|
modelId | True |
string |
Nome de modelo de documento exclusivo. |
description |
string |
Descrição do modelo de documento. |
|
tags |
object |
Lista de atributos de etiquetas chave-valor associados ao modelo de documento. |
Respostas
Name | Tipo | Description |
---|---|---|
202 Accepted |
O pedido é feito em fila com êxito. Cabeçalhos Operation-Location: string |
|
Other Status Codes |
Erro encontrado. |
Segurança
Ocp-Apim-Subscription-Key
Tipo:
apiKey
Em:
header
Exemplos
ComposeDocumentModel
Pedido de amostra
POST {endpoint}/formrecognizer/documentModels:compose?api-version=2022-08-31
{
"modelId": "{composedModelId}",
"description": "{composedModelDescription}",
"componentModels": [
{
"modelId": "{modelId1}"
},
{
"modelId": "{modelId2}"
}
]
}
Resposta da amostra
Operation-Location: {endpoint}/formrecognizer/operations/{operationId}?api-version=2022-08-31
Definições
Name | Description |
---|---|
Api |
Versão da API. |
Component |
Um componente de um modelo de documento composto. |
Compose |
Corpo do pedido para criar um modelo de documento composto a partir de modelos de documentos de componentes. |
Error |
Informações de erro. |
Error |
Objeto de resposta de erro. |
Inner |
Erro detalhado. |
ApiVersion
Versão da API.
Name | Tipo | Description |
---|---|---|
2022-08-31 |
string |
ComponentDocumentModelDetails
Um componente de um modelo de documento composto.
Name | Tipo | Description |
---|---|---|
modelId |
string |
Nome de modelo de documento exclusivo. |
ComposeDocumentModelRequest
Corpo do pedido para criar um modelo de documento composto a partir de modelos de documentos de componentes.
Name | Tipo | Description |
---|---|---|
componentModels |
Lista de modelos de documentos de componentes a compor. |
|
description |
string |
Descrição do modelo de documento. |
modelId |
string |
Nome de modelo de documento exclusivo. |
tags |
object |
Lista de atributos de etiquetas chave-valor associados ao modelo de documento. |
Error
Informações de erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro. |
details |
Error[] |
Lista de erros detalhados. |
innererror |
Erro detalhado. |
|
message |
string |
Mensagem de erro. |
target |
string |
Destino do erro. |
ErrorResponse
Objeto de resposta de erro.
Name | Tipo | Description |
---|---|---|
error |
Informações de erro. |
InnerError
Erro detalhado.
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro. |
innererror |
Erro detalhado. |
|
message |
string |
Mensagem de erro. |