Document Models - Compose Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Slutpunkten för dokumentinformationstjänsten.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

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 godkänts för bearbetning, men bearbetningen har ännu inte slutförts. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

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

Exempel

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

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	Felobjektet.
ErrorResponse	Felsvarsobjekt.
InnerError	Ett objekt som innehåller mer specifik information om felet.

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

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorResponse

Felsvarsobjekt.

Name	Typ	Description
error	Error	Felinformation.

InnerError

Ett objekt som innehåller mer specifik information om felet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	InnerError	Inre fel.
message	string	En mänsklig läsbar representation av felet.