@azure/ai-form-recognizer package

  • Referensi

Kelas

AzureKeyCredential

Kredensial berbasis kunci statis yang mendukung pembaruan nilai kunci yang mendasar.
DocumentAnalysisClient

Klien untuk berinteraksi dengan fitur analisis layanan Form Recognizer.

Contoh:

Layanan Form Recognizer dan klien mendukung dua cara autentikasi:

Azure Active Directory

import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();

const client = new DocumentAnalysisClient(endpoint, credential);

Kunci API (Kunci Langganan)

import { DocumentAnalysisClient, AzureKeyCredential } from "@azure/ai-form-recognizer";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");

const client = new DocumentAnalysisClient(endpoint, credential);
DocumentModelAdministrationClient

Klien untuk berinteraksi dengan fitur manajemen model layanan Form Recognizer, seperti membuat, membaca, mencantumkan, menghapus, dan menyalin model.

Contoh:

Azure Active Directory

import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();

const client = new DocumentModelAdministrationClient(endpoint, credential);

Kunci API (Kunci Langganan)

import { DocumentModelAdministrationClient, AzureKeyCredential } from "@azure/ai-form-recognizer";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");

const client = new DocumentModelAdministrationClient(endpoint, credential);

Antarmuka

AddressValue

Nilai bidang alamat.
AnalyzeDocumentOptions

Opsi untuk operasi analisis dokumen.
AnalyzeResult

Hasil dari operasi analisis. Jenis Dokumen dapat ditentukan oleh model yang digunakan untuk melakukan analisis.
AnalyzeResultCommon

Bidang umum dari semua jenis seperti AnalyzeResult, seperti LayoutResult, ReadResult, dan GeneralDocumentResult.
AnalyzedDocument

Objek dokumen yang diekstrak.

AnalyzedDocument adalah instans dari salah satu jenis dokumen dalam model. Bidangnya sesuai dengan skema bidang dari jenis dokumen.
AzureBlobFileListSource

Sumber data pelatihan yang ditentukan oleh Kontainer Blob Azure dan daftar file JSONL dalam kontainer.
AzureBlobFileListSourceDetails

Daftar file di Azure Blob Storage.
AzureBlobSource

Sumber data pelatihan yang ditentukan oleh Kontainer Blob Azure.
AzureBlobSourceDetails

Azure Blob Storage konten.
BeginBuildDocumentClassifierOptions

Opsi untuk operasi build pengklasifikasi dokumen.
BeginBuildDocumentModelOptions

Opsi untuk operasi build model.
BeginComposeDocumentModelOptions

Opsi untuk operasi pembuatan model.
BeginCopyModelOptions

Opsi untuk operasi model salin.
BoundingRegion

Poligon pembatas pada halaman input tertentu.
ClassifierDocumentTypeDetails

Info jenis dokumen penggolonal.
ClassifyDocumentOptions

Opsi untuk operasi klasifikasi dokumen.
CommonModelCreationOptions

Opsi umum untuk semua operasi yang menentukan model baru, seperti beginBuildDocumentModel, , beginComposeDocumentModeldan getCopyAuthorization.
CopyAuthorization

Otorisasi untuk menyalin model dokumen ke sumber daya target dan modelId yang ditentukan.
CreateDocumentModelOptions

Opsi untuk operasi pembuatan model.
CurrencyValue

Nilai bidang mata uang.
CustomDocumentModelsDetails

Detail mengenai model dokumen kustom.
DeleteDocumentModelOptions

Opsi untuk penghapusan model.
DocumentAddressField

Bidang dokumen yang menjelaskan alamat fisik terstruktur.
DocumentAnalysisClientOptions

Opsi yang dapat dikonfigurasi untuk DocumentAnalysisClient.
DocumentAnalysisPollOperationState

Status operasi analisis, yang pada akhirnya akan menghasilkan jenis hasil yang sesuai dengan model.
DocumentAnnotation

Elemen anotasi visual dalam dokumen, seperti tanda centang atau silang.
DocumentArrayField

DocumentField yang terdiri dari array bidang berlapis. Semua bidang dalam array akan memiliki jenis yang sama.
DocumentBarcode

Kode batang yang diekstrak.
DocumentBooleanField

DocumentField yang memiliki nilai boolean.
DocumentCaption

Objek yang mewakili lokasi dan konten tabel caption.
DocumentClassifierBuildOperationDetails

Mendapatkan objek respons Operasi.
DocumentClassifierDetails

Info klasifikasi dokumen.
DocumentClassifierDocumentTypeSources

Sekumpulan sumber yang digunakan untuk membuat pengklasifikasi dokumen. Ini adalah peta nama jenis dokumen ke sumber yang akan digunakan untuk melatih model untuk mengklasifikasikan dokumen dari jenis sumber yang sesuai.
DocumentClassifierOperationState

Status operasi pembuatan model.
DocumentCountryRegionField

DocumentField yang memiliki nilai yang menunjukkan negara atau wilayah, direpresentasikan sebagai string.
DocumentCurrencyField

DocumentField yang menjelaskan sejumlah mata uang tertentu.
DocumentDateField

DocumentField yang memiliki nilai Tanggal.
DocumentFieldCommon

Bidang yang umum untuk semua varian DocumentField.
DocumentFieldSchema

Deskripsi skema semantik bidang menggunakan sintaks gaya Skema JSON.
DocumentFootnote

Objek yang mewakili lokasi dan konten catatan kaki tabel.
DocumentFormula

Rumus yang diekstrak.
DocumentIntegerField

DocumentField yang memiliki nilai bilangan bulat.
DocumentKeyValueElement

Objek yang mewakili kunci bidang atau nilai dalam pasangan kunci-nilai.
DocumentKeyValuePair

Objek yang mewakili bidang formulir dengan label bidang (kunci) dan nilai bidang yang berbeda (mungkin kosong).
DocumentLanguage

Objek yang mewakili bahasa yang terdeteksi untuk rentang teks tertentu.
DocumentLine

Objek baris konten yang terdiri dari urutan elemen konten yang berdekatan, seperti kata dan tanda pilihan.
DocumentModel

Spesifikasi model terkenal yang mendukung ekstraksi dokumen terstruktur.

beginAnalyzeDocument Lihat metode DocumentAnalysisClient, yang mendukung penggunaan objek ini alih-alih DocumentModel string ID model untuk memberikan jenis hasil yang lebih kuat.
DocumentModelAdministrationClientOptions

Opsi yang dapat dikonfigurasi untuk DocumentModelAdministrationClient.
DocumentModelBuildOperationDetails

Mendapatkan objek respons Operasi.
DocumentModelComposeOperationDetails

Mendapatkan objek respons Operasi.
DocumentModelCopyToOperationDetails

Mendapatkan objek respons Operasi.
DocumentModelDetails

Info model dokumen.
DocumentModelOperationState

Status operasi pembuatan model.
DocumentModelSummary

Ringkasan model dokumen.
DocumentNumberField

DocumentField yang memiliki nilai angka.
DocumentObjectField

DocumentField yang terdiri dari beberapa properti bernama yang memiliki nilai DocumentField sendiri.
DocumentPage

Elemen konten dan tata letak yang diekstrak dari halaman dari input.
DocumentParagraph

Objek paragraf yang terdiri dari garis yang bersebelahan umumnya dengan perataan dan penspasian umum.
DocumentPhoneNumberField

DocumentField yang memiliki nilai nomor telepon, direpresentasikan sebagai string.
DocumentSelectionMark

Objek tanda pilihan yang mewakili kotak centang, tombol radio, dan elemen lain yang menunjukkan pilihan.
DocumentSelectionMarkField

DocumentField yang memiliki nilai yang menunjukkan status tanda pilihan (seperti kotak centang atau tombol radio), direpresentasikan sebagai string.
DocumentSignatureField

DocumentField yang menunjukkan status tanda tangan, direpresentasikan sebagai string.
DocumentSpan

Wilayah yang berdampingan dari properti konten yang digabungkan, ditentukan sebagai offset dan panjang.
DocumentStringField

DocumentField yang memiliki nilai string.
DocumentStyle

Objek yang mewakili gaya teks yang diamati.
DocumentTable

Objek tabel yang terdiri dari sel tabel yang disusun dalam tata letak persegi panjang.
DocumentTableCell

Objek yang mewakili lokasi dan konten sel tabel.
DocumentTimeField

DocumentField yang memiliki nilai waktu, direpresentasikan sebagai string.
DocumentTypeDetails

Info jenis dokumen.
DocumentValueField

Bidang sederhana yang memiliki nilai primitif, seperti string, angka, dll.
DocumentWord

Objek kata yang terdiri dari urutan karakter yang bersebelahan. Untuk bahasa yang dibatasi non-spasi, seperti Tionghoa, Jepang, dan Korea, setiap karakter direpresentasikan sebagai katanya sendiri.
ErrorModel

Info kesalahan.
GetCopyAuthorizationOptions

Opsi untuk metode dapatkan otorisasi salin.
GetModelOptions

Opsi untuk mengambil informasi model.
GetOperationOptions

Opsi untuk mengambil status operasi.
GetResourceDetailsOptions

Opsi untuk mengambil informasi sumber daya Form Recognizer.
HasBoundingPolygon

Elemen dokumen sederhana seperti kata, tanda pilihan, dan garis dibatasi oleh poligon.
InnerError

Kesalahan terperinci.
ListModelsOptions

Opsi untuk mencantumkan model.
ListOperationsOptions

Opsi untuk mencantumkan operasi.
ModelAdministrationOperationStateCommon

Kumpulan bidang yang umum untuk semua operasi administrasi.
OperationDetails

Mendapatkan objek respons Operasi.
OperationSummary

Info operasi.
Point2D

Mewakili titik yang digunakan untuk menentukan poligon pembatas. Unitnya adalah 'piksel' atau 'inci' (Lihat LengthUnit).
PollerOptions

Opsi untuk operasi jangka panjang (poller) di klien Form Recognizer.
QuotaDetails

Kuota yang digunakan, batas, dan tanggal/waktu reset berikutnya.
ResourceDetails

Informasi umum mengenai sumber daya saat ini.

Alias Jenis

AnalysisPoller

Operasi jangka panjang (poller) yang melacak status operasi analisis, akhirnya menghasilkan jenis hasil yang sesuai dengan model.
AnalyzeResultOperationStatus

Menentukan nilai untuk AnalyzeResultOperationStatus.
DocumentBarcodeKind

Menentukan nilai untuk DocumentBarcodeKind.
KnownDocumentBarcodeKind dapat digunakan secara bergantian dengan DocumentBarcodeKind, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

QRCode: Kode QR, seperti yang didefinisikan dalam ISO/IEC 18004:2015.
PDF417: PDF417, sebagaimana didefinisikan dalam ISO 15438.
UPCA: GS1 12 digit Kode Produk Universal.
UPCE: GS1 6 digit Kode Produk Universal.
Kode39: Kode 39 barcode, seperti yang didefinisikan dalam ISO/IEC 16388:2007.
Code128: Kode 128 barcode, seperti yang didefinisikan dalam ISO/IEC 15417:2007.
EAN8: GS1 8 digit Nomor Artikel Internasional (Nomor Artikel Eropa).
EAN13: Nomor Artikel Internasional GS1 13 digit (Nomor Artikel Eropa).
Bilah Data: Kode batang GS1 DataBar.
Code93: Kode 93 barcode, seperti yang didefinisikan dalam ANSI/AIM BC5-1995.
Codabar: Kode batang Codabar, seperti yang didefinisikan dalam ANSI/AIM BC3-1995.
DataBarExpanded: GS1 DataBar Expanded barcode.
ITF: Interleaved 2 dari 5 barcode, seperti yang didefinisikan dalam ANSI/AIM BC2-1995.
MicroQRCode: Kode QR mikro, seperti yang didefinisikan dalam ISO/IEC 23941:2022.
Aztec: Kode Aztec, seperti yang didefinisikan dalam ISO/IEC 24778:2008.
DataMatrix: Kode matriks data, seperti yang didefinisikan dalam ISO/IEC 16022:2006.
MaxiCode: MaxiCode, seperti yang didefinisikan dalam ISO/IEC 16023:2000.
DocumentBuildMode

Menentukan nilai untuk DocumentBuildMode.
KnownDocumentBuildMode dapat digunakan secara bergantian dengan DocumentBuildMode, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

templat: Dokumen target dengan templat visual serupa.
neural: Mendukung dokumen dengan templat visual yang beragam.
DocumentClassifierPoller

Operasi jangka panjang (poller) yang melacak status operasi pembuatan pengklasifikasi kustom, akhirnya menghasilkan DocumentClassifierDetails.
DocumentClassifierSource

Sumber konten yang dapat digunakan untuk membangun pengklasifikasi dokumen.

Salah satu:

  • BlobSource
  • BlobFileListSource
DocumentField

Bidang yang diekstrak. Properti kind mengidentifikasi (mendiskriminasi) jenis DocumentField.
DocumentFieldType

Menentukan nilai untuk DocumentFieldType.
KnownDocumentFieldType dapat digunakan secara bergantian dengan DocumentFieldType, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

string: Teks biasa.
tanggal: Tanggal, dinormalisasi ke format ISO 8601 (YYYY-MM-DD).
waktu: Waktu, dinormalisasi ke format ISO 8601 (hh:mm:ss).
phoneNumber: Nomor telepon, dinormalisasi ke format E.164 (+{CountryCode}{SubscriberNumber}).
angka: Angka titik mengambang, dinormalisasi ke titik mengambang presisi ganda.
bilangan bulat: Bilangan bulat, dinormalisasi menjadi bilangan bulat bertanda 64-bit.
selectionMark: Apakah bidang dipilih?
countryRegion: Negara/wilayah, dinormalisasi ke format ISO 3166-1 alpha-3 (misalnya AS).
tanda tangan: Apakah tanda tangan ada?
array: Daftar subbidang dengan jenis yang sama.
objek: Dinamai daftar subbidang dari jenis yang berpotensi berbeda.
mata uang: Jumlah mata uang dengan simbol dan unit mata uang opsional.
address: Alamat yang diurai.
boolean: Nilai Boolean, dinormalisasi menjadi true atau false.
DocumentFormulaKind

Mendefinisikan nilai untuk DocumentFormulaKind.
KnownDocumentFormulaKind dapat digunakan secara bergantian dengan DocumentFormulaKind, enum ini berisi nilai-nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

sebaris: Rumus yang disematkan di dalam konten paragraf.
tampilan: Rumus dalam mode tampilan yang mengambil seluruh baris.
DocumentModelBuildMode

Mode build model yang didukung. Mode build model memilih mesin yang digunakan layanan untuk melatih model berdasarkan data pelatihan berlabel.

Dua opsi tersebut adalah:

  • "neural", yang menghasilkan kualitas model tertinggi yang mampu mengekstrak data dari kelas dokumen yang memiliki struktur data yang sama, tetapi tata letak yang berbeda (misalnya, formulir pajak W2, yang dapat bervariasi dari perusahaan ke perusahaan, tetapi selalu berisi informasi yang sama).
  • "template", yang mengharuskan semua dokumen memiliki tata letak tetap (templat) yang sama.

Silakan lihat tautan berikut untuk informasi selengkapnya: https://aka.ms/azsdk/formrecognizer/buildmode
DocumentModelPoller

Operasi jangka panjang (poller) yang melacak status operasi pembuatan model, akhirnya menghasilkan DocumentModelDetails.
DocumentModelSource

Sumber konten yang dapat digunakan untuk membangun model dokumen.

Salah satu:

  • BlobSource
  • BlobFileListSource
DocumentSignatureType

Menentukan nilai untuk DocumentSignatureType.
KnownDocumentSignatureType dapat digunakan secara bergantian dengan DocumentSignatureType, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

ditandatangani: Tanda tangan terdeteksi.
tidak ditandatangani: Tidak ada tanda tangan yang terdeteksi.
DocumentTableCellKind

Menentukan nilai untuk DocumentTableCellKind.
KnownDocumentTableCellKind dapat digunakan secara bergantian dengan DocumentTableCellKind, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

content: Berisi konten/data utama.
rowHeader: Menjelaskan konten baris.
columnHeader: Menjelaskan konten kolom.
stubHead: Menjelaskan header baris, biasanya terletak di sudut kiri atas tabel.
deskripsi: Menjelaskan konten dalam (bagian dari) tabel.
FontStyle

Menentukan nilai untuk FontStyle.
KnownFontStyle dapat digunakan secara bergantian dengan FontStyle, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

normal: Karakter diwakili secara normal.
miring: Karakter secara visual miring ke kanan.
FontWeight

Menentukan nilai untuk FontWeight.
KnownFontWeight dapat digunakan secara bergantian dengan FontWeight, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

normal: Karakter diwakili secara normal.
tebal: Karakter diwakili dengan goresan yang lebih tebal.
FormRecognizerFeature

Kemampuan add-on (fitur) yang dapat diaktifkan untuk permintaan tersebut.

Untuk informasi selengkapnya tentang fitur yang tersedia di Form Recognizer, lihat dokumentasi layanan:

https://aka.ms/azsdk/formrecognizer/features
FormRecognizerRequestBody

Input permintaan yang dapat diunggah sebagai data biner ke layanan Form Recognizer. Form Recognizer memperlakukan string input sebagai URL, jadi untuk mengirim string sebagai input biner, pertama-tama konversi string ke salah satu jenis input berikut.
LengthUnit

Menentukan nilai untuk LengthUnit.
KnownLengthUnit dapat digunakan secara bergantian dengan LengthUnit, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

piksel: Unit panjang untuk file gambar.
inch: Unit panjang untuk file PDF.
OperationDetailsUnion

Detail tentang salah satu dari beberapa jenis operasi manajemen Form Recognizer yang berbeda.
OperationKind

Menentukan nilai untuk OperationKind.
KnownOperationKind dapat digunakan secara bergantian dengan OperationKind, enum ini berisi nilai-nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

documentModelBuild: Bangun model dokumen kustom baru.
documentModelCompose: Buat model dokumen kustom baru dari model yang sudah ada.
documentModelCopyTo: Salin model dokumen yang ada ke sumber daya, wilayah, atau langganan yang berpotensi berbeda.
documentClassifierBuild: Bangun model pengklasifikasi kustom baru.
OperationStatus

Menentukan nilai untuk OperationStatus.
ParagraphRole

Menentukan nilai untuk ParagraphRole.
KnownParagraphRole dapat digunakan secara bergantian dengan ParagraphRole, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

pageHeader: Teks di dekat tepi atas halaman.
pageFooter: Teks di dekat tepi bawah halaman.
pageNumber: Nomor halaman.
title: Judul tingkat atas yang menjelaskan seluruh dokumen.
sectionHeading: Sub judul yang menjelaskan bagian dokumen.
catatan kaki: Catatan biasanya ditempatkan setelah konten utama di halaman.
formulaBlock: Blok rumus, sering kali dengan perataan bersama.
SelectionMarkState

Menentukan nilai untuk SelectionMarkState.
KnownSelectionMarkState dapat digunakan secara bergantian dengan SelectionMarkState, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

dipilih: Tanda pilihan dipilih, sering ditunjukkan oleh pemeriksaan ✓ atau silang X di dalam tanda pilihan.
tidak dipilih: Tanda pilihan tidak dipilih.
StringIndexType

Jenis indeks string yang valid didukung oleh layanan Form Recognizer dan klien SDK.

Enum

KnownDocumentBarcodeKind

Nilai yang diketahui dari DocumentBarcodeKind yang diterima layanan.
KnownDocumentBuildMode

Nilai yang diketahui dari DocumentBuildMode yang diterima layanan.
KnownDocumentFieldType

Nilai yang diketahui dari DocumentFieldType yang diterima layanan.
KnownDocumentFormulaKind

Nilai yang diketahui dari DocumentFormulaKind yang diterima layanan.
KnownDocumentSignatureType

Nilai yang diketahui dari DocumentSignatureType yang diterima layanan.
KnownDocumentTableCellKind

Nilai yang diketahui dari DocumentTableCellKind yang diterima layanan.
KnownFontStyle

Nilai FontStyle yang diketahui yang diterima layanan.
KnownFontWeight

Nilai FontWeight yang diketahui yang diterima layanan.
KnownLengthUnit

Nilai yang diketahui dari LengthUnit yang diterima layanan.
KnownOperationKind

Nilai OperationKind yang diketahui yang diterima layanan.
KnownParagraphRole

Nilai yang diketahui dari ParagraphRole yang diterima layanan.
KnownSelectionMarkState

Nilai yang diketahui dari SelectionMarkState yang diterima layanan.