Aquaforest PDF
O conector PDF do Aquaforest contém um grupo de ações que executa diferentes operações de PDF, como divisão, extração de texto, extração de código de barras e operações OCR para Office 365 e Power Automate.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte do Aquaforest |
| URL | https://www.aquaforest.com/en/aquaforest-flow-doc.asp |
| support@aquaforest.com |
| Metadados do conector | |
|---|---|
| Publicador | Aquaforest Limited |
| Site | https://www.aquaforest.com/en/aquaforest-connector.asp |
| Política de privacidade | https://www.aquaforest.com/en/privacy policy.pdf |
| Categorias | Conteúdo e arquivos; Dados |
O conector PDF do Aquaforest contém um grupo de ações que executa diferentes operações de PDF, como divisão, extração de texto, extração de código de barras e operações OCR para Office 365 e Flow.
Pré-requisitos
Em primeiro lugar, você precisa criar uma Conta de API PDF do Aquaforest. Essa conta é usada para gerenciar o Aquaforest PDF Actions e a API PDF do Aquaforest. Use seu endereço de email ativo, pois a assinatura será vinculada a esse endereço. Se você já tiver uma conta, basta entrar aqui.
Como obter credenciais
Faça logon no portal do desenvolvedor, acesse a página Produtos e selecione o produto ao qual você deseja assinar.

Clique no botão Assinar

Clique no botão Confirmar para confirmar sua solicitação de assinatura

Você pode acessar suas chaves de API na página Perfil

Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | secureString | A chave de API para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Dividir PDF por correspondência de texto |
Divide arquivos PDF com base em correspondências de texto definidas pelo usuário. Visite [https://www.aquaforest.com/en/aquaforest-flow-doc.asp] para obter documentação. Além disso, a Ferramenta de Extração Zonal do Aquaforest está disponível em [https://www.aquaforest.com/en/zone/get-pdf-zone.html]. |
| Dividir PDF por código de barras |
Divide arquivos PDF com base em correspondências de código de barras definidas pelo usuário. Visite [https://www.aquaforest.com/en/aquaforest-flow-doc.asp] para obter documentação. Além disso, a Ferramenta de Extração Zonal do Aquaforest está disponível em [https://www.aquaforest.com/en/zone/get-pdf-zone.html]. |
| Dividir PDF por página |
Divide arquivos PDF com base nas opções de divisão definidas pelo usuário. Visite [https://www.aquaforest.com/en/aquaforest-flow-doc.asp] para obter documentação. |
| Extrair páginas PDF por código de barras |
Extraia arquivos PDF com base nas correspondências de código de barras definidas pelo usuário. Visite [https://www.aquaforest.com/en/aquaforest-flow-doc.asp] para obter mais informações. |
| Extrair páginas PDF por texto |
Extraia arquivos PDF com base em correspondências de texto definidas pelo usuário. Visite [https://www.aquaforest.com/en/aquaforest-flow-doc.asp] para obter mais informações. |
| Obter dados do PDF |
Essa ação extrairá dados importantes de arquivos PDF na forma de pares Chave/Valor. |
| Obter o valor do código de barras |
Obter código de barras do PDF. Visite [https://www.aquaforest.com/en/aquaforest-flow-doc.asp] para obter mais informações. |
| Obter propriedades PDF |
Obtém as informações sobre um arquivo PDF |
| Obter texto do PDF |
Obtenha texto de arquivos PDF com base no local do texto e expressões regulares. Visite [https://www.aquaforest.com/en/aquaforest-flow-doc.asp] para obter mais informações. |
| PDF do OCR ou imagens |
Gere PDF pesquisável de uma imagem PDF ou imagens digitalizadas. Visite [https://www.aquaforest.com/en/aquaforest-flow-doc.asp] para obter mais informações. |
Dividir PDF por correspondência de texto
Divide arquivos PDF com base em correspondências de texto definidas pelo usuário. Visite [https://www.aquaforest.com/en/aquaforest-flow-doc.asp] para obter documentação. Além disso, a Ferramenta de Extração Zonal do Aquaforest está disponível em [https://www.aquaforest.com/en/zone/get-pdf-zone.html].
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo de origem |
|
Modelo de nome de arquivo
|
fileNameTemplate | True | string |
Modelo para o arquivo de saída se as correspondências de texto forem encontradas |
|
Páginas sem correspondência
|
noMatch | string |
Dependendo da opção de divisão escolhida acima, algumas páginas não terão nenhum valor de texto extraído. Escolha o que fazer nessas páginas. |
|
|
Nenhum modelo de arquivo
|
noTextFileName | True | string |
Modelo para o arquivo de saída se nenhuma correspondência de texto for encontrada |
|
Nome do Arquivo
|
sourceFileName | True | string |
O nome do arquivo de origem |
|
Opções de arquivo de saída
|
splitOption | string |
Escolha o local da página com o código de barras nos arquivos de saída da operação de divisão. |
|
|
Value
|
expression | array of string |
Forneça um ou mais valores aqui para serem usados com a propriedade acima, retornaremos o primeiro valor de texto que corresponde à regra declarada acima. |
|
|
Localização
|
location | True | string |
Área da página – use a ferramenta Zonal para obter coordenadas: [https://www.aquaforest.com/en/zone/get-pdf-zone.html] |
|
Selecionar
|
position | string |
Use isso para refinar o texto que você extrai mais, selecione uma opção que corresponda aos seus requisitos |
|
|
Padrão
|
regex | string |
Se uma expressão regular for fornecida aqui, corresponderemos a qualquer texto extraído a ela e retornaremos a correspondência. |
Retornos
Dividir PDF por código de barras
Divide arquivos PDF com base em correspondências de código de barras definidas pelo usuário. Visite [https://www.aquaforest.com/en/aquaforest-flow-doc.asp] para obter documentação. Além disso, a Ferramenta de Extração Zonal do Aquaforest está disponível em [https://www.aquaforest.com/en/zone/get-pdf-zone.html].
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo de origem |
|
Modelo de nome de arquivo
|
fileNameTemplate | True | string |
Modelo para o arquivo de saída se o código de barras for encontrado |
|
Páginas sem correspondência
|
noMatch | string |
Dependendo da opção de divisão escolhida acima, algumas páginas não terão nenhum valor de código de barras. Escolha o que fazer nessas páginas. |
|
|
Nenhum modelo de correspondência de código de barras
|
noTextFileName | True | string |
Modelo para o arquivo de saída se nenhum código de barras for encontrado |
|
Nome do Arquivo
|
sourceFileName | True | string |
O nome do arquivo de origem |
|
Opções de arquivo de saída
|
splitOption | string |
Use isso para refinar o texto que você extrai mais, selecione uma opção que corresponda aos seus requisitos |
|
|
Tipo
|
barcodeFormats | array of string |
Especificar os tipos de Código de Barras que você deseja identificar |
|
|
Localização
|
location | True | string |
Área da página – use a ferramenta Zonal para obter coordenadas: [https://www.aquaforest.com/en/zone/get-pdf-zone.html] |
|
Padrão
|
regex | string |
Se uma expressão regular for fornecida aqui, corresponderemos a qualquer código de barras extraído a ela e retornaremos a correspondência. |
Retornos
Dividir PDF por página
Divide arquivos PDF com base nas opções de divisão definidas pelo usuário. Visite [https://www.aquaforest.com/en/aquaforest-flow-doc.asp] para obter documentação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo de origem. |
|
Nome do arquivo de saída
|
fileNameTemplate | True | string |
Modelo de arquivo de destino que pode incluir %UNIQUEn (número exclusivo começando em 1, zero acolchoado a n dígitos) e %FILENAME (nome de arquivo original sem a extensão). |
|
Nome do Arquivo
|
sourceFileName | True | string |
O nome do arquivo de origem. |
|
Tipo de divisão
|
splitOption | True | string |
Escolha a operação de divisão a ser usada para cada arquivo. |
|
Intervalo de Páginas
|
pageRange | string |
Conjunto de intervalos de páginas separados por vírgulas que define quais páginas do original devem ser extraídas. |
|
|
Repetir Cada
|
repeatEvery | integer |
Aplique o intervalo de páginas a cada conjunto de páginas de Intervalos de Páginas dentro do documento. Por exemplo, se 2-4 for especificado para intervalos de página e 4 for especificado como o intervalo de repetição, o intervalo será aplicado novamente a cada 4 páginas. |
|
|
Reter indicadores
|
retainBookmarks | boolean |
Os arquivos gerados incluirão indicadores do arquivo original. |
|
|
Reter metadados
|
retainMetadata | boolean |
Os arquivos gerados incluirão metadados (como Autor e Título) do arquivo original. |
Retornos
Extrair páginas PDF por código de barras
Extraia arquivos PDF com base nas correspondências de código de barras definidas pelo usuário. Visite [https://www.aquaforest.com/en/aquaforest-flow-doc.asp] para obter mais informações.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo de origem |
|
Modelo de nome de arquivo
|
fileNameTemplate | True | string |
Modelo para o arquivo de saída se o código de barras for encontrado |
|
Nenhum modelo de arquivo
|
noTextFileName | True | string |
Modelo para o arquivo de saída se nenhum código de barras for encontrado |
|
Nome do Arquivo
|
sourceFileName | True | string |
O nome do arquivo de origem |
|
Tipo
|
barcodeFormats | array of string |
Especificar os tipos de Código de Barras que você deseja identificar |
|
|
Localização
|
location | True | string |
Área da página – use a ferramenta Zonal para obter coordenadas: [https://www.aquaforest.com/en/zone/get-pdf-zone.html] |
|
Padrão
|
regex | string |
Se uma expressão regular for fornecida aqui, corresponderemos a qualquer código de barras extraído a ela e retornaremos a correspondência. |
Retornos
Extrair páginas PDF por texto
Extraia arquivos PDF com base em correspondências de texto definidas pelo usuário. Visite [https://www.aquaforest.com/en/aquaforest-flow-doc.asp] para obter mais informações.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo de origem |
|
Modelo de nome de arquivo
|
fileNameTemplate | True | string |
Modelo para o arquivo de saída se as correspondências de texto forem encontradas |
|
Nenhum modelo de arquivo
|
noTextFileName | True | string |
Modelo para o arquivo de saída se nenhuma correspondência de texto for encontrada |
|
Nome do Arquivo
|
sourceFileName | True | string |
O nome do arquivo de origem |
|
Value
|
expression | array of string |
Forneça um ou mais valores aqui para serem usados com a propriedade acima, retornaremos o primeiro valor de texto que corresponde à regra declarada acima. |
|
|
Localização
|
location | True | string |
Área da página – use a ferramenta Zonal para obter coordenadas: [https://www.aquaforest.com/en/zone/get-pdf-zone.html] |
|
Selecionar
|
position | string |
Use isso para refinar o texto que você extrai mais, selecione uma opção que corresponda aos seus requisitos |
|
|
Padrão
|
regex | string |
Se uma expressão regular for fornecida aqui, corresponderemos a qualquer texto extraído a ela e retornaremos a correspondência. |
Retornos
Obter dados do PDF
Essa ação extrairá dados importantes de arquivos PDF na forma de pares Chave/Valor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
settingName | True | string |
Insira o nome da configuração aqui |
|
Value
|
settingValue | True | string |
Insira o valor da configuração aqui. |
|
Pontuação de confiança
|
confidenceScore | number |
Defina uma pontuação de confiança mais alta para filtrar valores com menor confiança. Você pode definir qualquer valor entre 0 e 1. Recomendamos começar a partir de 0,5 |
|
|
Conversão de data
|
dateAsISO | string |
Selecione qual formato retornar valor de data como |
|
|
Chaves esperadas
|
expectedKeys | string |
Forneça um nome de chave por linha para disponibilizar valores para ações posteriores sem analisar JSON. |
|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo de origem |
|
Limite de Página
|
pageLimit | integer |
Número máximo de páginas a serem processadas |
|
|
Intervalo de Páginas
|
pageRange | string |
Uma representação de cadeia de caracteres dos números de página que você deseja processar. Por exemplo, 1,3-4 |
|
|
Símbolo de moeda de faixa
|
stripCurrencySymbol | boolean |
Defina isso como true se você quiser que os símbolos e cadeias de caracteres sejam removidos antes de retornarmos valores de moeda |
|
|
Sinônimo de correspondência
|
synonym | boolean |
Defina isso como true se você quiser que retornemos todas as chaves que são sinônimos para a chave esperada. |
|
|
Dicionário de sinônimos
|
synonymDictionary | string |
Você pode fornecer uma matriz JSON de objetos de "entrada", em que cada objeto contém uma lista de sinônimos em uma matriz. Por exemplo, se você quiser que "Fatura Não" e "Número da Fatura" (não diferencia maiúsculas de minúsculas) sejam interpretados como a mesma chave, use o seguinte JSON: [{'entry': [ 'Fatura Não', 'número da fatura' ]}] |
|
|
Cortar símbolos
|
trimSymbols | boolean |
Defina isso como true se você quiser que removamos todos os símbolos à esquerda e à direita das chaves encontradas antes de combiná-los com uma chave esperada. |
Retornos
Obter o valor do código de barras
Obter código de barras do PDF. Visite [https://www.aquaforest.com/en/aquaforest-flow-doc.asp] para obter mais informações.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Modelo de resultado do código de barras
|
barcodeResultTemplate | True | string |
Modelo para o resultado do texto de saída se um código de barras for encontrado |
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo de origem |
|
Nenhum modelo de código de barras
|
noBarcodeTemplate | True | string |
Modelo para o resultado do texto de saída se nenhum código de barras for encontrado |
|
Separador de Página
|
pageSeparator | string |
Forneça um separador de página para que você possa saber onde estão as quebras de página. |
|
|
Páginas
|
pagerange | string |
Forneça um intervalo de páginas do qual você deseja extrair texto, pode ser um único número de página (1), vários números de página separados por vírgulas (1,2,3), um intervalo de páginas (1-4) ou uma mistura de todos (1,2,4-7). |
|
|
Nome do Arquivo
|
sourceFileName | True | string |
O nome do arquivo de origem |
|
Tipo
|
barcodeFormats | array of string |
Especificar os tipos de Código de Barras que você deseja identificar |
|
|
Localização
|
location | True | string |
Área da página – use a ferramenta Zonal para obter coordenadas: [https://www.aquaforest.com/en/zone/get-pdf-zone.html] |
|
Página (Preterida)
|
pagenumber | integer |
Essa propriedade foi preterida, recomendamos que você use a propriedade Pages. A propriedade Pages se aplica a todas as zonas e permite que você selecione as páginas que deseja processar. |
|
|
Padrão
|
regex | string |
Se uma expressão regular for fornecida aqui, corresponderemos a qualquer texto extraído a ela e retornaremos a correspondência. |
Retornos
Obter propriedades PDF
Obtém as informações sobre um arquivo PDF
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo de origem |
|
Limite de Página
|
pageLimit | integer |
Número máximo de páginas a serem processadas, isso só é usado para verificar se as páginas contêm texto oculto ou para verificar se o PDF é pesquisável |
Retornos
- Corpo
- GetPDFInfoResponse
Obter texto do PDF
Obtenha texto de arquivos PDF com base no local do texto e expressões regulares. Visite [https://www.aquaforest.com/en/aquaforest-flow-doc.asp] para obter mais informações.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo de origem |
|
Nenhum modelo de correspondência de texto
|
noTextTemplate | True | string |
Modelo para o texto a ser retornado se uma correspondência não for encontrada |
|
Separador de Página
|
pageSeparator | string |
Forneça um separador de página para que você possa saber onde estão as quebras de página. |
|
|
Páginas
|
pagerange | string |
Forneça um intervalo de páginas do qual você deseja extrair texto, pode ser um único número de página (1), vários números de página separados por vírgulas (1,2,3), um intervalo de páginas (1-4) ou uma mistura de todos (1,2,4-7). |
|
|
Nome do Arquivo
|
sourceFileName | True | string |
O nome do arquivo de origem |
|
Modelo de resultado de texto
|
textResultTemplate | True | string |
Modelo para o texto a ser retornado se uma correspondência for encontrada |
|
Value
|
expression | array of string |
Forneça um ou mais valores aqui para serem usados com a propriedade acima, retornaremos o primeiro valor de texto que corresponde à regra declarada acima. |
|
|
Localização
|
location | True | string |
Área da página – use a ferramenta Zonal para obter coordenadas: [https://www.aquaforest.com/en/zone/get-pdf-zone.html] |
|
Página (Preterida)
|
pagenumber | integer |
Essa propriedade foi preterida, recomendamos que você use a propriedade Pages. A propriedade Pages se aplica a todas as zonas e permite que você selecione as páginas que deseja processar. |
|
|
Selecionar
|
position | string |
Use isso para refinar o texto que você extrai mais, selecione uma opção que corresponda aos seus requisitos |
|
|
Padrão
|
regex | string |
Se uma expressão regular for fornecida aqui, corresponderemos a qualquer texto extraído a ela e retornaremos a correspondência. |
Retornos
PDF do OCR ou imagens
Gere PDF pesquisável de uma imagem PDF ou imagens digitalizadas. Visite [https://www.aquaforest.com/en/aquaforest-flow-doc.asp] para obter mais informações.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
AquaforestImageTimeout
|
aquaforestImageTimeout | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
Autor
|
author | string |
Defina um Autor personalizado nas propriedades do documento PDF de saída. |
|
|
Girar automaticamente
|
autorotate | boolean |
Girar automaticamente a imagem – isso garantirá que todos os textos sejam orientados normalmente |
|
|
Binário
|
binarize | integer |
Esse valor geralmente só deve ser usado sob orientação do suporte técnico. Ele pode controlar a maneira como as imagens coloridas são processadas e forçar a binagem com um limite específico. Um valor de 200 geralmente tem sido mostrado para fornecer bons resultados em testes, mas isso deve ser confirmado com documentos "típicos" do cliente. Ao definir isso como -1 um método alternativo é usado, o que tentará separar o texto de qualquer imagem ou cores de plano de fundo. Isso pode fornecer resultados aprimorados do OCR para determinados documentos, como páginas de jornais e revistas. |
|
|
Limite de pixel preto
|
blackPixelLimit | float |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
Limite de página em branco
|
blankPageThreshold | integer |
Use isso para definir o número mínimo de "On Pixels" que deve estar presente na imagem para que uma página não seja considerada em branco. Um valor de -1 desativará a detecção de página em branco. |
|
|
Tamanho da caixa
|
boxSize | integer |
Essa opção é ideal para formulários em que, às vezes, caixas ao redor do texto podem fazer com que uma área seja identificada como gráficos. Essa opção remove as caixas da cópia temporária da imagem usada pelo mecanismo OCR. Ele não remove caixas da imagem final. Tecnicamente, essa opção remove elementos conectados com uma área mínima (em pixels e definida por essa propriedade). No momento, essa opção só é aplicada a imagens bi-tonal. |
|
|
ConvertToTiff
|
convertToTiff | boolean |
Cada página no documento PDF é rasterizada para uma imagem TIFF. |
|
|
CreateProcess
|
createProcess | boolean |
Defina isso como true se você quiser iniciar o processo por meio do pinvoke. |
|
|
Data de Criação
|
creationDate | string |
Defina uma data de criação personalizada nas propriedades do documento PDF de saída. A cadeia de caracteres de data deve estar no formato 'yyy-MM-dd HH:mm:ss'. |
|
|
Deskew
|
deskew | boolean |
Deskew (endireitar) a imagem. |
|
|
Despeckle
|
despeckle | integer |
Isso remove todos os elementos desconectados na imagem que têm altura ou largura em pixels menores que a figura especificada. O valor máximo é 9 e o valor padrão é 0. |
|
|
DictionaryLookup
|
dictionaryLookup | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
Dotmatrix
|
dotmatrix | boolean |
Defina isso como true para melhorar o reconhecimento de fontes de matriz de ponto. O valor padrão é falso. Se definido como true para fontes não de matriz de ponto, o reconhecimento poderá ser ruim. |
|
|
Habilitar saída de depuração
|
enableDebugOutput | boolean |
Habilita a saída de depuração. |
|
|
Compactar PDF (MRC)
|
enableMrc | boolean |
Isso permite a Compactação de Raster Misturada, que pode reduzir drasticamente o tamanho de saída de PDFs que compreendem verificações de cores. Observe que essa opção só é adequada quando a origem não é um PDF ou usando ConvertToTiff. |
|
|
Saída de PDF/A
|
enablePDFAOutput | boolean |
Se deseja ou não gerar como PDF/A. |
|
|
Modo de erro
|
errorMode | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
Conteúdo do arquivo de origem
|
fileContent | True | byte |
Conteúdo do arquivo para OCR |
|
Nome do arquivo de origem com extensão
|
fileNameWithExtension | True | string |
O nome do arquivo de origem com extensão ou apenas a extensão (com um período à esquerda '.') |
|
Detecção de inverter
|
flipDetect | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
Qualidade de escala de cinza
|
grayscaleQuality | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
Heurística
|
heuristics | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
Jbig2EncFlags
|
jbig2EncFlags | string |
Esses são os sinalizadores que serão passados para o aplicativo usado para gerar versões JBIG2 de imagens usadas na geração de PDF (supondo que essa compactação esteja habilitada). Essa opção geralmente só deve ser usada sob orientação do suporte técnico. |
|
|
Linguagem
|
language | enum |
Selecionar uma das opções abaixo define o idioma a ser usado para o processamento do OCR. O idioma padrão é inglês. |
|
|
LibTiffSavePageAsBmp
|
libTiffSavePageAsBmp | boolean |
Às vezes, se houver uma imagem que seja 1bpp e tenha compactação LZW, o pré-processamento poderá fazer com que a cor da imagem seja invertida (preto para branco e branco para preto). Defina isso como true para evitar isso. |
|
|
Máximo de deskew
|
maxDeskew | float |
Ângulo máximo pelo qual uma página será resmissada. Essa opção geralmente só deve ser usada sob orientação do suporte técnico (support@aquaforest.com). |
|
|
Confiança mínima do deskew
|
minDeskewConfidence | float |
Essa opção geralmente só deve ser usada sob orientação do suporte técnico (support@aquaforest.com). |
|
|
Data modificada
|
modifiedDate | string |
Defina uma data modificada personalizada nas propriedades do documento PDF de saída. A cadeia de caracteres de data deve estar no formato 'yyy-MM-dd HH:mm:ss'. |
|
|
Morph
|
morph | string |
Opções morfológicas que serão aplicadas à imagem binária antes do OCR. Se definido como vazio nenhum for aplicado. As opções comuns incluem as listadas abaixo, mas para obter mais opções, entre em contato support@aquaforest.com. |
|
|
MrcBackgroundFactor
|
mrcBackgroundFactor | integer |
Tamanho da amostragem da parte da tela de fundo da imagem. Quanto maior o número, maior o tamanho dos blocos de imagem usados para média, o que resultará em uma redução no tamanho, mas também na qualidade. O valor padrão é 3 |
|
|
MrcForegroundFactor
|
mrcForegroundFactor | integer |
Tamanho da amostragem para a parte de primeiro plano da imagem. Quanto maior o número, maior o tamanho dos blocos de imagem usados para média, o que resultará em uma redução no tamanho, mas também na qualidade. O valor padrão é 3 |
|
|
MrcQuality
|
mrcQuality | integer |
Configuração de qualidade JPEG (valor percentual de 1 a 100) para uso ao salvar as imagens em segundo plano e em primeiro plano. O valor padrão é 75 |
|
|
MrcTimeout
|
mrcTimeout | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
NoPictures
|
noPictures | boolean |
Por padrão, se uma área do documento for identificada como uma área gráfica, nenhum processamento de OCR será executado nessa área. No entanto, determinados documentos podem incluir áreas ou caixas identificadas como áreas "gráficas" ou "imagem", mas que realmente contêm texto útil. A configuração de NoPictures como True fará com que ela ignore as áreas identificadas como imagens enquanto a configura como False forçará o OCR de áreas identificadas como imagens. |
|
|
OcrProcessSetupTimeout
|
ocrProcessSetupTimeout | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
OcrTimeout
|
ocrTimeout | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
Senha
|
password | string |
A senha para abrir o arquivo PDF de origem |
|
|
PdfToImageBpp
|
pdfToImageBpp | enum |
Os Bits por Pixel a serem usados para a página de PDF rasterizada ao usar o mecanismo 1. Isso só se aplica a documentos processados usando ConvertToTiff. O valor padrão dessa propriedade é obtido da página PDF. |
|
|
PdfToImageCompression
|
pdfToImageCompression | enum |
A compactação a ser definida para as imagens extraídas ou rasterizadas de cada página do arquivo PDF de origem. Essas imagens são então OCRed para criar o PDF pesquisável. O valor padrão dessa propriedade é obtido de cada página no arquivo PDF de origem. |
|
|
PdfToImageDpi
|
pdfToImageDpi | enum |
O DPI a ser definido como as imagens rasterizadas de cada página do arquivo PDF de origem. Essas imagens são então OCRed para criar o PDF pesquisável. O valor padrão dessa propriedade é obtido de cada página no arquivo PDF de origem. |
|
|
PdfToImageForceVectorCheck
|
pdfToImageForceVectorCheck | boolean |
Essa configuração é útil ao lidar com documentos que contêm objetos de vetor (por exemplo, desenhos cad). Por padrão, as páginas que contêm apenas objetos vetoriais são rasterizadas. Páginas que não têm imagens, mas contêm objetos de vetor, bem como texto eletrônico, são ignoradas da rasterização. No entanto, às vezes pode haver uma página que contém objetos de vetor (desenhos CAD), mas seu título pode estar em texto eletrônico. Para forçar a rasterização de páginas como essas, defina essa propriedade como true. |
|
|
PdfToImageIncludeText
|
pdfToImageIncludeText | boolean |
Quando definido como False, isso impedirá que a conversão de texto real (ou seja, gerada eletronicamente em vez de texto que faz parte de uma imagem digitalizada) seja renderizada nas imagens de página extraídas do PDF. Isso ocorre porque o texto já é pesquisável e, portanto, geralmente não requer OCR. No entanto, o valor pode ser definido como True se o OCR for necessário nesse texto real. |
|
|
PdfToImageMaxRes
|
pdfToImageMaxRes | integer |
A resolução máxima das imagens rasterizadas. Se a resolução recuperada da página PDF for maior que esse valor, ela será definida como esse valor. O valor padrão dessa propriedade é 600. |
|
|
PdfToImageMinRes
|
pdfToImageMinRes | integer |
A resolução mínima das imagens rasterizadas. Se a resolução recuperada da página PDF for menor que esse valor, ela será definida como esse valor. O valor padrão dessa propriedade é 200. |
|
|
Versão do PDF/A
|
pdfaVersion | enum |
A versão PDF/A. |
|
|
PipeClientConnectionTimeout
|
pipeClientConnectionTimeout | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
RemoveBlankPage
|
removeBlankPage | boolean |
Remova páginas em branco quando BlankPageThreshold for maior que -1 e ConvertToTiff for true. |
|
|
RemoveLines
|
removeLines | boolean |
Remover linhas de imagens fpr melhor reconhecimento. |
|
|
RestartEngineEvery
|
restartEngineEvery | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
Reter indicadores
|
retainBookmarks | boolean |
Retém todos os indicadores do arquivo de origem na saída ao usar ConvertToTiff. |
|
|
Manter a data de criação
|
retainCreationDate | boolean |
Retém a data de criação do arquivo de origem nas propriedades do documento PDF de saída. |
|
|
Reter metadados
|
retainMetadata | boolean |
Retém os metadados do arquivo de origem na saída ao usar ConvertToTiff. |
|
|
Manter a data modificada
|
retainModifiedDate | boolean |
Retém a data modificada do arquivo de origem nas propriedades do documento PDF de saída. |
|
|
Manter preferências do visualizador
|
retainViewerPreferences | boolean |
Retém as Preferências do Visualizador de PDF, o Modo de Página e o Layout de Página do arquivo de origem na saída ao usar ConvertToTiff. |
|
|
SavePredespeckle
|
savePredespeckle | boolean |
Isso usará a imagem original (ou seja, antes de aplicar o pré-processamento) no PDF de saída. |
|
|
Tables
|
tables | boolean |
Essa opção, quando definida como true, tenta o OCR dentro das células da tabela. |
|
|
TextLayerFilterHeight
|
textLayerFilterHeight | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
TextLayerFilterHeightInverted
|
textLayerFilterHeightInverted | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
TextLayerFilterPercentage
|
textLayerFilterPercentage | float |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
TextLayerFilterPercentageInverted
|
textLayerFilterPercentageInverted | float |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
TextLayerFilterRatio
|
textLayerFilterRatio | float |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
TextLayerFilterRatioInverted
|
textLayerFilterRatioInverted | float |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
TextLayerFilterWidth
|
textLayerFilterWidth | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
TextLayerFilterWidthInverted
|
textLayerFilterWidthInverted | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
TextLayerMaxBoxes
|
textLayerMaxBoxes | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
Modo de arrumação
|
tidyUpMode | integer |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
|
|
Validar PDF/A
|
validatePDFA | boolean |
Se deseja ou não validar o documento PDF/A após a conversão |
|
|
Limite de correspondência do Word
|
wordMatchThreshold | float |
Entre em contato com o suporte técnico (support@aquaforest.com) para obter diretrizes sobre como usar essa propriedade. |
Retornos
Dados de resposta para a operação do OCR
- Corpo
- ocr_response
Definições
ApiExtractPost200ApplicationJsonResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erro
|
ErrorMessage | string |
Se o valor de É Bem-Sucedido for false, retornaremos uma Mensagem de Erro |
|
É bem-sucedido
|
IsSuccessful | boolean |
Isso retornará true se pelo menos uma página tiver sido extraída |
|
Informações de licença
|
LicenceInfo | string |
Informações sobre sua chave de assinatura de API |
|
Extrair arquivos de saída
|
SplittedFile | array of object |
Matriz de arquivos extraídos |
|
(Conteúdo do Arquivo)
|
SplittedFile.SplitFileContent | byte |
Uma cadeia de caracteres base 64 que representa o conteúdo do arquivo |
|
(Nome do Arquivo)
|
SplittedFile.SplitFileName | string |
Uma cadeia de caracteres que contém o nome do arquivo gerado |
|
(Número da Página)
|
SplittedFile.pageNumber | string |
O intervalo de páginas que contém o número da página em que a extração ocorreu |
ApiGetTextValueJsonResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Mensagem de erro
|
ErrorMessage | string |
Se o valor de É Bem-Sucedido for false, retornaremos uma Mensagem de Erro |
|
É bem-sucedido
|
IsSuccessful | boolean |
Se o texto foi correspondido com êxito |
|
Informações de licença
|
LicenceInfo | string |
Informações sobre sua chave de assinatura de API |
|
Resultado do Texto
|
TextResult | string |
Uma cadeia de caracteres gerada com a aplicação do texto extraído ao Modelo de Resultado de Texto fornecido. Observe que se a contagem de páginas for maior que uma, concatenará todas as páginas usando o Separador de Páginas. |
|
Results
|
TextResults | array of object |
Uma matriz que contém uma lista de páginas e os valores de texto extraídos |
|
(Número da Página)
|
TextResults.pageNumber | string |
A página em que o texto foi encontrado |
|
(Texto da Página)
|
TextResults.valueExtracted | string |
Uma cadeia de caracteres gerada com a aplicação do texto extraído ao Modelo de Resultado de Texto fornecido. |
|
(Valores de zona)
|
TextResults.zoneValues | array of string |
Uma matriz que contém o texto extraído de cada zona. |
ApiRenameByBarcodePost200ApplicationJsonResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de barras
|
BarcodeResult | string |
Uma cadeia de caracteres gerada com a aplicação do texto extraído ao modelo de resultado do código de barras fornecido. Observe que se a contagem de páginas for maior que uma, concatenará todas as páginas usando o Separador de Páginas. |
|
Results
|
BarcodeResults | array of object |
Uma matriz que contém uma lista de páginas e os valores de código de barras extraídos |
|
(Número da Página)
|
BarcodeResults.pageNumber | string |
A página em que o código de barras foi encontrado |
|
(Código de Barras de Página)
|
BarcodeResults.valueExtracted | string |
Uma cadeia de caracteres gerada com a aplicação do valor do código de barras extraído ao modelo de resultado do código de barras fornecido. |
|
(Valores de zona)
|
BarcodeResults.zoneValues | array of string |
Uma matriz que contém o código de barras extraído de cada zona. |
|
Mensagem de erro
|
ErrorMessage | string |
Se o valor de É Bem-Sucedido for false, retornaremos uma Mensagem de Erro |
|
É bem-sucedido
|
IsSuccessful | boolean |
Se um código de barras foi detectado |
|
Informações de licença
|
LicenceInfo | string |
Informações sobre sua chave de assinatura de API |
ApiSplitPost200ApplicationJsonResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Mensagem de erro
|
ErrorMessage | string |
Se o valor de É Bem-Sucedido for false, retornaremos uma Mensagem de Erro |
|
É bem-sucedido
|
IsSuccessful | boolean |
Isso retornará true se pelo menos uma página dividida tiver sido correspondida. |
|
Informações de licença
|
LicenceInfo | string |
Informações sobre sua chave de assinatura de API |
|
Dividir arquivos de saída
|
SplittedFile | array of object |
Matriz que contém cada um dos arquivos divididos junto com detalhes como o nome do arquivo gerado e o número da página. |
|
(Conteúdo do Arquivo)
|
SplittedFile.SplitFileContent | byte |
Uma cadeia de caracteres base 64 que representa o conteúdo do arquivo |
|
(Nome do Arquivo)
|
SplittedFile.SplitFileName | string |
Uma cadeia de caracteres que contém o nome do arquivo gerado |
|
(Intervalo de Páginas)
|
SplittedFile.pageNumber | string |
O intervalo de páginas que contém os números de página da operação de divisão |
GetPDFInfoResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Permitir assembly
|
AllowAssembly | boolean |
Permitir rotação, inserção ou exclusão de páginas. |
|
Permitir impressão degradada
|
AllowDegradedPrinting | boolean |
Permitir impressão de baixa qualidade. |
|
Permitir Extrair Conteúdo
|
AllowExtractContents | boolean |
Permitir a extração de texto e elementos gráficos. |
|
Permitir extração para acessibilidade
|
AllowExtractForAccessibility | boolean |
Permitir a extração de texto e elementos gráficos em suporte à acessibilidade. |
|
Permitir preenchimento de formulário
|
AllowFillInForm | boolean |
Permitir o preenchimento de campos de formulário. |
|
Permitir modificar anotações
|
AllowModifyAnnotations | boolean |
Permitir a modificação de anotações. |
|
Permitir modificar conteúdo
|
AllowModifyContents | boolean |
Permitir a modificação do conteúdo. |
|
Permitir Impressão
|
AllowPrinting | boolean |
Permitir impressão de alta qualidade. |
|
Autor
|
Author | string |
Quem criou o documento. |
|
Data de Criação
|
CreationDate | string |
Essa é a data e a hora em que o PDF foi criado. |
|
Criador
|
Creator | string |
O aplicativo ou biblioteca de origem. |
|
Mensagem de erro
|
ErrorMessage | string |
Se o valor de É Bem-Sucedido for false, retornaremos uma Mensagem de Erro |
|
Tamanho do arquivo (bytes)
|
FileSize | number |
O tamanho do arquivo em bytes |
|
Tem texto oculto
|
HasHiddenText | boolean |
Isso retornará true se o arquivo PDF tiver uma camada OCR. |
|
É Criptografado
|
IsEncrypted | boolean |
Isso retornará true se este documento estiver criptografado ou não. |
|
É pesquisável
|
IsSearchable | boolean |
Isso retornará true se o arquivo PDF for pesquisável. |
|
É bem-sucedido
|
IsSuccessful | boolean |
Retornará true se a ação tiver sido bem-sucedida. |
|
Palavras-chave
|
Keywords | string |
Palavras-chave podem ser separadas por vírgula. |
|
Informações de licença
|
LicenceInfo | string |
Resumo Json da cota de assinatura. |
|
Data modificada
|
ModifiedDate | string |
Essa propriedade representa a data e a hora em que o PDF foi modificado pela última vez |
|
Número de páginas
|
NumberofPages | integer |
O número de páginas no arquivo PDF. |
|
Versão do PDF
|
PDFversion | number |
A versão da especificação pdf na qual o documento foi criado. |
|
Producer
|
Producer | string |
O produto que criou o PDF. Nos primeiros dias de PDF, as pessoas usavam um aplicativo criador como o Microsoft Word para escrever um documento, imprimi-lo em um arquivo PostScript e, em seguida, o Produtor seria Acrobat Distiller, o aplicativo que converteu o arquivo PostScript em um PDF. Atualmente, o Criador e o Produtor geralmente são os mesmos ou um campo é deixado em branco. |
|
Assunto
|
Subject | string |
Sobre o que é o documento. |
|
Title
|
Title | string |
O título do documento. |
|
Preso
|
Trapped | string |
Essa propriedade é um valor booliano que indica se o documento foi preso. O trapping é um processo de pré-pressionamento que introduz áreas coloridas em separações de cores para obscurecer possíveis erros de registro. |
|
Metadados XMP
|
XmpMetadata | string |
A Plataforma de Metadados Extensíveis (XMP) é um padrão ISO, originalmente criado pela Adobe Systems Inc., para a criação, processamento e intercâmbio de metadados padronizados e personalizados para documentos digitais e conjuntos de dados. |
ocr_response
Dados de resposta para a operação do OCR
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Mensagem de erro
|
ErrorMessage | string |
Se o valor de É Bem-Sucedido for false, retornaremos uma Mensagem de Erro |
|
É bem-sucedido
|
IsSuccessful | boolean |
Retorna true se o OCR foi bem-sucedido. |
|
Informações de licença
|
LicenceInfo | string |
Informações sobre sua chave de assinatura de API |
|
Conteúdo do arquivo de log
|
LogFileContent | byte |
O conteúdo do log da operação |
|
Conteúdo do arquivo processado
|
OutputFileContent | byte |
Arquivo gerado pelo conversor de PDF do Aquaforest. |