FormRecognizerClient class

Initialise une nouvelle instance de la classe FormRecognizerClient.

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

Paramètres

credentials: ServiceClientCredentials

Valeur de propriété

héritée deFormRecognizerClientContext.credentials

endpoint: string

Valeur de propriété

héritée deFormRecognizerClientContext.endpoint

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

Retours

Promise<Models.AnalyzeWithCustomModelResponse>

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

Paramètres

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

Paramètres

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

Retours

Promise<Models.BatchReadReceiptResponse>

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

Paramètres

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

Paramètres

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

Retours

Promise<Models.BatchReadReceiptInStreamResponse>

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

Paramètres

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

Paramètres

Supprimez les artefacts de modèle.

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

Paramètres

Retours

Promesse<msRest.RestResponse>

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

Paramètres

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

Paramètres

Obtenez des informations sur un modèle.

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

Paramètres

Retours

Promise<Models.GetCustomModelResponse>

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

Paramètres

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

Paramètres

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

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

Paramètres

Retours

Promise<Models.GetCustomModelsResponse>

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

Paramètres

function getCustomModels(callback: ServiceCallback<ModelsResult>)

Paramètres

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

Retours

Promise<Models.GetExtractedKeysResponse>

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

Paramètres

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

Paramètres

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

Retours

Promise<Models.GetReadReceiptResultResponse>

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

Paramètres

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

Paramètres

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

Retours

Promise<Models.TrainCustomModelResponse>

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

Paramètres

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

Paramètres

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

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

Paramètres

Retours

héritée deFormRecognizerClientContext.sendOperationRequest

Envoyez le httpRequest fourni.

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

Paramètres

Retours

héritée deFormRecognizerClientContext.sendRequest