Dela via

FormRecognizerClient class

  • Referens
Paket:
@azure/cognitiveservices-formrecognizer
Extends
FormRecognizerClientContext

Konstruktorer

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Initierar en ny instans av klassen FormRecognizerClient.

Ärvda egenskaper

credentials
endpoint

Metoder

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)

Extrahera nyckel/värde-par från ett visst dokument. Indatadokumentet måste ha någon av de innehållstyper som stöds – "application/pdf", "image/jpeg" eller "image/png". Ett lyckat svar returneras i JSON.
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
batchReadReceipt(string, RequestOptionsBase)

Batchläsningskvittoåtgärd. Svaret innehåller ett fält med namnet "Operation-Location", som innehåller den URL som du måste använda för åtgärden Hämta läskvittoresultat.
batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
batchReadReceipt(string, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)

Åtgärden Läskvitto. När du använder gränssnittet "Batch-läskvitto" innehåller svaret ett fält med namnet "Operation-Location". Fältet "Åtgärdsplats" innehåller den URL som du måste använda för åtgärden Hämta läskvittoresultat.
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)
deleteCustomModel(string, RequestOptionsBase)

Ta bort modellartefakter.
deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)
deleteCustomModel(string, ServiceCallback<void>)
getCustomModel(string, RequestOptionsBase)

Hämta information om en modell.
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
getCustomModel(string, ServiceCallback<ModelResult>)
getCustomModels(RequestOptionsBase)

Hämta information om alla tränade anpassade modeller
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
getCustomModels(ServiceCallback<ModelsResult>)
getExtractedKeys(string, RequestOptionsBase)

Hämta nycklarna som extraherades under träningen av den angivna modellen.
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
getExtractedKeys(string, ServiceCallback<KeysResult>)
getReadReceiptResult(string, RequestOptionsBase)

Det här gränssnittet används för att hämta analysresultatet för en batchläsningskvittoåtgärd. URL:en till det här gränssnittet ska hämtas från fältet "Åtgärdsplats" som returneras från åtgärden "Batch-läskvitto".
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
trainCustomModel(TrainRequest, RequestOptionsBase)

Skapa och träna en anpassad modell. Träningsbegäran måste innehålla en källparameter som antingen är en externt tillgänglig Azure Storage-blobcontainer-URI (helst en signatur för delad åtkomst) eller en giltig sökväg till en datamapp på en lokalt monterad enhet. När lokala sökvägar har angetts måste de följa sökvägsformatet för Linux/Unix och vara en absolut sökväg rotad till inställningsvärdet för konfiguration av indatamontering, t.ex. om konfigurationsinställningsvärdet {Mounts:Input} är /input är en giltig källsökväg :/input/contosodataset. Alla data som ska tränas förväntas vara direkt under källmappen. Undermappar stöds inte. Modeller tränas med dokument som är av följande innehållstyp – "application/pdf", "image/jpeg" och "image/png". Annan typ av innehåll ignoreras.
trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

Ärvda metoder

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Skicka en HTTP-begäran som fylls i med den angivna OperationSpec.
sendRequest(RequestPrepareOptions | WebResourceLike)

Skicka angivet httpRequest.

Konstruktorinformation

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Initierar en ny instans av klassen FormRecognizerClient.

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

Parametrar

credentials
ServiceClientCredentials

Autentiseringsuppgifter för prenumeration som unikt identifierar klientprenumeration.

endpoint

string

Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus2.api.cognitive.microsoft.com).

options
ServiceClientOptions

Parameteralternativen

Information om ärvda egenskaper

credentials 

credentials: ServiceClientCredentials

Egenskapsvärde

ServiceClientCredentials

ärvs frånFormRecognizerClientContext.credentials

endpoint 

endpoint: string

Egenskapsvärde

string

ärvd frånFormRecognizerClientContext.endpoint

Metodinformation

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)

Extrahera nyckel/värde-par från ett visst dokument. Indatadokumentet måste ha någon av de innehållstyper som stöds – "application/pdf", "image/jpeg" eller "image/png". Ett lyckat svar returneras i JSON.

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

Parametrar

id

string

Modellidentifierare som dokumentet ska analyseras med.

formStream
HttpRequestBody

Ett pdf-dokument eller en bildfil (jpg, png) som ska analyseras.

options
FormRecognizerClientAnalyzeWithCustomModelOptionalParams

De valfria parametrarna

Returer

Promise<AnalyzeWithCustomModelResponse>

Promise<Models.AnalyzeWithCustomModelResponse>

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

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

Parametrar

id

string

Modellidentifierare som dokumentet ska analyseras med.

formStream
HttpRequestBody

Ett pdf-dokument eller en bildfil (jpg, png) som ska analyseras.

options
FormRecognizerClientAnalyzeWithCustomModelOptionalParams

De valfria parametrarna

callback

ServiceCallback<AnalyzeResult>

Återanropet

analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>) 

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

Parametrar

id

string

Modellidentifierare som dokumentet ska analyseras med.

formStream
HttpRequestBody

Ett pdf-dokument eller en bildfil (jpg, png) som ska analyseras.

callback

ServiceCallback<AnalyzeResult>

Återanropet

batchReadReceipt(string, RequestOptionsBase)

Batchläsningskvittoåtgärd. Svaret innehåller ett fält med namnet "Operation-Location", som innehåller den URL som du måste använda för åtgärden Hämta läskvittoresultat.

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

Parametrar

url

string

Offentligt nåbar URL för en bild.

options
RequestOptionsBase

De valfria parametrarna

Returer

Promise<BatchReadReceiptResponse>

Promise<Models.BatchReadReceiptResponse>

batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>) 

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

Parametrar

url

string

Offentligt nåbar URL för en bild.

options
RequestOptionsBase

De valfria parametrarna

callback

ServiceCallback<void>

Återanropet

batchReadReceipt(string, ServiceCallback<void>) 

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

Parametrar

url

string

Offentligt nåbar URL för en bild.

callback

ServiceCallback<void>

Återanropet

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)

Åtgärden Läskvitto. När du använder gränssnittet "Batch-läskvitto" innehåller svaret ett fält med namnet "Operation-Location". Fältet "Åtgärdsplats" innehåller den URL som du måste använda för åtgärden Hämta läskvittoresultat.

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

Parametrar

image
HttpRequestBody

En bildström.

options
RequestOptionsBase

De valfria parametrarna

Returer

Promise<BatchReadReceiptInStreamResponse>

Promise<Models.BatchReadReceiptInStreamResponse>

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>) 

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

Parametrar

image
HttpRequestBody

En bildström.

options
RequestOptionsBase

De valfria parametrarna

callback

ServiceCallback<void>

Återanropet

batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>) 

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

Parametrar

image
HttpRequestBody

En bildström.

callback

ServiceCallback<void>

Återanropet

deleteCustomModel(string, RequestOptionsBase)

Ta bort modellartefakter.

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

Parametrar

id

string

Identifieraren för modellen som ska tas bort.

options
RequestOptionsBase

De valfria parametrarna

Returer

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>) 

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

Parametrar

id

string

Identifieraren för modellen som ska tas bort.

options
RequestOptionsBase

De valfria parametrarna

callback

ServiceCallback<void>

Återanropet

deleteCustomModel(string, ServiceCallback<void>) 

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

Parametrar

id

string

Identifieraren för modellen som ska tas bort.

callback

ServiceCallback<void>

Återanropet

getCustomModel(string, RequestOptionsBase)

Hämta information om en modell.

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

Parametrar

id

string

Modellidentifierare.

options
RequestOptionsBase

De valfria parametrarna

Returer

Promise<GetCustomModelResponse>

Promise<Models.GetCustomModelResponse>

getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>) 

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

Parametrar

id

string

Modellidentifierare.

options
RequestOptionsBase

De valfria parametrarna

callback

ServiceCallback<ModelResult>

Återanropet

getCustomModel(string, ServiceCallback<ModelResult>) 

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

Parametrar

id

string

Modellidentifierare.

callback

ServiceCallback<ModelResult>

Återanropet

getCustomModels(RequestOptionsBase)

Hämta information om alla tränade anpassade modeller

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

Parametrar

options
RequestOptionsBase

De valfria parametrarna

Returer

Promise<GetCustomModelsResponse>

Promise<Models.GetCustomModelsResponse>

getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>) 

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

Parametrar

options
RequestOptionsBase

De valfria parametrarna

callback

ServiceCallback<ModelsResult>

Återanropet

getCustomModels(ServiceCallback<ModelsResult>) 

function getCustomModels(callback: ServiceCallback<ModelsResult>)

Parametrar

callback

ServiceCallback<ModelsResult>

Återanropet

getExtractedKeys(string, RequestOptionsBase)

Hämta nycklarna som extraherades under träningen av den angivna modellen.

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

Parametrar

id

string

Modellidentifierare.

options
RequestOptionsBase

De valfria parametrarna

Returer

Promise<GetExtractedKeysResponse>

Promise<Models.GetExtractedKeysResponse>

getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>) 

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

Parametrar

id

string

Modellidentifierare.

options
RequestOptionsBase

De valfria parametrarna

callback

ServiceCallback<KeysResult>

Återanropet

getExtractedKeys(string, ServiceCallback<KeysResult>) 

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

Parametrar

id

string

Modellidentifierare.

callback

ServiceCallback<KeysResult>

Återanropet

getReadReceiptResult(string, RequestOptionsBase)

Det här gränssnittet används för att hämta analysresultatet för en batchläsningskvittoåtgärd. URL:en till det här gränssnittet ska hämtas från fältet "Åtgärdsplats" som returneras från åtgärden "Batch-läskvitto".

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

Parametrar

operationId

string

ID för läsåtgärd som returneras i svaret för en batchläsningskvittoåtgärd.

options
RequestOptionsBase

De valfria parametrarna

Returer

Promise<GetReadReceiptResultResponse>

Promise<Models.GetReadReceiptResultResponse>

getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>) 

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

Parametrar

operationId

string

ID för läsåtgärd som returneras i svaret för en batchläsningskvittoåtgärd.

options
RequestOptionsBase

De valfria parametrarna

callback

ServiceCallback<ReadReceiptResult>

Återanropet

getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>) 

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

Parametrar

operationId

string

ID för läsåtgärd som returneras i svaret för en batchläsningskvittoåtgärd.

callback

ServiceCallback<ReadReceiptResult>

Återanropet

trainCustomModel(TrainRequest, RequestOptionsBase)

Skapa och träna en anpassad modell. Träningsbegäran måste innehålla en källparameter som antingen är en externt tillgänglig Azure Storage-blobcontainer-URI (helst en signatur för delad åtkomst) eller en giltig sökväg till en datamapp på en lokalt monterad enhet. När lokala sökvägar har angetts måste de följa sökvägsformatet för Linux/Unix och vara en absolut sökväg rotad till inställningsvärdet för konfiguration av indatamontering, t.ex. om konfigurationsinställningsvärdet {Mounts:Input} är /input är en giltig källsökväg :/input/contosodataset. Alla data som ska tränas förväntas vara direkt under källmappen. Undermappar stöds inte. Modeller tränas med dokument som är av följande innehållstyp – "application/pdf", "image/jpeg" och "image/png". Annan typ av innehåll ignoreras.

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

Parametrar

trainRequest
TrainRequest

Begär objekt för träning.

options
RequestOptionsBase

De valfria parametrarna

Returer

Promise<TrainCustomModelResponse>

Promise<Models.TrainCustomModelResponse>

trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>) 

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

Parametrar

trainRequest
TrainRequest

Begär objekt för träning.

options
RequestOptionsBase

De valfria parametrarna

callback

ServiceCallback<TrainResult>

Återanropet

trainCustomModel(TrainRequest, ServiceCallback<TrainResult>) 

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

Parametrar

trainRequest
TrainRequest

Begär objekt för träning.

callback

ServiceCallback<TrainResult>

Återanropet

Ärvd metodinformation

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Skicka en HTTP-begäran som fylls i med den angivna OperationSpec.

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

Parametrar

operationArguments
OperationArguments

Argumenten som HTTP-begärans mallade värden fylls i från.

operationSpec
OperationSpec

Den OperationSpec som ska användas för att fylla i httpRequest.

callback

ServiceCallback<any>

Återanropet för att anropa när svaret tas emot.

Returer

Promise<RestResponse>

ärvd frånFormRecognizerClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Skicka angivet httpRequest.

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

Parametrar

options

RequestPrepareOptions | WebResourceLike

Returer

Promise<HttpOperationResponse>

ärvd frånFormRecognizerClientContext.sendRequest