Introdução geral
O Onyx (anteriormente conhecido como Danswer) é uma plataforma de bate-papo de IA de código aberto desenvolvida pela equipe do onyx-dot-app para ajudar as organizações a integrar e gerenciar documentos, aplicativos e dados de funcionários. Ela oferece uma rica funcionalidade de bate-papo, suporta a conexão com qualquer Modelo de Linguagem Grande (LLM) e sincroniza o conhecimento e o acesso por meio de mais de 40 conectores (por exemplo, Google Drive, Slack, Confluence etc.). O Onyx é compatível com uma implementação flexível, executada em laptops, servidores locais ou na nuvem, com uma licença MIT gratuita para a Community Edition e uma Enterprise Edition que oferece recursos avançados, como Single Sign-On (SSO), para equipes que precisam de gerenciamento de conhecimento eficiente e suporte de IA.
Lista de funções
- Bate-papo inteligente com IAInteraja com documentos e dados corporativos por meio de linguagem natural.
- Pesquisa em várias plataformasRecupere o conteúdo de conhecimento da equipe em vários aplicativos.
- Mais de 40 conectores de dadosFerramentas de encaixe como Google Drive, Slack, Salesforce e muito mais.
- Agentes de IA personalizadosConfigure um assistente de IA com dicas, conhecimentos e ações exclusivas.
- processamento multimodalSuporte a uma ampla variedade de tipos de dados, como texto, imagens, etc.
- Integração arbitrária do LLMConexão de modelos de idiomas grandes externos ou auto-hospedados.
- Acesso no aplicativoUse o Onyx diretamente no Slack, no Teams e em outras ferramentas.
- gerenciamento de segurançaSSO: fornece SSO, permissões de função e criptografia.
- Ferramentas de gerenciamento de conhecimentoSuporte para conjuntos de documentos, histórico de consultas e análise de uso.
- Implementação escalávelAlta disponibilidade via Docker ou Kubernetes.
Usando a Ajuda
Processo de instalação
O Onyx oferece suporte a uma variedade de métodos de implantação. A implantação local do Docker a seguir é um exemplo, com descrição detalhada das etapas da operação:
pré-condições
- Instale o Docker (recomenda-se a versão 20.10+) e o Docker Compose.
- Requisitos de hardware: mínimo de 4 GB de RAM, CPU de dois núcleos, 8 GB de RAM recomendados.
- Conexão de rede para fazer download de imagens e dependências.
Etapas de instalação
- Obter código
Abra um terminal e clone o repositório Onyx:
git clone https://github.com/onyx-dot-app/onyx.git
Vá para o diretório do Docker:
cd onyx/deployment/docker_compose
- Ambiente de configuração
- A configuração padrão é executada sem modificações.
- Para personalização (por exemplo, alteração de LLMs ou portas), edite o arquivo
docker-compose.dev.yml
ou criar.env
para adicionar uma chave, por exemplo:OPENAI_API_KEY=sua-openai-key
- Início dos serviços
Execute o seguinte comando para extrair a imagem e executá-la:
docker compose -f docker-compose.dev.yml -p onyx-stack up -d --pull always --force-recreate
- A primeira execução leva de 5 a 15 minutos, dependendo da rede e do hardware.
- Verifique o status do contêiner:
docker ps
seguro
servidor api
eservidor web
etc. estão funcionando corretamente.
- Plataformas de acesso
- Entrada do navegador
http://localhost:3000
Entre na interface do Onyx. - O uso inicial requer a inserção de uma chave de API do LLM (por exemplo, chave OpenAI), o que pode ser feito em Settings (Configurações).
- resolução de falhas
- Se não conseguir acessá-lo, verifique o registro:
Registros do docker onyx-stack_api_server_1
- Se for solicitado que a memória seja insuficiente, ajuste a alocação de memória do Docker (Docker Desktop > Settings > Resources).
Outras opções de implementação
- Nuvem Onyx: Acessocloud.onyx.app/signupRegistre-se e use-o sem instalação.
- Kubernetes: Referência
implantação/helm
adequado para implantação em larga escala.
Funções principais
1. bate-papo inteligente com IA
- Como chegar à interfaceApós fazer o login, clique em "Chat" no lado esquerdo.
- Seleção de uma fonte de dadosMarque o documento ou aplicativo de destino no painel esquerdo.
- fazer perguntasDigite uma pergunta como, por exemplo, "Onde estão os projetos mais recentes programados?". .
- Ajuste das configuraçõesClique no ícone de engrenagem para selecionar LLM ou para ajustar os parâmetros.
- Manutenção de registrosClique em "Save" (Salvar) para armazenar o diálogo.
2. pesquisa entre plataformas
- Acesso à pesquisaClique em "Search" (Pesquisar) na parte superior.
- Inserir palavras-chave:: por exemplo, "2024 sales data" (dados de vendas de 2024).
- Filtrar resultadosFiltro por fonte (por exemplo, Google Drive) ou hora.
- Respostas inteligentesAtivar "AI Answer" para obter uma resposta resumida.
3. configuração do conector de dados
- Adicionar conexãoConectores: Vá para "Admin" > "Connectors".
- Selecionar aplicativoClique na ferramenta de destino (por exemplo, Slack) e siga as instruções para autorizar.
- Dados sincronizadosDefina o intervalo de sincronização (por exemplo, de hora em hora) e salve a configuração.
- validar (uma teoria)Teste a capacidade de recuperação de novos dados em "Search".
4. personalização de agentes de IA
- Criação de um proxyClique em "New" (Novo) em "Admin" > "AI Assistants" (Assistentes de IA).
- Dicas de configuraçãoDigite instruções como "Responda às perguntas como um especialista em RH".
- Dados de ligaçãoSelecione o documento ou o conector relevante.
- uso de testeMudar para o novo agente no "Chat" e digitar a pergunta para verificação.
5. acesso no aplicativo
- Integração com o SlackAdicione o Onyx Bot no Slack e autorize conforme solicitado.
- Uso: Entrada
@Onyx Encontre as atas de ontem
Obtenha uma resposta. - Suporte às equipesProcesso semelhante, requer permissões do Enterprise Edition.
Exemplo de fluxo de operação
tomarDocumentação: encontre a documentação mais recente da equipe e faça perguntas.
- Faça login no Onyx e vá para "Search" (Pesquisar).
- Digite "Latest Documents" (Documentos mais recentes) e filtre a fonte para "Confluence".
- Para visualizar os resultados, verifique o documento de destino.
- Mude para "Chat" e pergunte "What are the new features mentioned in the document?" (Quais são os novos recursos mencionados no documento?). Pergunte "What are the new features mentioned in the docs?
- Obtenha a resposta da IA e clique em "Share" para gerar um link para compartilhamento.
Recursos avançados
- Configurações de segurançaEnterprise Edition oferece suporte a SSO (por exemplo, OAuth2), configurado em "Admin" > "Security".
- Análise de usoVerifique a frequência de consultas e perguntas populares no Analytics.
- implantação em massaKubernetes oferece suporte ao processamento de vários milhões de documentos, consulte a documentação oficial.
A natureza de código aberto e a implementação flexível do Onyx facilitam o início das atividades, e a documentação detalhada e o suporte de registro permitem a rápida resolução de problemas.