FormRecognizerClient class

Pacote:

@azure/cognitiveservices-formrecognizer

Extends

FormRecognizerClientContext

Construtores

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Inicializa uma nova instância da classe FormRecognizerClient.

Propriedades Herdadas

credentials
endpoint

Métodos

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)	Extraia pares chave-valor de um determinado documento. O documento de entrada deve ser de um dos tipos de conteúdo suportados - 'application/pdf', 'image/jpeg' ou 'image/png'. Uma resposta bem-sucedida é retornada em JSON.
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
batchReadReceipt(string, RequestOptionsBase)	Operação de recebimento de leitura em lote. A resposta contém um campo chamado 'Operation-Location', que contém o URL que você deve usar para sua operação 'Get Read Receipt Result'.
batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
batchReadReceipt(string, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)	Operação de leitura de recibo. Quando você usa a interface 'Batch Read Receipt', a resposta contém um campo chamado 'Operation-Location'. O campo 'Localização da operação' contém o URL que deve utilizar para a operação 'Obter resultado do recibo de leitura'.
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)
deleteCustomModel(string, RequestOptionsBase)	Exclua artefatos de modelo.
deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)
deleteCustomModel(string, ServiceCallback<void>)
getCustomModel(string, RequestOptionsBase)	Obtenha informações sobre um modelo.
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
getCustomModel(string, ServiceCallback<ModelResult>)
getCustomModels(RequestOptionsBase)	Obtenha informações sobre todos os modelos personalizados treinados
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
getCustomModels(ServiceCallback<ModelsResult>)
getExtractedKeys(string, RequestOptionsBase)	Recupere as chaves que foram extraídas durante o treinamento do modelo especificado.
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
getExtractedKeys(string, ServiceCallback<KeysResult>)
getReadReceiptResult(string, RequestOptionsBase)	Esta interface é usada para obter os resultados da análise de uma operação 'Batch Read Receipt'. O URL para esta interface deve ser recuperado do campo 'Operation-Location' retornado da operação 'Batch Read Receipt'.
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
trainCustomModel(TrainRequest, RequestOptionsBase)	Crie e treine um modelo personalizado. A solicitação de trem deve incluir um parâmetro de origem que seja um Uri de contêiner de blob do Armazenamento do Azure acessível externamente (de preferência um Uri de Assinatura de Acesso Compartilhado) ou um caminho válido para uma pasta de dados em uma unidade montada localmente. Quando os caminhos locais são especificados, eles devem seguir o formato de caminho Linux/Unix e ser um caminho absoluto enraizado para o valor da configuração de montagem de entrada, por exemplo, se o valor da definição de configuração '{Mounts:Input}' for '/input', então um caminho de origem válido seria '/input/contosodataset'. Espera-se que todos os dados a serem treinados estejam diretamente sob a pasta de origem. Não há suporte para subpastas. Os modelos são treinados usando documentos que são do seguinte tipo de conteúdo - 'aplicativo/pdf', 'imagem/jpeg' e 'imagem/png'." Outro tipo de conteúdo é ignorado.
trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

Métodos Herdados

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Envie uma solicitação HTTP que é preenchida usando o OperationSpec fornecido.
sendRequest(RequestPrepareOptions | WebResourceLike)	Envie o httpRequest fornecido.

Detalhes do Construtor

FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)

Inicializa uma nova instância da classe FormRecognizerClient.

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

Parâmetros

credentials

ServiceClientCredentials

Credenciais de subscrição que identificam exclusivamente a subscrição do cliente.

endpoint

string

Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: https://westus2.api.cognitive.microsoft.com).

options

ServiceClientOptions

As opções de parâmetro

Detalhes da Propriedade Herdada

credentials

credentials: ServiceClientCredentials

Valor de Propriedade

ServiceClientCredentials

herdado deFormRecognizerClientContext.credentials

endpoint

endpoint: string

Valor de Propriedade

string

herdado deFormRecognizerClientContext.endpoint

Detalhes de Método

analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)

Extraia pares chave-valor de um determinado documento. O documento de entrada deve ser de um dos tipos de conteúdo suportados - 'application/pdf', 'image/jpeg' ou 'image/png'. Uma resposta bem-sucedida é retornada em JSON.

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

Parâmetros

id

string

Identificador de modelo para analisar o documento.

formStream

HttpRequestBody

Um documento pdf ou arquivo de imagem (jpg,png) para analisar.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

Os parâmetros opcionais

Devoluções

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 para analisar o documento.

formStream

HttpRequestBody

Um documento pdf ou arquivo de imagem (jpg,png) para analisar.

options

FormRecognizerClientAnalyzeWithCustomModelOptionalParams

Os parâmetros opcionais

callback

ServiceCallback<AnalyzeResult>

O retorno de chamada

analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)

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

Parâmetros

id

string

Identificador de modelo para analisar o documento.

formStream

HttpRequestBody

Um documento pdf ou arquivo de imagem (jpg,png) para analisar.

callback

ServiceCallback<AnalyzeResult>

O retorno de chamada

batchReadReceipt(string, RequestOptionsBase)

Operação de recebimento de leitura em lote. A resposta contém um campo chamado 'Operation-Location', que contém o URL que você deve usar para sua operação 'Get Read Receipt Result'.

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

Parâmetros

url

string

URL publicamente acessível de uma imagem.

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<BatchReadReceiptResponse>

Promise<Models.BatchReadReceiptResponse>

batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)

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

Parâmetros

url

string

URL publicamente acessível de uma imagem.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<void>

O retorno de chamada

batchReadReceipt(string, ServiceCallback<void>)

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

Parâmetros

url

string

URL publicamente acessível de uma imagem.

callback

ServiceCallback<void>

O retorno de chamada

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)

Operação de leitura de recibo. Quando você usa a interface 'Batch Read Receipt', a resposta contém um campo chamado 'Operation-Location'. O campo 'Localização da operação' contém o URL que deve utilizar para a operação 'Obter resultado do recibo de leitura'.

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

Parâmetros

image

HttpRequestBody

Um fluxo de imagem.

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<BatchReadReceiptInStreamResponse>

Promise<Models.BatchReadReceiptInStreamResponse>

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)

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

Parâmetros

image

HttpRequestBody

Um fluxo de imagem.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<void>

O retorno de chamada

batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)

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

Parâmetros

image

HttpRequestBody

Um fluxo de imagem.

callback

ServiceCallback<void>

O retorno de chamada

deleteCustomModel(string, RequestOptionsBase)

Exclua artefatos de modelo.

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

Parâmetros

id

string

O identificador do modelo a ser excluído.

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<RestResponse>

Prometa<> msRest.RestResponse

deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)

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

Parâmetros

id

string

O identificador do modelo a ser excluído.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<void>

O retorno de chamada

deleteCustomModel(string, ServiceCallback<void>)

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

Parâmetros

id

string

O identificador do modelo a ser excluído.

callback

ServiceCallback<void>

O retorno de chamada

getCustomModel(string, RequestOptionsBase)

Obtenha informações sobre um modelo.

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

Parâmetros

id

string

Identificador do modelo.

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<GetCustomModelResponse>

Promise<Models.GetCustomModelResponse>

getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)

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

Parâmetros

id

string

Identificador do modelo.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<ModelResult>

O retorno de chamada

getCustomModel(string, ServiceCallback<ModelResult>)

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

Parâmetros

id

string

Identificador do modelo.

callback

ServiceCallback<ModelResult>

O retorno de chamada

getCustomModels(RequestOptionsBase)

Obtenha informações sobre todos os modelos personalizados treinados

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

Parâmetros

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<GetCustomModelsResponse>

Promise<Models.GetCustomModelsResponse>

getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)

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

Parâmetros

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<ModelsResult>

O retorno de chamada

getCustomModels(ServiceCallback<ModelsResult>)

function getCustomModels(callback: ServiceCallback<ModelsResult>)

Parâmetros

callback

ServiceCallback<ModelsResult>

O retorno de chamada

getExtractedKeys(string, RequestOptionsBase)

Recupere as chaves que foram extraídas durante o treinamento do modelo especificado.

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

Parâmetros

id

string

Identificador do modelo.

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<GetExtractedKeysResponse>

Promise<Models.GetExtractedKeysResponse>

getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)

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

Parâmetros

id

string

Identificador do modelo.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<KeysResult>

O retorno de chamada

getExtractedKeys(string, ServiceCallback<KeysResult>)

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

Parâmetros

id

string

Identificador do modelo.

callback

ServiceCallback<KeysResult>

O retorno de chamada

getReadReceiptResult(string, RequestOptionsBase)

Esta interface é usada para obter os resultados da análise de uma operação 'Batch Read Receipt'. O URL para esta interface deve ser recuperado do campo 'Operation-Location' retornado da operação 'Batch Read Receipt'.

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

Parâmetros

operationId

string

Id da operação de leitura retornada na resposta de uma operação 'Batch Read Receipt'.

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<GetReadReceiptResultResponse>

Promise<Models.GetReadReceiptResultResponse>

getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)

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

Parâmetros

operationId

string

Id da operação de leitura retornada na resposta de uma operação 'Batch Read Receipt'.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<ReadReceiptResult>

O retorno de chamada

getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)

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

Parâmetros

operationId

string

Id da operação de leitura retornada na resposta de uma operação 'Batch Read Receipt'.

callback

ServiceCallback<ReadReceiptResult>

O retorno de chamada

trainCustomModel(TrainRequest, RequestOptionsBase)

Crie e treine um modelo personalizado. A solicitação de trem deve incluir um parâmetro de origem que seja um Uri de contêiner de blob do Armazenamento do Azure acessível externamente (de preferência um Uri de Assinatura de Acesso Compartilhado) ou um caminho válido para uma pasta de dados em uma unidade montada localmente. Quando os caminhos locais são especificados, eles devem seguir o formato de caminho Linux/Unix e ser um caminho absoluto enraizado para o valor da configuração de montagem de entrada, por exemplo, se o valor da definição de configuração '{Mounts:Input}' for '/input', então um caminho de origem válido seria '/input/contosodataset'. Espera-se que todos os dados a serem treinados estejam diretamente sob a pasta de origem. Não há suporte para subpastas. Os modelos são treinados usando documentos que são do seguinte tipo de conteúdo - 'aplicativo/pdf', 'imagem/jpeg' e 'imagem/png'." Outro tipo de conteúdo é ignorado.

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

Parâmetros

trainRequest

TrainRequest

Objeto de solicitação para treinamento.

options

RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<TrainCustomModelResponse>

Promise<Models.TrainCustomModelResponse>

trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)

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

Parâmetros

trainRequest

TrainRequest

Objeto de solicitação para treinamento.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<TrainResult>

O retorno de chamada

trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

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

Parâmetros

trainRequest

TrainRequest

Objeto de solicitação para treinamento.

callback

ServiceCallback<TrainResult>

O retorno de chamada

Detalhes do Método Herdado

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Envie uma solicitação HTTP que é preenchida usando o OperationSpec fornecido.

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

Parâmetros

operationArguments

OperationArguments

Os argumentos a partir dos quais os valores de modelo da solicitação HTTP serão preenchidos.

operationSpec

OperationSpec

O OperationSpec a ser usado para preencher o httpRequest.

callback

ServiceCallback<any>

O retorno de chamada para ligar quando a resposta for recebida.

Devoluções

Promise<RestResponse>

herdado de FormRecognizerClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Envie o httpRequest fornecido.

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

Parâmetros

options

RequestPrepareOptions | WebResourceLike

Devoluções

Promise<HttpOperationResponse>

herdado de FormRecognizerClientContext.sendRequest