FormRecognizerClient class
- Extends
Construtores
Form |
Inicializa uma nova instância da classe FormRecognizerClient. |
Propriedades herdadas
credentials | |
endpoint |
Métodos
analyze |
Extraia pares chave-valor de um determinado documento. O documento de entrada deve ser de um dos tipos de conteúdo com suporte – 'application/pdf', 'image/jpeg' ou 'image/png'. Uma resposta de êxito é retornada no JSON. |
analyze |
|
analyze |
|
batch |
Operação confirmação de leitura em lote. A resposta contém um campo chamado 'Operation-Location', que contém a URL que você deve usar para sua operação "Obter Resultado do Recebimento de Leitura". |
batch |
|
batch |
|
batch |
Operação de confirmação de leitura. Quando você usa a interface 'Recebimento de Leitura em Lote', a resposta contém um campo chamado 'Operation-Location'. O campo 'Operation-Location' contém a URL que você deve usar para sua operação "Obter Resultado do Recebimento de Leitura". |
batch |
|
batch |
|
delete |
Excluir artefatos de modelo. |
delete |
|
delete |
|
get |
Obtenha informações sobre um modelo. |
get |
|
get |
|
get |
Obter informações sobre todos os modelos personalizados treinados |
get |
|
get |
|
get |
Recupere as chaves que foram extraídas durante o treinamento do modelo especificado. |
get |
|
get |
|
get |
Essa interface é usada para obter os resultados de análise de uma operação "Recebimento de Leitura em Lote". A URL para essa interface deve ser recuperada do campo 'Operation-Location' retornado da operação 'Recebimento de Leitura em Lote'. |
get |
|
get |
|
train |
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 com raiz para o valor de configuração de montagem de entrada, por exemplo, se o valor da configuração '{Mounts:Input}' for '/input', um caminho de origem válido será '/input/contosodataset'. Espera-se que todos os dados a serem treinados estejam diretamente na pasta de origem. Não há suporte para subpastas. Os modelos são treinados usando documentos do seguinte tipo de conteúdo : 'application/pdf', 'image/jpeg' e 'image/png'." Outro tipo de conteúdo é ignorado. |
train |
|
train |
Métodos herdados
send |
Envie uma solicitação HTTP preenchida usando o OperationSpec fornecido. |
send |
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 assinatura que identificam exclusivamente a assinatura do cliente.
- endpoint
-
string
Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus2.api.cognitive.microsoft.com).
- options
- ServiceClientOptions
As opções de parâmetro
Detalhes das propriedades herdadas
credentials
credentials: ServiceClientCredentials
Valor da propriedade
herdado deFormRecognizerClientContext.credentials
endpoint
Detalhes do 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 com suporte – 'application/pdf', 'image/jpeg' ou 'image/png'. Uma resposta de êxito é retornada no 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 arquivo de documento ou imagem em pdf (jpg,png) a ser analisado.
Os parâmetros opcionais
Retornos
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 arquivo de documento ou imagem em pdf (jpg,png) a ser analisado.
Os parâmetros opcionais
- callback
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 com o qual analisar o documento.
- formStream
- HttpRequestBody
Um arquivo de documento ou imagem em pdf (jpg,png) a ser analisado.
- callback
O retorno de chamada
batchReadReceipt(string, RequestOptionsBase)
Operação confirmação de leitura em lote. A resposta contém um campo chamado 'Operation-Location', que contém a URL que você deve usar para sua operação "Obter Resultado do Recebimento 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
Retornos
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>
O retorno de chamada
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>
O retorno de chamada
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)
Operação de confirmação de leitura. Quando você usa a interface 'Recebimento de Leitura em Lote', a resposta contém um campo chamado 'Operation-Location'. O campo 'Operation-Location' contém a URL que você deve usar para sua operação "Obter Resultado do Recebimento de Leitura".
function batchReadReceiptInStream(image: HttpRequestBody, options?: RequestOptionsBase): Promise<BatchReadReceiptInStreamResponse>
Parâmetros
- image
- HttpRequestBody
Um fluxo de imagem.
- options
- RequestOptionsBase
Os parâmetros opcionais
Retornos
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)
Excluir 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
Retornos
Promise<RestResponse>
Promessa<> 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 de modelo.
- options
- RequestOptionsBase
Os parâmetros opcionais
Retornos
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
O retorno de chamada
getCustomModel(string, ServiceCallback<ModelResult>)
function getCustomModel(id: string, callback: ServiceCallback<ModelResult>)
Parâmetros
- id
-
string
Identificador de modelo.
- callback
O retorno de chamada
getCustomModels(RequestOptionsBase)
Obter informações sobre todos os modelos personalizados treinados
function getCustomModels(options?: RequestOptionsBase): Promise<GetCustomModelsResponse>
Parâmetros
- options
- RequestOptionsBase
Os parâmetros opcionais
Retornos
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
O retorno de chamada
getCustomModels(ServiceCallback<ModelsResult>)
function getCustomModels(callback: ServiceCallback<ModelsResult>)
Parâmetros
- callback
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 de modelo.
- options
- RequestOptionsBase
Os parâmetros opcionais
Retornos
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
O retorno de chamada
getExtractedKeys(string, ServiceCallback<KeysResult>)
function getExtractedKeys(id: string, callback: ServiceCallback<KeysResult>)
Parâmetros
- id
-
string
Identificador de modelo.
- callback
O retorno de chamada
getReadReceiptResult(string, RequestOptionsBase)
Essa interface é usada para obter os resultados de análise de uma operação "Recebimento de Leitura em Lote". A URL para essa interface deve ser recuperada do campo 'Operation-Location' retornado da operação 'Recebimento de Leitura em Lote'.
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 'Recebimento de Leitura em Lote'.
- options
- RequestOptionsBase
Os parâmetros opcionais
Retornos
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 'Recebimento de Leitura em Lote'.
- options
- RequestOptionsBase
Os parâmetros opcionais
- callback
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 'Recebimento de Leitura em Lote'.
- callback
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 com raiz para o valor de configuração de montagem de entrada, por exemplo, se o valor da configuração '{Mounts:Input}' for '/input', um caminho de origem válido será '/input/contosodataset'. Espera-se que todos os dados a serem treinados estejam diretamente na pasta de origem. Não há suporte para subpastas. Os modelos são treinados usando 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
Solicitar objeto para treinamento.
- options
- RequestOptionsBase
Os parâmetros opcionais
Retornos
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 treinamento.
- options
- RequestOptionsBase
Os parâmetros opcionais
- callback
O retorno de chamada
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)
function trainCustomModel(trainRequest: TrainRequest, callback: ServiceCallback<TrainResult>)
Parâmetros
- trainRequest
- TrainRequest
Solicitar objeto para treinamento.
- callback
O retorno de chamada
Detalhes do método herdado
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
Envie uma solicitação HTTP preenchida usando o OperationSpec fornecido.
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>
Parâmetros
- operationArguments
- OperationArguments
Os argumentos 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 a ser chamado quando a resposta é recebida.
Retornos
Promise<RestResponse>
sendRequest(RequestPrepareOptions | WebResourceLike)
Envie o httpRequest fornecido.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>
Parâmetros
- options
Retornos
Promise<HttpOperationResponse>
Herdado deFormRecognizerClientContext.sendRequest
Azure SDK for JavaScript