Visão geral
- Acessar a configuração de Connections
- Adicionar uma nova conexão de LLM
- Configurar credenciais e parâmetros da conexão
- Testar sua conexão
- OpenAI ChatGPT
- Microsoft Foundry
Pré-requisitos
- Acesso de administrador à Configuração do ABBYY Vantage.
- 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/completionse a versão da API) e nome do modelo do Microsoft Foundry no Azure.
- Assinatura ativa com o seu provedor de LLM.
Etapa 1: Acessar as Configurações
- Na interface do ABBYY Vantage, localize a seção ADMIN na barra lateral esquerda.
- Clique em Configuration (ícone de engrenagem).
- General
- Connections (é aqui que vamos trabalhar)
- Identity Provider
- Public API Client
- Security Log
- Environment Variables
- IP Restrictions
Acesse a interface de gerenciamento de Connections.
- No menu Configuration à esquerda, clique em Connections.
- Lista de conexões existentes (se houver)
- Detalhes da conexão: Name, Description, Used in Skills, Last Updated
- Botões de gerenciamento: Add Connection, Test, Edit, Delete
- Ferramenta de pesquisa para localizar conexões específicas
Etapa 3: Adicionar uma Nova Conexão de LLM
- Clique no botão + Add Connection na parte superior da página Connections.
- A caixa de diálogo Add Connection será 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 do Azure da Microsoft
- Selecione o provedor desejado (neste exemplo, usaremos Microsoft Foundry).
- Clique em Next.
Etapa 4: Configurar os detalhes da conexão
Configurações gerais
- Um identificador exclusivo para esta conexão
- Exemplo:
Microsoft FoundryouProduction GPT-4 - Esse nome será exibido ao selecionar conexões em Skills de Documento.
- Opcional, mas recomendada.
- Forneça um contexto útil sobre a conexão.
- Exemplo: “Conexão Microsoft Foundry 1” ou “API de Produção GPT-4”.
- Importante: Não inclua credenciais confidenciais na descrição.
Configurações de conexão
Para Microsoft Foundry:
- Sua chave de API do Microsoft Foundry no Azure Portal.
- Encontre em: Azure Portal → Seu recurso Microsoft Foundry → Keys and Endpoint.
- Formato: Uma longa sequência alfanumérica.
- Exemplo de placeholder:
[API Key Here]
- 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
- 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 - Este nome deve corresponder exatamente ao do seu deployment.
Para OpenAI ChatGPT:
- Sua chave de API da OpenAI obtida em platform.openai.com.
- Encontre em: OpenAI Platform → API Keys.
- Formato: começa com
sk-
- O modelo específico a ser usado (por exemplo,
gpt-4,gpt-3.5-turbo)
Etapa 5: Testar a conexão
- Depois de informar todas as informações necessárias, clique no botão Test.
- O Vantage tentará se conectar ao seu provedor de LLM usando as credenciais fornecidas.
- Observe o resultado do teste:
- Sucesso (marca de verificação verde): a conexão está funcionando corretamente.
- Falha (X em vermelho ou mensagem de erro): verifique suas credenciais e tente novamente.
Resultados do teste
- 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 uso em Skills de Documento.
- Revise a mensagem de erro para identificar problemas específicos.
- Problemas comuns:
- Chave de API incorreta
- URL do endpoint inválida
- Nome de modelo incorreto
- Problemas de conectividade de rede
- Permissões ou cota insuficientes
Etapa 6: Salvar sua conexão
- Quando o teste for bem-sucedido, clique no botão Add.
- Sua conexão agora aparece na lista Connections.
- A conexão fica imediatamente disponível para todos os designers de skills no seu tenant.
- Connection name: Conforme você especificou
- Description: Sua descrição útil
- Used in Skills: Mostra quais skills estão usando essa conexão
- Last Updated: Data e hora atuais
Gerenciando conexões existentes
Editar uma conexão
- Selecione a conexão na lista.
- Clique no botão Edit (ícone de lápis).
- Atualize os campos necessários.
- Teste a conexão novamente.
- Clique em Save.
Testar a conexão
- Selecione a conexão na lista.
- Clique no botão Test (ícone de atualização).
- Verifique se a conexão ainda está funcionando.
- Isso é útil para diagnosticar problemas ou verificar credenciais.
Excluir uma conexão
- Selecione a conexão na lista.
- Clique no botão Delete (ícone de lixeira).
- Confirme a exclusão.
Solução de problemas
Falha no teste de conexão
- Chave de API inválida:
- Verifique se você copiou toda a chave corretamente.
- Verifique se há espaços ou caracteres extras.
- Gere novamente a chave no portal do seu provedor, se necessário.
- URL de endpoint inválida:
- Certifique-se de que a URL está completa e corretamente formatada.
- Verifique se a URL corresponde ao seu recurso do Azure.
- Verifique se há erros de digitação no caminho da implantação (deployment).
- Nome de modelo incorreto:
- Confirme que a implantação (deployment) existe no seu portal do Azure.
- Verifique a grafia e o uso de maiúsculas/minúsculas (diferencia maiúsculas de minúsculas).
- Verifique se a implantação (deployment) está ativa e disponível.
- Problemas de rede:
- Verifique sua conexão 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 se conectar ao provedor de LLM.
- Cota ou permissões:
- Verifique se sua assinatura está ativa.
- Verifique se você não excedeu os limites de requisições (rate limits).
- Certifique-se de que sua chave de API tenha as permissões necessárias.
Conexão funciona no teste, mas falha em Skills
- 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.
- Verifique se a Skill está publicada e não em modo de rascunho.
Custos de API acima do esperado
- Verifique quais skills estão usando a conexão.
- Confira o volume e a frequência de processamento.
- Considere implementar limitação de taxa de requisições.
- Monitore o uso no painel do seu provedor.
- Use modelos mais econômicos para testes.
Melhores práticas
Segurança
- Nunca compartilhe chaves de API em e-mails ou chats em texto simples.
- Faça a rotação das credenciais regularmente (recomenda-se a cada 90 dias).
- Use conexões separadas para desenvolvimento e produção.
- Monitore os logs de acesso no painel do 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 casos de emergência.
Gerenciamento de conexões
- Use nomes descritivos que indiquem o propósito ou o ambiente.
- Bom: “Production GPT-4”, “Development Microsoft Foundry”
- Evite: “Connection 1”, “Test”
- Documente nas descrições para que serve cada conexão
- Incluir: ambiente, caso de uso, contato do responsável
- Excluir: credenciais, informações confidenciais
- Teste as conexões regularmente para identificar problemas com antecedência
- 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 o 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 seu provedor.
- Analise 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 documentos semelhantes
- Configure as Skills de Documento adequadas para o seu caso de uso
- Teste com documentos de exemplo antes do uso em produção
- Documente seu fluxo de trabalho para referência da equipe
Compreendendo os Tipos de Conexão
OpenAI ChatGPT
- Acesso direto aos modelos mais recentes da OpenAI
- Configuração simples com apenas uma chave de API
- Organizações que já utilizam a plataforma OpenAI
- Os dados são processados pela infraestrutura da OpenAI
- Sujeito aos termos e às políticas de dados da OpenAI
- Exige uma conta na OpenAI e acesso à API
Microsoft Foundry
- Implantações corporativas com infraestrutura no Azure
- Organizações que exigem controles de residência de dados
- Integração com outros serviços do Azure
- Recursos aprimorados de segurança e conformidade
- Acesso ao OpenAI e a outros modelos de IA por meio do Azure
- Organizações com assinaturas do Azure já existentes
- Requer assinatura do Azure e configuração do Microsoft Foundry
- Mais configuração (url de endpoint com caminho completo, nome do modelo, versão da API)
- Os modelos disponíveis podem diferir do acesso direto ao 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
- Documentação da API OpenAI: https://platform.openai.com/docs
- Microsoft Foundry: https://azure.microsoft.com/products/ai-foundry
- Documentação dos Serviços de IA do Azure: https://learn.microsoft.com/azure/ai-services/
- Suporte: Entre em contato com o suporte da ABBYY para obter assistência técnica
Resumo
- ✅ Acessou as configurações na seção Configuration
- ✅ Navegou até o gerenciamento de Connections
- ✅ Adicionou uma nova conexão LLM
- ✅ Configurou as credenciais e demais parâmetros da conexão
- ✅ Testou sua conexão
- ✅ Aprendeu como gerenciar conexões