FormRecognizerClient class

Balíček:

@azure/cognitiveservices-formrecognizer

Extends

FormRecognizerClientContext

Konstruktory

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Inicializuje novou instanci FormRecognizerClient třídy.

Zděděné vlastnosti

credentials
endpoint

Metody

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)	Extrahujte páry klíč-hodnota z daného dokumentu. Vstupní dokument musí být jedním z podporovaných typů obsahu – application/pdf, image/jpeg nebo image/png. Ve formátu JSON se vrátí odpověď na úspěch.
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
batchReadReceipt(string, RequestOptionsBase)	Operace dávkového potvrzení o přečtení. Odpověď obsahuje pole s názvem "Operation-Location", které obsahuje adresu URL, kterou musíte použít pro operaci Získat výsledek potvrzení o přečtení.
batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
batchReadReceipt(string, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)	Operace potvrzení o přečtení Při použití rozhraní Batch Read Receipt obsahuje odpověď pole s názvem Operation-Location. Pole Operation-Location obsahuje adresu URL, kterou musíte použít pro operaci Získat výsledek potvrzení o přečtení.
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)
deleteCustomModel(string, RequestOptionsBase)	Odstranění artefaktů modelu
deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)
deleteCustomModel(string, ServiceCallback<void>)
getCustomModel(string, RequestOptionsBase)	Získejte informace o modelu.
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
getCustomModel(string, ServiceCallback<ModelResult>)
getCustomModels(RequestOptionsBase)	Získání informací o všech natrénovaných vlastních modelech
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
getCustomModels(ServiceCallback<ModelsResult>)
getExtractedKeys(string, RequestOptionsBase)	Načtěte klíče extrahované během trénování zadaného modelu.
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
getExtractedKeys(string, ServiceCallback<KeysResult>)
getReadReceiptResult(string, RequestOptionsBase)	Toto rozhraní slouží k získání výsledků analýzy operace Potvrzení o přečtení dávky. Adresa URL tohoto rozhraní by se měla načíst z pole Operation-Location vráceného z operace Potvrzení o přečtení dávky.
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
trainCustomModel(TrainRequest, RequestOptionsBase)	Vytvoření a trénování vlastního modelu Požadavek na trénování musí obsahovat zdrojový parametr, který je buď externě přístupný identifikátor URI kontejneru objektů blob služby Azure Storage (nejlépe identifikátor URI sdíleného přístupového podpisu), nebo platnou cestu ke složce dat v místně připojené jednotce. Pokud jsou zadány místní cesty, musí se řídit formátem cesty Systému Linux/Unix a musí být absolutní kořenovou cestou ke vstupní hodnotě nastavení konfigurace připojení, například pokud je hodnota nastavení konfigurace {Mounts:Input} hodnota /input, bude platná zdrojová cesta /input /contosodataset. Očekává se, že všechna data, která se mají trénovat, budou přímo ve zdrojové složce. Podsložky nejsou podporovány. Modely se trénují pomocí dokumentů, které mají následující typ obsahu – application/pdf, image/jpeg a image/png. Jiný typ obsahu se ignoruje.
trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

Zděděné metody

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Odešlete požadavek HTTP naplněný zadaným objektem OperationSpec.
sendRequest(RequestPrepareOptions | WebResourceLike)	Odešle zadaný httpRequest.

Podrobnosti konstruktoru

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Inicializuje novou instanci FormRecognizerClient třídy.

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

Parametry

credentials

ServiceClientCredentials

Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné klienta.

endpoint

string

Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus2.api.cognitive.microsoft.com).

options

ServiceClientOptions

Možnosti parametrů

Podrobnosti zděděných vlastností

credentials

credentials: ServiceClientCredentials

Hodnota vlastnosti

ServiceClientCredentials

zděděno zFormRecognizerClientContext.credentials

endpoint

endpoint: string

Hodnota vlastnosti

string

zděděno zFormRecognizerClientContext.endpoint

Podrobnosti metody

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)

Extrahujte páry klíč-hodnota z daného dokumentu. Vstupní dokument musí být jedním z podporovaných typů obsahu – application/pdf, image/jpeg nebo image/png. Ve formátu JSON se vrátí odpověď na úspěch.

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

Parametry

id

string

Identifikátor modelu pro analýzu dokumentu.

formStream

HttpRequestBody

Soubor pdf dokumentu nebo obrázku (jpg,png) k analýze.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

Volitelné parametry

Návraty

Promise<AnalyzeWithCustomModelResponse>

Příslib<Models.AnalyzeWithCustomModelResponse>

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

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

Parametry

id

string

Identifikátor modelu pro analýzu dokumentu.

formStream

HttpRequestBody

Soubor pdf dokumentu nebo obrázku (jpg,png) k analýze.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

Volitelné parametry

callback

ServiceCallback<AnalyzeResult>

Zpětné volání

analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)

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

Parametry

id

string

Identifikátor modelu pro analýzu dokumentu.

formStream

HttpRequestBody

Soubor pdf dokumentu nebo obrázku (jpg,png) k analýze.

callback

ServiceCallback<AnalyzeResult>

Zpětné volání

batchReadReceipt(string, RequestOptionsBase)

Operace dávkového potvrzení o přečtení. Odpověď obsahuje pole s názvem "Operation-Location", které obsahuje adresu URL, kterou musíte použít pro operaci Získat výsledek potvrzení o přečtení.

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

Parametry

url

string

Veřejně dostupná adresa URL obrázku

options

RequestOptionsBase

Volitelné parametry

Návraty

Promise<BatchReadReceiptResponse>

Příslib<Models.BatchReadReceiptResponse>

batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)

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

Parametry

url

string

Veřejně dostupná adresa URL obrázku

options

RequestOptionsBase

Volitelné parametry

callback

ServiceCallback<void>

Zpětné volání

batchReadReceipt(string, ServiceCallback<void>)

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

Parametry

url

string

Veřejně dostupná adresa URL obrázku

callback

ServiceCallback<void>

Zpětné volání

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)

Operace potvrzení o přečtení Při použití rozhraní Batch Read Receipt obsahuje odpověď pole s názvem Operation-Location. Pole Operation-Location obsahuje adresu URL, kterou musíte použít pro operaci Získat výsledek potvrzení o přečtení.

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

Parametry

image

HttpRequestBody

Stream obrázku.

options

RequestOptionsBase

Volitelné parametry

Návraty

Promise<BatchReadReceiptInStreamResponse>

Příslib<Models.BatchReadReceiptInStreamResponse>

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)

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

Parametry

image

HttpRequestBody

Stream obrázku.

options

RequestOptionsBase

Volitelné parametry

callback

ServiceCallback<void>

Zpětné volání

batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)

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

Parametry

image

HttpRequestBody

Stream obrázku.

callback

ServiceCallback<void>

Zpětné volání

deleteCustomModel(string, RequestOptionsBase)

Odstranění artefaktů modelu

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

Parametry

id

string

Identifikátor modelu, který chcete odstranit.

options

RequestOptionsBase

Volitelné parametry

Návraty

Promise<RestResponse>

Příslib<msRest.RestResponse>

deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)

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

Parametry

id

string

Identifikátor modelu, který chcete odstranit.

options

RequestOptionsBase

Volitelné parametry

callback

ServiceCallback<void>

Zpětné volání

deleteCustomModel(string, ServiceCallback<void>)

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

Parametry

id

string

Identifikátor modelu, který chcete odstranit.

callback

ServiceCallback<void>

Zpětné volání

getCustomModel(string, RequestOptionsBase)

Získejte informace o modelu.

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

Parametry

id

string

Identifikátor modelu.

options

RequestOptionsBase

Volitelné parametry

Návraty

Promise<GetCustomModelResponse>

Příslib<Models.GetCustomModelResponse>

getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)

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

Parametry

id

string

Identifikátor modelu.

options

RequestOptionsBase

Volitelné parametry

callback

ServiceCallback<ModelResult>

Zpětné volání

getCustomModel(string, ServiceCallback<ModelResult>)

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

Parametry

id

string

Identifikátor modelu.

callback

ServiceCallback<ModelResult>

Zpětné volání

getCustomModels(RequestOptionsBase)

Získání informací o všech natrénovaných vlastních modelech

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

Parametry

options

RequestOptionsBase

Volitelné parametry

Návraty

Promise<GetCustomModelsResponse>

Příslib<Models.GetCustomModelsResponse>

getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)

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

Parametry

options

RequestOptionsBase

Volitelné parametry

callback

ServiceCallback<ModelsResult>

Zpětné volání

getCustomModels(ServiceCallback<ModelsResult>)

function getCustomModels(callback: ServiceCallback<ModelsResult>)

Parametry

callback

ServiceCallback<ModelsResult>

Zpětné volání

getExtractedKeys(string, RequestOptionsBase)

Načtěte klíče extrahované během trénování zadaného modelu.

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

Parametry

id

string

Identifikátor modelu.

options

RequestOptionsBase

Volitelné parametry

Návraty

Promise<GetExtractedKeysResponse>

Příslib<Models.GetExtractedKeysResponse>

getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)

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

Parametry

id

string

Identifikátor modelu.

options

RequestOptionsBase

Volitelné parametry

callback

ServiceCallback<KeysResult>

Zpětné volání

getExtractedKeys(string, ServiceCallback<KeysResult>)

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

Parametry

id

string

Identifikátor modelu.

callback

ServiceCallback<KeysResult>

Zpětné volání

getReadReceiptResult(string, RequestOptionsBase)

Toto rozhraní slouží k získání výsledků analýzy operace Potvrzení o přečtení dávky. Adresa URL tohoto rozhraní by se měla načíst z pole Operation-Location vráceného z operace Potvrzení o přečtení dávky.

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

Parametry

operationId

string

ID operace čtení vrácené v odpovědi operace "Dávkové potvrzení o přečtení".

options

RequestOptionsBase

Volitelné parametry

Návraty

Promise<GetReadReceiptResultResponse>

Příslib<Models.GetReadReceiptResultResponse>

getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)

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

Parametry

operationId

string

ID operace čtení vrácené v odpovědi operace "Dávkové potvrzení o přečtení".

options

RequestOptionsBase

Volitelné parametry

callback

ServiceCallback<ReadReceiptResult>

Zpětné volání

getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)

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

Parametry

operationId

string

ID operace čtení vrácené v odpovědi operace "Dávkové potvrzení o přečtení".

callback

ServiceCallback<ReadReceiptResult>

Zpětné volání

trainCustomModel(TrainRequest, RequestOptionsBase)

Vytvoření a trénování vlastního modelu Požadavek na trénování musí obsahovat zdrojový parametr, který je buď externě přístupný identifikátor URI kontejneru objektů blob služby Azure Storage (nejlépe identifikátor URI sdíleného přístupového podpisu), nebo platnou cestu ke složce dat v místně připojené jednotce. Pokud jsou zadány místní cesty, musí se řídit formátem cesty Systému Linux/Unix a musí být absolutní kořenovou cestou ke vstupní hodnotě nastavení konfigurace připojení, například pokud je hodnota nastavení konfigurace {Mounts:Input} hodnota /input, bude platná zdrojová cesta /input /contosodataset. Očekává se, že všechna data, která se mají trénovat, budou přímo ve zdrojové složce. Podsložky nejsou podporovány. Modely se trénují pomocí dokumentů, které mají následující typ obsahu – application/pdf, image/jpeg a image/png. Jiný typ obsahu se ignoruje.

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

Parametry

trainRequest

TrainRequest

Vyžádání objektu pro trénování

options

RequestOptionsBase

Volitelné parametry

Návraty

Promise<TrainCustomModelResponse>

Příslib<Models.TrainCustomModelResponse>

trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)

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

Parametry

trainRequest

TrainRequest

Vyžádání objektu pro trénování

options

RequestOptionsBase

Volitelné parametry

callback

ServiceCallback<TrainResult>

Zpětné volání

trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

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

Parametry

trainRequest

TrainRequest

Vyžádání objektu pro trénování

callback

ServiceCallback<TrainResult>

Zpětné volání

Podrobnosti zděděných metod

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Odešlete požadavek HTTP naplněný zadaným objektem OperationSpec.

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

Parametry

operationArguments

OperationArguments

Argumenty, ze které se vyplní hodnoty šablony požadavku HTTP.

operationSpec

OperationSpec

OperationSpec, který se má použít k naplnění httpRequest.

callback

ServiceCallback<any>

Zpětné volání, které se má volat při přijetí odpovědi.

Návraty

Promise<RestResponse>

zděděno zFormRecognizerClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Odešle zadaný httpRequest.

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

Parametry

options

RequestPrepareOptions | WebResourceLike

Návraty

Promise<HttpOperationResponse>

zděděno zFormRecognizerClientContext.sendRequest