FormRecognizerClient class
- Extends
Konstruktor
| Form |
Menginisialisasi instans baru kelas FormRecognizerClient. |
Properti yang Diwariskan
| credentials | |
| endpoint |
Metode
| analyze |
Ekstrak pasangan kunci-nilai dari dokumen tertentu. Dokumen masukan harus dari salah satu jenis konten yang didukung - 'application/pdf', 'image/jpeg' atau 'image/png'. Respons sukses dikembalikan dalam JSON. |
| analyze |
|
| analyze |
|
| batch |
Operasi Tanda Terima Baca Batch. Respons berisi bidang yang disebut 'Operation-Location', yang berisi URL yang harus Anda gunakan untuk operasi 'Dapatkan Hasil Tanda Terima Baca' Anda. |
| batch |
|
| batch |
|
| batch |
Membaca operasi Tanda Terima. Saat Anda menggunakan antarmuka 'Tanda Terima Baca Batch', respons berisi bidang yang disebut 'Operation-Location'. Bidang 'Lokasi-Operasi' berisi URL yang harus Anda gunakan untuk operasi 'Dapatkan Hasil Tanda Terima Baca' Anda. |
| batch |
|
| batch |
|
| delete |
Menghapus artefak model. |
| delete |
|
| delete |
|
| get |
Dapatkan informasi tentang model. |
| get |
|
| get |
|
| get |
Mendapatkan informasi tentang semua model kustom terlatih |
| get |
|
| get |
|
| get |
Ambil kunci yang diekstrak selama pelatihan model yang ditentukan. |
| get |
|
| get |
|
| get |
Antarmuka ini digunakan untuk mendapatkan hasil analisis operasi 'Tanda Terima Baca Batch'. URL ke antarmuka ini harus diambil dari bidang 'Operation-Location' yang dikembalikan dari operasi 'Tanda Terima Baca Batch'. |
| get |
|
| get |
|
| train |
Membuat dan latih model kustom. Permintaan kereta harus menyertakan parameter sumber yang berupa Uri kontainer blob Azure Storage yang dapat diakses secara eksternal (sebaiknya Uri Tanda Tangan Akses Berbagi) atau jalur yang valid ke folder data di drive yang dipasang secara lokal. Ketika jalur lokal ditentukan, jalur tersebut harus mengikuti format jalur Linux/Unix dan menjadi jalur absolut yang di-root ke nilai pengaturan konfigurasi pemasangan input misalnya, jika nilai pengaturan konfigurasi '{Mounts:Input}' adalah '/input' maka jalur sumber yang valid adalah '/input/contosodataset'. Semua data yang akan dilatih diharapkan berada langsung di bawah folder sumber. Subfolder tidak didukung. Model dilatih menggunakan dokumen yang merupakan jenis konten berikut - 'application/pdf', 'image/jpeg' dan 'image/png'." Tipe isi lainnya diabaikan. |
| train |
|
| train |
Metode yang Diwarisi
| send |
Kirim permintaan HTTP yang diisi menggunakan OperationSpec yang disediakan. |
| send |
Kirim httpRequest yang disediakan. |
Detail Konstruktor
FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)
Menginisialisasi instans baru kelas FormRecognizerClient.
new FormRecognizerClient(credentials: ServiceClientCredentials, endpoint: string, options?: ServiceClientOptions)Parameter
- credentials
- ServiceClientCredentials
Kredensial langganan yang secara unik mengidentifikasi langganan klien.
- endpoint
-
string
Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://westus2.api.cognitive.microsoft.com).
- options
- ServiceClientOptions
Opsi parameter
Detail Properti yang Diwariskan
credentials
credentials: ServiceClientCredentialsNilai Properti
Diwarisi DariFormRecognizerClientContext.credentials
endpoint
Detail Metode
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)
Ekstrak pasangan kunci-nilai dari dokumen tertentu. Dokumen masukan harus dari salah satu jenis konten yang didukung - 'application/pdf', 'image/jpeg' atau 'image/png'. Respons sukses dikembalikan dalam JSON.
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options?: FormRecognizerClientAnalyzeWithCustomModelOptionalParams): Promise<AnalyzeWithCustomModelResponse>Parameter
- id
-
string
Pengidentifikasi Model untuk menganalisis dokumen.
- formStream
- HttpRequestBody
File dokumen atau gambar pdf (jpg,png) untuk dianalisis.
Parameter opsional
Mengembalikan
Promise<AnalyzeWithCustomModelResponse>
Promise<Models.AnalyzeWithCustomModelResponse>
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options: FormRecognizerClientAnalyzeWithCustomModelOptionalParams, callback: ServiceCallback<AnalyzeResult>)Parameter
- id
-
string
Pengidentifikasi Model untuk menganalisis dokumen.
- formStream
- HttpRequestBody
File dokumen atau gambar pdf (jpg,png) untuk dianalisis.
Parameter opsional
- callback
Panggilan balik
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, callback: ServiceCallback<AnalyzeResult>)Parameter
- id
-
string
Pengidentifikasi Model untuk menganalisis dokumen.
- formStream
- HttpRequestBody
File dokumen atau gambar pdf (jpg,png) untuk dianalisis.
- callback
Panggilan balik
batchReadReceipt(string, RequestOptionsBase)
Operasi Tanda Terima Baca Batch. Respons berisi bidang yang disebut 'Operation-Location', yang berisi URL yang harus Anda gunakan untuk operasi 'Dapatkan Hasil Tanda Terima Baca' Anda.
function batchReadReceipt(url: string, options?: RequestOptionsBase): Promise<BatchReadReceiptResponse>Parameter
- url
-
string
URL gambar yang dapat dijangkau secara publik.
- options
- RequestOptionsBase
Parameter opsional
Mengembalikan
Promise<BatchReadReceiptResponse>
Promise<Models.BatchReadReceiptResponse>
batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
function batchReadReceipt(url: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameter
- url
-
string
URL gambar yang dapat dijangkau secara publik.
- options
- RequestOptionsBase
Parameter opsional
- callback
-
ServiceCallback<void>
Panggilan balik
batchReadReceipt(string, ServiceCallback<void>)
function batchReadReceipt(url: string, callback: ServiceCallback<void>)Parameter
- url
-
string
URL gambar yang dapat dijangkau secara publik.
- callback
-
ServiceCallback<void>
Panggilan balik
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)
Membaca operasi Tanda Terima. Saat Anda menggunakan antarmuka 'Tanda Terima Baca Batch', respons berisi bidang yang disebut 'Operation-Location'. Bidang 'Lokasi-Operasi' berisi URL yang harus Anda gunakan untuk operasi 'Dapatkan Hasil Tanda Terima Baca' Anda.
function batchReadReceiptInStream(image: HttpRequestBody, options?: RequestOptionsBase): Promise<BatchReadReceiptInStreamResponse>Parameter
- image
- HttpRequestBody
Aliran gambar.
- options
- RequestOptionsBase
Parameter opsional
Mengembalikan
Promise<BatchReadReceiptInStreamResponse>
Promise<Models.BatchReadReceiptInStreamResponse>
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
function batchReadReceiptInStream(image: HttpRequestBody, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameter
- image
- HttpRequestBody
Aliran gambar.
- options
- RequestOptionsBase
Parameter opsional
- callback
-
ServiceCallback<void>
Panggilan balik
batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)
function batchReadReceiptInStream(image: HttpRequestBody, callback: ServiceCallback<void>)Parameter
- image
- HttpRequestBody
Aliran gambar.
- callback
-
ServiceCallback<void>
Panggilan balik
deleteCustomModel(string, RequestOptionsBase)
Menghapus artefak model.
function deleteCustomModel(id: string, options?: RequestOptionsBase): Promise<RestResponse>Parameter
- id
-
string
Pengidentifikasi model yang akan dihapus.
- options
- RequestOptionsBase
Parameter opsional
Mengembalikan
Promise<RestResponse>
Menjanjikan<msRest.RestResponse>
deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)
function deleteCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameter
- id
-
string
Pengidentifikasi model yang akan dihapus.
- options
- RequestOptionsBase
Parameter opsional
- callback
-
ServiceCallback<void>
Panggilan balik
deleteCustomModel(string, ServiceCallback<void>)
function deleteCustomModel(id: string, callback: ServiceCallback<void>)Parameter
- id
-
string
Pengidentifikasi model yang akan dihapus.
- callback
-
ServiceCallback<void>
Panggilan balik
getCustomModel(string, RequestOptionsBase)
Dapatkan informasi tentang model.
function getCustomModel(id: string, options?: RequestOptionsBase): Promise<GetCustomModelResponse>Parameter
- id
-
string
Pengidentifikasi model.
- options
- RequestOptionsBase
Parameter opsional
Mengembalikan
Promise<GetCustomModelResponse>
Promise<Models.GetCustomModelResponse>
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
function getCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<ModelResult>)Parameter
- id
-
string
Pengidentifikasi model.
- options
- RequestOptionsBase
Parameter opsional
- callback
Panggilan balik
getCustomModel(string, ServiceCallback<ModelResult>)
function getCustomModel(id: string, callback: ServiceCallback<ModelResult>)Parameter
- id
-
string
Pengidentifikasi model.
- callback
Panggilan balik
getCustomModels(RequestOptionsBase)
Mendapatkan informasi tentang semua model kustom terlatih
function getCustomModels(options?: RequestOptionsBase): Promise<GetCustomModelsResponse>Parameter
- options
- RequestOptionsBase
Parameter opsional
Mengembalikan
Promise<GetCustomModelsResponse>
Promise<Models.GetCustomModelsResponse>
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
function getCustomModels(options: RequestOptionsBase, callback: ServiceCallback<ModelsResult>)Parameter
- options
- RequestOptionsBase
Parameter opsional
- callback
Panggilan balik
getCustomModels(ServiceCallback<ModelsResult>)
function getCustomModels(callback: ServiceCallback<ModelsResult>)Parameter
- callback
Panggilan balik
getExtractedKeys(string, RequestOptionsBase)
Ambil kunci yang diekstrak selama pelatihan model yang ditentukan.
function getExtractedKeys(id: string, options?: RequestOptionsBase): Promise<GetExtractedKeysResponse>Parameter
- id
-
string
Pengidentifikasi model.
- options
- RequestOptionsBase
Parameter opsional
Mengembalikan
Promise<GetExtractedKeysResponse>
Promise<Models.GetExtractedKeysResponse>
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
function getExtractedKeys(id: string, options: RequestOptionsBase, callback: ServiceCallback<KeysResult>)Parameter
- id
-
string
Pengidentifikasi model.
- options
- RequestOptionsBase
Parameter opsional
- callback
Panggilan balik
getExtractedKeys(string, ServiceCallback<KeysResult>)
function getExtractedKeys(id: string, callback: ServiceCallback<KeysResult>)Parameter
- id
-
string
Pengidentifikasi model.
- callback
Panggilan balik
getReadReceiptResult(string, RequestOptionsBase)
Antarmuka ini digunakan untuk mendapatkan hasil analisis operasi 'Tanda Terima Baca Batch'. URL ke antarmuka ini harus diambil dari bidang 'Operation-Location' yang dikembalikan dari operasi 'Tanda Terima Baca Batch'.
function getReadReceiptResult(operationId: string, options?: RequestOptionsBase): Promise<GetReadReceiptResultResponse>Parameter
- operationId
-
string
Id operasi baca dikembalikan sebagai respons operasi 'Tanda Terima Baca Batch'.
- options
- RequestOptionsBase
Parameter opsional
Mengembalikan
Promise<GetReadReceiptResultResponse>
Promise<Models.GetReadReceiptResultResponse>
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
function getReadReceiptResult(operationId: string, options: RequestOptionsBase, callback: ServiceCallback<ReadReceiptResult>)Parameter
- operationId
-
string
Id operasi baca dikembalikan sebagai respons operasi 'Tanda Terima Baca Batch'.
- options
- RequestOptionsBase
Parameter opsional
- callback
Panggilan balik
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
function getReadReceiptResult(operationId: string, callback: ServiceCallback<ReadReceiptResult>)Parameter
- operationId
-
string
Id operasi baca dikembalikan sebagai respons operasi 'Tanda Terima Baca Batch'.
- callback
Panggilan balik
trainCustomModel(TrainRequest, RequestOptionsBase)
Membuat dan latih model kustom. Permintaan kereta harus menyertakan parameter sumber yang berupa Uri kontainer blob Azure Storage yang dapat diakses secara eksternal (sebaiknya Uri Tanda Tangan Akses Berbagi) atau jalur yang valid ke folder data di drive yang dipasang secara lokal. Ketika jalur lokal ditentukan, jalur tersebut harus mengikuti format jalur Linux/Unix dan menjadi jalur absolut yang di-root ke nilai pengaturan konfigurasi pemasangan input misalnya, jika nilai pengaturan konfigurasi '{Mounts:Input}' adalah '/input' maka jalur sumber yang valid adalah '/input/contosodataset'. Semua data yang akan dilatih diharapkan berada langsung di bawah folder sumber. Subfolder tidak didukung. Model dilatih menggunakan dokumen yang merupakan jenis konten berikut - 'application/pdf', 'image/jpeg' dan 'image/png'." Tipe isi lainnya diabaikan.
function trainCustomModel(trainRequest: TrainRequest, options?: RequestOptionsBase): Promise<TrainCustomModelResponse>Parameter
- trainRequest
- TrainRequest
Minta objek untuk pelatihan.
- options
- RequestOptionsBase
Parameter opsional
Mengembalikan
Promise<TrainCustomModelResponse>
Promise<Models.TrainCustomModelResponse>
trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
function trainCustomModel(trainRequest: TrainRequest, options: RequestOptionsBase, callback: ServiceCallback<TrainResult>)Parameter
- trainRequest
- TrainRequest
Minta objek untuk pelatihan.
- options
- RequestOptionsBase
Parameter opsional
- callback
Panggilan balik
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)
function trainCustomModel(trainRequest: TrainRequest, callback: ServiceCallback<TrainResult>)Parameter
- trainRequest
- TrainRequest
Minta objek untuk pelatihan.
- callback
Panggilan balik
Detail Metode yang Diwarisi
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
Kirim permintaan HTTP yang diisi menggunakan OperationSpec yang disediakan.
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>Parameter
- operationArguments
- OperationArguments
Argumen tempat nilai templat permintaan HTTP akan diisi.
- operationSpec
- OperationSpec
OperationSpec yang digunakan untuk mengisi httpRequest.
- callback
-
ServiceCallback<any>
Panggilan balik untuk memanggil saat respons diterima.
Mengembalikan
Promise<RestResponse>
Diwarisi DariFormRecognizerClientContext.sendOperationRequest
sendRequest(RequestPrepareOptions | WebResourceLike)
Kirim httpRequest yang disediakan.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>Parameter
- options
Mengembalikan
Promise<HttpOperationResponse>
Diwarisi DariFormRecognizerClientContext.sendRequest
Azure SDK for JavaScript
Saran dan Komentar
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat: https://aka.ms/ContentUserFeedback.
Kirim dan lihat umpan balik untuk