Document Models - Compose Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

Varolan belge modellerinin belge türlerinden yeni bir belge modeli oluşturur.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string	Belge Yönetim Bilgileri hizmeti uç noktası.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
componentModels	True	ComponentDocumentModelDetails[]	Oluşturacak bileşen belge modellerinin listesi.
modelId	True	string	Benzersiz belge modeli adı.
description		string	Belge modeli açıklaması.
tags		object	Belge modeliyle ilişkili anahtar-değer etiketi özniteliklerinin listesi.

Yanıtlar

Name	Tür	Description
202 Accepted		İstek işleme için kabul edildi, ancak işleme henüz tamamlanmadı. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

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

Örnekler

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

Tanımlar

Name	Description
ComponentDocumentModelDetails	Oluşturulan belge modelinin bileşeni.
ComposeDocumentModelRequest	Bileşen belge modellerinden oluşturulmuş bir belge modeli oluşturmak için istek gövdesi.
Error	Hata nesnesi.
ErrorResponse	Hata yanıtı nesnesi.
InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne.

ComponentDocumentModelDetails

Oluşturulan belge modelinin bileşeni.

Name	Tür	Description
modelId	string	Benzersiz belge modeli adı.

ComposeDocumentModelRequest

Bileşen belge modellerinden oluşturulmuş bir belge modeli oluşturmak için istek gövdesi.

Name	Tür	Description
componentModels	ComponentDocumentModelDetails[]	Oluşturacak bileşen belge modellerinin listesi.
description	string	Belge modeli açıklaması.
modelId	string	Benzersiz belge modeli adı.
tags	object	Belge modeliyle ilişkili anahtar-değer etiketi özniteliklerinin listesi.

Error

Hata nesnesi.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
details	Error[]	Bu bildirilen hataya yol açan belirli hatalarla ilgili ayrıntılar dizisi.
innererror	InnerError	Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilen bir gösterimi.
target	string	Hatanın hedefi.

ErrorResponse

Hata yanıtı nesnesi.

Name	Tür	Description
error	Error	Hata bilgileri.

InnerError

Hata hakkında daha ayrıntılı bilgi içeren bir nesne.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
innererror	InnerError	İç hata.
message	string	Hatanın insan tarafından okunabilen bir gösterimi.