FormRecognizerClient class
- Extends
Constructors
| Form |
Initialiseert een nieuw exemplaar van de klasse FormRecognizerClient. |
Overgenomen eigenschappen
| credentials | |
| endpoint |
Methoden
| analyze |
Sleutel-waardeparen extraheren uit een bepaald document. Het invoerdocument moet van een van de ondersteunde inhoudstypen zijn: 'application/pdf', 'image/jpeg' of 'image/png'. Een geslaagd antwoord wordt geretourneerd in JSON. |
| analyze |
|
| analyze |
|
| batch |
Batch leesbevestigingsbewerking. Het antwoord bevat een veld met de naam 'Operation-Location', dat de URL bevat die u moet gebruiken voor de bewerking Leesbevestiging ophalen. |
| batch |
|
| batch |
|
| batch |
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'. |
| batch |
|
| batch |
|
| delete |
Verwijder modelartefacten. |
| delete |
|
| delete |
|
| get |
Informatie over een model ophalen. |
| get |
|
| get |
|
| get |
Informatie ophalen over alle getrainde aangepaste modellen |
| get |
|
| get |
|
| get |
Haal de sleutels op die zijn geëxtraheerd tijdens de training van het opgegeven model. |
| get |
|
| get |
|
| get |
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 is geretourneerd door de bewerking Batch Read Receipt. |
| get |
|
| get |
|
| train |
Een aangepast model maken en trainen. De treinaanvraag moet een bronparameter bevatten die een extern toegankelijke Azure Storage-blobcontainer-URI is (bij voorkeur een Shared Access Signature-URI) of een geldig pad naar een gegevensmap in een lokaal gekoppeld station. Wanneer lokale paden zijn opgegeven, moeten deze de indeling van het Linux-/Unix-pad volgen en een absoluut pad zijn dat is geroot naar de waarde van de configuratie-instelling voor invoerkoppeling, bijvoorbeeld als de configuratie-instellingswaarde {Mounts:Input} '/input' is, is een geldig bronpad '/input/contosodataset'. Alle gegevens die moeten worden getraind, bevinden zich naar verwachting rechtstreeks onder de bronmap. Submappen worden niet ondersteund. Modellen worden getraind met behulp van documenten van het volgende inhoudstype: 'application/pdf', 'image/jpeg' en 'image/png'. Ander type inhoud wordt genegeerd. |
| train |
|
| train |
Overgenomen methoden
| send |
Verzend een HTTP-aanvraag die is ingevuld met behulp van de opgegeven OperationSpec. |
| send |
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: ServiceClientCredentialsWaarde van eigenschap
Overgenomen vanFormRecognizerClientContext.credentials
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'. Een geslaagd antwoord wordt geretourneerd in JSON.
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options?: FormRecognizerClientAnalyzeWithCustomModelOptionalParams): Promise<AnalyzeWithCustomModelResponse>Parameters
- id
-
string
Model-id om het document mee te analyseren.
- formStream
- HttpRequestBody
Een PDF-document of afbeeldingsbestand (jpg, png) om te analyseren.
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 om het document mee te analyseren.
- formStream
- HttpRequestBody
Een PDF-document of afbeeldingsbestand (jpg, png) om te analyseren.
De optionele parameters
- callback
De callback
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, callback: ServiceCallback<AnalyzeResult>)Parameters
- id
-
string
Model-id om het document mee te analyseren.
- formStream
- HttpRequestBody
Een PDF-document of afbeeldingsbestand (jpg, png) om te analyseren.
- callback
De callback
batchReadReceipt(string, RequestOptionsBase)
Batch leesbevestigingsbewerking. Het antwoord bevat een veld met de naam 'Operation-Location', dat de URL bevat die u moet gebruiken voor de bewerking Leesbevestiging ophalen.
function batchReadReceipt(url: string, options?: RequestOptionsBase): Promise<BatchReadReceiptResponse>Parameters
- url
-
string
Openbaar bereikbare 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 bereikbare 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 bereikbare 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)
Verwijder modelartefacten.
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 u wilt verwijderen.
- 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
De callback
getCustomModel(string, ServiceCallback<ModelResult>)
function getCustomModel(id: string, callback: ServiceCallback<ModelResult>)Parameters
- id
-
string
Model-id.
- callback
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
De callback
getCustomModels(ServiceCallback<ModelsResult>)
function getCustomModels(callback: ServiceCallback<ModelsResult>)Parameters
- callback
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
De callback
getExtractedKeys(string, ServiceCallback<KeysResult>)
function getExtractedKeys(id: string, callback: ServiceCallback<KeysResult>)Parameters
- id
-
string
Model-id.
- callback
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 is geretourneerd door de bewerking Batch Read Receipt.
function getReadReceiptResult(operationId: string, options?: RequestOptionsBase): Promise<GetReadReceiptResultResponse>Parameters
- operationId
-
string
Id van leesbewerking die wordt geretourneerd in het antwoord van een 'Batch Read Receipt'-bewerking.
- 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
Id van leesbewerking die wordt geretourneerd in het antwoord van een 'Batch Read Receipt'-bewerking.
- options
- RequestOptionsBase
De optionele parameters
- callback
De callback
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
function getReadReceiptResult(operationId: string, callback: ServiceCallback<ReadReceiptResult>)Parameters
- operationId
-
string
Id van leesbewerking die wordt geretourneerd in het antwoord van een 'Batch Read Receipt'-bewerking.
- callback
De callback
trainCustomModel(TrainRequest, RequestOptionsBase)
Een aangepast model maken en trainen. De treinaanvraag moet een bronparameter bevatten die een extern toegankelijke Azure Storage-blobcontainer-URI is (bij voorkeur een Shared Access Signature-URI) of een geldig pad naar een gegevensmap in een lokaal gekoppeld station. Wanneer lokale paden zijn opgegeven, moeten deze de indeling van het Linux-/Unix-pad volgen en een absoluut pad zijn dat is geroot naar de waarde van de configuratie-instelling voor invoerkoppeling, bijvoorbeeld als de configuratie-instellingswaarde {Mounts:Input} '/input' is, is een geldig bronpad '/input/contosodataset'. Alle gegevens die moeten worden getraind, bevinden zich naar verwachting rechtstreeks onder de bronmap. Submappen worden niet ondersteund. Modellen worden getraind met behulp van documenten van het volgende inhoudstype: '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
De callback
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)
function trainCustomModel(trainRequest: TrainRequest, callback: ServiceCallback<TrainResult>)Parameters
- trainRequest
- TrainRequest
Aanvraagobject voor training.
- callback
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 in te vullen.
- callback
-
ServiceCallback<any>
De callback om aan te roepen 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
Retouren
Promise<HttpOperationResponse>
Overgenomen vanFormRecognizerClientContext.sendRequest
Azure SDK for JavaScript
Feedback
Binnenkort beschikbaar: In de loop van 2024 zullen we GitHub-problemen geleidelijk uitfaseren als het feedbackmechanisme voor inhoud en deze vervangen door een nieuw feedbacksysteem. Zie voor meer informatie: https://aka.ms/ContentUserFeedback.
Feedback verzenden en weergeven voor