Document Models - Compose Model

Service:

Azure AI Services

API Version:

2023-07-31

Skapar en ny dokumentmodell från dokumenttyper av befintliga dokumentmodeller.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string url	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	Begärd API-version.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Den hemliga nyckeln för din Azure Cognitive Services-prenumeration.

Begärandetext

Name	Obligatorisk	Typ	Description
componentModels	True	ComponentDocumentModelDetails[]	Lista över de komponentdokumentmodeller som ska skrivas.
modelId	True	string	Unikt namn på dokumentmodell.
description		string	Beskrivning av dokumentmodell.
tags		object	Lista över nyckel/värde-taggattribut som är associerade med dokumentmodellen.

Svar

Name	Typ	Description
202 Accepted		Begäran har placerats i kö. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Ett fel påträffades.

Säkerhet

Ocp-Apim-Subscription-Key

Den hemliga nyckeln för din Azure Cognitive Services-prenumeration.

Type: apiKey
In: header

Exempel

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

Definitioner

Name	Description
ComponentDocumentModelDetails	En komponent i en sammansatt dokumentmodell.
ComposeDocumentModelRequest	Begär brödtext för att skapa en sammansatt dokumentmodell från komponentdokumentmodeller.
Error	Felinformation.
ErrorResponse	Felsvarsobjekt.
InnerError	Detaljerat fel.

ComponentDocumentModelDetails

En komponent i en sammansatt dokumentmodell.

Name	Typ	Description
modelId	string	Unikt namn på dokumentmodell.

ComposeDocumentModelRequest

Begär brödtext för att skapa en sammansatt dokumentmodell från komponentdokumentmodeller.

Name	Typ	Description
componentModels	ComponentDocumentModelDetails[]	Lista över de komponentdokumentmodeller som ska skrivas.
description	string	Beskrivning av dokumentmodell.
modelId	string	Unikt namn på dokumentmodell.
tags	object	Lista över nyckel/värde-taggattribut som är associerade med dokumentmodellen.

Error

Felinformation.

Name	Typ	Description
code	string	Felkod.
details	Error[]	Lista över detaljerade fel.
innererror	InnerError	Detaljerat fel.
message	string	Felmeddelande.
target	string	Målet för felet.

ErrorResponse

Felsvarsobjekt.

Name	Typ	Description
error	Error	Felinformation.

InnerError

Detaljerat fel.

Name	Typ	Description
code	string	Felkod.
innererror	InnerError	Detaljerat fel.
message	string	Felmeddelande.