Skip to content

Commit

Permalink
Docs: add data search update OneAPI guide and wechat (#607)
Browse files Browse the repository at this point in the history
* Docs:update OneAPI guide

* Docs:update use-cases weachat

* Docs:add data search
  • Loading branch information
zuoFeng59556 authored Dec 15, 2023
1 parent 7630417 commit 7b5c350
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 24 deletions.
Binary file added docSite/assets/imgs/data_search1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 40 additions & 0 deletions docSite/content/docs/course/data_search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: '知识库搜索参数'
description: '知识库搜索原理'
icon: 'language'
draft: false
toc: true
weight: 106
---

在知识库搜索的方式上,FastGPT提供了三种方式,分别为“语义检索”“增强语义检索”“混合检索”。

![](/imgs/data_search1.png)

## 语义检索

语义检索就是向量检索,同时把用户的问题和知识库内容向量化,然后通过“语义相关度匹配”的方式从知识库中查找到匹配的知识点。

优点:
- 相近语义理解
- 跨多语言理解(例如输入中文问题匹配英文知识点)
- 多模态理解(文本,图片,音视频等)

## 增强语义检索

在语义检索的基础上,增强“语义相关度匹配”并在搜索结束后进行 Rerank(重排)。

Rerank(重排):把检索结果按“与用户问题语义”相关性,从高到低排序,简单的说就是把最匹配用户问题的检索结果排在前面。

## 混合检索(推荐)


在向量检索的同时进行全文检索,并把两项检索的结果混合一起重排,以便选中匹配用户问题的最佳结果。

全文检索:理解为全文关键词检索,通过关键词查询知识库,并返回包含关键词的文本片段。

优点:
- 精确匹配(姓名,编号,ID等)
- 少量关键词匹配(当用户问题字数过少时向量检索效果非常不好)

混合检索结合了向量检索和全文检索的优点,并且对查询结果进行了重排,大大提高了命中率,推荐使用。
2 changes: 1 addition & 1 deletion docSite/content/docs/development/one-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ BATCH_UPDATE_ENABLED=true
BATCH_UPDATE_INTERVAL=60
```

## 使用步骤
## One API使用步骤

### 1. 登录 One API

Expand Down
23 changes: 2 additions & 21 deletions docSite/content/docs/development/sealos.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ FastGPT 商业版共包含了3个应用(fastgpt, fastgpt-plus, fastgpt-admin
点击右侧的详情,可以查看对应应用的详细信息。

### 如何更新/升级 FastGPT
[升级脚本文档](https://doc.fastgpt.in/docs/installation/upgrading/)先看下文档,看下需要升级哪个版本。注意,不要跨版本升级!!!!!
[升级脚本文档](https://doc.fastgpt.in/docs/development/upgrading/)先看下文档,看下需要升级哪个版本。注意,不要跨版本升级!!!!!

例如,目前是4.5 版本,要升级到4.5.1,就先把镜像版本改成v4.5.1,执行一下升级脚本,等待完成后再继续升级。如果目标版本不需要执行初始化,则可以跳过。

Expand Down Expand Up @@ -191,23 +191,4 @@ SYSTEM_FAVICON 可以是一个网络地址

### One API 使用

One API 管理默认账号密码为: root 123456

首先在sealos中找到 one-api 开头的应用。
![](/imgs/onsealos10.png)

点击详情,进入应用详情页。

![](/imgs/onsealos11.png)

#### 概念介绍

OneAPI 会将不同的模型(GPT,向量模型,文心一言,GLM 等)集中起来管理,并通过暴露一个 key 给 FastGPT 进行访问。FastGPT 中只需要填 OneAPI 的地址及令牌即可。

![](/imgs/onsealos12.png)

#### 注意

OpenAI 渠道务必添加 Embedding 模型,否则无法使用知识库。一般用 openai 的话,直接点填入基础模型即可。

![](/imgs/onsealos13.png)
[参考 OneAPI 使用步骤](http://localhost:1313/docs/development/one-api/#one-api%E4%BD%BF%E7%94%A8%E6%AD%A5%E9%AA%A4)
3 changes: 1 addition & 2 deletions docSite/content/docs/use-cases/wechat.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ weight: 506
AIBOTK_KEY=微秘书 APIKEY
AIBOTK_SECRET=微秘书 APISECRET
WORK_PRO_TOKEN=你申请的企微 token (企业微信需要填写,私人微信不需要)
WECHATY_PUPPET_SERVICE_AUTHORITY=token-service-discovery-test.juzibot.com(企业微信需要填写,私人微信不需要)
```

这里最后两个变量只有部署企业微信才需要,私人微信只需要填写前两个即可。
Expand All @@ -56,7 +55,7 @@ WECHATY_PUPPET_SERVICE_AUTHORITY=token-service-discovery-test.juzibot.com(企

![](/imgs/wechat7.png)

`WORK_PRO_TOKEN` [点击这里](https://tss.juzibot.com?aff=aibotk)申请 token 然后填入即可。
`WORK_PRO_TOKEN` [点击这里](https://tss.rpachat.com/?aff=aibotk)申请 token 然后填入即可。

`WECHATY_PUPPET_SERVICE_AUTHORITY`的值复制过去就可以。

Expand Down

0 comments on commit 7b5c350

Please sign in to comment.