Bagikan melalui


formrecognizer Paket

Paket

aio

Kelas

AccountProperties

Ringkasan semua model kustom di akun.

Baru dalam versi v2.1: Dukungan untuk metode to_dict dan from_dict

AddressValue

Nilai bidang alamat.

Baru dalam versi 2023-07-31: Properti unit, city_district, state_district, pinggir kota, rumah, dan tingkat .

AnalyzeResult

Hasil analisis dokumen.

AnalyzedDocument

Objek yang menjelaskan lokasi dan konten semantik dokumen.

BlobFileListSource

Sumber konten untuk daftar file di Azure Blob Storage.

BlobSource

Sumber konten untuk Azure Blob Storage.

BoundingRegion

Wilayah pembatas yang terkait dengan halaman.

ClassifierDocumentTypeDetails

Sumber data pelatihan.

CurrencyValue

Elemen nilai mata uang.

Baru dalam versi 2023-07-31: Properti kode .

CustomDocumentModelsDetails

Detail mengenai model kustom di bawah sumber daya Form Recognizer.

CustomFormModel

Mewakili model terlatih.

Baru dalam versi v2.1: Properti model_name dan properti, dukungan untuk metode to_dict dan from_dict

CustomFormModelField

Bidang yang akan diekstrak model dari formulir yang dianalisisnya.

Baru dalam versi v2.1: Dukungan untuk metode to_dict dan from_dict

CustomFormModelInfo

Informasi model kustom.

Baru dalam versi v2.1: Properti model_name dan properti, dukungan untuk metode to_dict dan from_dict

CustomFormModelProperties

Properti model opsional.

Baru dalam versi v2.1: Dukungan untuk metode to_dict dan from_dict

CustomFormSubmodel

Mewakili submodel yang mengekstrak bidang dari jenis formulir tertentu.

Baru dalam versi v2.1: Properti model_id, dukungan untuk metode to_dict dan from_dict

DocumentAnalysisClient

DocumentAnalysisClient menganalisis informasi dari dokumen dan gambar, dan mengklasifikasikan dokumen. Ini adalah antarmuka yang digunakan untuk menganalisis dengan model bawaan (tanda terima, kartu nama, faktur, dokumen identitas, antara lain), menganalisis tata letak dari dokumen, menganalisis jenis dokumen umum, dan menganalisis dokumen kustom dengan model bawaan (untuk melihat daftar lengkap model yang didukung oleh layanan, lihat: https://aka.ms/azsdk/formrecognizer/models). Ini menyediakan metode yang berbeda berdasarkan input dari URL dan input dari aliran.

Catatan

DocumentAnalysisClient harus digunakan dengan versi API

2022-08-31 ke atas. Untuk menggunakan versi <API =v2.1, buat instans FormRecognizerClient.

Baru dalam versi 2022-08-31: DocumentAnalysisClient dan metode kliennya.

DocumentAnalysisError

DocumentAnalysisError berisi detail kesalahan yang dikembalikan oleh layanan.

DocumentAnalysisInnerError

Detail kesalahan dalam untuk DocumentAnalysisError.

DocumentBarcode

Objek kode batang.

DocumentClassifierDetails

Informasi pengklasifikasi dokumen. Termasuk jenis dokumen yang dapat diklasifikasikan model.

DocumentField

Objek yang mewakili konten dan lokasi nilai bidang dokumen.

Baru dalam versi 2023-07-31: Nilai boolean value_type dan bool

DocumentFormula

Objek rumus.

DocumentKeyValueElement

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

DocumentKeyValuePair

Objek yang mewakili bidang dokumen 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 mewakili konten yang ditemukan pada satu baris dokumen.

DocumentModelAdministrationClient

DocumentModelAdministrationClient adalah antarmuka Form Recognizer yang digunakan untuk membangun dan mengelola model.

Ini menyediakan metode untuk membangun model dan pengklasifikasi, serta metode untuk melihat dan menghapus model dan pengklasifikasi, melihat operasi model dan pengklasifikasi, mengakses informasi akun, menyalin model ke sumber daya Form Recognizer lain, dan menyusun model baru dari kumpulan model yang ada.

Catatan

DocumentModelAdministrationClient harus digunakan dengan versi API

2022-08-31 ke atas. Untuk menggunakan versi <API =v2.1, buat instans FormTrainingClient.

Baru dalam versi 2022-08-31: DocumentModelAdministrationClient dan metode kliennya.

DocumentModelAdministrationLROPoller

Menerapkan protokol yang diikuti oleh objek poller yang dikembalikan.

DocumentModelDetails

Informasi model dokumen. Termasuk jenis dokumen yang dapat dianalisis model.

Baru dalam versi 2023-07-31: Properti expires_on .

DocumentModelSummary

Ringkasan informasi model dokumen termasuk ID model, deskripsinya, dan kapan model dibuat.

Baru dalam versi 2023-07-31: Properti expires_on .

DocumentPage

Elemen konten dan tata letak yang diekstrak dari halaman input.

Baru dalam versi 2023-07-31: Properti kode batang, dan rumus .

DocumentParagraph

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

Baru dalam versi 2023-07-31: Peran formulaBlock .

DocumentSelectionMark

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

DocumentSpan

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

DocumentStyle

Objek yang mewakili gaya teks yang diamati.

Baru dalam versi 2023-07-31: Properti similar_font_family, font_style, font_weight, warna, dan background_color .

DocumentTable

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

DocumentTableCell

Objek yang mewakili lokasi dan konten sel tabel.

DocumentTypeDetails

DocumentTypeDetails mewakili tipe dokumen yang dapat dikenali model, termasuk bidang dan jenisnya, dan keyakinan untuk bidang tersebut.

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.

FieldData

Berisi data untuk bidang formulir. Ini termasuk teks, lokasi teks pada formulir, dan kumpulan elemen yang membentuk teks.

Baru dalam versi v2.1: FormSelectionMark ditambahkan ke jenis yang dikembalikan dalam daftar field_elements, dukungan untuk metode to_dict dan from_dict

FormElement

Jenis dasar yang mencakup properti untuk elemen formulir.

Baru dalam versi v2.1: Dukungan untuk metode to_dict dan from_dict

FormField

Mewakili bidang yang dikenali dalam formulir input.

Baru dalam versi v2.1: Dukungan untuk metode to_dict dan from_dict

FormLine

Objek yang mewakili baris teks yang diekstrak.

Baru dalam versi v2.1: properti tampilan, dukungan untuk metode to_dict dan from_dict

FormPage

Mewakili halaman yang dikenali dari dokumen input. Berisi baris, kata, tanda pilihan, tabel, dan metadata halaman.

Baru dalam versi v2.1: properti selection_marks, dukungan untuk metode to_dict dan from_dict

FormPageRange

Rentang halaman formulir berbasis 1.

Baru dalam versi v2.1: Dukungan untuk metode to_dict dan from_dict

FormRecognizerClient

FormRecognizerClient mengekstrak informasi dari formulir dan gambar ke dalam data terstruktur. Ini adalah antarmuka yang digunakan untuk menganalisis dengan model bawaan (tanda terima, kartu nama, faktur, dokumen identitas), mengenali konten/tata letak dari formulir, dan menganalisis formulir kustom dari model terlatih. Ini menyediakan metode yang berbeda berdasarkan input dari URL dan input dari aliran.

Catatan

FormRecognizerClient harus digunakan dengan versi <API =v2.1.

Untuk menggunakan API versi 2022-08-31 dan yang lebih baru, buat instans DocumentAnalysisClient.

FormRecognizerError

Mewakili kesalahan yang terjadi saat pelatihan.

Baru dalam versi v2.1: Dukungan untuk metode to_dict dan from_dict

FormSelectionMark

Informasi tentang tanda pilihan yang diekstrak.

Baru dalam versi v2.1: Dukungan untuk metode to_dict dan from_dict

FormTable

Informasi tentang tabel yang diekstrak yang terkandung di halaman.

Baru dalam versi v2.1: Properti bounding_box, dukungan untuk metode to_dict dan from_dict

FormTableCell

Mewakili sel yang terkandung dalam tabel yang dikenali dari dokumen input.

Baru dalam versi v2.1: FormSelectionMark ditambahkan ke jenis yang dikembalikan dalam daftar field_elements, dukungan untuk metode to_dict dan from_dict

FormTrainingClient

FormTrainingClient adalah antarmuka Form Recognizer yang digunakan untuk membuat dan mengelola model kustom. Ini menyediakan metode untuk model pelatihan pada formulir yang Anda berikan, serta metode untuk melihat dan menghapus model, mengakses properti akun, menyalin model ke sumber daya Form Recognizer lain, dan menyusun model dari kumpulan model yang ada yang dilatih dengan label.

Catatan

FormTrainingClient harus digunakan dengan versi <API =v2.1.

Untuk menggunakan API versi 2022-08-31 ke atas, buat instans DocumentModelAdministrationClient.

FormWord

Mewakili kata yang dikenali dari dokumen input.

Baru dalam versi v2.1: Dukungan untuk metode to_dict dan from_dict

OperationDetails

OperationDetails terdiri dari informasi tentang operasi model, termasuk hasil atau kesalahan operasi jika telah selesai.

Perhatikan bahwa informasi operasi hanya bertahan selama 24 jam. Jika operasi berhasil, model juga dapat diakses menggunakan <xref:azure.ai.formrecognizer.get_document_model>, , <xref:azure.ai.formrecognizer.list_document_models><xref:azure.ai.formrecognizer.get_document_classifier>, <xref:azure.ai.formrecognizer.list_document_classifiers> API.

Baru dalam versi 2023-07-31: Hasil documentClassifierBuild kind dan DocumentClassifierDetails .

OperationSummary

Informasi operasi model, termasuk jenis dan status operasi, saat dibuat, dan banyak lagi.

Perhatikan bahwa informasi operasi hanya bertahan selama 24 jam. Jika operasi berhasil, model dapat diakses menggunakan <xref:azure.ai.formrecognizer.get_document_model>, , <xref:azure.ai.formrecognizer.list_document_models><xref:azure.ai.formrecognizer.get_document_classifier>, <xref:azure.ai.formrecognizer.list_document_classifiers> API. Untuk mengetahui mengapa operasi gagal, gunakan <xref:azure.ai.formrecognizer.get_operation> dan berikan operation_id.

Baru dalam versi 2023-07-31: Jenis documentClassifierBuild .

Point

Koordinat x, y dari titik pada kotak pembatas atau poligon.

Baru dalam versi v2.1: Dukungan untuk metode to_dict dan from_dict

QuotaDetails

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

RecognizedForm

Mewakili formulir yang telah dikenali oleh model terlatih atau bawaan. Properti bidang berisi bidang formulir yang diekstrak dari formulir. Tabel, baris teks/kata, dan tanda pilihan diekstrak per halaman dan ditemukan di properti halaman .

Baru dalam versi v2.1: Properti form_type_confidence dan model_id, dukungan untuk metode to_dict dan from_dict

ResourceDetails

Detail mengenai sumber daya Form Recognizer.

Baru dalam versi 2023-07-31: Properti neural_document_model_quota .

TextAppearance

Objek yang mewakili tampilan baris teks.

Baru dalam versi v2.1: Dukungan untuk metode to_dict dan from_dict

TrainingDocumentInfo

Laporan untuk dokumen individual yang digunakan untuk melatih model kustom.

Baru dalam versi v2.1: Properti model_id, dukungan untuk metode to_dict dan from_dict

Enum

AnalysisFeature

Fitur analisis dokumen untuk diaktifkan.

CustomFormModelStatus

Status yang menunjukkan kesiapan model untuk digunakan.

DocumentAnalysisApiVersion

Form Recognizer versi API yang didukung oleh DocumentAnalysisClient dan DocumentModelAdministrationClient.

FieldValueType

Jenis data semantik dari nilai bidang.

Baru dalam versi v2.1: Nilai selectionMark dan countryRegion

FormContentType

Jenis konten untuk diunggah.

Baru dalam versi v2.1: Dukungan untuk gambar/bmp

FormRecognizerApiVersion

Form Recognizer versi API yang didukung oleh FormRecognizerClient dan FormTrainingClient.

LengthUnit

Unit yang digunakan oleh properti lebar, tinggi, dan kotak pembatas. Untuk gambar, unitnya adalah "piksel". Untuk PDF, unitnya adalah "inch".

ModelBuildMode

Mode yang digunakan saat membangun model kustom.

Untuk informasi selengkapnya, lihat https://aka.ms/azsdk/formrecognizer/buildmode.

TrainingStatus

Status operasi pelatihan.