FormRecognizerClient class

Referência

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)	Extrair pares chave-valor de um determinado documento. O documento de entrada tem de ser de um dos tipos de conteúdo suportados : "application/pdf", "image/jpeg" ou "image/png". Uma resposta de sucesso é devolvida em JSON.
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
batchReadReceipt(string, RequestOptionsBase)	Operação de Recibo de Leitura do Batch. A resposta contém um campo chamado "Operation-Location", que contém o URL que tem de utilizar para a operação "Obter Resultado do Recibo de Leitura".
batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
batchReadReceipt(string, ServiceCallback<void>)
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)	Operação de Recibo de Leitura. Quando utiliza a interface "Recibo de Leitura do Batch", a resposta contém um campo chamado "Operation-Location". O campo "Operation-Location" contém o URL que tem de utilizar para a operação "Obter Resultado do Recibo de Leitura".
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)	Obtenha informações sobre um modelo.
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
getCustomModel(string, ServiceCallback<ModelResult>)
getCustomModels(RequestOptionsBase)	Obter informações sobre todos os modelos personalizados preparados
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
getCustomModels(ServiceCallback<ModelsResult>)
getExtractedKeys(string, RequestOptionsBase)	Obtenha as chaves que foram extraídas durante a preparação do modelo especificado.
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
getExtractedKeys(string, ServiceCallback<KeysResult>)
getReadReceiptResult(string, RequestOptionsBase)	Esta interface é utilizada para obter os resultados da análise de uma operação "Recibo de Leitura do Batch". O URL para esta interface deve ser obtido a partir do campo "Operation-Location" devolvido da operação "Recibo de Leitura do Batch".
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
trainCustomModel(TrainRequest, RequestOptionsBase)	Criar e preparar um modelo personalizado. O pedido de preparação tem de incluir um parâmetro de origem que seja um Uri de contentor de blobs do Armazenamento do Azure acessível externamente (de preferência um Uri de Assinatura de Acesso Partilhado) ou um caminho válido para uma pasta de dados numa unidade montada localmente. Quando os caminhos locais são especificados, têm de seguir o formato de caminho Linux/Unix e ter um caminho absoluto enraizado no valor da definição de configuração da 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 preparados estejam diretamente na pasta de origem. As subpastas não são suportadas. Os modelos são preparados com documentos do seguinte tipo de conteúdo – "application/pdf", "image/jpeg" e "image/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 um pedido HTTP preenchido com 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 finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus2.api.cognitive.microsoft.com).

options: ServiceClientOptions

As opções de parâmetros

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)

Extrair pares chave-valor de um determinado documento. O documento de entrada tem de ser de um dos tipos de conteúdo suportados : "application/pdf", "image/jpeg" ou "image/png". Uma resposta de sucesso é devolvida em JSON.

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

Parâmetros

id: string

Identificador de Modelo com o qual analisar o documento.

formStream: HttpRequestBody

Um ficheiro de documento ou imagem pdf (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 com o qual analisar o documento.

formStream: HttpRequestBody

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

options: FormRecognizerClientAnalyzeWithCustomModelOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<AnalyzeResult>

A chamada de retorno

analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)

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

Parâmetros

id: string

Identificador de Modelo com o qual analisar o documento.

formStream: HttpRequestBody

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

callback: ServiceCallback<AnalyzeResult>

A chamada de retorno

batchReadReceipt(string, RequestOptionsBase)

Operação de Recibo de Leitura do Batch. A resposta contém um campo chamado "Operation-Location", que contém o URL que tem de utilizar para a operação "Obter Resultado do Recibo de Leitura".

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

Parâmetros

url: string

URL acessível publicamente 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 acessível publicamente de uma imagem.

options: RequestOptionsBase

Os parâmetros opcionais

callback: ServiceCallback<void>

A chamada de retorno

batchReadReceipt(string, ServiceCallback<void>)

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

Parâmetros

url: string

URL acessível publicamente de uma imagem.

callback: ServiceCallback<void>

A chamada de retorno

batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)

Operação de Recibo de Leitura. Quando utiliza a interface "Recibo de Leitura do Batch", a resposta contém um campo chamado "Operation-Location". O campo "Operation-Location" contém o URL que tem de 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 imagens.

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 imagens.

options: RequestOptionsBase

Os parâmetros opcionais

callback: ServiceCallback<void>

A chamada de retorno

batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)

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

Parâmetros

image: HttpRequestBody

Um fluxo de imagens.

callback: ServiceCallback<void>

A chamada de retorno

deleteCustomModel(string, RequestOptionsBase)

Eliminar artefactos de modelo.

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

Parâmetros

id: string

O identificador do modelo a eliminar.

options: RequestOptionsBase

Os parâmetros opcionais

Devoluções

Promise<RestResponse>

Promise<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 eliminar.

options: RequestOptionsBase

Os parâmetros opcionais

callback: ServiceCallback<void>

A chamada de retorno

deleteCustomModel(string, ServiceCallback<void>)

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

Parâmetros

id: string

O identificador do modelo a eliminar.

callback: ServiceCallback<void>

A chamada de retorno

getCustomModel(string, RequestOptionsBase)

Obtenha informações sobre um modelo.

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

Parâmetros

id: string

Identificador de 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 de modelo.

options: RequestOptionsBase

Os parâmetros opcionais

callback: ServiceCallback<ModelResult>

A chamada de retorno

getCustomModel(string, ServiceCallback<ModelResult>)

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

Parâmetros

id: string

Identificador de modelo.

callback: ServiceCallback<ModelResult>

A chamada de retorno

getCustomModels(RequestOptionsBase)

Obter informações sobre todos os modelos personalizados preparados

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>

A chamada de retorno

getCustomModels(ServiceCallback<ModelsResult>)

function getCustomModels(callback: ServiceCallback<ModelsResult>)

Parâmetros

callback: ServiceCallback<ModelsResult>

A chamada de retorno

getExtractedKeys(string, RequestOptionsBase)

Obtenha as chaves que foram extraídas durante a preparação do modelo especificado.

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

Parâmetros

id: string

Identificador de 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 de modelo.

options: RequestOptionsBase

Os parâmetros opcionais

callback: ServiceCallback<KeysResult>

A chamada de retorno

getExtractedKeys(string, ServiceCallback<KeysResult>)

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

Parâmetros

id: string

Identificador de modelo.

callback: ServiceCallback<KeysResult>

A chamada de retorno

getReadReceiptResult(string, RequestOptionsBase)

Esta interface é utilizada para obter os resultados da análise de uma operação "Recibo de Leitura do Batch". O URL para esta interface deve ser obtido a partir do campo "Operation-Location" devolvido da operação "Recibo de Leitura do Batch".

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

Parâmetros

operationId: string

ID da operação de leitura devolvido na resposta de uma operação "Recibo de Leitura do Batch".

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 devolvido na resposta de uma operação "Recibo de Leitura do Batch".

options: RequestOptionsBase

Os parâmetros opcionais

callback: ServiceCallback<ReadReceiptResult>

A chamada de retorno

getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)

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

Parâmetros

operationId: string

ID da operação de leitura devolvido na resposta de uma operação "Recibo de Leitura do Batch".

callback: ServiceCallback<ReadReceiptResult>

A chamada de retorno

trainCustomModel(TrainRequest, RequestOptionsBase)

Criar e preparar um modelo personalizado. O pedido de preparação tem de incluir um parâmetro de origem que seja um Uri de contentor de blobs do Armazenamento do Azure acessível externamente (de preferência um Uri de Assinatura de Acesso Partilhado) ou um caminho válido para uma pasta de dados numa unidade montada localmente. Quando os caminhos locais são especificados, têm de seguir o formato de caminho Linux/Unix e ter um caminho absoluto enraizado no valor da definição de configuração da 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 preparados estejam diretamente na pasta de origem. As subpastas não são suportadas. Os modelos são preparados com documentos do seguinte tipo de conteúdo – "application/pdf", "image/jpeg" e "image/png"." Outro tipo de conteúdo é ignorado.

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

Parâmetros

trainRequest: TrainRequest

Peça objeto para preparação.

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

Peça objeto para preparação.

options: RequestOptionsBase

Os parâmetros opcionais

callback: ServiceCallback<TrainResult>

A chamada de retorno

trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)

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

Parâmetros

trainRequest: TrainRequest

Peça objeto para preparação.

callback: ServiceCallback<TrainResult>

A chamada de retorno

Detalhes do Método Herdado

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Envie um pedido HTTP preenchido com 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 do pedido HTTP serão preenchidos.

operationSpec: OperationSpec

O OperationSpec a utilizar para preencher o httpRequest.

callback: ServiceCallback<any>

A chamada de retorno a chamar quando a resposta é recebida.

Devoluções

Promise<RestResponse>

Herdado deFormRecognizerClientContext.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 doFormulárioRecognizerClientContext.sendRequest