FormRecognizerClient class

Paket:

@azure/cognitiveservices-formrecognizer

Extends

FormRecognizerClientContext

Konstruktoren

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Initialisiert eine neue Instanz der FormRecognizerClient-Klasse.

Geerbte Eigenschaften

credentials
endpoint

Methoden

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)	Extrahieren sie Schlüsselwertpaare aus einem bestimmten Dokument. Das Eingabedokument muss eines der unterstützten Inhaltstypen sein : "application/pdf", "image/jpeg" oder "image/png". Eine Erfolgsantwort wird in JSON zurückgegeben.
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
batchReadReceipt(string, RequestOptionsBase)	Batchlesebestätigungsvorgang. Die Antwort enthält ein Feld namens "Operation-Location", das die URL enthält, die Sie für den Vorgang "Lesebestätigungsergebnis abrufen" verwenden müssen.
batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
batchReadReceipt(string, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)	Lesebestätigungsvorgang. Wenn Sie die Schnittstelle "Batchlesebestätigung" verwenden, enthält die Antwort ein Feld namens "Operation-Location". Das Feld "Vorgangsspeicherort" enthält die URL, die Sie für den Vorgang "Lesebestätigungsergebnis abrufen" verwenden müssen.
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)
deleteCustomModel(string, RequestOptionsBase)	Löschen sie Modellartefakte.
deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)
deleteCustomModel(string, ServiceCallback<void>)
getCustomModel(string, RequestOptionsBase)	Abrufen von Informationen zu einem Modell.
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
getCustomModel(string, ServiceCallback<ModelResult>)
getCustomModels(RequestOptionsBase)	Abrufen von Informationen zu allen trainierten benutzerdefinierten Modellen
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
getCustomModels(ServiceCallback<ModelsResult>)
getExtractedKeys(string, RequestOptionsBase)	Rufen Sie die Schlüssel ab, die während der Schulung des angegebenen Modells extrahiert wurden.
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
getExtractedKeys(string, ServiceCallback<KeysResult>)
getReadReceiptResult(string, RequestOptionsBase)	Diese Schnittstelle wird verwendet, um die Analyseergebnisse eines Vorgangs "Batchlesebestätigung" zu erhalten. Die URL zu dieser Schnittstelle sollte aus dem Feld "Operation-Location" abgerufen werden, das vom Vorgang "Batchlesebestätigung" zurückgegeben wird.
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
trainCustomModel(TrainRequest, RequestOptionsBase)	Erstellen und Trainieren eines benutzerdefinierten Modells. Die Train-Anforderung muss einen Quellparameter enthalten, der entweder ein extern zugänglicher Azure Storage-BLOB-Container-URI (vorzugsweise ein URI für freigegebenen Zugriff) oder ein gültiger Pfad zu einem Datenordner in einem lokal bereitgestellten Laufwerk ist. Wenn lokale Pfade angegeben werden, müssen sie dem Linux/Unix-Pfadformat folgen und ein absoluter Pfad sein, der mit dem Einstellungswert der Eingabebereitstellungseinstellung verknüpft ist, z. B. wenn "{Mounts:Input}" konfigurationseinstellungswert "/input" lautet, dann würde ein gültiger Quellpfad "/input/contosodataset" lauten. Es wird erwartet, dass alle zu trainierenden Daten direkt unter dem Quellordner stehen. Unterordner werden nicht unterstützt. Modelle werden mit Dokumenten trainiert, die den folgenden Inhaltstyp aufweisen : 'application/pdf', 'image/jpeg' und 'image/png'." Andere Inhaltstypen werden ignoriert.
trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

Geerbte Methoden

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Senden Sie eine HTTP-Anforderung, die mit der bereitgestellten OperationSpec aufgefüllt wird.
sendRequest(RequestPrepareOptions | WebResourceLike)	Senden Sie die bereitgestellte httpRequest.

Details zum Konstruktor

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Initialisiert eine neue Instanz der FormRecognizerClient-Klasse.

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

Parameter

credentials

ServiceClientCredentials

Abonnementanmeldeinformationen, die das Clientabonnement eindeutig identifizieren.

endpoint

string

Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://westus2.api.cognitive.microsoft.com).

options

ServiceClientOptions

Die Parameteroptionen

Geerbte Eigenschaftsdetails

credentials

credentials: ServiceClientCredentials

Eigenschaftswert

ServiceClientCredentials

Geerbt vonFormRecognizerClientContext.credentials

endpoint

endpoint: string

Eigenschaftswert

string

geerbt vonFormRecognizerClientContext.endpoint

Details zur Methode

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)

Extrahieren sie Schlüsselwertpaare aus einem bestimmten Dokument. Das Eingabedokument muss eines der unterstützten Inhaltstypen sein : "application/pdf", "image/jpeg" oder "image/png". Eine Erfolgsantwort wird in JSON zurückgegeben.

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

Parameter

id

string

Modellbezeichner zum Analysieren des Dokuments mit.

formStream

HttpRequestBody

Eine pdf-Dokument- oder Bilddatei (jpg,png), die analysiert werden soll.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

Die optionalen Parameter

Gibt zurück

Promise<AnalyzeWithCustomModelResponse>

Promise<Models.AnalyzeWithCustomModelResponse>

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

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

Parameter

id

string

Modellbezeichner zum Analysieren des Dokuments mit.

formStream

HttpRequestBody

Eine pdf-Dokument- oder Bilddatei (jpg,png), die analysiert werden soll.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

Die optionalen Parameter

callback

ServiceCallback<AnalyzeResult>

Der Rückruf

analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)

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

Parameter

id

string

Modellbezeichner zum Analysieren des Dokuments mit.

formStream

HttpRequestBody

Eine pdf-Dokument- oder Bilddatei (jpg,png), die analysiert werden soll.

callback

ServiceCallback<AnalyzeResult>

Der Rückruf

batchReadReceipt(string, RequestOptionsBase)

Batchlesebestätigungsvorgang. Die Antwort enthält ein Feld namens "Operation-Location", das die URL enthält, die Sie für den Vorgang "Lesebestätigungsergebnis abrufen" verwenden müssen.

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

Parameter

url

string

Öffentlich erreichbare URL eines Bilds.

options

RequestOptionsBase

Die optionalen Parameter

Gibt zurück

Promise<BatchReadReceiptResponse>

Promise<Models.BatchReadReceiptResponse>

batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)

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

Parameter

url

string

Öffentlich erreichbare URL eines Bilds.

options

RequestOptionsBase

Die optionalen Parameter

callback

ServiceCallback<void>

Der Rückruf

batchReadReceipt(string, ServiceCallback<void>)

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

Parameter

url

string

Öffentlich erreichbare URL eines Bilds.

callback

ServiceCallback<void>

Der Rückruf

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)

Lesebestätigungsvorgang. Wenn Sie die Schnittstelle "Batchlesebestätigung" verwenden, enthält die Antwort ein Feld namens "Operation-Location". Das Feld "Vorgangsspeicherort" enthält die URL, die Sie für den Vorgang "Lesebestätigungsergebnis abrufen" verwenden müssen.

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

Parameter

image

HttpRequestBody

Ein Bildstream.

options

RequestOptionsBase

Die optionalen Parameter

Gibt zurück

Promise<BatchReadReceiptInStreamResponse>

Promise<Models.BatchReadReceiptInStreamResponse>

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)

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

Parameter

image

HttpRequestBody

Ein Bildstream.

options

RequestOptionsBase

Die optionalen Parameter

callback

ServiceCallback<void>

Der Rückruf

batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)

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

Parameter

image

HttpRequestBody

Ein Bildstream.

callback

ServiceCallback<void>

Der Rückruf

deleteCustomModel(string, RequestOptionsBase)

Löschen sie Modellartefakte.

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

Parameter

id

string

Der Bezeichner des zu löschenden Modells.

options

RequestOptionsBase

Die optionalen Parameter

Gibt zurück

Promise<RestResponse>

Zusage<msRest.RestResponse>

deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)

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

Parameter

id

string

Der Bezeichner des zu löschenden Modells.

options

RequestOptionsBase

Die optionalen Parameter

callback

ServiceCallback<void>

Der Rückruf

deleteCustomModel(string, ServiceCallback<void>)

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

Parameter

id

string

Der Bezeichner des zu löschenden Modells.

callback

ServiceCallback<void>

Der Rückruf

getCustomModel(string, RequestOptionsBase)

Abrufen von Informationen zu einem Modell.

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

Parameter

id

string

Modellbezeichner.

options

RequestOptionsBase

Die optionalen Parameter

Gibt zurück

Promise<GetCustomModelResponse>

Promise<Models.GetCustomModelResponse>

getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)

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

Parameter

id

string

Modellbezeichner.

options

RequestOptionsBase

Die optionalen Parameter

callback

ServiceCallback<ModelResult>

Der Rückruf

getCustomModel(string, ServiceCallback<ModelResult>)

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

Parameter

id

string

Modellbezeichner.

callback

ServiceCallback<ModelResult>

Der Rückruf

getCustomModels(RequestOptionsBase)

Abrufen von Informationen zu allen trainierten benutzerdefinierten Modellen

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

Parameter

options

RequestOptionsBase

Die optionalen Parameter

Gibt zurück

Promise<GetCustomModelsResponse>

Promise<Models.GetCustomModelsResponse>

getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)

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

Parameter

options

RequestOptionsBase

Die optionalen Parameter

callback

ServiceCallback<ModelsResult>

Der Rückruf

getCustomModels(ServiceCallback<ModelsResult>)

function getCustomModels(callback: ServiceCallback<ModelsResult>)

Parameter

callback

ServiceCallback<ModelsResult>

Der Rückruf

getExtractedKeys(string, RequestOptionsBase)

Rufen Sie die Schlüssel ab, die während der Schulung des angegebenen Modells extrahiert wurden.

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

Parameter

id

string

Modellbezeichner.

options

RequestOptionsBase

Die optionalen Parameter

Gibt zurück

Promise<GetExtractedKeysResponse>

Promise<Models.GetExtractedKeysResponse>

getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)

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

Parameter

id

string

Modellbezeichner.

options

RequestOptionsBase

Die optionalen Parameter

callback

ServiceCallback<KeysResult>

Der Rückruf

getExtractedKeys(string, ServiceCallback<KeysResult>)

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

Parameter

id

string

Modellbezeichner.

callback

ServiceCallback<KeysResult>

Der Rückruf

getReadReceiptResult(string, RequestOptionsBase)

Diese Schnittstelle wird verwendet, um die Analyseergebnisse eines Vorgangs "Batchlesebestätigung" zu erhalten. Die URL zu dieser Schnittstelle sollte aus dem Feld "Operation-Location" abgerufen werden, das vom Vorgang "Batchlesebestätigung" zurückgegeben wird.

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

Parameter

operationId

string

Die ID des Lesevorgangs, der in der Antwort eines Vorgangs "Batchlesebestätigung" zurückgegeben wird.

options

RequestOptionsBase

Die optionalen Parameter

Gibt zurück

Promise<GetReadReceiptResultResponse>

Promise<Models.GetReadReceiptResultResponse>

getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)

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

Parameter

operationId

string

Die ID des Lesevorgangs, der in der Antwort eines Vorgangs "Batchlesebestätigung" zurückgegeben wird.

options

RequestOptionsBase

Die optionalen Parameter

callback

ServiceCallback<ReadReceiptResult>

Der Rückruf

getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)

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

Parameter

operationId

string

Die ID des Lesevorgangs, der in der Antwort eines Vorgangs "Batchlesebestätigung" zurückgegeben wird.

callback

ServiceCallback<ReadReceiptResult>

Der Rückruf

trainCustomModel(TrainRequest, RequestOptionsBase)

Erstellen und Trainieren eines benutzerdefinierten Modells. Die Train-Anforderung muss einen Quellparameter enthalten, der entweder ein extern zugänglicher Azure Storage-BLOB-Container-URI (vorzugsweise ein URI für freigegebenen Zugriff) oder ein gültiger Pfad zu einem Datenordner in einem lokal bereitgestellten Laufwerk ist. Wenn lokale Pfade angegeben werden, müssen sie dem Linux/Unix-Pfadformat folgen und ein absoluter Pfad sein, der mit dem Einstellungswert der Eingabebereitstellungseinstellung verknüpft ist, z. B. wenn "{Mounts:Input}" konfigurationseinstellungswert "/input" lautet, dann würde ein gültiger Quellpfad "/input/contosodataset" lauten. Es wird erwartet, dass alle zu trainierenden Daten direkt unter dem Quellordner stehen. Unterordner werden nicht unterstützt. Modelle werden mit Dokumenten trainiert, die den folgenden Inhaltstyp aufweisen : 'application/pdf', 'image/jpeg' und 'image/png'." Andere Inhaltstypen werden ignoriert.

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

Parameter

trainRequest

TrainRequest

Anforderungsobjekt für Schulungen.

options

RequestOptionsBase

Die optionalen Parameter

Gibt zurück

Promise<TrainCustomModelResponse>

Promise<Models.TrainCustomModelResponse>

trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)

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

Parameter

trainRequest

TrainRequest

Anforderungsobjekt für Schulungen.

options

RequestOptionsBase

Die optionalen Parameter

callback

ServiceCallback<TrainResult>

Der Rückruf

trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

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

Parameter

trainRequest

TrainRequest

Anforderungsobjekt für Schulungen.

callback

ServiceCallback<TrainResult>

Der Rückruf

Details zur geerbten Methode

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Senden Sie eine HTTP-Anforderung, die mit der bereitgestellten OperationSpec aufgefüllt wird.

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

Parameter

operationArguments

OperationArguments

Die Argumente, aus denen die vorlagenbasierten Werte der HTTP-Anforderung ausgefüllt werden.

operationSpec

OperationSpec

Die OperationSpec, die zum Auffüllen der httpRequest verwendet werden soll.

callback

ServiceCallback<any>

Der Rückruf, der aufgerufen werden soll, wenn die Antwort empfangen wird.

Gibt zurück

Promise<RestResponse>

geerbt vonFormRecognizerClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Senden Sie die bereitgestellte httpRequest.

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

Parameter

options

RequestPrepareOptions | WebResourceLike

Gibt zurück

Promise<HttpOperationResponse>

geerbt vonFormRecognizerClientContext.sendRequest