FormRecognizerClient class

Pakket:

@azure/cognitiveservices-formrecognizer

Uitbreiding

FormRecognizerClientContext

Constructors

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Initialiseert een nieuw exemplaar van de klasse FormRecognizerClient.

Overgenomen eigenschappen

credentials
endpoint

Methoden

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)	Sleutel-waardeparen extraheren uit een bepaald document. Het invoerdocument moet van een van de ondersteunde inhoudstypen zijn: 'application/pdf', 'image/jpeg' of 'image/png'. Er wordt een geslaagd antwoord geretourneerd in JSON.
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
batchReadReceipt(string, RequestOptionsBase)	Batchbewerking leesbevestiging. Het antwoord bevat een veld met de naam Operation-Location, dat de URL bevat die u moet gebruiken voor de bewerking 'Resultaat leesbevestiging ophalen'.
batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
batchReadReceipt(string, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)	Leesbevestigingsbewerking. Wanneer u de interface Batch Read Receipt gebruikt, bevat het antwoord een veld met de naam 'Operation-Location'. Het veld 'Operation-Location' bevat de URL die u moet gebruiken voor de bewerking 'Resultaat leesbevestiging ophalen'.
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)
deleteCustomModel(string, RequestOptionsBase)	Modelartefacten verwijderen.
deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)
deleteCustomModel(string, ServiceCallback<void>)
getCustomModel(string, RequestOptionsBase)	Informatie over een model ophalen.
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
getCustomModel(string, ServiceCallback<ModelResult>)
getCustomModels(RequestOptionsBase)	Informatie ophalen over alle getrainde aangepaste modellen
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
getCustomModels(ServiceCallback<ModelsResult>)
getExtractedKeys(string, RequestOptionsBase)	Haal de sleutels op die zijn geëxtraheerd tijdens de training van het opgegeven model.
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
getExtractedKeys(string, ServiceCallback<KeysResult>)
getReadReceiptResult(string, RequestOptionsBase)	Deze interface wordt gebruikt voor het ophalen van de analyseresultaten van een 'Batch Read Receipt'-bewerking. De URL naar deze interface moet worden opgehaald uit het veld 'Operation-Location' dat wordt geretourneerd door de bewerking Batch-leesbevestiging.
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
trainCustomModel(TrainRequest, RequestOptionsBase)	Een aangepast model maken en trainen. De aanvraag voor de trein moet een bronparameter bevatten die een extern toegankelijke Azure Storage-blobcontainer-URI (bij voorkeur een Shared Access Signature-URI) of een geldig pad naar een gegevensmap in een lokaal gekoppeld station is. Wanneer lokale paden worden opgegeven, moeten ze de indeling van het Linux-/Unix-pad volgen en een absoluut pad zijn dat is geroot naar de waarde van de configuratie-instelling voor invoerkoppelingen, bijvoorbeeld als de waarde voor de configuratie-instelling {Mounts:Input} '/input}' is, dan is een geldig bronpad '/input/contosodataset'. Alle gegevens die moeten worden getraind, worden naar verwachting rechtstreeks onder de bronmap geplaatst. Submappen worden niet ondersteund. Modellen worden getraind met documenten die van het volgende inhoudstype zijn: 'application/pdf', 'image/jpeg' en 'image/png'. Ander type inhoud wordt genegeerd.
trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

Overgenomen methoden

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Verzend een HTTP-aanvraag die is ingevuld met behulp van de opgegeven OperationSpec.
sendRequest(RequestPrepareOptions | WebResourceLike)	Verzend de opgegeven httpRequest.

Constructordetails

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Initialiseert een nieuw exemplaar van de klasse FormRecognizerClient.

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

Parameters

credentials

ServiceClientCredentials

Abonnementsreferenties waarmee het clientabonnement uniek wordt geïdentificeerd.

endpoint

string

Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus2.api.cognitive.microsoft.com).

options

ServiceClientOptions

De parameteropties

Details van overgenomen eigenschap

credentials

credentials: ServiceClientCredentials

Waarde van eigenschap

ServiceClientCredentials

overgenomen vanFormRecognizerClientContext.credentials

endpoint

endpoint: string

Waarde van eigenschap

string

overgenomen vanFormRecognizerClientContext.endpoint

Methodedetails

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)

Sleutel-waardeparen extraheren uit een bepaald document. Het invoerdocument moet van een van de ondersteunde inhoudstypen zijn: 'application/pdf', 'image/jpeg' of 'image/png'. Er wordt een geslaagd antwoord geretourneerd in JSON.

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

Parameters

id

string

Model-id waarmee het document moet worden geanalyseerd.

formStream

HttpRequestBody

Een PDF-document- of afbeeldingsbestand (jpg,png) dat moet worden geanalyseerd.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

De optionele parameters

Retouren

Promise<AnalyzeWithCustomModelResponse>

Promise<Models.AnalyzeWithCustomModelResponse>

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

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

Parameters

id

string

Model-id waarmee het document moet worden geanalyseerd.

formStream

HttpRequestBody

Een PDF-document- of afbeeldingsbestand (jpg,png) dat moet worden geanalyseerd.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

De optionele parameters

callback

ServiceCallback<AnalyzeResult>

De callback

analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)

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

Parameters

id

string

Model-id waarmee het document moet worden geanalyseerd.

formStream

HttpRequestBody

Een PDF-document- of afbeeldingsbestand (jpg,png) dat moet worden geanalyseerd.

callback

ServiceCallback<AnalyzeResult>

De callback

batchReadReceipt(string, RequestOptionsBase)

Batchbewerking leesbevestiging. Het antwoord bevat een veld met de naam Operation-Location, dat de URL bevat die u moet gebruiken voor de bewerking 'Resultaat leesbevestiging ophalen'.

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

Parameters

url

string

Openbaar toegankelijke URL van een afbeelding.

options

RequestOptionsBase

De optionele parameters

Retouren

Promise<BatchReadReceiptResponse>

Promise<Models.BatchReadReceiptResponse>

batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)

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

Parameters

url

string

Openbaar toegankelijke URL van een afbeelding.

options

RequestOptionsBase

De optionele parameters

callback

ServiceCallback<void>

De callback

batchReadReceipt(string, ServiceCallback<void>)

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

Parameters

url

string

Openbaar toegankelijke URL van een afbeelding.

callback

ServiceCallback<void>

De callback

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)

Leesbevestigingsbewerking. Wanneer u de interface Batch Read Receipt gebruikt, bevat het antwoord een veld met de naam 'Operation-Location'. Het veld 'Operation-Location' bevat de URL die u moet gebruiken voor de bewerking 'Resultaat leesbevestiging ophalen'.

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

Parameters

image

HttpRequestBody

Een afbeeldingsstroom.

options

RequestOptionsBase

De optionele parameters

Retouren

Promise<BatchReadReceiptInStreamResponse>

Promise<Models.BatchReadReceiptInStreamResponse>

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)

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

Parameters

image

HttpRequestBody

Een afbeeldingsstroom.

options

RequestOptionsBase

De optionele parameters

callback

ServiceCallback<void>

De callback

batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)

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

Parameters

image

HttpRequestBody

Een afbeeldingsstroom.

callback

ServiceCallback<void>

De callback

deleteCustomModel(string, RequestOptionsBase)

Modelartefacten verwijderen.

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

Parameters

id

string

De id van het model dat moet worden verwijderd.

options

RequestOptionsBase

De optionele parameters

Retouren

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)

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

Parameters

id

string

De id van het model dat moet worden verwijderd.

options

RequestOptionsBase

De optionele parameters

callback

ServiceCallback<void>

De callback

deleteCustomModel(string, ServiceCallback<void>)

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

Parameters

id

string

De id van het model dat moet worden verwijderd.

callback

ServiceCallback<void>

De callback

getCustomModel(string, RequestOptionsBase)

Informatie over een model ophalen.

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

Parameters

id

string

Model-id.

options

RequestOptionsBase

De optionele parameters

Retouren

Promise<GetCustomModelResponse>

Promise<Models.GetCustomModelResponse>

getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)

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

Parameters

id

string

Model-id.

options

RequestOptionsBase

De optionele parameters

callback

ServiceCallback<ModelResult>

De callback

getCustomModel(string, ServiceCallback<ModelResult>)

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

Parameters

id

string

Model-id.

callback

ServiceCallback<ModelResult>

De callback

getCustomModels(RequestOptionsBase)

Informatie ophalen over alle getrainde aangepaste modellen

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

Parameters

options

RequestOptionsBase

De optionele parameters

Retouren

Promise<GetCustomModelsResponse>

Promise<Models.GetCustomModelsResponse>

getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)

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

Parameters

options

RequestOptionsBase

De optionele parameters

callback

ServiceCallback<ModelsResult>

De callback

getCustomModels(ServiceCallback<ModelsResult>)

function getCustomModels(callback: ServiceCallback<ModelsResult>)

Parameters

callback

ServiceCallback<ModelsResult>

De callback

getExtractedKeys(string, RequestOptionsBase)

Haal de sleutels op die zijn geëxtraheerd tijdens de training van het opgegeven model.

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

Parameters

id

string

Model-id.

options

RequestOptionsBase

De optionele parameters

Retouren

Promise<GetExtractedKeysResponse>

Promise<Models.GetExtractedKeysResponse>

getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)

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

Parameters

id

string

Model-id.

options

RequestOptionsBase

De optionele parameters

callback

ServiceCallback<KeysResult>

De callback

getExtractedKeys(string, ServiceCallback<KeysResult>)

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

Parameters

id

string

Model-id.

callback

ServiceCallback<KeysResult>

De callback

getReadReceiptResult(string, RequestOptionsBase)

Deze interface wordt gebruikt voor het ophalen van de analyseresultaten van een 'Batch Read Receipt'-bewerking. De URL naar deze interface moet worden opgehaald uit het veld 'Operation-Location' dat wordt geretourneerd door de bewerking Batch-leesbevestiging.

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

Parameters

operationId

string

De id van de leesbewerking die wordt geretourneerd in het antwoord van een bewerking Batch-leesbevestiging.

options

RequestOptionsBase

De optionele parameters

Retouren

Promise<GetReadReceiptResultResponse>

Promise<Models.GetReadReceiptResultResponse>

getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)

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

Parameters

operationId

string

De id van de leesbewerking die wordt geretourneerd in het antwoord van een bewerking Batch-leesbevestiging.

options

RequestOptionsBase

De optionele parameters

callback

ServiceCallback<ReadReceiptResult>

De callback

getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)

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

Parameters

operationId

string

De id van de leesbewerking die wordt geretourneerd in het antwoord van een bewerking Batch-leesbevestiging.

callback

ServiceCallback<ReadReceiptResult>

De callback

trainCustomModel(TrainRequest, RequestOptionsBase)

Een aangepast model maken en trainen. De aanvraag voor de trein moet een bronparameter bevatten die een extern toegankelijke Azure Storage-blobcontainer-URI (bij voorkeur een Shared Access Signature-URI) of een geldig pad naar een gegevensmap in een lokaal gekoppeld station is. Wanneer lokale paden worden opgegeven, moeten ze de indeling van het Linux-/Unix-pad volgen en een absoluut pad zijn dat is geroot naar de waarde van de configuratie-instelling voor invoerkoppelingen, bijvoorbeeld als de waarde voor de configuratie-instelling {Mounts:Input} '/input}' is, dan is een geldig bronpad '/input/contosodataset'. Alle gegevens die moeten worden getraind, worden naar verwachting rechtstreeks onder de bronmap geplaatst. Submappen worden niet ondersteund. Modellen worden getraind met documenten die van het volgende inhoudstype zijn: 'application/pdf', 'image/jpeg' en 'image/png'. Ander type inhoud wordt genegeerd.

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

Parameters

trainRequest

TrainRequest

Aanvraagobject voor training.

options

RequestOptionsBase

De optionele parameters

Retouren

Promise<TrainCustomModelResponse>

Promise<Models.TrainCustomModelResponse>

trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)

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

Parameters

trainRequest

TrainRequest

Aanvraagobject voor training.

options

RequestOptionsBase

De optionele parameters

callback

ServiceCallback<TrainResult>

De callback

trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

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

Parameters

trainRequest

TrainRequest

Aanvraagobject voor training.

callback

ServiceCallback<TrainResult>

De callback

Details overgenomen methode

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Verzend een HTTP-aanvraag die is ingevuld met behulp van de opgegeven OperationSpec.

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

Parameters

operationArguments

OperationArguments

De argumenten waaruit de sjabloonwaarden van de HTTP-aanvraag worden ingevuld.

operationSpec

OperationSpec

De OperationSpec die moet worden gebruikt om de httpRequest te vullen.

callback

ServiceCallback<any>

De callback die moet worden aangeroepen wanneer het antwoord wordt ontvangen.

Retouren

Promise<RestResponse>

overgenomen vanFormRecognizerClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Verzend de opgegeven httpRequest.

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

Parameters

options

RequestPrepareOptions | WebResourceLike

Retouren

Promise<HttpOperationResponse>

overgenomen vanFormRecognizerClientContext.sendRequest