Document Models - Compose Model

Service:

Azure AI Services

API Version:

2023-07-31

Erstellt ein neues Dokumentmodell aus Dokumenttypen vorhandener Dokumentmodelle.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string url	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus2.api.cognitive.microsoft.com
api-version	query	True	string	Angeforderte API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string	Der geheime Schlüssel für Ihr Azure Cognitive Services-Abonnement.

Anforderungstext

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

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung wird erfolgreich in die Warteschlange gestellt. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Fehler.

Sicherheit

Ocp-Apim-Subscription-Key

Der geheime Schlüssel für Ihr Azure Cognitive Services-Abonnement.

Type: apiKey
In: header

Beispiele

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

Definitionen

Name	Beschreibung
ComponentDocumentModelDetails	Eine Komponente eines zusammengesetzten Dokumentmodells.
ComposeDocumentModelRequest	Anforderungstext zum Erstellen eines zusammengesetzten Dokumentmodells aus Komponentendokumentmodellen.
Error	Fehlerinformationen.
ErrorResponse	Fehlerantwortobjekt.
InnerError	Detaillierter Fehler.

ComponentDocumentModelDetails

Eine Komponente eines zusammengesetzten Dokumentmodells.

Name	Typ	Beschreibung
modelId	string	Eindeutiger Dokumentmodellname.

ComposeDocumentModelRequest

Anforderungstext zum Erstellen eines zusammengesetzten Dokumentmodells aus Komponentendokumentmodellen.

Name	Typ	Beschreibung
componentModels	ComponentDocumentModelDetails[]	Liste der zu verfassenden Komponentendokumentmodelle.
description	string	Dokumentmodellbeschreibung.
modelId	string	Eindeutiger Dokumentmodellname.
tags	object	Liste der Schlüssel-Wert-Tag-Attribute, die dem Dokumentmodell zugeordnet sind.

Error

Fehlerinformationen.

Name	Typ	Beschreibung
code	string	Fehlercode
details	Error[]	Liste der detaillierten Fehler.
innererror	InnerError	Detaillierter Fehler.
message	string	Fehlermeldung.
target	string	Ziel des Fehlers.

ErrorResponse

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	Error	Fehlerinformationen.

InnerError

Detaillierter Fehler.

Name	Typ	Beschreibung
code	string	Fehlercode
innererror	InnerError	Detaillierter Fehler.
message	string	Fehlermeldung.