Document Models - Compose Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

Erstellt ein neues Dokumentmodell aus Dokumenttypen vorhandener Dokumentmodelle.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Der Document Intelligence-Dienstendpunkt.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
componentModels	True	ComponentDocumentModelDetails[]	Liste der zu erstellenden Komponentendokumentmodelle.
modelId	True	string	Eindeutiger Name des Dokumentmodells.
description		string	Dokumentmodellbeschreibung.
tags		object	Liste der Schlüssel-Wert-Tagattribute, die dem Dokumentmodell zugeordnet sind.

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung wurde für die Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Eine unerwartete Fehlerantwort.

Sicherheit

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	Beschreibung
https://cognitiveservices.azure.com/.default

Beispiele

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

Definitionen

Name	Beschreibung
ComponentDocumentModelDetails	Eine Komponente eines zusammengesetzten Dokumentmodells.
ComposeDocumentModelRequest	Fordern Sie den Text an, um ein zusammengesetztes Dokumentmodell aus Komponentendokumentmodellen zu erstellen.
Error	Das Fehlerobjekt.
ErrorResponse	Fehlerantwortobjekt.
InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.

ComponentDocumentModelDetails

Eine Komponente eines zusammengesetzten Dokumentmodells.

Name	Typ	Beschreibung
modelId	string	Eindeutiger Name des Dokumentmodells.

ComposeDocumentModelRequest

Fordern Sie den Text an, um ein zusammengesetztes Dokumentmodell aus Komponentendokumentmodellen zu erstellen.

Name	Typ	Beschreibung
componentModels	ComponentDocumentModelDetails[]	Liste der zu erstellenden Komponentendokumentmodelle.
description	string	Dokumentmodellbeschreibung.
modelId	string	Eindeutiger Name des Dokumentmodells.
tags	object	Liste der Schlüssel-Wert-Tagattribute, die dem Dokumentmodell zugeordnet sind.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorResponse

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	Error	Fehlerinformationen.

InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält.

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten Fehlercodes.
innererror	InnerError	Innerer Fehler.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.