Document Models - Compose Model

Service:

Azure AI Services

API Version:

2023-07-31

Crea un nuovo modello di documento dai tipi di documenti esistenti.

POST {endpoint}/formrecognizer/documentModels:compose?api-version=2023-07-31

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string url	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	Versione dell'API richiesta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string	Chiave privata per la sottoscrizione di Servizi cognitivi di Azure.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
componentModels	True	ComponentDocumentModelDetails[]	Elenco dei modelli di documento dei componenti da comporre.
modelId	True	string	Nome univoco del modello di documento.
description		string	Descrizione del modello di documento.
tags		object	Elenco degli attributi di tag chiave-valore associati al modello di documento.

Risposte

Nome	Tipo	Descrizione
202 Accepted		La richiesta viene accodata correttamente. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Errore rilevato.

Sicurezza

Ocp-Apim-Subscription-Key

Chiave privata per la sottoscrizione di Servizi cognitivi di Azure.

Type: apiKey
In: header

Esempio

Compose Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels:compose?api-version=2023-07-31

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

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

Definizioni

Nome	Descrizione
ComponentDocumentModelDetails	Componente di un modello di documento composto.
ComposeDocumentModelRequest	Richiedere il corpo per creare un modello di documento composto da modelli di documento componente.
Error	Informazioni sull'errore.
ErrorResponse	Oggetto risposta errore.
InnerError	Errore dettagliato.

ComponentDocumentModelDetails

Componente di un modello di documento composto.

Nome	Tipo	Descrizione
modelId	string	Nome univoco del modello di documento.

ComposeDocumentModelRequest

Richiedere il corpo per creare un modello di documento composto da modelli di documento componente.

Nome	Tipo	Descrizione
componentModels	ComponentDocumentModelDetails[]	Elenco dei modelli di documento dei componenti da comporre.
description	string	Descrizione del modello di documento.
modelId	string	Nome univoco del modello di documento.
tags	object	Elenco degli attributi di tag chiave-valore associati al modello di documento.

Error

Informazioni sull'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	Error[]	Elenco degli errori dettagliati.
innererror	InnerError	Errore dettagliato.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto risposta errore.

Nome	Tipo	Descrizione
error	Error	Informazioni sull'errore.

InnerError

Errore dettagliato.

Nome	Tipo	Descrizione
code	string	Codice di errore.
innererror	InnerError	Errore dettagliato.
message	string	Messaggio di errore.