Document Models - Compose Model

Service:

Azure AI Services

API Version:

2023-07-31

Hiermee maakt u een nieuw documentmodel op basis van documenttypen van bestaande documentmodellen.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string url	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	Aangevraagde API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string	De geheime sleutel voor uw Azure Cognitive Services-abonnement.

Aanvraagbody

Name	Vereist	Type	Description
componentModels	True	ComponentDocumentModelDetails[]	Lijst met documentmodellen voor onderdelen die moeten worden opgesteld.
modelId	True	string	Unieke documentmodelnaam.
description		string	Beschrijving van documentmodel.
tags		object	Lijst met sleutel-waardetagkenmerken die zijn gekoppeld aan het documentmodel.

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag is in de wachtrij geplaatst. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Er is een fout opgetreden.

Beveiliging

Ocp-Apim-Subscription-Key

De geheime sleutel voor uw Azure Cognitive Services-abonnement.

Type: apiKey
In: header

Voorbeelden

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

Definities

Name	Description
ComponentDocumentModelDetails	Een onderdeel van een samengesteld documentmodel.
ComposeDocumentModelRequest	Aanvraagbody om een samengesteld documentmodel te maken op basis van onderdeeldocumentmodellen.
Error	Foutinformatie.
ErrorResponse	Foutreactieobject.
InnerError	Gedetailleerde fout.

ComponentDocumentModelDetails

Een onderdeel van een samengesteld documentmodel.

Name	Type	Description
modelId	string	Unieke documentmodelnaam.

ComposeDocumentModelRequest

Aanvraagbody om een samengesteld documentmodel te maken op basis van onderdeeldocumentmodellen.

Name	Type	Description
componentModels	ComponentDocumentModelDetails[]	Lijst met documentmodellen voor onderdelen die moeten worden opgesteld.
description	string	Beschrijving van documentmodel.
modelId	string	Unieke documentmodelnaam.
tags	object	Lijst met sleutel-waardetagkenmerken die zijn gekoppeld aan het documentmodel.

Error

Foutinformatie.

Name	Type	Description
code	string	Foutcode.
details	Error[]	Lijst met gedetailleerde fouten.
innererror	InnerError	Gedetailleerde fout.
message	string	Foutbericht.
target	string	Doel van de fout.

ErrorResponse

Foutreactieobject.

Name	Type	Description
error	Error	Foutinformatie.

InnerError

Gedetailleerde fout.

Name	Type	Description
code	string	Foutcode.
innererror	InnerError	Gedetailleerde fout.
message	string	Foutbericht.