Document Models - Compose Model

Služba:

Azure AI Services

Verze rozhraní API:

2022-08-31

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

POST {endpoint}/formrecognizer/documentModels:compose?api-version=2022-08-31

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	ApiVersion	Požadovaná verze rozhraní API

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string

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		Požadavek je úspěšně zařazen do fronty. Hlavičky Operation-Location: string
Other Status Codes	ErrorResponse	Došlo k chybě.

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

Příklady

ComposeDocumentModel

Ukázkový požadavek

HTTP

POST {endpoint}/formrecognizer/documentModels:compose?api-version=2022-08-31

{
  "modelId": "{composedModelId}",
  "description": "{composedModelDescription}",
  "componentModels": [
    {
      "modelId": "{modelId1}"
    },
    {
      "modelId": "{modelId2}"
    }
  ]
}

Ukázková odpověď

Stavový kód:

202

Operation-Location: {endpoint}/formrecognizer/operations/{operationId}?api-version=2022-08-31

Definice

Name	Description
ApiVersion	Verze rozhraní API.
ComponentDocumentModelDetails	Součást složeného modelu dokumentu.
ComposeDocumentModelRequest	Text požadavku na vytvoření složeného modelu dokumentu z modelů dokumentů komponent.
Error	Informace o chybě.
ErrorResponse	Objekt odpovědi na chybu.
InnerError	Podrobná chyba.

ApiVersion

Verze rozhraní API.

Name	Typ	Description
2022-08-31	string

ComponentDocumentModelDetails

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

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

ComposeDocumentModelRequest

Text požadavku na 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

Informace o chybě.

Name	Typ	Description
code	string	Kód chyby
details	Error[]	Seznam podrobných chyb
innererror	InnerError	Podrobná chyba.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt odpovědi na chybu.

Name	Typ	Description
error	Error	Informace o chybě.

InnerError

Podrobná chyba.

Name	Typ	Description
code	string	Kód chyby
innererror	InnerError	Podrobná chyba.
message	string	Chybová zpráva.