# BIC-QA

**Repository Path**: BIC-QA/bic-qa

## Basic Information

- **Project Name**: BIC-QA
- **Description**: BIC-QA是一个数据库知识智能问答系统，API服务器将为用户提供免费的知识检索服务，安装插件后，可以使用简单的对话界面向知识问答服务提问，API服务将会根据你的问题返回检索结果，再由大模型进行加工输出最终结果。对大模型规模要求极低，使用本地显卡部署的QWEN3:8B即可得到比较完美的效果
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 29
- **Forks**: 2
- **Created**: 2025-08-15
- **Last Updated**: 2025-11-11

## Categories & Tags

**Categories**: rag

**Tags**: None

## README

# BIC-QA 智能问答助手

<div align="center">

## 🌐 语言选择 / Language Selection

[![中文版](https://img.shields.io/badge/📖_中文版_README-blue?style=for-the-badge&logo=github)](README.md) [![English Version](https://img.shields.io/badge/📖_English_README-green?style=for-the-badge&logo=github)](README_EN.md)

</div>

## 📖 产品介绍

**BIC-QA（Business Intelligence & Knowledge Query Assistant）** 是一款专为企业级数据库知识管理而设计的智能问答系统。作为新一代数据库知识检索解决方案，BIC-QA 致力于为数据库管理员、开发人员和运维工程师提供高效、精准的知识查询服务。

### 🎯 核心定位
BIC-QA 是一个全面的数据库知识问答平台，支持所有主流数据库系统，特别针对国产数据库生态进行了深度优化。系统集成了丰富的数据库知识库，涵盖 SQL 语法、性能优化、故障诊断、最佳实践等全方位内容，为用户提供即问即答的专业数据库技术支持。

### 🗄️ 数据库支持
- **国际主流数据库**：Oracle、MySQL、PostgreSQL、SQL Server、MongoDB、Redis 等
- **国产数据库优先支持**：达梦数据库（DM）、人大金仓（KingBase）、OceanBase、GoldenDB、华为 GaussDB、腾讯 TDSQL 等

### 🚀 技术优势
- **智能语义理解**：基于先进的 NLP 技术，准确理解用户查询意图
- **知识图谱构建**：构建完整的数据库知识关联网络，提供上下文相关的答案
- **实时知识更新**：持续更新数据库版本特性和最佳实践
- **多维度检索**：支持按数据库类型、问题类型、技术领域等多维度精准检索

<div align="center">
<img src="icons/logo.png" alt="BIC-QA Logo" width="600" height="150">

**功能强大的浏览器扩展插件，提供智能问答与知识库检索服务**

[![Chrome Web Store](https://img.shields.io/badge/Chrome-Web%20Store-blue?logo=google-chrome)](https://chrome.google.com/webstore)
[![Edge Add-ons](https://img.shields.io/badge/Edge-Add--ons-blue?logo=microsoft-edge)](https://microsoftedge.microsoft.com/addons)
[![Version](https://img.shields.io/badge/Version-v1.0.5-green)](https://github.com/your-repo/BIC-QA)
[![License](https://img.shields.io/badge/License-MIT-yellow)](LICENSE)

</div>

<div align="center">

## 🚀 立即下载

[![Download](https://img.shields.io/badge/📥_立即下载_BIC--QA_v1.0.7-orange?style=for-the-badge&logo=download)](https://gitee.com/BIC-QA/bic-qa/releases/download/v1.0.7/BIC-QA_v1.0.7.zip)

**版本**: v1.0.7 | **大小**: ~15MB | **更新日期**: 2025年11月

</div>

## 📋 目录

- [🚀 快速开始](#-快速开始)
- [⚙️ 配置指南](#️-配置指南)
- [🔧 高级功能](#-高级功能)
  - [📊 AWR 报告分析功能](#-awr-报告分析功能)
- [🛠️ 故障排除](#️-故障排除)
- [📱 系统要求](#-系统要求)
- [🔒 隐私安全](#-隐私安全)
- [📞 技术支持](#-技术支持)


## 🚀 快速开始

### 📦 安装扩展

1. 下载扩展文件到本地
2. 打开浏览器扩展管理页面
3. 启用开发者模式
4. 点击"加载已解压的扩展程序"
5. 选择扩展文件夹

### ⚡ 四步配置

#### 步骤 1：用户注册

![用户注册界面](assets/image-20250815140746815.png)

1. 打开扩展设置页面
2. 填写用户名、企业名称和邮箱地址
3. 点击 **保存** 按钮
4. 查收邮件获取 API Key

> ⚠️ **重要提醒**：请勿随意修改默认 URL，以免影响插件正常运行。如已修改，请重置设置恢复默认值。

#### 步骤 2：知识库服务配置

![知识库配置](assets/image-20250815140930391.png)

1. 进入知识库服务配置页面
2. 将邮件中的 API Key 填入对应字段
3. 点击 **保存** 完成配置

#### 步骤 3：AI 模型配置

##### 3.1 配置服务商接口

![模型服务商配置](assets/image-20250815141625955.png)

1. 打开 **设置** → **模型与服务商**
2. 添加服务商（如 `ollama`、`deepseek` 等）
3. 填写对应的 **API 地址** 和 **API Key**（如需要）

**本地 Ollama 配置示例**：
```bash
API 地址：http://localhost:11434/v1
```

4. 点击 **测试** 连接，系统自动发现可用模型
5. 勾选所需模型，点击 **批量纳管** 保存

![模型纳管界面](assets/image-20250815141948338.png)

> 💡 **提示**：首页下拉菜单会显示 **模型名（服务商）** 格式，避免同名模型混淆。

##### 3.2 手动配置模型

![模型配置界面](assets/image-20250815142020584.png)

对于不支持自动发现的服务商：

1. 点击 **添加模型**
2. 填写模型名称、Token 限制、温度等参数
3. 点击 **保存** 完成配置

![模型参数设置](assets/image-20250815142317185.png)

#### 步骤 4：开始使用

1. 在首页选择已配置的 **模型（服务商）**
2. 从 **知识库** 下拉菜单选择目标知识库
3. 输入问题，点击 **发送** 或按回车键
4. 享受智能问答体验！

> 💡 **使用技巧**：开启知识库后，系统会自动加载最新配置并优先使用知识库服务。

## ⚙️ 配置指南

### 🔧 参数规则设置

BIC-QA 支持自定义提示词和检索参数，提供三种预设模式：

| 模式 | 温度 | 相似度 | 适用场景 |
|------|------|--------|----------|
| **创意模式** | 高 | 中等 | 需要创造性回答 |
| **精确模式** | 低 | 高 | 需要准确性优先 |
| **自定义模式** | 可调 | 可调 | 完全自定义需求 |

**可配置参数**：
- **提示词（Prompt）**：系统指令模板
- **温度（Temperature）**：控制回答随机性
- **相似度（Similarity）**：知识库检索阈值
- **TopN**：检索结果数量

> ⚠️ **参数影响**：温度越高创造性越强，相似度/TopN 影响知识库检索范围和数量。

## 🔧 高级功能

### 📊 AWR 报告分析功能

BIC-QA 提供了强大的 Oracle 数据库 AWR（Automatic Workload Repository）报告分析功能，帮助数据库管理员快速诊断数据库性能问题，获取专业的分析报告和优化建议。

#### 🎯 功能概述

AWR 分析功能可以：
- **智能解析**：自动解析 Oracle AWR 报告的 HTML 格式文件
- **深度分析**：基于 AI 大模型进行全面的性能问题诊断
- **专业报告**：生成结构化的分析报告，包含问题诊断和优化建议
- **多语言支持**：支持中文和英文分析报告
- **历史管理**：查看和管理历史分析记录，支持重新分析

> ⚠️ **版本说明**：AWR 报告分析功能当前为 Beta 测试版本。我们诚挚邀请您在使用过程中提供宝贵的意见和建议，您的反馈将帮助我们持续改进产品。当前版本无使用限制，可正常使用所有功能。

#### 📝 使用步骤

##### 1. 打开 AWR 分析功能

1. 在左侧导航栏中，点击 **"AWR分析(Analysis)"** 按钮
2. 系统将打开 AWR 分析对话框

##### 2. 新建分析任务

在 **"新建分析"** 标签页中，按以下步骤操作：

**步骤 1：填写系统问题概述（可选）**

- 在 **"系统问题概述"** 文本框中，描述您遇到的系统问题
- 例如："数据库响应缓慢"、"CPU 使用率过高"、"存在锁等待问题" 等
- ⚠️ **重要提示**：请填写相对明确的系统问题描述。如果不确定某些细节，建议不填写，以免误导 AI 模型的分析结果

**步骤 2：填写接收邮箱（必填）**

- 在 **"接收邮箱"** 输入框中，填写您的邮箱地址
- 分析完成后，系统会将分析报告发送到此邮箱
- 此字段为必填项（标记有 * 号）

**步骤 3：上传 AWR 报告文件（必填）**

- 点击 **"上传文件"** 按钮
- 选择您要分析的 Oracle AWR 报告 HTML 文件
- 支持标准的 Oracle AWR 报告格式（Oracle 10g、11g、12c、19c+ 等版本）
- 此字段为必填项（标记有 * 号）

**步骤 4：选择分析语言**

- 在 **"语言"** 下拉菜单中选择分析报告的语言
- 可选：**中文（Chinese）** 或 **English**
- 系统将根据您的选择生成对应语言的分析报告

**步骤 5：执行分析**

- 确认所有必填信息已填写完整
- 点击 **"执行分析"** 按钮提交分析任务
- 系统将开始处理您的 AWR 报告

##### 3. 查看历史记录

在 **"历史记录"** 标签页中，您可以：

**查看分析历史**
- 查看所有已提交的 AWR 分析任务记录
- 每条记录显示以下信息：
  - **创建时间**：任务提交的时间
  - **状态**：任务执行状态（成功/失败/处理中）
  - **文件名**：上传的 AWR 报告文件名
  - **问题描述**：提交时填写的问题描述
  - **邮箱**：接收报告的邮箱地址
  - **语言**：分析报告的语言

**筛选和搜索**
- **开始时间**：选择查询的开始日期
- **结束时间**：选择查询的结束日期
- **任务状态**：按状态筛选（全部/成功/失败/处理中）
- 点击 **"搜索"** 按钮执行筛选
- 点击 **"重置"** 按钮清除筛选条件

**重新分析**
- 对于历史记录，您可以点击 **"重新分析"** 按钮
- 系统将使用相同的参数重新执行分析任务
- 适用于需要更新分析结果或使用不同模型重新分析的场景

#### 💡 使用建议

1. **问题描述要准确**：如果明确知道系统存在的问题，建议详细描述，有助于 AI 模型更精准地分析相关指标
2. **不确定时不填写**：如果对问题描述不确定，建议留空，让 AI 进行全面分析
3. **检查邮箱地址**：确保邮箱地址正确，以便及时收到分析报告
4. **文件格式确认**：确保上传的是标准的 Oracle AWR 报告 HTML 文件
5. **定期查看历史**：通过历史记录功能，可以对比不同时期的分析结果，跟踪性能变化趋势

#### ⚠️ 注意事项

- AWR 报告文件大小限制：请确保上传的文件不超过系统限制
- 分析处理时间：根据报告大小和复杂度，分析可能需要几分钟时间
- 网络连接：确保网络连接稳定，以便成功上传文件和接收报告
- 邮箱接收：请检查邮箱的垃圾邮件文件夹，确保能正常接收分析报告

#### 🔍 分析报告内容

系统生成的 AWR 分析报告通常包含以下内容：

- **报告概览**：数据库版本、报告时间范围等基本信息
- **负载概况**：数据库整体负载情况分析
- **性能指标**：关键性能指标（如命中率、等待事件等）的详细分析
- **问题诊断**：识别出的潜在性能问题和瓶颈
- **优化建议**：针对发现问题的具体优化建议和解决方案
- **SQL 分析**：高负载 SQL 语句的分析和优化建议
- **等待事件分析**：等待事件的详细分析和处理建议

## 🛠️ 故障排除

### ❗ 常见问题

#### 1. 插件导入失败

**可能原因**：
- 解压出现文件损坏
- 浏览器选择插件时候没有选最后一层文件

**解决方案**：
- 选择的文件夹下有manifest.json,如下所示：

![导入文件层级](assets/q1-chajian.png)

#### 2. 请求失败
**可能原因**：
- 模型服务地址错误
- 网络连接问题
- API Key 无效
- 本地模型权限未放行

**解决方案**：
```bash
# 检查服务地址
curl http://localhost:11434/v1/models

# 验证网络连接
ping your-api-endpoint.com

# 配置本地环境变量
系统变量设置OLLAMA_ORIGINS值为*
```
![](./assets/ollama_origins.png)

#### 3. 模型无法加载
**可能原因**：
- Ollama 服务未启动
- API 地址格式错误
- 模型未正确部署

**解决方案**：
```bash
# 启动 Ollama 服务
ollama serve

# 检查模型列表
ollama list
```

#### 4. 知识库连接失败

**可能原因**：
- 知识库服务 URL 错误
- API Key 过期或无效
- 网络权限限制

**解决方案**：
- 检查知识库服务状态
- 重新获取 API Key
- 验证网络访问权限

### 🔍 调试步骤

1. **重新加载扩展**
   - 打开扩展管理页面
   - 点击重新加载按钮

2. **清除缓存**
   - 清除浏览器缓存和 Cookie
   - 重启浏览器

3. **检查控制台**
   - 按 F12 打开开发者工具
   - 查看 Console 错误信息

4. **验证配置**
   - 检查配置文件格式
   - 确认所有必填字段

## 📱 系统要求

### 🌐 浏览器支持
- **Chrome** 88+
- **Edge** 88+
- **其他基于 Chromium 的浏览器**


### 🌍 网络要求
- 支持 HTTPS/HTTP 请求
- 稳定的网络连接
- 防火墙允许扩展访问

## 🔒 隐私安全

### 🛡️ 数据保护
- **本地存储**：对话历史存储在本地
- **加密传输**：所有网络请求使用 HTTPS
- **权限控制**：最小化权限要求

### 🔐 安全特性
- **本地模型**：支持完全本地部署
- **API 密钥**：安全存储和传输
- **访问控制**：可配置网络访问权限

### 📋 隐私政策
- 不收集个人敏感信息
- 不向第三方分享数据
- 支持数据导出和删除

## 📞 技术支持

### 🆘 获取帮助
- **社区**：加入BIC-QA讨论群

<img src="assets/bic-qa-wechat.jpg" style="zoom: 30%;" />

- **反馈**：提交问题反馈

### 📧 联系方式
- **售后邮箱**：support@dbaiops.com
- **DBAIOps社区:**
<img src="assets/DBAIOps社区二维码.png" style="zoom:50%;" />
- **GitHub**：[提交 Issue](https://gitee.com/BIC-QA/BIC-QA/issues)

### 🔄 更新日志
- **v1.0.7**：新增 AWR 报告分析功能，支持 Oracle 数据库性能诊断
- **v1.0.6**：支持添加大模型服务商，修复已知问题
- **v1.0.5**：优化性能，修复已知问题
- **v1.0.4**：新增知识库功能
- **v1.0.3**：支持本地 Ollama 模型

---

<div align="center">

**BIC-QA 智能问答助手** - 让知识检索更智能，让问答更高效

**版本**：v1.0.7 | **更新日期**：2025年11月

[⭐ 给我们一个星标](https://github.com/your-repo/BIC-QA)  | [🐛 报告问题](https://github.com/your-repo/BIC-QA/issues)

</div>