更新时间：2024-09-05 GMT+08:00
KnowledgeRetriever
导入KnowledgeRetriever
from wiseagent_dev_sdk_python.modules.knowledge_db import KnowledgeRetriever
KnowledgeRetriever提供了知识库检索的能力，可以检索开发者的知识库，提取相关的信息。
实例化
|
参数名 |
参数类型 |
是否必选 |
参数描述 |
|---|---|---|---|
|
base_url |
str |
False |
模型网关开放的ip和端口，有默认值可以不填。功能类似OpenAI的base_url。 |
|
custom_hearders |
dict |
False |
其他自定义请求头信息。 |
|
http_client |
httpx.client |
False |
自定义的httpx client。 |
|
kwargs |
- |
False |
其他可选参数，如api_key、timeout等。 |
接口调用
KnowledgeRetriever.retrieve
参数说明
|
参数名称 |
参数类型 |
是否必选 |
参数描述 |
|---|---|---|---|
|
vector_index_id |
str |
True |
知识库id |
|
query |
str |
False |
输入内容 |
|
top_n |
int |
False |
返回条数限制 |
|
offset |
int |
False |
起始位置 |
|
similarity_min |
float |
False |
返回相似性最小值阈值 |
|
filter |
dict |
False |
过滤条件 |
|
order_by |
dict |
False |
排序条件 |
返回值
EmbedData对象列表。
|
键 |
值类型 |
描述 |
|---|---|---|
|
id |
str |
唯一标识 |
|
document |
str |
知识库内容 |
|
metadata |
dict |
知识库元数据 |
|
similarity |
float |
匹配相似度 |
父主题： modules模块
