Pular para o conteúdo principal

Visão geral

As conexões de LLM no ABBYY Vantage permitem integrar modelos de linguagem avançados de provedores como OpenAI e Microsoft Foundry diretamente em seus fluxos de trabalho de processamento de documentos. Essas conexões permitem que suas Skills de Documento aproveitem IA de ponta para extração, classificação e compreensão mais precisas de documentos complexos. O que você vai fazer:
  • Acessar a configuração de Connections
  • Adicionar uma nova conexão de LLM
  • Configurar credenciais e configurações da conexão
  • Testar sua conexão
Tempo para concluir: 10–15 minutos Provedores de LLM compatíveis:
  • OpenAI ChatGPT
  • Microsoft Foundry
Observação: As conexões de LLM atualmente podem ser usadas em Skills de Documento apenas por meio do ABBYY Advanced Designer.

Pré-requisitos

Antes de começar, certifique-se de que você tenha:
  1. Acesso de administrador à configuração do ABBYY Vantage.
  2. Credenciais de API do provedor de LLM escolhido:
    • OpenAI: chave de API da sua conta OpenAI
    • Microsoft Foundry: chave de API, URL de endpoint completa (incluindo o caminho /chat/completions e a versão da API) e nome do modelo do Microsoft Foundry no Azure.
  3. Assinatura ativa com o seu provedor de LLM.
Observação: As conexões de LLM são gerenciadas no nível do tenant e podem ser usadas por todos os Skill Designers da sua organização. Atualmente, conexões de LLM só podem ser integradas a Skills de Documento por meio do ABBYY Advanced Designer.

Etapa 1: Acessar as Configurações

Vá até a área Configuration, onde você vai gerenciar as conexões de LLM.
  1. Na interface do ABBYY Vantage, localize a seção ADMIN na barra lateral esquerda.
  2. Clique em Configuration (ícone de engrenagem).
Accessing Configuration Você verá a página Configuration com várias opções no menu à esquerda:
  • General
  • Connections (é aqui que vamos trabalhar)
  • Identity Provider
  • Public API Client
  • Security Log
  • Environment Variables
  • IP Restrictions

Etapa 2: Navegar até Connections

Acesse a interface de gerenciamento de Connections.
  1. No menu esquerdo Configuration, clique em Connections.
Connections Page A página Connections exibe:
  • Lista de Connections existentes (se houver)
  • Detalhes da Connection: Name, Description, Used in Skills, Last Updated
  • Botões de gerenciamento: Add Connection, Test, Edit, Delete
  • Funcionalidade de pesquisa para encontrar Connections específicas
Observação: Connections são recursos compartilhados. Todos os usuários do Skill Designer no seu tenant podem usar essas Connections em suas skills.

Etapa 3: Adicionar uma Nova Conexão de LLM

Inicie o processo de criação de uma nova conexão com o seu provedor de LLM.
  1. Clique no botão + Add Connection na parte superior da página Connections.
  2. A caixa de diálogo Add Connection é exibida, mostrando os provedores de LLM disponíveis:
    • OpenAI ChatGPT - Conexão direta com a API da OpenAI
    • Microsoft Foundry - Modelos OpenAI e outros modelos de IA hospedados na infraestrutura da Microsoft Azure
  3. Selecione o provedor desejado (para este exemplo, usaremos Microsoft Foundry).
  4. Clique em Next.
Observação: Cada provedor tem diferentes requisitos de configuração. Escolha o provedor que corresponda à assinatura de LLM da sua organização.

Etapa 4: Configurar detalhes da conexão

Preencha as informações obrigatórias para sua conexão LLM. Configuração da Conexão

Configurações Gerais

Name
  • Um identificador exclusivo para esta conexão
  • Exemplo: Microsoft Foundry ou Production GPT-4
  • Este nome aparecerá ao selecionar conexões em Skill de Documento.
Description
  • Opcional, mas recomendado.
  • Forneça contexto útil sobre a conexão.
  • Exemplo: “Microsoft Foundry Connection 1” ou “GPT-4 Production API”.
  • Importante: Não inclua credenciais confidenciais na descrição.
Observação: Escolha nomes descritivos que ajudem os designers de Skills a entender qual conexão usar para diferentes finalidades.

Configurações de conexão

Os campos obrigatórios dependem do seu provedor de LLM:

Para Microsoft Foundry:

Api Key
  • Sua chave de API do Microsoft Foundry no Portal do Azure.
  • Encontre em: Azure Portal → Seu recurso Microsoft Foundry → Keys and Endpoint.
  • Formato: Uma string alfanumérica longa.
  • Exemplo de placeholder: [API Key Here]
Url
  • A URL do endpoint do Microsoft Foundry.
  • Encontre em: Azure Portal → Seu recurso Microsoft Foundry → Keys and Endpoint.
  • Formato: https://[resource].cognitiveservices.azure.com/openai/deployments/[model-name]/chat/completions?api-version=2025-01-01-preview
  • Exemplo: https://[redacted]resource.cognitiveservices.azure.com/openai/deployments/gpt-4.1-nano/chat/completions?api-version=2025-01-01-preview
Model Name
  • O nome do modelo implantado no Microsoft Foundry.
  • Encontre em: Azure Portal → Seu recurso Microsoft Foundry → Deployments.
  • Exemplo: gpt-4.1-nano, gpt-35-turbo, gpt-4
  • Deve corresponder exatamente ao nome da sua implantação.

Para OpenAI ChatGPT:

API Key
  • Sua chave de API da OpenAI obtida em platform.openai.com.
  • Encontre isto em: OpenAI Platform → API Keys.
  • Formato: começa com sk-
Model
  • O modelo específico a ser usado (por exemplo, gpt-4, gpt-3.5-turbo)
Aviso: Nunca compartilhe chaves de API nem as inclua em descrições. Essas credenciais concedem acesso aos seus serviços de LLM e aos custos correspondentes.

Etapa 5: Testar sua conexão

Verifique se a sua conexão está configurada corretamente antes de salvar.
  1. Após informar todas as informações obrigatórias, clique no botão Test.
Testing Connection
  1. O Vantage tentará se conectar ao seu provedor de LLM usando as credenciais que você forneceu.
  2. Observe o resultado do teste:
    • Sucesso (marca de verificação verde): a conexão está funcionando corretamente.
    • Falha (X vermelho ou mensagem de erro): verifique suas credenciais e tente novamente.

Resultados do teste

Teste bem-sucedido:
  • Um ícone de marca de seleção verde aparece ao lado da sua conexão.
  • Agora você pode salvar a conexão.
  • A conexão está pronta para ser usada em Skills de Documento.
Teste com falha:
  • Revise a mensagem de erro para identificar problemas específicos.
  • Problemas comuns:
    • Chave de API incorreta
    • URL de endpoint inválida
    • Nome de modelo incorreto
    • Problemas de conectividade de rede
    • Permissões ou cota insuficientes
Observação: Sempre teste sua conexão antes de salvar. Isso garante que suas Skills de Documento consigam usar o provedor de LLM com sucesso.

Etapa 6: Salvar sua conexão

Finalize a configuração da conexão.
  1. Quando o teste for bem-sucedido, clique no botão Add.
  2. Sua conexão agora aparece na lista Connections.
  3. A conexão fica imediatamente disponível para todos os skill designers no seu tenant.
A página Connections agora exibe:
  • Connection name: Conforme especificado
  • Description: Sua descrição informativa
  • Used in Skills: Mostra quais skills estão usando essa conexão
  • Last Updated: Data e hora atuais

Gerenciando conexões existentes

Você pode gerenciar suas conexões depois de criadas.

Editar uma conexão

  1. Selecione a conexão da lista.
  2. Clique no botão Editar (ícone de lápis).
  3. Atualize os campos necessários.
  4. Teste a conexão novamente.
  5. Clique em Salvar.
Aviso: Editar uma conexão afeta todas as skills que a utilizam. Teste cuidadosamente depois de fazer alterações.

Testar uma conexão

  1. Selecione a conexão da lista.
  2. Clique no botão Testar (ícone de atualizar).
  3. Verifique se a conexão ainda está funcionando.
  4. Isso é útil para solução de problemas ou verificação de credenciais.

Excluir uma conexão

  1. Selecione a conexão na lista.
  2. Clique no botão Delete (ícone de lixeira).
  3. Confirme a exclusão.
Aviso: Não é possível excluir uma conexão que esteja sendo usada em skills ativas. Remova a conexão de todas as skills antes de excluí-la.

Solução de problemas

Falha no teste de conexão

Problema: O teste de conexão retorna um erro. Soluções:
  • Chave de API inválida:
    • Verifique se você copiou toda a chave corretamente.
    • Verifique se há espaços ou caracteres extras.
    • Gere uma nova chave no portal do seu provedor, se necessário.
  • URL do endpoint inválida:
    • Certifique-se de que a URL está completa e devidamente formatada.
    • Verifique se a URL corresponde ao seu recurso do Azure.
    • Verifique se há erros de digitação no caminho de deployment.
  • Nome de modelo incorreto:
    • Confirme que o deployment existe no seu portal do Azure.
    • Verifique a ortografia e o uso de maiúsculas/minúsculas (case-sensitive).
    • Verifique se o deployment está ativo e disponível.
  • Problemas de rede:
    • Verifique sua conectividade com a internet.
    • Verifique se as configurações de firewall permitem conexões HTTPS de saída.
    • Confirme se sua instância do Vantage consegue acessar o provedor de LLM.
  • Cota ou permissões:
    • Verifique se sua assinatura está ativa.
    • Verifique se você não excedeu os limites de requisições.
    • Certifique-se de que sua chave de API tem as permissões necessárias.

Conexão funciona no teste, mas falha nas Skills

Problema: O teste é bem-sucedido, mas as skills não conseguem utilizar a conexão. Soluções:
  • Atualize a página do Skill Designer.
  • Selecione novamente a conexão na configuração da skill.
  • Verifique os logs de erro da skill em busca de mensagens específicas.
  • Confirme que a skill está publicada e não está em modo de rascunho.

Custos de API mais altos que o esperado

Problema: Cobranças inesperadas do seu provedor de LLM. Soluções:
  • Revise quais skills estão usando essa conexão.
  • Verifique o volume e a frequência de processamento.
  • Considere implementar limitação de taxa de requisições (rate limiting).
  • Monitore o uso pelo painel do seu provedor.
  • Use modelos mais econômicos nos testes.

Práticas recomendadas

Segurança

  • Nunca compartilhe chaves de API em e-mails ou chats em texto puro.
  • Faça a rotação das credenciais regularmente (recomendado a cada 90 dias).
  • Use conexões distintas para desenvolvimento e produção.
  • Monitore os logs de acesso no painel do seu provedor de LLM.
  • Implemente o princípio do menor privilégio — conceda apenas as permissões necessárias.
  • Armazene credenciais de backup com segurança para uso em situações de emergência.

Gerenciamento de conexões

  • Use nomes descritivos que indiquem a finalidade ou o ambiente.
    • Bom: “Produção GPT-4”, “Desenvolvimento Microsoft Foundry”
    • Evite: “Conexão 1”, “Teste”
  • Documente nas descrições para que serve cada conexão
    • Inclua: Ambiente, caso de uso, contato do responsável
    • Exclua: Credenciais, informações confidenciais
  • Teste as conexões regularmente para identificar problemas o quanto antes
    • Configure uma rotina de revisão mensal.
    • Teste após qualquer alteração de credenciais.
  • Acompanhe o uso para entender quais conexões estão ativas
    • Verifique a coluna “Used in Skills”.
    • Arquive ou exclua conexões não utilizadas.

Gerenciamento de custos

  • Escolha modelos apropriados para cada caso de uso.
    • Use modelos menores e mais rápidos para tarefas simples.
    • Reserve modelos avançados para extrações complexas.
  • Implemente rate limiting (limitação de taxa) se seu provedor oferecer esse recurso.
    • Evita picos de custos inesperados.
    • Protege contra processamento descontrolado.
  • Monitore os padrões de uso
    • Configure alertas de cobrança no painel do provedor.
    • Revise mensalmente os custos e o consumo.
  • Otimize os prompts em suas Skills de Documento.
    • Prompts eficientes reduzem o uso de tokens.
    • Teste e refine para obter os melhores resultados com o menor custo.

Otimização do fluxo de trabalho

  • Agrupe tipos de documento semelhantes
  • Configure as Skills de Documento apropriadas para o seu caso de uso
  • Teste com documentos de teste antes do uso em produção
  • Documente seu fluxo de trabalho para referência da equipe

Visão geral dos tipos de conexão

OpenAI ChatGPT

Ideal para:
  • Acesso direto aos modelos mais recentes da OpenAI
  • Configuração simples usando apenas uma chave de API
  • Organizações que já utilizam a plataforma OpenAI
Considerações:
  • Os dados são processados pela infraestrutura da OpenAI
  • Sujeito aos termos e políticas de dados da OpenAI
  • Requer uma conta na OpenAI e acesso à API

Microsoft Foundry

Melhor para:
  • Implantações corporativas com infraestrutura Azure
  • Organizações que exigem controles de residência de dados
  • Integração com outros serviços Azure
  • Recursos avançados de segurança e conformidade
  • Acesso ao OpenAI e a outros modelos de IA por meio do Azure
  • Organizações com assinaturas Azure existentes
Considerações:
  • Requer assinatura Azure e configuração do Microsoft Foundry
  • Exige mais configurações (URL do endpoint com caminho completo, nome do modelo, versão da API)
  • Os modelos disponíveis podem ser diferentes dos oferecidos diretamente pelo OpenAI
  • A URL deve incluir o caminho completo: /openai/deployments/[model-name]/chat/completions?api-version=...
  • Pode oferecer recursos especializados e hospedagem de modelos personalizados

Recursos adicionais


Resumo

Você concluiu com sucesso:
  • ✅ Acessou as configurações de Configuration
  • ✅ Navegou até o gerenciamento de Connections
  • ✅ Adicionou uma nova conexão de LLM
  • ✅ Configurou as credenciais e demais parâmetros da conexão
  • ✅ Testou sua conexão
  • ✅ Aprendeu a gerenciar conexões
Sua conexão de LLM agora está pronta para potencializar recursos avançados de IA em suas Skills de Documento do ABBYY Vantage!