FormRecognizerClient class

Paket:

@azure/cognitiveservices-formrecognizer

Extends

FormRecognizerClientContext

Oluşturucular

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

FormRecognizerClient sınıfının yeni bir örneğini başlatır.

Devralınan Özellikler

credentials
endpoint

Yöntemler

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)	Belirli bir belgeden anahtar-değer çiftlerini ayıklayın. Giriş belgesi desteklenen içerik türlerinden biri olmalıdır: 'application/pdf', 'image/jpeg' veya 'image/png'. JSON'da bir başarı yanıtı döndürülür.
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
batchReadReceipt(string, RequestOptionsBase)	Toplu Okundu Bilgisi işlemi. Yanıt, 'Okundu Bilgisi Sonucunu Al' işleminizde kullanmanız gereken URL'yi içeren 'Operation-Location' adlı bir alan içerir.
batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
batchReadReceipt(string, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)	Okundu Bilgisi işlemi. 'Batch Read Receipt' arabirimini kullandığınızda, yanıt 'Operation-Location' adlı bir alan içerir. 'Operation-Location' alanı, 'Okundu Bilgisi Sonucunu Al' işleminizde kullanmanız gereken URL'yi içerir.
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)
deleteCustomModel(string, RequestOptionsBase)	Model yapıtlarını silin.
deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)
deleteCustomModel(string, ServiceCallback<void>)
getCustomModel(string, RequestOptionsBase)	Model hakkında bilgi edinin.
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
getCustomModel(string, ServiceCallback<ModelResult>)
getCustomModels(RequestOptionsBase)	Tüm eğitilmiş özel modeller hakkında bilgi alma
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
getCustomModels(ServiceCallback<ModelsResult>)
getExtractedKeys(string, RequestOptionsBase)	Belirtilen modelin eğitimi sırasında ayıklanan anahtarları alın.
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
getExtractedKeys(string, ServiceCallback<KeysResult>)
getReadReceiptResult(string, RequestOptionsBase)	Bu arabirim, 'Batch Read Receipt' işleminin analiz sonuçlarını almak için kullanılır. Bu arabirimin URL'si , 'Batch Read Receipt' işleminden döndürülen 'Operation-Location' alanından alınmalıdır.
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
trainCustomModel(TrainRequest, RequestOptionsBase)	Özel model oluşturma ve eğitma. Eğitme isteği, dışarıdan erişilebilir bir Azure Depolama blob kapsayıcısı Uri'si (tercihen Paylaşılan Erişim İmzası Uri'si) veya yerel olarak bağlı bir sürücüdeki veri klasörünün geçerli yolu olan bir kaynak parametre içermelidir. Yerel yollar belirtildiğinde, Linux/Unix yol biçimini izlemeli ve giriş bağlama yapılandırma ayarı değerine köklenmiş mutlak bir yol olmalıdır. Örneğin, '{Mounts:Input}' yapılandırma ayarı değeri '/input' ise geçerli bir kaynak yolu '/input/contosodataset' olacaktır. Eğitilecek tüm verilerin doğrudan kaynak klasörün altında olması beklenir. Alt klasörler desteklenmez. Modeller şu içerik türündeki belgeler kullanılarak eğitilir: 'application/pdf', 'image/jpeg' ve 'image/png'." Diğer içerik türleri yoksayılır.
trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

Devralınan Yöntemler

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Sağlanan OperationSpec kullanılarak doldurulan bir HTTP isteği gönderin.
sendRequest(RequestPrepareOptions | WebResourceLike)	Sağlanan httpRequest dosyasını gönderin.

Oluşturucu Ayrıntıları

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

FormRecognizerClient sınıfının yeni bir örneğini başlatır.

new FormRecognizerClient(credentials: ServiceClientCredentials, endpoint: string, options?: ServiceClientOptions)

Parametreler

credentials

ServiceClientCredentials

İstemci aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri.

endpoint

string

Desteklenen Bilişsel Hizmetler uç noktaları (protokol ve konak adı, örneğin: https://westus2.api.cognitive.microsoft.com).

options

ServiceClientOptions

Parametre seçenekleri

Devralınan Özellik Detayları

credentials

credentials: ServiceClientCredentials

Özellik Değeri

ServiceClientCredentials

FormRecognizerClientContext.credentials Devralındı

endpoint

endpoint: string

Özellik Değeri

string

FormRecognizerClientContext.endpointDevralındı

Yöntem Ayrıntıları

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)

Belirli bir belgeden anahtar-değer çiftlerini ayıklayın. Giriş belgesi desteklenen içerik türlerinden biri olmalıdır: 'application/pdf', 'image/jpeg' veya 'image/png'. JSON'da bir başarı yanıtı döndürülür.

function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options?: FormRecognizerClientAnalyzeWithCustomModelOptionalParams): Promise<AnalyzeWithCustomModelResponse>

Parametreler

id

string

Belgeyi analiz etmek için model tanımlayıcısı.

formStream

HttpRequestBody

Analiz etmek için bir pdf belgesi veya resim (jpg,png) dosyası.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

İsteğe bağlı parametreler

Döndürülenler

Promise<AnalyzeWithCustomModelResponse>

Promise<Models.AnalyzeWithCustomModelResponse>

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)

function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options: FormRecognizerClientAnalyzeWithCustomModelOptionalParams, callback: ServiceCallback<AnalyzeResult>)

Parametreler

id

string

Belgeyi analiz etmek için model tanımlayıcısı.

formStream

HttpRequestBody

Analiz etmek için bir pdf belgesi veya resim (jpg,png) dosyası.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

İsteğe bağlı parametreler

callback

ServiceCallback<AnalyzeResult>

Geri çağırma

analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)

function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, callback: ServiceCallback<AnalyzeResult>)

Parametreler

id

string

Belgeyi analiz etmek için model tanımlayıcısı.

formStream

HttpRequestBody

Analiz etmek için bir pdf belgesi veya resim (jpg,png) dosyası.

callback

ServiceCallback<AnalyzeResult>

Geri çağırma

batchReadReceipt(string, RequestOptionsBase)

Toplu Okundu Bilgisi işlemi. Yanıt, 'Okundu Bilgisi Sonucunu Al' işleminizde kullanmanız gereken URL'yi içeren 'Operation-Location' adlı bir alan içerir.

function batchReadReceipt(url: string, options?: RequestOptionsBase): Promise<BatchReadReceiptResponse>

Parametreler

url

string

Görüntünün genel olarak erişilebilen URL'si.

options

RequestOptionsBase

İsteğe bağlı parametreler

Döndürülenler

Promise<BatchReadReceiptResponse>

Promise<Models.BatchReadReceiptResponse>

batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)

function batchReadReceipt(url: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parametreler

url

string

Görüntünün genel olarak erişilebilen URL'si.

options

RequestOptionsBase

İsteğe bağlı parametreler

callback

ServiceCallback<void>

Geri çağırma

batchReadReceipt(string, ServiceCallback<void>)

function batchReadReceipt(url: string, callback: ServiceCallback<void>)

Parametreler

url

string

Görüntünün genel olarak erişilebilen URL'si.

callback

ServiceCallback<void>

Geri çağırma

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)

Okundu Bilgisi işlemi. 'Batch Read Receipt' arabirimini kullandığınızda, yanıt 'Operation-Location' adlı bir alan içerir. 'Operation-Location' alanı, 'Okundu Bilgisi Sonucunu Al' işleminizde kullanmanız gereken URL'yi içerir.

function batchReadReceiptInStream(image: HttpRequestBody, options?: RequestOptionsBase): Promise<BatchReadReceiptInStreamResponse>

Parametreler

image

HttpRequestBody

Bir görüntü akışı.

options

RequestOptionsBase

İsteğe bağlı parametreler

Döndürülenler

Promise<BatchReadReceiptInStreamResponse>

Promise<Models.BatchReadReceiptInStreamResponse>

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)

function batchReadReceiptInStream(image: HttpRequestBody, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parametreler

image

HttpRequestBody

Bir görüntü akışı.

options

RequestOptionsBase

İsteğe bağlı parametreler

callback

ServiceCallback<void>

Geri çağırma

batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)

function batchReadReceiptInStream(image: HttpRequestBody, callback: ServiceCallback<void>)

Parametreler

image

HttpRequestBody

Bir görüntü akışı.

callback

ServiceCallback<void>

Geri çağırma

deleteCustomModel(string, RequestOptionsBase)

Model yapıtlarını silin.

function deleteCustomModel(id: string, options?: RequestOptionsBase): Promise<RestResponse>

Parametreler

id

string

Silinecek modelin tanımlayıcısı.

options

RequestOptionsBase

İsteğe bağlı parametreler

Döndürülenler

Promise<RestResponse>

promise<msRest.RestResponse>

deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)

function deleteCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parametreler

id

string

Silinecek modelin tanımlayıcısı.

options

RequestOptionsBase

İsteğe bağlı parametreler

callback

ServiceCallback<void>

Geri çağırma

deleteCustomModel(string, ServiceCallback<void>)

function deleteCustomModel(id: string, callback: ServiceCallback<void>)

Parametreler

id

string

Silinecek modelin tanımlayıcısı.

callback

ServiceCallback<void>

Geri çağırma

getCustomModel(string, RequestOptionsBase)

Model hakkında bilgi edinin.

function getCustomModel(id: string, options?: RequestOptionsBase): Promise<GetCustomModelResponse>

Parametreler

id

string

Model tanımlayıcısı.

options

RequestOptionsBase

İsteğe bağlı parametreler

Döndürülenler

Promise<GetCustomModelResponse>

Promise<Models.GetCustomModelResponse>

getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)

function getCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<ModelResult>)

Parametreler

id

string

Model tanımlayıcısı.

options

RequestOptionsBase

İsteğe bağlı parametreler

callback

ServiceCallback<ModelResult>

Geri çağırma

getCustomModel(string, ServiceCallback<ModelResult>)

function getCustomModel(id: string, callback: ServiceCallback<ModelResult>)

Parametreler

id

string

Model tanımlayıcısı.

callback

ServiceCallback<ModelResult>

Geri çağırma

getCustomModels(RequestOptionsBase)

Tüm eğitilmiş özel modeller hakkında bilgi alma

function getCustomModels(options?: RequestOptionsBase): Promise<GetCustomModelsResponse>

Parametreler

options

RequestOptionsBase

İsteğe bağlı parametreler

Döndürülenler

Promise<GetCustomModelsResponse>

Promise<Models.GetCustomModelsResponse>

getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)

function getCustomModels(options: RequestOptionsBase, callback: ServiceCallback<ModelsResult>)

Parametreler

options

RequestOptionsBase

İsteğe bağlı parametreler

callback

ServiceCallback<ModelsResult>

Geri çağırma

getCustomModels(ServiceCallback<ModelsResult>)

function getCustomModels(callback: ServiceCallback<ModelsResult>)

Parametreler

callback

ServiceCallback<ModelsResult>

Geri çağırma

getExtractedKeys(string, RequestOptionsBase)

Belirtilen modelin eğitimi sırasında ayıklanan anahtarları alın.

function getExtractedKeys(id: string, options?: RequestOptionsBase): Promise<GetExtractedKeysResponse>

Parametreler

id

string

Model tanımlayıcısı.

options

RequestOptionsBase

İsteğe bağlı parametreler

Döndürülenler

Promise<GetExtractedKeysResponse>

Promise<Models.GetExtractedKeysResponse>

getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)

function getExtractedKeys(id: string, options: RequestOptionsBase, callback: ServiceCallback<KeysResult>)

Parametreler

id

string

Model tanımlayıcısı.

options

RequestOptionsBase

İsteğe bağlı parametreler

callback

ServiceCallback<KeysResult>

Geri çağırma

getExtractedKeys(string, ServiceCallback<KeysResult>)

function getExtractedKeys(id: string, callback: ServiceCallback<KeysResult>)

Parametreler

id

string

Model tanımlayıcısı.

callback

ServiceCallback<KeysResult>

Geri çağırma

getReadReceiptResult(string, RequestOptionsBase)

Bu arabirim, 'Batch Read Receipt' işleminin analiz sonuçlarını almak için kullanılır. Bu arabirimin URL'si , 'Batch Read Receipt' işleminden döndürülen 'Operation-Location' alanından alınmalıdır.

function getReadReceiptResult(operationId: string, options?: RequestOptionsBase): Promise<GetReadReceiptResultResponse>

Parametreler

operationId

string

'Batch Read Receipt' işleminin yanıtında döndürülen okuma işleminin kimliği.

options

RequestOptionsBase

İsteğe bağlı parametreler

Döndürülenler

Promise<GetReadReceiptResultResponse>

Promise<Models.GetReadReceiptResultResponse>

getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)

function getReadReceiptResult(operationId: string, options: RequestOptionsBase, callback: ServiceCallback<ReadReceiptResult>)

Parametreler

operationId

string

'Batch Read Receipt' işleminin yanıtında döndürülen okuma işleminin kimliği.

options

RequestOptionsBase

İsteğe bağlı parametreler

callback

ServiceCallback<ReadReceiptResult>

Geri çağırma

getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)

function getReadReceiptResult(operationId: string, callback: ServiceCallback<ReadReceiptResult>)

Parametreler

operationId

string

'Batch Read Receipt' işleminin yanıtında döndürülen okuma işleminin kimliği.

callback

ServiceCallback<ReadReceiptResult>

Geri çağırma

trainCustomModel(TrainRequest, RequestOptionsBase)

Özel model oluşturma ve eğitma. Eğitme isteği, dışarıdan erişilebilir bir Azure Depolama blob kapsayıcısı Uri'si (tercihen Paylaşılan Erişim İmzası Uri'si) veya yerel olarak bağlı bir sürücüdeki veri klasörünün geçerli yolu olan bir kaynak parametre içermelidir. Yerel yollar belirtildiğinde, Linux/Unix yol biçimini izlemeli ve giriş bağlama yapılandırma ayarı değerine köklenmiş mutlak bir yol olmalıdır. Örneğin, '{Mounts:Input}' yapılandırma ayarı değeri '/input' ise geçerli bir kaynak yolu '/input/contosodataset' olacaktır. Eğitilecek tüm verilerin doğrudan kaynak klasörün altında olması beklenir. Alt klasörler desteklenmez. Modeller şu içerik türündeki belgeler kullanılarak eğitilir: 'application/pdf', 'image/jpeg' ve 'image/png'." Diğer içerik türleri yoksayılır.

function trainCustomModel(trainRequest: TrainRequest, options?: RequestOptionsBase): Promise<TrainCustomModelResponse>

Parametreler

trainRequest

TrainRequest

Eğitim için istek nesnesi.

options

RequestOptionsBase

İsteğe bağlı parametreler

Döndürülenler

Promise<TrainCustomModelResponse>

Promise<Models.TrainCustomModelResponse>

trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)

function trainCustomModel(trainRequest: TrainRequest, options: RequestOptionsBase, callback: ServiceCallback<TrainResult>)

Parametreler

trainRequest

TrainRequest

Eğitim için istek nesnesi.

options

RequestOptionsBase

İsteğe bağlı parametreler

callback

ServiceCallback<TrainResult>

Geri çağırma

trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

function trainCustomModel(trainRequest: TrainRequest, callback: ServiceCallback<TrainResult>)

Parametreler

trainRequest

TrainRequest

Eğitim için istek nesnesi.

callback

ServiceCallback<TrainResult>

Geri çağırma

Devralınan Yöntemin Ayrıntıları

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Sağlanan OperationSpec kullanılarak doldurulan bir HTTP isteği gönderin.

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>

Parametreler

operationArguments

OperationArguments

HTTP isteğinin şablonlu değerlerinin doldurulacağı bağımsız değişkenler.

operationSpec

OperationSpec

httpRequest'i doldurmak için kullanılacak OperationSpec.

callback

ServiceCallback<any>

Yanıt alındığında çağrılacak geri çağırma.

Döndürülenler

Promise<RestResponse>

FormRecognizerClientContext.sendOperationRequest Devralındı

sendRequest(RequestPrepareOptions | WebResourceLike)

Sağlanan httpRequest dosyasını gönderin.

function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>

Parametreler

options

RequestPrepareOptions | WebResourceLike

Döndürülenler

Promise<HttpOperationResponse>

FormRecognizerClientContext.sendRequest'den Devralınan