FormRecognizerClient class

Paquete:

@azure/cognitiveservices-formrecognizer

Extends

FormRecognizerClientContext

Constructores

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Inicializa una nueva instancia de la clase FormRecognizerClient.

Propiedades heredadas

credentials
endpoint

Métodos

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)	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.
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
batchReadReceipt(string, RequestOptionsBase)	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".
batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
batchReadReceipt(string, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)	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".
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)
deleteCustomModel(string, RequestOptionsBase)	Eliminar artefactos de modelo.
deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)
deleteCustomModel(string, ServiceCallback<void>)
getCustomModel(string, RequestOptionsBase)	Obtenga información sobre un modelo.
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
getCustomModel(string, ServiceCallback<ModelResult>)
getCustomModels(RequestOptionsBase)	Obtener información sobre todos los modelos personalizados entrenados
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
getCustomModels(ServiceCallback<ModelsResult>)
getExtractedKeys(string, RequestOptionsBase)	Recupere las claves que se extrajeron durante el entrenamiento del modelo especificado.
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
getExtractedKeys(string, ServiceCallback<KeysResult>)
getReadReceiptResult(string, RequestOptionsBase)	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".
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
trainCustomModel(TrainRequest, RequestOptionsBase)	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.
trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

Métodos heredados

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Envíe una solicitud HTTP que se rellene mediante operationSpec proporcionada.
sendRequest(RequestPrepareOptions | WebResourceLike)	Envíe el httpRequest proporcionado.

Detalles del constructor

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Inicializa una nueva instancia de la clase FormRecognizerClient.

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

Parámetros

credentials

ServiceClientCredentials

Credenciales de suscripción que identifican de forma única la suscripción de cliente.

endpoint

string

Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus2.api.cognitive.microsoft.com).

options

ServiceClientOptions

Opciones del parámetro

Detalles de las propiedades heredadas

credentials

credentials: ServiceClientCredentials

Valor de propiedad

ServiceClientCredentials

heredado deformRecognizerClientContext.credentials

endpoint

endpoint: string

Valor de propiedad

string

heredado deFormRecognizerClientContext.endpoint

Detalles del método

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)

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

id

string

Identificador de modelo con el que analizar el documento.

formStream

HttpRequestBody

Archivo pdf o imagen (jpg,png) que se va a analizar.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

Los parámetros opcionales

Devoluciones

Promise<AnalyzeWithCustomModelResponse>

Promise<Models.AnalyzeWithCustomModelResponse>

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

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

Parámetros

id

string

Identificador de modelo con el que analizar el documento.

formStream

HttpRequestBody

Archivo pdf o imagen (jpg,png) que se va a analizar.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

Los parámetros opcionales

callback

ServiceCallback<AnalyzeResult>

Devolución de llamada

analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)

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

Parámetros

id

string

Identificador de modelo con el que analizar el documento.

formStream

HttpRequestBody

Archivo pdf o imagen (jpg,png) que se va a analizar.

callback

ServiceCallback<AnalyzeResult>

Devolución de llamada

batchReadReceipt(string, RequestOptionsBase)

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

url

string

Dirección URL accesible públicamente de una imagen.

options

RequestOptionsBase

Los parámetros opcionales

Devoluciones

Promise<BatchReadReceiptResponse>

Promise<Models.BatchReadReceiptResponse>

batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)

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

Parámetros

url

string

Dirección URL accesible públicamente de una imagen.

options

RequestOptionsBase

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada

batchReadReceipt(string, ServiceCallback<void>)

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

Parámetros

url

string

Dirección URL accesible públicamente de una imagen.

callback

ServiceCallback<void>

Devolución de llamada

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)

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

image

HttpRequestBody

Secuencia de imágenes.

options

RequestOptionsBase

Los parámetros opcionales

Devoluciones

Promise<BatchReadReceiptInStreamResponse>

Promise<Models.BatchReadReceiptInStreamResponse>

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)

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

Parámetros

image

HttpRequestBody

Secuencia de imágenes.

options

RequestOptionsBase

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada

batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)

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

Parámetros

image

HttpRequestBody

Secuencia de imágenes.

callback

ServiceCallback<void>

Devolución de llamada

deleteCustomModel(string, RequestOptionsBase)

Eliminar artefactos de modelo.

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

Parámetros

id

string

Identificador del modelo que se va a eliminar.

options

RequestOptionsBase

Los parámetros opcionales

Devoluciones

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)

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

Parámetros

id

string

Identificador del modelo que se va a eliminar.

options

RequestOptionsBase

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada

deleteCustomModel(string, ServiceCallback<void>)

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

Parámetros

id

string

Identificador del modelo que se va a eliminar.

callback

ServiceCallback<void>

Devolución de llamada

getCustomModel(string, RequestOptionsBase)

Obtenga información sobre un modelo.

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

Parámetros

id

string

Identificador del modelo.

options

RequestOptionsBase

Los parámetros opcionales

Devoluciones

Promise<GetCustomModelResponse>

Promise<Models.GetCustomModelResponse>

getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)

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

Parámetros

id

string

Identificador del modelo.

options

RequestOptionsBase

Los parámetros opcionales

callback

ServiceCallback<ModelResult>

Devolución de llamada

getCustomModel(string, ServiceCallback<ModelResult>)

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

Parámetros

id

string

Identificador del modelo.

callback

ServiceCallback<ModelResult>

Devolución de llamada

getCustomModels(RequestOptionsBase)

Obtener información sobre todos los modelos personalizados entrenados

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

Parámetros

options

RequestOptionsBase

Los parámetros opcionales

Devoluciones

Promise<GetCustomModelsResponse>

Promise<Models.GetCustomModelsResponse>

getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)

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

Parámetros

options

RequestOptionsBase

Los parámetros opcionales

callback

ServiceCallback<ModelsResult>

Devolución de llamada

getCustomModels(ServiceCallback<ModelsResult>)

function getCustomModels(callback: ServiceCallback<ModelsResult>)

Parámetros

callback

ServiceCallback<ModelsResult>

Devolución de llamada

getExtractedKeys(string, RequestOptionsBase)

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

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

Parámetros

id

string

Identificador del modelo.

options

RequestOptionsBase

Los parámetros opcionales

Devoluciones

Promise<GetExtractedKeysResponse>

Promise<Models.GetExtractedKeysResponse>

getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)

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

Parámetros

id

string

Identificador del modelo.

options

RequestOptionsBase

Los parámetros opcionales

callback

ServiceCallback<KeysResult>

Devolución de llamada

getExtractedKeys(string, ServiceCallback<KeysResult>)

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

Parámetros

id

string

Identificador del modelo.

callback

ServiceCallback<KeysResult>

Devolución de llamada

getReadReceiptResult(string, RequestOptionsBase)

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

operationId

string

Identificador de la operación de lectura devuelta en la respuesta de una operación "Batch Read Receipt".

options

RequestOptionsBase

Los parámetros opcionales

Devoluciones

Promise<GetReadReceiptResultResponse>

Promise<Models.GetReadReceiptResultResponse>

getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)

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

Parámetros

operationId

string

Identificador de la operación de lectura devuelta en la respuesta de una operación "Batch Read Receipt".

options

RequestOptionsBase

Los parámetros opcionales

callback

ServiceCallback<ReadReceiptResult>

Devolución de llamada

getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)

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

Parámetros

operationId

string

Identificador de la operación de lectura devuelta en la respuesta de una operación "Batch Read Receipt".

callback

ServiceCallback<ReadReceiptResult>

Devolución de llamada

trainCustomModel(TrainRequest, RequestOptionsBase)

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

trainRequest

TrainRequest

Solicitar objeto para el entrenamiento.

options

RequestOptionsBase

Los parámetros opcionales

Devoluciones

Promise<TrainCustomModelResponse>

Promise<Models.TrainCustomModelResponse>

trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)

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

Parámetros

trainRequest

TrainRequest

Solicitar objeto para el entrenamiento.

options

RequestOptionsBase

Los parámetros opcionales

callback

ServiceCallback<TrainResult>

Devolución de llamada

trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

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

Parámetros

trainRequest

TrainRequest

Solicitar objeto para el entrenamiento.

callback

ServiceCallback<TrainResult>

Devolución de llamada

Detalles de los métodos heredados

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

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

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

Parámetros

operationArguments

OperationArguments

Argumentos desde los que se rellenarán los valores con plantilla de la solicitud HTTP.

operationSpec

OperationSpec

OperationSpec que se va a usar para rellenar httpRequest.

callback

ServiceCallback<any>

Devolución de llamada que se va a llamar cuando se recibe la respuesta.

Devoluciones

Promise<RestResponse>

Heredado deFormRecognizerClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Envíe el httpRequest proporcionado.

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

Parámetros

options

RequestPrepareOptions | WebResourceLike

Devoluciones

Promise<HttpOperationResponse>

heredado deFormRecognizerClientContext.sendRequest