Introdução geral
O Base Chat é um chatbot multilocatário que usa o Conexão Ragie conectar e conversar com a base de conhecimento da organização. O projeto é Ragie Um aplicativo de referência com vários recursos, desenvolvido em Next.js, com suporte para a autenticação do Google. O Base Chat foi projetado para ajudar os usuários a interagir com a base de conhecimento de sua organização por meio de um chatbot, oferecendo uma maneira conveniente de acessar e gerenciar o conhecimento. O projeto ainda está em desenvolvimento ativo e as versões futuras poderão sofrer alterações significativas.
Lista de funções
- Suporte a vários locatáriosPermite que várias organizações usem a mesma instância de chatbot.
- Integração do Ragie ConnectConecte-se à base de conhecimento de sua organização por meio do Ragie Connect.
- Autenticação do GoogleAutenticação: Os usuários são autenticados usando a autenticação do Google fornecida pelo Auth.js.
- Gerenciamento de banco de dadosBanco de dados PostgreSQL: Usa um banco de dados PostgreSQL para armazenar e gerenciar dados.
- Configuração da variável de ambienteConfigure as variáveis de ambiente por meio do arquivo .env.
- Migração de banco de dadosUse o script npm para a migração do banco de dados.
- modelo de desenvolvimentoSuporte à inicialização rápida e à depuração no modo de desenvolvimento.
Usando a Ajuda
Processo de instalação
- projeto de clonagemClone o projeto Base Chat do GitHub.
git clone https://github.com/ragieai/basechat.git
cd basechat
- Instalação de dependênciasInstalação das dependências do projeto usando o npm.
npm install
- Criação de um banco de dadosCriar um arquivo chamado
basechat
Banco de dados PostgreSQL. - Configuração de variáveis de ambiente: Reprodução
env.example
arquivo é.env
e definir variáveis de ambiente conforme necessário.
cp env.example .env
- Migração de banco de dadosExecute o script de migração do banco de dados.
npm run db:migrate
- Iniciando o servidor de desenvolvimentoIniciar o projeto no modo de desenvolvimento.
npm run dev
Guia de operação de funções
- autenticação do usuárioOs usuários são obrigados a se autenticar com uma conta do Google na primeira visita, garantindo a segurança e a autenticação do usuário.
- Conexão com a base de conhecimentoRagie Connect: conecta-se à base de conhecimento da organização por meio do Ragie Connect, permitindo que os usuários consultem e acessem informações na base de conhecimento por meio de um chatbot.
- gerenciamento de vários locatáriosSuporte ao uso simultâneo por várias organizações, com administradores capazes de configurar bases de conhecimento e permissões de usuário separadas para diferentes organizações.
- Configuração da variável de ambiente: em
.env
para configurar as variáveis de ambiente necessárias, como informações de conexão com o banco de dados, informações de autenticação do Google e assim por diante. - Gerenciamento de banco de dadosBanco de dados PostgreSQL: Um banco de dados PostgreSQL é usado para armazenar dados de usuários e transcrições de bate-papo, garantindo a segurança e a capacidade de gerenciamento dos dados.
- modelo de desenvolvimentoNo modo de desenvolvimento, os desenvolvedores podem iniciar e depurar projetos rapidamente, realizar testes funcionais e fazer alterações no código.