Document Models - Compose Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Punkt końcowy usługi Analizy dokumentów.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

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 zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

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

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

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

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	Obiekt błędu.
ErrorResponse	Błąd obiektu odpowiedzi.
InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie.

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

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorResponse

Błąd obiektu odpowiedzi.

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

InnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	InnerError	Błąd wewnętrzny.
message	string	Czytelna dla człowieka reprezentacja błędu.