mainbot

主机器人

多租户无头 RAG 聊天机器人。

这是使用检索增强生成的多租户聊天机器人的简单实现。

其中一些代码来自 Wanderling，但所有游戏特定功能和规则引擎都已被删除（尚未准备好开源）

快速启动

将example.env文件复制到.env
更新 openai 和 pinecone 的值。

 make dev

打开 http://localhost:8080/swagger-ui/index.html

概述

特征

• 用于多租户准备的命名空间向量存储
• 通过 JWT 标头进行 OAuth 身份验证
• 用户会话隔离
• 用户会话历史记录和延续
• 使用简单的嵌入管道将文档添加到矢量存储
• 检索增强生成作为默认聊天体验

身份验证选项

• 匿名的
• 智威汤逊
• OAuth2

对话存储选项

• 氢2
• Postgres

矢量存储选项

• 松果
• 开放搜索
• 记忆中

嵌入管道选项

• 开放人工智能
• 开放搜索
• 复制

昂首阔步

开始会话

发送消息

配置示例

Spring Profiles 用于配置应用程序。
请参阅一些示例配置（./src/main/resources/）[./src/main/resources/]

可以在 YAML、属性或环境变量中设置配置。

用于嵌入的 OpenAI 和用于矢量存储的 Pinecone

OPENAI_ENABLED=true
OPENAI_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxx
OPENAI_CHAT_MODEL_ID=gpt-3.5-turbo
PINECONE_ENABLED=true
PINECONE_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
PINECONE_PROJECT_NAME=my-project
PINECONE_INDEX=my-index
PINECONE_ENVIRONMENT=us-east4-gcp
APP_SECURITY_ENABLED=false

用于嵌入的 OpenAI 和用于矢量存储的 OpenSearch

有关更多详细信息，请参阅 application-opensearch.yml 中的应用程序配置。

SPRING_PROFILES_ACTIVE=opensearch
OPENAI_ENABLED=true
OPENAI_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxx
OPENAI_CHAT_MODEL_ID=gpt-3.5-turbo
OPENSEARCH_URL=https://localhost:9200

GitHub Action 上传

如果您将文档存储在存储库中，则可以轻松地将它们上传到 mainbot。
利用 GitHub Action 将文本/markdown 文件直接上传到 mainbot。

 name : Upload Files to Mainbot

on :
  workflow_dispatch : {} # Manually trigger the workflow
  push :
    branches :
      - main
    paths :
      - ' docs/** '
      - ' README.md '

jobs :
  upload :
    runs-on : ubuntu-latest
    steps :
      - name : Checkout repository
        uses : actions/checkout@v2
      
      - name : Upload Files
        uses : savantly-net/mainbot-github-action@main
        with :
          glob-patterns : ' *.md '  # Set your file pattern here
          namespace : ' /mainbot-documents '
          api-url : ' https://mainbot.my-company.apps.savantly.cloud '
          client-id : ${{ secrets.MAINBOT_CLIENT_ID }}
          client-secret : ${{ secrets.MAINBOT_CLIENT_SECRET }}
          token-endpoint : https://oidc.apps.savantly.cloud/realms/savantly/protocol/openid-connect/token 

后台整合

我们还构建了一个 Backstage 插件来与 mainbot 集成。
结合 Github 操作和 Techdocs 插件，您可以使所有文档立即在 Backstage 中可用并可在 mainbot 中搜索。