FormRecognizerClient class

Pakiet:

@azure/cognitiveservices-formrecognizer

Extends

FormRecognizerClientContext

Konstruktory

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Inicjuje nowe wystąpienie klasy FormRecognizerClient.

Właściwości dziedziczone

credentials
endpoint

Metody

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)	Wyodrębnij pary klucz-wartość z danego dokumentu. Dokument wejściowy musi być jednym z obsługiwanych typów zawartości — "application/pdf", "image/jpeg" lub "image/png". Odpowiedź z informacją o powodzeniu jest zwracana w formacie JSON.
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
batchReadReceipt(string, RequestOptionsBase)	Operacja paragonu odczytu wsadowego. Odpowiedź zawiera pole o nazwie "Operation-Location", które zawiera adres URL, którego należy użyć dla operacji "Pobierz wynik potwierdzenia odczytu".
batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
batchReadReceipt(string, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)	Operacja odczytu paragonu. W przypadku korzystania z interfejsu "Potwierdzenie odczytu w usłudze Batch" odpowiedź zawiera pole o nazwie "Operation-Location". Pole "Operation-Location" zawiera adres URL, którego należy użyć dla operacji "Pobierz wynik potwierdzenia odczytu".
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)
deleteCustomModel(string, RequestOptionsBase)	Usuwanie artefaktów modelu.
deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)
deleteCustomModel(string, ServiceCallback<void>)
getCustomModel(string, RequestOptionsBase)	Uzyskaj informacje o modelu.
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
getCustomModel(string, ServiceCallback<ModelResult>)
getCustomModels(RequestOptionsBase)	Uzyskiwanie informacji o wszystkich wytrenowanych modelach niestandardowych
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
getCustomModels(ServiceCallback<ModelsResult>)
getExtractedKeys(string, RequestOptionsBase)	Pobierz klucze wyodrębnione podczas trenowania określonego modelu.
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
getExtractedKeys(string, ServiceCallback<KeysResult>)
getReadReceiptResult(string, RequestOptionsBase)	Ten interfejs jest używany do uzyskiwania wyników analizy operacji "Potwierdzenie odczytu w usłudze Batch". Adres URL tego interfejsu należy pobrać z pola "Operation-Location" zwróconego z operacji "Potwierdzenie odczytu w usłudze Batch".
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
trainCustomModel(TrainRequest, RequestOptionsBase)	Tworzenie i trenowanie modelu niestandardowego. Żądanie pociągu musi zawierać parametr źródłowy, który jest zewnętrznie dostępnym identyfikatorem URI kontenera obiektów blob usługi Azure Storage (najlepiej identyfikatorem URI sygnatury dostępu współdzielonego) lub prawidłową ścieżką do folderu danych na dysku zainstalowanym lokalnie. Po określeniu ścieżek lokalnych muszą one postępować zgodnie z formatem ścieżki systemu Linux/Unix i być ścieżką bezwzględną zakorzenioną w wartości ustawienia konfiguracji instalacji wejściowej, np. jeśli wartość ustawienia konfiguracji "{Mounts:Input}" to "/input", prawidłowa ścieżka źródłowa będzie "/input/contosodataset". Oczekuje się, że wszystkie dane do wytrenowania będą znajdować się bezpośrednio w folderze źródłowym. Podfoldery nie są obsługiwane. Modele są trenowane przy użyciu dokumentów o następującym typie zawartości — "application/pdf", "image/jpeg" i "image/png". Inny typ zawartości jest ignorowany.
trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

Metody dziedziczone

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Wyślij żądanie HTTP wypełnione przy użyciu podanego elementu OperationSpec.
sendRequest(RequestPrepareOptions | WebResourceLike)	Wyślij podany element httpRequest.

Szczegóły konstruktora

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Inicjuje nowe wystąpienie klasy FormRecognizerClient.

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

Parametry

credentials

ServiceClientCredentials

Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję klienta.

endpoint

string

Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus2.api.cognitive.microsoft.com).

options

ServiceClientOptions

Opcje parametrów

Szczegóły właściwości dziedziczonej

credentials

credentials: ServiceClientCredentials

Wartość właściwości

ServiceClientCredentials

Dziedziczone zobiektu FormRecognizerClientContext.credentials

endpoint

endpoint: string

Wartość właściwości

string

Dziedziczone zobiektu FormRecognizerClientContext.endpoint

Szczegóły metody

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)

Wyodrębnij pary klucz-wartość z danego dokumentu. Dokument wejściowy musi być jednym z obsługiwanych typów zawartości — "application/pdf", "image/jpeg" lub "image/png". Odpowiedź z informacją o powodzeniu jest zwracana w formacie JSON.

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

Parametry

id

string

Identyfikator modelu do analizowania dokumentu za pomocą polecenia .

formStream

HttpRequestBody

Plik pdf lub obraz (jpg,png) do analizy.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

Parametry opcjonalne

Zwraca

Promise<AnalyzeWithCustomModelResponse>

Promise<Models.AnalyzeWithCustomModelResponse>

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

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

Parametry

id

string

Identyfikator modelu do analizowania dokumentu za pomocą polecenia .

formStream

HttpRequestBody

Plik pdf lub obraz (jpg,png) do analizy.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

Parametry opcjonalne

callback

ServiceCallback<AnalyzeResult>

Wywołanie zwrotne

analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)

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

Parametry

id

string

Identyfikator modelu do analizowania dokumentu za pomocą polecenia .

formStream

HttpRequestBody

Plik pdf lub obraz (jpg,png) do analizy.

callback

ServiceCallback<AnalyzeResult>

Wywołanie zwrotne

batchReadReceipt(string, RequestOptionsBase)

Operacja paragonu odczytu wsadowego. Odpowiedź zawiera pole o nazwie "Operation-Location", które zawiera adres URL, którego należy użyć dla operacji "Pobierz wynik potwierdzenia odczytu".

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

Parametry

url

string

Publicznie dostępny adres URL obrazu.

options

RequestOptionsBase

Parametry opcjonalne

Zwraca

Promise<BatchReadReceiptResponse>

Promise<Models.BatchReadReceiptResponse>

batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)

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

Parametry

url

string

Publicznie dostępny adres URL obrazu.

options

RequestOptionsBase

Parametry opcjonalne

callback

ServiceCallback<void>

Wywołanie zwrotne

batchReadReceipt(string, ServiceCallback<void>)

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

Parametry

url

string

Publicznie dostępny adres URL obrazu.

callback

ServiceCallback<void>

Wywołanie zwrotne

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)

Operacja odczytu paragonu. W przypadku korzystania z interfejsu "Potwierdzenie odczytu w usłudze Batch" odpowiedź zawiera pole o nazwie "Operation-Location". Pole "Operation-Location" zawiera adres URL, którego należy użyć dla operacji "Pobierz wynik potwierdzenia odczytu".

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

Parametry

image

HttpRequestBody

Strumień obrazu.

options

RequestOptionsBase

Parametry opcjonalne

Zwraca

Promise<BatchReadReceiptInStreamResponse>

Promise<Models.BatchReadReceiptInStreamResponse>

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)

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

Parametry

image

HttpRequestBody

Strumień obrazu.

options

RequestOptionsBase

Parametry opcjonalne

callback

ServiceCallback<void>

Wywołanie zwrotne

batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)

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

Parametry

image

HttpRequestBody

Strumień obrazu.

callback

ServiceCallback<void>

Wywołanie zwrotne

deleteCustomModel(string, RequestOptionsBase)

Usuwanie artefaktów modelu.

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

Parametry

id

string

Identyfikator modelu do usunięcia.

options

RequestOptionsBase

Parametry opcjonalne

Zwraca

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)

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

Parametry

id

string

Identyfikator modelu do usunięcia.

options

RequestOptionsBase

Parametry opcjonalne

callback

ServiceCallback<void>

Wywołanie zwrotne

deleteCustomModel(string, ServiceCallback<void>)

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

Parametry

id

string

Identyfikator modelu do usunięcia.

callback

ServiceCallback<void>

Wywołanie zwrotne

getCustomModel(string, RequestOptionsBase)

Uzyskaj informacje o modelu.

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

Parametry

id

string

Identyfikator modelu.

options

RequestOptionsBase

Parametry opcjonalne

Zwraca

Promise<GetCustomModelResponse>

Promise<Models.GetCustomModelResponse>

getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)

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

Parametry

id

string

Identyfikator modelu.

options

RequestOptionsBase

Parametry opcjonalne

callback

ServiceCallback<ModelResult>

Wywołanie zwrotne

getCustomModel(string, ServiceCallback<ModelResult>)

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

Parametry

id

string

Identyfikator modelu.

callback

ServiceCallback<ModelResult>

Wywołanie zwrotne

getCustomModels(RequestOptionsBase)

Uzyskiwanie informacji o wszystkich wytrenowanych modelach niestandardowych

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

Parametry

options

RequestOptionsBase

Parametry opcjonalne

Zwraca

Promise<GetCustomModelsResponse>

Promise<Models.GetCustomModelsResponse>

getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)

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

Parametry

options

RequestOptionsBase

Parametry opcjonalne

callback

ServiceCallback<ModelsResult>

Wywołanie zwrotne

getCustomModels(ServiceCallback<ModelsResult>)

function getCustomModels(callback: ServiceCallback<ModelsResult>)

Parametry

callback

ServiceCallback<ModelsResult>

Wywołanie zwrotne

getExtractedKeys(string, RequestOptionsBase)

Pobierz klucze wyodrębnione podczas trenowania określonego modelu.

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

Parametry

id

string

Identyfikator modelu.

options

RequestOptionsBase

Parametry opcjonalne

Zwraca

Promise<GetExtractedKeysResponse>

Promise<Models.GetExtractedKeysResponse>

getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)

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

Parametry

id

string

Identyfikator modelu.

options

RequestOptionsBase

Parametry opcjonalne

callback

ServiceCallback<KeysResult>

Wywołanie zwrotne

getExtractedKeys(string, ServiceCallback<KeysResult>)

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

Parametry

id

string

Identyfikator modelu.

callback

ServiceCallback<KeysResult>

Wywołanie zwrotne

getReadReceiptResult(string, RequestOptionsBase)

Ten interfejs jest używany do uzyskiwania wyników analizy operacji "Potwierdzenie odczytu w usłudze Batch". Adres URL tego interfejsu należy pobrać z pola "Operation-Location" zwróconego z operacji "Potwierdzenie odczytu w usłudze Batch".

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

Parametry

operationId

string

Identyfikator operacji odczytu zwróconej w odpowiedzi operacji "Potwierdzenie odczytu w usłudze Batch".

options

RequestOptionsBase

Parametry opcjonalne

Zwraca

Promise<GetReadReceiptResultResponse>

Promise<Models.GetReadReceiptResultResponse>

getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)

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

Parametry

operationId

string

Identyfikator operacji odczytu zwróconej w odpowiedzi operacji "Potwierdzenie odczytu w usłudze Batch".

options

RequestOptionsBase

Parametry opcjonalne

callback

ServiceCallback<ReadReceiptResult>

Wywołanie zwrotne

getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)

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

Parametry

operationId

string

Identyfikator operacji odczytu zwróconej w odpowiedzi operacji "Potwierdzenie odczytu w usłudze Batch".

callback

ServiceCallback<ReadReceiptResult>

Wywołanie zwrotne

trainCustomModel(TrainRequest, RequestOptionsBase)

Tworzenie i trenowanie modelu niestandardowego. Żądanie pociągu musi zawierać parametr źródłowy, który jest zewnętrznie dostępnym identyfikatorem URI kontenera obiektów blob usługi Azure Storage (najlepiej identyfikatorem URI sygnatury dostępu współdzielonego) lub prawidłową ścieżką do folderu danych na dysku zainstalowanym lokalnie. Po określeniu ścieżek lokalnych muszą one postępować zgodnie z formatem ścieżki systemu Linux/Unix i być ścieżką bezwzględną zakorzenioną w wartości ustawienia konfiguracji instalacji wejściowej, np. jeśli wartość ustawienia konfiguracji "{Mounts:Input}" to "/input", prawidłowa ścieżka źródłowa będzie "/input/contosodataset". Oczekuje się, że wszystkie dane do wytrenowania będą znajdować się bezpośrednio w folderze źródłowym. Podfoldery nie są obsługiwane. Modele są trenowane przy użyciu dokumentów o następującym typie zawartości — "application/pdf", "image/jpeg" i "image/png". Inny typ zawartości jest ignorowany.

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

Parametry

trainRequest

TrainRequest

Zażądaj obiektu na potrzeby trenowania.

options

RequestOptionsBase

Parametry opcjonalne

Zwraca

Promise<TrainCustomModelResponse>

Promise<Models.TrainCustomModelResponse>

trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)

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

Parametry

trainRequest

TrainRequest

Zażądaj obiektu na potrzeby trenowania.

options

RequestOptionsBase

Parametry opcjonalne

callback

ServiceCallback<TrainResult>

Wywołanie zwrotne

trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

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

Parametry

trainRequest

TrainRequest

Zażądaj obiektu na potrzeby trenowania.

callback

ServiceCallback<TrainResult>

Wywołanie zwrotne

Szczegóły metody dziedziczonej

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Wyślij żądanie HTTP wypełnione przy użyciu podanego elementu OperationSpec.

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

Parametry

operationArguments

OperationArguments

Argumenty, z których zostaną wypełnione wartości szablonowe żądania HTTP.

operationSpec

OperationSpec

Element OperationSpec używany do wypełniania żądania httpRequest.

callback

ServiceCallback<any>

Wywołanie zwrotne do wywołania po odebraniu odpowiedzi.

Zwraca

Promise<RestResponse>

Dziedziczone zformRecognizerClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Wyślij podany element httpRequest.

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

Parametry

options

RequestPrepareOptions | WebResourceLike

Zwraca

Promise<HttpOperationResponse>

Dziedziczone zobiektu FormRecognizerClientContext.sendRequest