FormRecognizerClient class

Inicializa una nueva instancia de la clase FormRecognizerClient.

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

Parámetros

credentials: ServiceClientCredentials

Valor de propiedad

heredado deformRecognizerClientContext.credentials

endpoint: string

Valor de propiedad

heredado deFormRecognizerClientContext.endpoint

Extraiga pares clave-valor de un documento determinado. El documento de entrada debe ser de uno de los tipos de contenido admitidos: "application/pdf", "image/jpeg" o "image/png". Se devuelve una respuesta correcta en JSON.

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

Parámetros

Devoluciones

Promise<Models.AnalyzeWithCustomModelResponse>

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

Parámetros

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

Parámetros

Operación de recepción de lectura por lotes. La respuesta contiene un campo denominado "Operation-Location", que contiene la dirección URL que debe usar para la operación "Obtener resultado de recibo de lectura".

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

Parámetros

Devoluciones

Promise<Models.BatchReadReceiptResponse>

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

Parámetros

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

Parámetros

Operación de recepción de lectura. Cuando se usa la interfaz "Recepción de lectura por lotes", la respuesta contiene un campo denominado "Operation-Location". El campo "Operation-Location" contiene la dirección URL que debe usar para la operación "Obtener resultado de recibo de lectura".

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

Parámetros

Devoluciones

Promise<Models.BatchReadReceiptInStreamResponse>

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

Parámetros

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

Parámetros

Eliminar artefactos de modelo.

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

Parámetros

Devoluciones

Promise<msRest.RestResponse>

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

Parámetros

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

Parámetros

Obtenga información sobre un modelo.

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

Parámetros

Devoluciones

Promise<Models.GetCustomModelResponse>

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

Parámetros

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

Parámetros

Obtener información sobre todos los modelos personalizados entrenados

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

Parámetros

Devoluciones

Promise<Models.GetCustomModelsResponse>

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

Parámetros

function getCustomModels(callback: ServiceCallback<ModelsResult>)

Parámetros

Recupere las claves que se extrajeron durante el entrenamiento del modelo especificado.

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

Parámetros

Devoluciones

Promise<Models.GetExtractedKeysResponse>

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

Parámetros

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

Parámetros

Esta interfaz se usa para obtener los resultados de análisis de una operación "Batch Read Receipt". La dirección URL a esta interfaz debe recuperarse del campo "Operation-Location" devuelto desde la operación "Batch Read Receipt".

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

Parámetros

Devoluciones

Promise<Models.GetReadReceiptResultResponse>

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

Parámetros

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

Parámetros

Cree y entrene un modelo personalizado. La solicitud de entrenamiento debe incluir un parámetro de origen que sea un URI de contenedor de blobs de Azure Storage accesible externamente (preferiblemente un URI de firma de acceso compartido) o una ruta de acceso válida a una carpeta de datos en una unidad montada localmente. Cuando se especifican rutas de acceso locales, deben seguir el formato de ruta de acceso de Linux/Unix y ser una ruta de acceso absoluta raíz al valor de configuración de montaje de entrada, por ejemplo, si el valor de configuración '{Mounts:Input}' es '/input', una ruta de acceso de origen válida sería '/input/contosodataset'. Se espera que todos los datos que se van a entrenar estén directamente en la carpeta de origen. No se admiten subcarpetas. Los modelos se entrenan mediante documentos que son del siguiente tipo de contenido: "application/pdf", "image/jpeg" y "image/png". Se omite otro tipo de contenido.

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

Parámetros

Devoluciones

Promise<Models.TrainCustomModelResponse>

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

Parámetros

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

Parámetros

Envíe una solicitud HTTP que se rellene mediante operationSpec proporcionada.

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

Parámetros

Devoluciones

Heredado deFormRecognizerClientContext.sendOperationRequest

Envíe el httpRequest proporcionado.

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

Parámetros

Devoluciones

heredado deFormRecognizerClientContext.sendRequest