Document Models - Compose Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

Vytvoří nový model dokumentu z typů dokumentů existujících modelů dokumentů.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Koncový bod služby Document Intelligence.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
componentModels	True	ComponentDocumentModelDetails[]	Seznam modelů dokumentů komponent, které se mají vytvořit
modelId	True	string	Jedinečný název modelu dokumentu.
description		string	Popis modelu dokumentu
tags		object	Seznam atributů značky klíč-hodnota přidružených k modelu dokumentu

Odpovědi

Name	Typ	Description
202 Accepted		Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď.

Zabezpečení

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

Příklady

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

Definice

Name	Description
ComponentDocumentModelDetails	Součást složeného modelu dokumentu.
ComposeDocumentModelRequest	Text žádosti o vytvoření složeného modelu dokumentu z modelů dokumentů komponent
Error	Objekt chyby.
ErrorResponse	Objekt odpovědi na chybu.
InnerError	Objekt obsahující konkrétnější informace o chybě.

ComponentDocumentModelDetails

Součást složeného modelu dokumentu.

Name	Typ	Description
modelId	string	Jedinečný název modelu dokumentu.

ComposeDocumentModelRequest

Text žádosti o vytvoření složeného modelu dokumentu z modelů dokumentů komponent

Name	Typ	Description
componentModels	ComponentDocumentModelDetails[]	Seznam modelů dokumentů komponent, které se mají vytvořit
description	string	Popis modelu dokumentu
modelId	string	Jedinečný název modelu dokumentu.
tags	object	Seznam atributů značky klíč-hodnota přidružených k modelu dokumentu

Error

Objekt chyby.

Name	Typ	Description
code	string	Jeden ze serverem definované sady kódů chyb.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerError	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl chyby.

ErrorResponse

Objekt odpovědi na chybu.

Name	Typ	Description
error	Error	Informace o chybě.

InnerError

Objekt obsahující konkrétnější informace o chybě.

Name	Typ	Description
code	string	Jeden ze serverem definované sady kódů chyb.
innererror	InnerError	Vnitřní chyba.
message	string	Lidsky čitelná reprezentace chyby.