FormRecognizerClient class
- Extends
Konstruktoren
| Form |
Initialisiert eine neue instance der FormRecognizerClient-Klasse. |
Geerbte Eigenschaften
| credentials | |
| endpoint |
Methoden
| analyze |
Extrahiert Schlüssel-Wert-Paare aus einem bestimmten Dokument. Das Eingabedokument muss einen der unterstützten Inhaltstypen aufweisen: „application/pdf“, „image/jpeg“ oder „image/png“. Eine erfolgreiche Antwort wird im JSON-Format zurückgegeben. |
| analyze |
|
| analyze |
|
| batch |
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. |
| batch |
|
| batch |
|
| batch |
Lesebestätigungsvorgang. Wenn Sie die Schnittstelle "Batch-Lesebestätigung" verwenden, enthält die Antwort ein Feld mit dem Namen "Operation-Location". Das Feld "Operation-Location" enthält die URL, die Sie für den Vorgang "Lesebestätigungsergebnis abrufen" verwenden müssen. |
| batch |
|
| batch |
|
| delete |
Löscht Modellartefakte. |
| delete |
|
| delete |
|
| get |
Ruft Informationen zu einem Modell ab. |
| get |
|
| get |
|
| get |
Abrufen von Informationen zu allen trainierten benutzerdefinierten Modellen |
| get |
|
| get |
|
| get |
Rufen Sie die Schlüssel ab, die während des Trainings des angegebenen Modells extrahiert wurden. |
| get |
|
| get |
|
| get |
Diese Schnittstelle wird verwendet, um die Analyseergebnisse eines Vorgangs "Batch-Lesebestätigung" zu erhalten. Die URL zu dieser Schnittstelle sollte aus dem Feld "Operation-Location" abgerufen werden, das vom Vorgang "Batch-Lesebestätigung" zurückgegeben wird. |
| get |
|
| get |
|
| train |
Erstellt und trainiert ein benutzerdefiniertes Modell. Die Trainingsanforderung muss einen Quellparameter enthalten, bei dem es sich entweder um einen extern zugänglichen Azure Storage-Blobcontainer-URI (vorzugsweise ein Shared Access Signature-URI) oder einen gültigen Pfad zu einem Datenordner auf einem lokal bereitgestellten Laufwerk handelt. Wenn lokale Pfade angegeben werden, müssen diese das Pfadformat von Linux/Unix befolgen und absolute Pfade sein, die mit dem eingegebenen Wert für die Einbindungskonfigurationseinstellung verknüpft sind. Wenn der Wert der Konfigurationseinstellung von „{Mounts:Input}“ beispielsweise „/input“ ist, wäre „/input/contosodataset“ ein gültiger Quellpfad. Es wird erwartet, dass sich alle zu trainierenden Daten direkt im Quellordner befinden. Unterordner werden nicht unterstützt. Modelle werden mit Dokumenten des folgenden Inhaltstyps trainiert: 'application/pdf', 'image/jpeg' und 'image/png'." Andere Inhaltstypen werden ignoriert. |
| train |
|
| train |
Geerbte Methoden
| send |
Senden Sie eine HTTP-Anforderung, die mit der angegebenen OperationSpec aufgefüllt wird. |
| send |
Senden Sie die bereitgestellte httpRequest. |
Details zum Konstruktor
FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)
Initialisiert eine neue instance 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: ServiceClientCredentialsEigenschaftswert
Geerbt vonFormRecognizerClientContext.credentials
endpoint
Details zur Methode
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)
Extrahiert Schlüssel-Wert-Paare aus einem bestimmten Dokument. Das Eingabedokument muss einen der unterstützten Inhaltstypen aufweisen: „application/pdf“, „image/jpeg“ oder „image/png“. Eine erfolgreiche Antwort wird im JSON-Format zurückgegeben.
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options?: FormRecognizerClientAnalyzeWithCustomModelOptionalParams): Promise<AnalyzeWithCustomModelResponse>Parameter
- id
-
string
Modellbezeichner, mit dem das Dokument analysiert werden soll.
- formStream
- HttpRequestBody
Eine zu analysierende PDF-Dokument- oder Bilddatei (jpg,png).
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, mit dem das Dokument analysiert werden soll.
- formStream
- HttpRequestBody
Eine zu analysierende PDF-Dokument- oder Bilddatei (jpg,png).
Die optionalen Parameter
- callback
Der Rückruf.
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, callback: ServiceCallback<AnalyzeResult>)Parameter
- id
-
string
Modellbezeichner, mit dem das Dokument analysiert werden soll.
- formStream
- HttpRequestBody
Eine zu analysierende PDF-Dokument- oder Bilddatei (jpg,png).
- callback
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 "Batch-Lesebestätigung" verwenden, enthält die Antwort ein Feld mit dem Namen "Operation-Location". Das Feld "Operation-Location" 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öscht 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)
Ruft Informationen zu einem Modell ab.
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
Der Rückruf.
getCustomModel(string, ServiceCallback<ModelResult>)
function getCustomModel(id: string, callback: ServiceCallback<ModelResult>)Parameter
- id
-
string
Modellbezeichner.
- callback
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
Der Rückruf.
getCustomModels(ServiceCallback<ModelsResult>)
function getCustomModels(callback: ServiceCallback<ModelsResult>)Parameter
- callback
Der Rückruf.
getExtractedKeys(string, RequestOptionsBase)
Rufen Sie die Schlüssel ab, die während des Trainings 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
Der Rückruf.
getExtractedKeys(string, ServiceCallback<KeysResult>)
function getExtractedKeys(id: string, callback: ServiceCallback<KeysResult>)Parameter
- id
-
string
Modellbezeichner.
- callback
Der Rückruf.
getReadReceiptResult(string, RequestOptionsBase)
Diese Schnittstelle wird verwendet, um die Analyseergebnisse eines Vorgangs "Batch-Lesebestätigung" zu erhalten. Die URL zu dieser Schnittstelle sollte aus dem Feld "Operation-Location" abgerufen werden, das vom Vorgang "Batch-Lesebestätigung" zurückgegeben wird.
function getReadReceiptResult(operationId: string, options?: RequestOptionsBase): Promise<GetReadReceiptResultResponse>Parameter
- operationId
-
string
ID des Lesevorgangs, der in der Antwort eines Vorgangs "Batch-Lesebestätigung" zurückgegeben wurde.
- 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
ID des Lesevorgangs, der in der Antwort eines Vorgangs "Batch-Lesebestätigung" zurückgegeben wurde.
- options
- RequestOptionsBase
Die optionalen Parameter
- callback
Der Rückruf.
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
function getReadReceiptResult(operationId: string, callback: ServiceCallback<ReadReceiptResult>)Parameter
- operationId
-
string
ID des Lesevorgangs, der in der Antwort eines Vorgangs "Batch-Lesebestätigung" zurückgegeben wurde.
- callback
Der Rückruf.
trainCustomModel(TrainRequest, RequestOptionsBase)
Erstellt und trainiert ein benutzerdefiniertes Modell. Die Trainingsanforderung muss einen Quellparameter enthalten, bei dem es sich entweder um einen extern zugänglichen Azure Storage-Blobcontainer-URI (vorzugsweise ein Shared Access Signature-URI) oder einen gültigen Pfad zu einem Datenordner auf einem lokal bereitgestellten Laufwerk handelt. Wenn lokale Pfade angegeben werden, müssen diese das Pfadformat von Linux/Unix befolgen und absolute Pfade sein, die mit dem eingegebenen Wert für die Einbindungskonfigurationseinstellung verknüpft sind. Wenn der Wert der Konfigurationseinstellung von „{Mounts:Input}“ beispielsweise „/input“ ist, wäre „/input/contosodataset“ ein gültiger Quellpfad. Es wird erwartet, dass sich alle zu trainierenden Daten direkt im Quellordner befinden. Unterordner werden nicht unterstützt. Modelle werden mit Dokumenten des folgenden Inhaltstyps trainiert: '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 das Training.
- 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 das Training.
- options
- RequestOptionsBase
Die optionalen Parameter
- callback
Der Rückruf.
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)
function trainCustomModel(trainRequest: TrainRequest, callback: ServiceCallback<TrainResult>)Parameter
- trainRequest
- TrainRequest
Anforderungsobjekt für das Training.
- callback
Der Rückruf.
Details zur geerbten Methode
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
Senden Sie eine HTTP-Anforderung, die mit der angegebenen OperationSpec aufgefüllt wird.
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>Parameter
- operationArguments
- OperationArguments
Die Argumente, aus denen die Vorlagenwerte der HTTP-Anforderung aufgefüllt werden.
- operationSpec
- OperationSpec
Die OperationSpec, die zum Auffüllen von httpRequest verwendet werden soll.
- callback
-
ServiceCallback<any>
Der Rückruf, der aufgerufen werden soll, wenn die Antwort empfangen wird.
Gibt zurück
Promise<RestResponse>
sendRequest(RequestPrepareOptions | WebResourceLike)
Senden Sie die bereitgestellte httpRequest.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>Parameter
- options
Gibt zurück
Promise<HttpOperationResponse>
Geerbt vonFormRecognizerClientContext.sendRequest
Azure SDK for JavaScript
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für