Document Models - Compose Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

Új dokumentummodellt hoz létre a meglévő dokumentummodellek dokumentumtípusaiból.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A Document Intelligence szolgáltatás végpontja.
api-version	query	True	string	A művelethez használandó API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
componentModels	True	ComponentDocumentModelDetails[]	A összeállítandó összetevő-dokumentummodellek listája.
modelId	True	string	Egyedi dokumentummodell neve.
description		string	A dokumentummodell leírása.
tags		object	A dokumentummodellhez társított kulcs-érték címkeattribútumok listája.

Válaszok

Name	Típus	Description
202 Accepted		A kérést elfogadták feldolgozásra, de a feldolgozás még nem fejeződött be. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

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éldák

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

Definíciók

Name	Description
ComponentDocumentModelDetails	Egy összeállított dokumentummodell összetevője.
ComposeDocumentModelRequest	Törzs kérése az összetevődokumentum-modellekből álló dokumentummodell létrehozásához.
Error	A hibaobjektum.
ErrorResponse	Hibaválasz-objektum.
InnerError	Egy objektum, amely pontosabb információkat tartalmaz a hibáról.

ComponentDocumentModelDetails

Egy összeállított dokumentummodell összetevője.

Name	Típus	Description
modelId	string	Egyedi dokumentummodell neve.

ComposeDocumentModelRequest

Törzs kérése az összetevődokumentum-modellekből álló dokumentummodell létrehozásához.

Name	Típus	Description
componentModels	ComponentDocumentModelDetails[]	A összeállítandó összetevő-dokumentummodellek listája.
description	string	A dokumentummodell leírása.
modelId	string	Egyedi dokumentummodell neve.
tags	object	A dokumentummodellhez társított kulcs-érték címkeattribútumok listája.

Error

A hibaobjektum.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorResponse

Hibaválasz-objektum.

Name	Típus	Description
error	Error	Hibaadatok.

InnerError

Egy objektum, amely pontosabb információkat tartalmaz a hibáról.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
innererror	InnerError	Belső hiba.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.