创建知识库-j9九游会登录
功能介绍
该接口用于创建知识库,创建的知识库启用后可在创建agent时引用。
调用方法
请参见。
uri
post https://aiae.appstage.myhuaweicloud.com/v1/knowledge-bases
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
authorization |
是 |
string |
参数解释: 鉴权信息。获取平台api key,并为api key添加前缀bearer,得到标准鉴权信息,例如bearer sk-74e4157***。api key获取方法请参见创建api key。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
string |
参数解释: 知识库名称。 约束限制: 不涉及。 取值范围: 支持中英文、数字、“_”,长度为[2-50],以中英文、数字开头。 默认取值: 不涉及。 |
|
description |
否 |
string |
参数解释: 知识库描述。 约束限制: 不涉及。 取值范围: 只能包含英文,中文,数字,下划线,中划线,空格及,.?:;"':;“”’‘,。?、()()/等符号,最长255个字符。 默认取值: 不涉及。 |
|
retrieval_status |
是 |
string |
参数解释: 知识库召回状态。 约束限制: 不涉及。 取值范围: 枚举值:enable(启用召回)、disable(禁用召回)。 默认取值: 不涉及。 |
|
rag_type |
否 |
string |
参数解释: 知识库rag类型。 约束限制: 不涉及。 取值范围: 可以为空,为空则使用默认值。枚举值:vector_rag(向量rag,是一种结合了向量化和大语言模型的rag技术)、graph_rag(知识图谱rag,是一种结合了知识图谱和大语言模型的rag技术)。 默认取值: vector_rag。 |
|
retrieval_config |
否 |
retrievalconfig object |
参数解释: 知识库检索召回配置。 约束限制: 不涉及。 取值范围: 可以为空,为空则使用默认值。 默认取值: 若不传,则检索配置(retrieval_config)中,检索模式(retrieval_modes)默认为语义检索(semantic_retrieval)。 |
|
knowledge_data_sets |
是 |
array of knowledgedataset objects |
参数解释: 知识数据集信息列表,选择知识数据集创建知识库。 约束限制: 不涉及。 取值范围: 不允许为空,数量最小为1,最大为5。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
retrieval_modes |
是 |
array of strings |
参数解释: 检索模式,用于设置知识库检索召回时的检索方式。 约束限制: 不涉及。 取值范围: 可传多个值。枚举值:
默认取值: 不涉及。 |
|
retrieval_hybrid_mode |
否 |
string |
参数解释: 此参数用于指定混合检索的模式。 “retrieval_modes”选择semantic_retrieval和full_text_retrieval时,为混合检索。 约束限制: “retrieval_modes”选择semantic_retrieval和full_text_retrieval。 取值范围: 支持rrf,枚举值:rrf。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
data_set_id |
是 |
string |
参数解释: 知识数据集id,获取方式:
约束限制: 需要先调用创建知识数据集接口,接口返回即为知识数据集id。 取值范围: 仅支持数字、字母和中划线。 默认取值: 不涉及。 |
|
data_set_version |
是 |
string |
参数解释: 数据集版本。 约束限制: 需根据知识数据集id,调用查询数据集详情接口,获取版本。 取值范围: 格式为:v2024-11-21t11:36:55z。 默认取值: 不涉及。 |
|
index_config_id |
是 |
string |
参数解释: 索引配置id。 约束限制: 需根据知识数据集id,调用查询数据集详情接口,获取索引配置id。 取值范围: 仅支持数字、字母和中划线。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
string |
参数解释: 正常返回的结果。 取值范围: 不涉及。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
string |
参数解释: 异常错误码。 取值范围: 不涉及。 |
|
error_msg |
string |
参数解释: 异常错误信息。 取值范围: 不涉及。 |
请求示例
{
"name" : "知识库名称",
"description" : "知识库描述",
"retrieval_status" : "enable",
"rag_type" : "vector_rag",
"retrieval_config" : {
"retrieval_modes" : [ "semantic_retrieval", "full_text_retrieval" ],
"retrieval_hybrid_mode" : "rrf"
},
"knowledge_data_sets" : [ {
"data_set_id" : "djh28e62-xxxxxxxxx-a15be0d63812",
"data_set_version" : "v2024-11-21t11:36:55z",
"index_config_id" : "d3f28e62-xxxxxxx-a15be0d638a2"
} ]
}
响应示例
状态码:200
操作成功,返回知识库id。
{
"data" : "3f28e62-xxxxxxxx-a15be0d638a2"
}
状态码:400
请求错误。
{
"error_code" : "aiae.40001001",
"error_msg" : "参数xxxx不合法。"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
操作成功,返回知识库id。 |
|
400 |
请求错误。 |
错误码
请参见错误码。
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨