FormRecognizerClient class

Paquet:

@azure/cognitiveservices-formrecognizer

Extends

FormRecognizerClientContext

Constructeurs

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Initialise une nouvelle instance de la classe FormRecognizerClient.

Propriétés héritées

credentials
endpoint

Méthodes

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)	Extrayez des paires clé-valeur à partir d’un document donné. Le document d’entrée doit être de l’un des types de contenu pris en charge : « application/pdf », « image/jpeg » ou « image/png ». Une réponse de réussite est retournée dans JSON.
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
batchReadReceipt(string, RequestOptionsBase)	Opération de confirmation de lecture par lot. La réponse contient un champ appelé « Operation-Location », qui contient l’URL que vous devez utiliser pour votre opération « Get Read Receipt Result ».
batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
batchReadReceipt(string, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)	Opération de confirmation de lecture. Lorsque vous utilisez l’interface « Batch Read Receipt », la réponse contient un champ appelé « Operation-Location ». Le champ « Operation-Location » contient l’URL que vous devez utiliser pour votre opération « Obtenir le résultat de la réception de lecture ».
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)
deleteCustomModel(string, RequestOptionsBase)	Supprimez les artefacts de modèle.
deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)
deleteCustomModel(string, ServiceCallback<void>)
getCustomModel(string, RequestOptionsBase)	Obtenez des informations sur un modèle.
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
getCustomModel(string, ServiceCallback<ModelResult>)
getCustomModels(RequestOptionsBase)	Obtenir des informations sur tous les modèles personnalisés entraînés
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
getCustomModels(ServiceCallback<ModelsResult>)
getExtractedKeys(string, RequestOptionsBase)	Récupérez les clés extraites pendant l’entraînement du modèle spécifié.
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
getExtractedKeys(string, ServiceCallback<KeysResult>)
getReadReceiptResult(string, RequestOptionsBase)	Cette interface est utilisée pour obtenir les résultats d’analyse d’une opération « Batch Read Receipt ». L’URL de cette interface doit être récupérée à partir du champ « Operation-Location » retourné à partir de l’opération « Batch Read Receipt ».
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
trainCustomModel(TrainRequest, RequestOptionsBase)	Créez et entraînez un modèle personnalisé. La demande d’apprentissage doit inclure un paramètre source qui est un URI de conteneur d’objets blob Stockage Azure accessible en externe (de préférence un URI de signature d’accès partagé) ou un chemin valide vers un dossier de données dans un lecteur monté localement. Lorsque des chemins locaux sont spécifiés, ils doivent suivre le format de chemin d’accès Linux/Unix et être un chemin absolu rooté à la valeur du paramètre de configuration du montage d’entrée, par exemple, si la valeur du paramètre de configuration « {Mounts :Input} » est « /input », un chemin d’accès source valide est « /input/contosodataset ». Toutes les données à former doivent être directement sous le dossier source. Les sous-dossiers ne sont pas pris en charge. Les modèles sont entraînés à l’aide de documents du type de contenu suivant : « application/pdf », « image/jpeg » et « image/png ». D’autres types de contenu sont ignorés.
trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

Méthodes héritées

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Envoyez une requête HTTP remplie à l’aide de operationSpec fournie.
sendRequest(RequestPrepareOptions | WebResourceLike)	Envoyez le httpRequest fourni.

Détails du constructeur

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Initialise une nouvelle instance de la classe FormRecognizerClient.

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

Paramètres

credentials

ServiceClientCredentials

Informations d’identification d’abonnement qui identifient de manière unique l’abonnement client.

endpoint

string

Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus2.api.cognitive.microsoft.com).

options

ServiceClientOptions

Options de paramètre

Détails de la propriété héritée

credentials

credentials: ServiceClientCredentials

Valeur de propriété

ServiceClientCredentials

héritée deFormRecognizerClientContext.credentials

endpoint

endpoint: string

Valeur de propriété

string

héritée deFormRecognizerClientContext.endpoint

Détails de la méthode

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)

Extrayez des paires clé-valeur à partir d’un document donné. Le document d’entrée doit être de l’un des types de contenu pris en charge : « application/pdf », « image/jpeg » ou « image/png ». Une réponse de réussite est retournée dans JSON.

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

Paramètres

id

string

Identificateur de modèle avec lequel analyser le document.

formStream

HttpRequestBody

Fichier pdf de document ou d’image (jpg,png) à analyser.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

Paramètres facultatifs

Retours

Promise<AnalyzeWithCustomModelResponse>

Promise<Models.AnalyzeWithCustomModelResponse>

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

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

Paramètres

id

string

Identificateur de modèle avec lequel analyser le document.

formStream

HttpRequestBody

Fichier pdf de document ou d’image (jpg,png) à analyser.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

Paramètres facultatifs

callback

ServiceCallback<AnalyzeResult>

Rappel

analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)

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

Paramètres

id

string

Identificateur de modèle avec lequel analyser le document.

formStream

HttpRequestBody

Fichier pdf de document ou d’image (jpg,png) à analyser.

callback

ServiceCallback<AnalyzeResult>

Rappel

batchReadReceipt(string, RequestOptionsBase)

Opération de confirmation de lecture par lot. La réponse contient un champ appelé « Operation-Location », qui contient l’URL que vous devez utiliser pour votre opération « Get Read Receipt Result ».

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

Paramètres

url

string

URL accessible publiquement d’une image.

options

RequestOptionsBase

Paramètres facultatifs

Retours

Promise<BatchReadReceiptResponse>

Promise<Models.BatchReadReceiptResponse>

batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)

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

Paramètres

url

string

URL accessible publiquement d’une image.

options

RequestOptionsBase

Paramètres facultatifs

callback

ServiceCallback<void>

Rappel

batchReadReceipt(string, ServiceCallback<void>)

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

Paramètres

url

string

URL accessible publiquement d’une image.

callback

ServiceCallback<void>

Rappel

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)

Opération de confirmation de lecture. Lorsque vous utilisez l’interface « Batch Read Receipt », la réponse contient un champ appelé « Operation-Location ». Le champ « Operation-Location » contient l’URL que vous devez utiliser pour votre opération « Obtenir le résultat de la réception de lecture ».

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

Paramètres

image

HttpRequestBody

Flux d’images.

options

RequestOptionsBase

Paramètres facultatifs

Retours

Promise<BatchReadReceiptInStreamResponse>

Promise<Models.BatchReadReceiptInStreamResponse>

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)

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

Paramètres

image

HttpRequestBody

Flux d’images.

options

RequestOptionsBase

Paramètres facultatifs

callback

ServiceCallback<void>

Rappel

batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)

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

Paramètres

image

HttpRequestBody

Flux d’images.

callback

ServiceCallback<void>

Rappel

deleteCustomModel(string, RequestOptionsBase)

Supprimez les artefacts de modèle.

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

Paramètres

id

string

Identificateur du modèle à supprimer.

options

RequestOptionsBase

Paramètres facultatifs

Retours

Promise<RestResponse>

Promesse<msRest.RestResponse>

deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)

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

Paramètres

id

string

Identificateur du modèle à supprimer.

options

RequestOptionsBase

Paramètres facultatifs

callback

ServiceCallback<void>

Rappel

deleteCustomModel(string, ServiceCallback<void>)

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

Paramètres

id

string

Identificateur du modèle à supprimer.

callback

ServiceCallback<void>

Rappel

getCustomModel(string, RequestOptionsBase)

Obtenez des informations sur un modèle.

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

Paramètres

id

string

Identificateur de modèle.

options

RequestOptionsBase

Paramètres facultatifs

Retours

Promise<GetCustomModelResponse>

Promise<Models.GetCustomModelResponse>

getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)

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

Paramètres

id

string

Identificateur de modèle.

options

RequestOptionsBase

Paramètres facultatifs

callback

ServiceCallback<ModelResult>

Rappel

getCustomModel(string, ServiceCallback<ModelResult>)

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

Paramètres

id

string

Identificateur de modèle.

callback

ServiceCallback<ModelResult>

Rappel

getCustomModels(RequestOptionsBase)

Obtenir des informations sur tous les modèles personnalisés entraînés

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

Paramètres

options

RequestOptionsBase

Paramètres facultatifs

Retours

Promise<GetCustomModelsResponse>

Promise<Models.GetCustomModelsResponse>

getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)

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

Paramètres

options

RequestOptionsBase

Paramètres facultatifs

callback

ServiceCallback<ModelsResult>

Rappel

getCustomModels(ServiceCallback<ModelsResult>)

function getCustomModels(callback: ServiceCallback<ModelsResult>)

Paramètres

callback

ServiceCallback<ModelsResult>

Rappel

getExtractedKeys(string, RequestOptionsBase)

Récupérez les clés extraites pendant l’entraînement du modèle spécifié.

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

Paramètres

id

string

Identificateur de modèle.

options

RequestOptionsBase

Paramètres facultatifs

Retours

Promise<GetExtractedKeysResponse>

Promise<Models.GetExtractedKeysResponse>

getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)

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

Paramètres

id

string

Identificateur de modèle.

options

RequestOptionsBase

Paramètres facultatifs

callback

ServiceCallback<KeysResult>

Rappel

getExtractedKeys(string, ServiceCallback<KeysResult>)

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

Paramètres

id

string

Identificateur de modèle.

callback

ServiceCallback<KeysResult>

Rappel

getReadReceiptResult(string, RequestOptionsBase)

Cette interface est utilisée pour obtenir les résultats d’analyse d’une opération « Batch Read Receipt ». L’URL de cette interface doit être récupérée à partir du champ « Operation-Location » retourné à partir de l’opération « Batch Read Receipt ».

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

Paramètres

operationId

string

ID de l’opération de lecture retournée dans la réponse d’une opération « Batch Read Receipt ».

options

RequestOptionsBase

Paramètres facultatifs

Retours

Promise<GetReadReceiptResultResponse>

Promise<Models.GetReadReceiptResultResponse>

getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)

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

Paramètres

operationId

string

ID de l’opération de lecture retournée dans la réponse d’une opération « Batch Read Receipt ».

options

RequestOptionsBase

Paramètres facultatifs

callback

ServiceCallback<ReadReceiptResult>

Rappel

getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)

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

Paramètres

operationId

string

ID de l’opération de lecture retournée dans la réponse d’une opération « Batch Read Receipt ».

callback

ServiceCallback<ReadReceiptResult>

Rappel

trainCustomModel(TrainRequest, RequestOptionsBase)

Créez et entraînez un modèle personnalisé. La demande d’apprentissage doit inclure un paramètre source qui est un URI de conteneur d’objets blob Stockage Azure accessible en externe (de préférence un URI de signature d’accès partagé) ou un chemin valide vers un dossier de données dans un lecteur monté localement. Lorsque des chemins locaux sont spécifiés, ils doivent suivre le format de chemin d’accès Linux/Unix et être un chemin absolu rooté à la valeur du paramètre de configuration du montage d’entrée, par exemple, si la valeur du paramètre de configuration « {Mounts :Input} » est « /input », un chemin d’accès source valide est « /input/contosodataset ». Toutes les données à former doivent être directement sous le dossier source. Les sous-dossiers ne sont pas pris en charge. Les modèles sont entraînés à l’aide de documents du type de contenu suivant : « application/pdf », « image/jpeg » et « image/png ». D’autres types de contenu sont ignorés.

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

Paramètres

trainRequest

TrainRequest

Objet de requête pour l’entraînement.

options

RequestOptionsBase

Paramètres facultatifs

Retours

Promise<TrainCustomModelResponse>

Promise<Models.TrainCustomModelResponse>

trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)

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

Paramètres

trainRequest

TrainRequest

Objet de requête pour l’entraînement.

options

RequestOptionsBase

Paramètres facultatifs

callback

ServiceCallback<TrainResult>

Rappel

trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

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

Paramètres

trainRequest

TrainRequest

Objet de requête pour l’entraînement.

callback

ServiceCallback<TrainResult>

Rappel

Détails de la méthode héritée

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Envoyez une requête HTTP remplie à l’aide de operationSpec fournie.

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

Paramètres

operationArguments

OperationArguments

Arguments à partir duquel les valeurs de modèle de la requête HTTP seront remplies.

operationSpec

OperationSpec

OperationSpec à utiliser pour remplir le httpRequest.

callback

ServiceCallback<any>

Rappel à appeler lorsque la réponse est reçue.

Retours

Promise<RestResponse>

héritée deFormRecognizerClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Envoyez le httpRequest fourni.

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

Paramètres

options

RequestPrepareOptions | WebResourceLike

Retours

Promise<HttpOperationResponse>

héritée deFormRecognizerClientContext.sendRequest