Document Models - Compose Model

Layanan:

Azure AI Services

Versi API:

2022-08-31

Membuat model dokumen baru dari tipe dokumen model dokumen yang sudah ada.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	ApiVersion	Versi API yang diminta.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Ocp-Apim-Subscription-Key	True	string

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
componentModels	True	ComponentDocumentModelDetails[]	Daftar model dokumen komponen untuk ditulis.
modelId	True	string	Nama model dokumen unik.
description		string	Deskripsi model dokumen.
tags		object	Daftar atribut tag nilai kunci yang terkait dengan model dokumen.

Respons

Nama	Jenis	Deskripsi
202 Accepted		Permintaan berhasil diantrekan. Header Operation-Location: string
Other Status Codes	ErrorResponse	Terjadi kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Jenis: apiKey
Dalam: header

Contoh

ComposeDocumentModel

Permintaan sampel

HTTP

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

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

Respon sampel

Kode status:

202

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

Definisi

Nama	Deskripsi
ApiVersion	Versi API.
ComponentDocumentModelDetails	Komponen model dokumen yang disusung.
ComposeDocumentModelRequest	Minta isi untuk membuat model dokumen yang disusung dari model dokumen komponen.
Error	Info kesalahan.
ErrorResponse	Objek respons kesalahan.
InnerError	Kesalahan terperinci.

ApiVersion

Versi API.

Nama	Jenis	Deskripsi
2022-08-31	string

ComponentDocumentModelDetails

Komponen model dokumen yang disusung.

Nama	Jenis	Deskripsi
modelId	string	Nama model dokumen unik.

ComposeDocumentModelRequest

Minta isi untuk membuat model dokumen yang disusung dari model dokumen komponen.

Nama	Jenis	Deskripsi
componentModels	ComponentDocumentModelDetails[]	Daftar model dokumen komponen untuk ditulis.
description	string	Deskripsi model dokumen.
modelId	string	Nama model dokumen unik.
tags	object	Daftar atribut tag nilai kunci yang terkait dengan model dokumen.

Error

Info kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan.
details	Error[]	Daftar kesalahan terperinci.
innererror	InnerError	Kesalahan terperinci.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Info kesalahan.

InnerError

Kesalahan terperinci.

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan.
innererror	InnerError	Kesalahan terperinci.
message	string	Pesan kesalahan.