Document Models - Get Model

Referensi

Service:: Azure AI Services

API Version:: 2024-02-29-preview

Mendapatkan informasi model dokumen terperinci.

GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-02-29-preview

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Titik akhir layanan Inteligensi Dokumen.
modelId	path	True	string	Nama model dokumen unik. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

endpoint

path

True

string

Titik akhir layanan Inteligensi Dokumen.

modelId

path

True

string

Nama model dokumen unik.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

api-version

query

True

string

Versi API yang digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-request-id		string uuid	Pengidentifikasi string yang buram, unik secara global, dan dihasilkan klien untuk permintaan tersebut.

Respons

Nama	Jenis	Deskripsi
200 OK	DocumentModelDetails	Permintaan telah berhasil. Headers x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Respons kesalahan yang tidak terduga.

Nama

Jenis

Deskripsi

200 OK

DocumentModelDetails

Permintaan telah berhasil.

Headers

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

Respons kesalahan yang tidak terduga.

Keamanan

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

Nama	Deskripsi
https://cognitiveservices.azure.com/.default

Contoh

Get Custom Document Model

Get Prebuilt Document Model

Get Custom Document Model

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel?api-version=2024-02-29-preview

Sample Response

Status code:: 200

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "createdDateTime": "2021-09-24T12:54:35Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-02-29-preview",
  "docTypes": {
    "myForm": {
      "fieldSchema": {
        "Name": {
          "type": "string"
        },
        "Date": {
          "type": "date"
        },
        "Amount": {
          "type": "number"
        }
      },
      "buildMode": "template",
      "fieldConfidence": {
        "Name": 0.9,
        "Date": 0.95,
        "Amount": 0.93
      }
    }
  },
  "tags": {
    "createdBy": "myUserId"
  }
}

Get Prebuilt Document Model

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice?api-version=2024-02-29-preview

Sample Response

Status code:: 200

{
  "modelId": "prebuilt-invoice",
  "description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.",
  "createdDateTime": "2021-07-30T00:00:00Z",
  "apiVersion": "2024-02-29-preview",
  "docTypes": {
    "prebuilt:invoice": {
      "fieldSchema": {
        "CustomerName": {
          "type": "string"
        },
        "CustomerId": {
          "type": "string"
        },
        "PurchaseOrder": {
          "type": "string"
        },
        "InvoiceId": {
          "type": "string"
        },
        "InvoiceDate": {
          "type": "date"
        },
        "DueDate": {
          "type": "date"
        },
        "VendorName": {
          "type": "string"
        },
        "VendorAddress": {
          "type": "string"
        },
        "VendorAddressRecipient": {
          "type": "string"
        },
        "CustomerAddress": {
          "type": "string"
        },
        "CustomerAddressRecipient": {
          "type": "string"
        },
        "BillingAddress": {
          "type": "string"
        },
        "BillingAddressRecipient": {
          "type": "string"
        },
        "ShippingAddress": {
          "type": "string"
        },
        "ShippingAddressRecipient": {
          "type": "string"
        },
        "SubTotal": {
          "type": "number"
        },
        "TotalTax": {
          "type": "number"
        },
        "InvoiceTotal": {
          "type": "number"
        },
        "AmountDue": {
          "type": "number"
        },
        "PreviousUnpaidBalance": {
          "type": "number"
        },
        "RemittanceAddress": {
          "type": "string"
        },
        "RemittanceAddressRecipient": {
          "type": "string"
        },
        "ServiceAddress": {
          "type": "string"
        },
        "ServiceAddressRecipient": {
          "type": "string"
        },
        "ServiceStartDate": {
          "type": "date"
        },
        "ServiceEndDate": {
          "type": "date"
        },
        "Items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "Amount": {
                "type": "number"
              },
              "Date": {
                "type": "date"
              },
              "Description": {
                "type": "string"
              },
              "Quantity": {
                "type": "number"
              },
              "ProductCode": {
                "type": "string"
              },
              "Tax": {
                "type": "number"
              },
              "Unit": {
                "type": "string"
              },
              "UnitPrice": {
                "type": "number"
              }
            }
          }
        }
      }
    }
  },
  "tags": {}
}

Definisi

Nama	Deskripsi
AzureBlobContentSource	Azure Blob Storage konten.
AzureBlobFileListContentSource	Daftar file di Azure Blob Storage.
DocumentBuildMode	Mode build model dokumen kustom.
DocumentFieldSchema	Deskripsi skema semantik bidang menggunakan sintaks gaya Skema JSON.
DocumentFieldType	Jenis data semantik dari nilai bidang.
DocumentModelDetails	Info model dokumen.
DocumentTypeDetails	Info jenis dokumen.
Error	Objek kesalahan.
ErrorResponse	Objek respons kesalahan.
InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut.
Warning	Objek kesalahan.

AzureBlobContentSource

Azure Blob Storage konten.

Nama	Jenis	Deskripsi
containerUrl	string	Azure Blob Storage URL kontainer.
prefix	string	Awalan nama blob.

AzureBlobFileListContentSource

Daftar file di Azure Blob Storage.

Nama	Jenis	Deskripsi
containerUrl	string	Azure Blob Storage URL kontainer.
fileList	string	Jalur ke file JSONL dalam kontainer yang menentukan subset dokumen.

DocumentBuildMode

Mode build model dokumen kustom.

Nama	Jenis	Deskripsi
neural	string	Dokumen dukungan dengan templat visual yang beragam.
template	string	Menargetkan dokumen dengan templat visual serupa.

DocumentFieldSchema

Deskripsi skema semantik bidang menggunakan sintaks gaya Skema JSON.

Nama	Jenis	Deskripsi
description	string	Deskripsi bidang.
example	string	Contoh konten bidang.
items	DocumentFieldSchema	Skema jenis bidang dari setiap elemen array.
properties	<string, DocumentFieldSchema>	Sub-bidang bernama dari bidang objek.
type	DocumentFieldType	Jenis data semantik dari nilai bidang.

DocumentFieldType

Jenis data semantik dari nilai bidang.

Nama	Jenis	Deskripsi
address	string	Alamat yang diurai.
array	string	Daftar subbidang dengan jenis yang sama.
boolean	string	Nilai Boolean, dinormalisasi menjadi benar atau salah.
countryRegion	string	Negara/wilayah, dinormalisasi ke format ISO 3166-1 alpha-3 (mis. AS).
currency	string	Jumlah mata uang dengan simbol dan unit mata uang opsional.
date	string	Tanggal, dinormalisasi ke format ISO 8601 (YYYY-MM-DD).
integer	string	Bilangan bulat, dinormalisasi menjadi bilangan bulat bertanda 64-bit.
number	string	Jumlah titik float, dinormalisasi ke titik mengambang presisi ganda.
object	string	Daftar subbidang bernama dari jenis yang berpotensi berbeda.
phoneNumber	string	Nomor telepon, dinormalisasi ke format E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	string	Array nilai string yang dipilih.
selectionMark	string	Apakah bidang dipilih?
signature	string	Apakah tanda tangan ada?
string	string	Teks biasa.
time	string	Waktu, dinormalisasi ke format ISO 8601 (hh:mm:ss).

DocumentModelDetails

Info model dokumen.

Nama	Jenis	Deskripsi
apiVersion	string	Versi API yang digunakan untuk membuat model dokumen ini.
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage daftar file yang menentukan data pelatihan. AzureBlobSource atau azureBlobFileListSource harus ditentukan.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage lokasi yang berisi data pelatihan. AzureBlobSource atau azureBlobFileListSource harus ditentukan.
buildMode	DocumentBuildMode	Mode build model dokumen kustom.
createdDateTime	string	Tanggal dan waktu (UTC) saat model dokumen dibuat.
description	string	Deskripsi model dokumen.
docTypes	<string, DocumentTypeDetails>	Jenis dokumen yang didukung.
expirationDateTime	string	Tanggal dan waktu (UTC) ketika model dokumen akan kedaluwarsa.
modelId	string	Nama model dokumen unik.
tags	object	Daftar atribut tag nilai kunci yang terkait dengan model dokumen.
warnings	Warning[]	Daftar peringatan yang ditemui saat membangun model.

DocumentTypeDetails

Info jenis dokumen.

Nama	Jenis	Deskripsi
buildMode	DocumentBuildMode	Mode build model dokumen kustom.
description	string	Deskripsi model dokumen.
fieldConfidence	object	Estimasi keyakinan untuk setiap bidang.
fieldSchema	<string, DocumentFieldSchema>	Deskripsi skema semantik dokumen menggunakan sintaks gaya Skema JSON.

Error

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu set kode kesalahan yang ditentukan server.
details	Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

ErrorResponse

Objek respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Info kesalahan.

InnerError

Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut.

Nama	Jenis	Deskripsi
code	string	Salah satu set kode kesalahan yang ditentukan server.
innererror	InnerError	Kesalahan dalam.
message	string	Representasi kesalahan yang dapat dibaca manusia.

Warning

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu set kode peringatan yang ditentukan server.
message	string	Representasi peringatan yang dapat dibaca manusia.
target	string	Target kesalahan.

Share via

Document Models - Get Model

Parameter URI

Header Permintaan

Respons

Keamanan

Ocp-Apim-Subscription-Key

OAuth2Auth

Scopes

Contoh

Get Custom Document Model

Sample Request

Sample Response

Get Prebuilt Document Model

Sample Request

Sample Response

Definisi

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

Warning

Sumber Daya Tambahan: