Document Models - Compose Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

POST {endpoint}/documentintelligence/documentModels:compose?api-version=2024-02-29-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Endpoint del servizio Document Intelligence.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

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 è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

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

Nome	Descrizione
https://cognitiveservices.azure.com/.default

Esempio

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

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	Oggetto error.
ErrorResponse	Oggetto risposta errore.
InnerError	Oggetto contenente informazioni più specifiche sull'errore.

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

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto risposta errore.

Nome	Tipo	Descrizione
error	Error	Informazioni sull'errore.

InnerError

Oggetto contenente informazioni più specifiche sull'errore.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
innererror	InnerError	Errore interno.
message	string	Rappresentazione leggibile dell'errore.