Document Models - Compose Model
Cria um novo modelo de documento a partir de tipos de documentos de modelos de documentos existentes.
POST {endpoint}/documentintelligence/documentModels:compose?api-version=2024-02-29-preview
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
O ponto final de serviço do Document Intelligence. |
api-version
|
query | True |
string |
A versão da API a utilizar para esta operação. |
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 foi aceite para processamento, mas o processamento ainda não foi concluído. Headers
|
|
Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
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
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Exemplos
Compose Document Model
Sample Request
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
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-02-29-preview
Definições
Name | Description |
---|---|
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 |
O objeto de erro. |
Error |
Objeto de resposta de erro. |
Inner |
Um objeto que contém informações mais específicas sobre o erro. |
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
O objeto de erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Um dos conjuntos de códigos de erro definidos pelo servidor. |
details |
Error[] |
Uma série de detalhes sobre erros específicos que levaram a este erro comunicado. |
innererror |
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 destino do erro. |
ErrorResponse
Objeto de resposta de erro.
Name | Tipo | Description |
---|---|---|
error |
Informações de erro. |
InnerError
Um objeto que contém informações mais específicas sobre o erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Um dos conjuntos de códigos de erro definidos pelo servidor. |
innererror |
Erro interno. |
|
message |
string |
Uma representação legível por humanos do erro. |