文档

CreateLibrary - 创建文档库

更新时间:

创建文档库。创建一个新的文档库,文档库用作隔离文档信息、索引信息,如果使用场景中需要经常按类别去做自然语言检索,建议创建多个文档库,来隔离不同类型的数据。支持按照格式自定义向量索引和文本索引。

接口说明

前提条件

已开通 百炼服务和通义点金服务。

获取到 workspaceId:获取 workspace 标识

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /{workspaceId}/api/library/create

请求参数

名称类型必填描述示例值
workspaceIdstring

业务空间 id

llm-ik******RVYCKzt
bodyobject

请求体。

descriptionstring

文档库的描述

描述文档库的具体作用
indexSettingobject

文档库的索引设置

chunkStrategyobject

分段策略

docTreeSplitboolean

版面切分

true
docTreeSplitSizeinteger

版面切分大小

300
enhanceGraphboolean

是否解析文档中的图片内容

true
enhanceTableboolean

是否解析文档中的表格内容

true
overlapinteger

chunk 重叠长度

20
sentenceSplitboolean

按句子切分

true
sentenceSplitSizeinteger

按句子切分大小

300
sizeinteger

chunk 大小

300
splitboolean

是否切块

true
modelConfigobject

模型配置

temperaturedouble

用于控制模型回复的随机性和多样性。具体来说,temperature 值控制了生成文本时对每个候选词的概率分布进行平滑的程度。较高的 temperature 值会降低概率分布的峰值,使得更多的低概率词被选择,生成结果更加多样化;而较低的 temperature 值则会增强概率分布的峰值,使得高概率词更容易被选择,生成结果更加确定。

取值范围: [0, 2),不建议取值为 0,无意义。

0.8
topPdouble

生成过程中的核采样方法概率阈值,例如,取值为 0.8 时,仅保留概率加起来大于等于 0.8 的最可能 token 的最小集合作为候选集。取值范围为(0,1.0),取值越大,生成的随机性越高;取值越低,生成的确定性越高。

0.8
promptRoleStylestring

prompt 风格角色。通过指定角色,描述语气风格,来控制最终回答质量。如:文档分析专家、温柔的客服、专业的金融行业分析师。

你是一位信息处理专家,耐心、友好、逻辑清晰。
queryEnhancerobject

问题增强配置

enableFollowUpboolean

是否根据历史记录改写问题

true
enableMultiQueryboolean

是否利用大模型知识拆解问题

true
enableOpenQaboolean

是否利用大模型知识回答问题

true
enableQueryRewriteboolean

是否使用问题改写

true
enableSessionboolean

是否开启多轮对话

true
localKnowledgeIdstring

知识改写使用的文档库 id

xxxx
withDocumentReferenceboolean

是否带文档引用

true
recallStrategyobject

召回策略

documentRankTypestring

合并&排序策略

枚举值:
  • linearlinear
  • modelmodel
model
limitinteger

两路合并总结的结果数

20
textIndexSettingobject

文本索引配置

categorystring

文本索引类型,目前只支持 ElasticSearch。

ElasticSearch
enableboolean

是否启用文本索引。

枚举值:
  • truetrue
  • falsefalse
true
indexAnalyzerstring

文本索引的索引分析器: (Standard, IkMaxWord, IkSmart)

Standard
rankThresholddouble

文本索引排序阈值

0.5
searchAnalyzerstring

文本索引的搜索分析器: (Standard, IkMaxWord, IkSmart)

Standard
topKinteger

文本索引最后总结结果数

50
vectorIndexSettingobject

向量索引设置

categorystring

向量索引来源:目前只支持 ADB

ADB
embeddingTypestring

向量索引文本 Embedding 类型

枚举值:
  • DashScopeDashScope
DashScope
enableboolean

是否开启

枚举值:
  • truetrue
  • falsefalse
true
rankThresholddouble

向量索引排序阈值

0.5
topKinteger

向量索引最后总结结果数

50
libraryNamestring

文档库的名称

金融知识文档库

返回参数

名称类型描述示例值
object

ResultCode

costlong

耗时

300
datastring

返回数据

a1b2c3
dataTypestring

数据类型

null
errCodestring

错误码

0
messagestring

错误信息

成功
requestIdstring

请求 id

xxxx-xxxx-xxxx-xxxx
successboolean

是否成功

true
timestring

时间戳

null

示例

正常返回示例

JSON格式

{
  "cost": 300,
  "data": "a1b2c3",
  "dataType": "null",
  "errCode": "0",
  "message": "成功",
  "requestId": "xxxx-xxxx-xxxx-xxxx",
  "success": true,
  "time": "null"
}

错误码

访问错误中心查看更多错误码。