Document Models - Compose Model

Service:

Azure AI Services

API Version:

2023-07-31

Tworzy nowy model dokumentu na podstawie typów dokumentów istniejących modeli dokumentów.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string url	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	Żądana wersja interfejsu API.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string	Klucz tajny subskrypcji usług Azure Cognitive Services.

Treść żądania

Nazwa	Wymagane	Typ	Opis
componentModels	True	ComponentDocumentModelDetails[]	Lista modeli dokumentów składników do tworzenia.
modelId	True	string	Unikatowa nazwa modelu dokumentu.
description		string	Opis modelu dokumentu.
tags		object	Lista atrybutów tagów klucz-wartość skojarzonych z modelem dokumentu.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Żądanie zostało pomyślnie w kolejce. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Napotkano błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Klucz tajny subskrypcji usług Azure Cognitive Services.

Type: apiKey
In: header

Przykłady

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

Definicje

Nazwa	Opis
ComponentDocumentModelDetails	Składnik złożonego modelu dokumentu.
ComposeDocumentModelRequest	Zażądaj treści utworzenia skomponowanego modelu dokumentu na podstawie modeli dokumentów składników.
Error	Informacje o błędzie.
ErrorResponse	Błąd obiektu odpowiedzi.
InnerError	Szczegółowy błąd.

ComponentDocumentModelDetails

Składnik złożonego modelu dokumentu.

Nazwa	Typ	Opis
modelId	string	Unikatowa nazwa modelu dokumentu.

ComposeDocumentModelRequest

Zażądaj treści utworzenia skomponowanego modelu dokumentu na podstawie modeli dokumentów składników.

Nazwa	Typ	Opis
componentModels	ComponentDocumentModelDetails[]	Lista modeli dokumentów składników do tworzenia.
description	string	Opis modelu dokumentu.
modelId	string	Unikatowa nazwa modelu dokumentu.
tags	object	Lista atrybutów tagów klucz-wartość skojarzonych z modelem dokumentu.

Error

Informacje o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	Error[]	Lista szczegółowych błędów.
innererror	InnerError	Szczegółowy błąd.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Błąd obiektu odpowiedzi.

Nazwa	Typ	Opis
error	Error	Informacje o błędzie.

InnerError

Szczegółowy błąd.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	InnerError	Szczegółowy błąd.
message	string	Komunikat o błędzie.