ask discord

Ask-Discord

Pesquisa semântica rápida em chamas por canais de discórdia

Visão geral

ask-discord permite que os usuários pesquisem semanticamente através de um conjunto de dados de mensagens Discord. Existem dois modos principais de pesquisa:

1. Raw : exibe as mensagens mais semelhantes com base na similaridade ANNS e cosseno.
2. LLM : alimenta resulta em um LLM para gerar uma resposta semelhante a chatbot.

Começando

Pré -requisitos

• Docker
• Chave da API OpenAI
• Milvus 2.4.4
• Python 3.12.3

Instalação

1. Clone o repositório :

   git clone https://github.com/yourusername/ask-discord.git
   cd ask-discord

2. Instale dependências :

   pip install -r requirements.txt

3. Configurar variáveis ​​de ambiente : Crie um arquivo .env no diretório raiz e adicione sua tecla API OpenAI:

    OPENAI_KEY = your_openai_api_key

4. Inicie Milvus : Siga o Guia de instalação do Milvus para configurar e iniciar o Milvus. (Requer uma instalação recente do Docker)

Executando o aplicativo

1. Gere os dados : faça o download de seus canais de interesse usando o Discord Chat Exports. Leia este guia se tiver problemas para obter seus IDs de token e canal. Este não é um endosso, pois os canais de download podem violar os TOS da discórdia.

2. Carregue os dados : verifique se o arquivo de dados JSON está no caminho correto especificado nas configs . Modifique o caminho no arquivo principal, se necessário.

3. Execute o aplicativo StreamLit :

   streamlit run ask-discord.py

4. Acesse o aplicativo : abra seu navegador da web e vá para http://localhost:8501 .

Documentação

Arquivos de projeto

• Ask-Discord.py : ponto de entrada principal no aplicativo Streamlit. Ele inicializa as configurações, se conecta a Milvus e OpenAI e configura o banco de dados e o chatbot.
• load_data.py : lida com o carregamento e processamento dos dados do JSON Discord e gerencia a coleção Milvus.
• Chatbot.py : contém a classe de Chatbot que lida com a consulta de milvus e interagindo com o modo Raw/LLM.

Configuração

As configurações são gerenciadas por meio de um dicionário em ask-discord.py . Estes incluem:

• OPENAI_CLIENT : Instância do cliente OpenAI.
• CHAT_MODEL : o modelo a ser usado para bate-papo (por exemplo, gpt-4o ).
• EMBEDDING_MODEL : o modelo a ser usado para gerar incorporações.
• JSON_DATA_PATH : caminho para o arquivo de dados JSON.
• EMBEDDING_DIMENSIONS : dimensões vetoriais.
• MAX_MESSAGE_LENGTH : número máximo de caracteres em uma mensagem a ser considerada.
• MIN_MESSAGE_LENGTH : número mínimo de caracteres em uma mensagem a ser considerada.
• COLLECTION_NAME : Nome da coleção Milvus.
• MAX_SIMILAR_EXAMPLES : número máximo de mensagens semelhantes para recuperar.
• SIMILARITY_SCORE_CUTOFF : corte para a pontuação de similaridade.

Contribuindo

As contribuições são bem -vindas! Envie uma solicitação de tração ou abra um problema para discutir quaisquer alterações.

Licença

Este projeto está licenciado sob a licença do MIT. Consulte o arquivo de licença para obter mais detalhes.

Agradecimentos

• Exportador de bate -papo com discórdia