文档

UpdateLibrary - 更新文档库

更新时间:

更新文档库,可用于更新文档库的名称、描述、索引配置等信息。

接口说明

前提条件

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

获取到 workspaceId:获取 workspace 标识

调试

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

授权信息

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

请求语法

PUT /{workspaceId}/api/library/update

请求参数

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

业务空间 id

llm-xxxxx
bodyobject

请求体参数。

descriptionstring

文档库描述

文档库描述
indexSettingobject

文档库索引配置

chunkStrategyobject

分块策略

docTreeSplitboolean

版面切分

true
docTreeSplitSizeinteger

版面切分大小

160
enhanceGraphboolean

是否增强图片

true
enhanceTableboolean

是否增强表格

true
overlapinteger

chunk 重叠长度

20
sentenceSplitboolean

是否按照句子切分:默认为 true

true
sentenceSplitSizeinteger

按照句子切分的平均长度

160
sizeinteger

定长切分的 chunk 长度

256
splitboolean

是否切块

true
modelConfigobject

模型配置

temperaturedouble

温度

0.8
topPdouble

topP

0.8
promptRoleStylestring

prompt 角色风格

你是一位文档分析专家,非常善于从给定的知识中,找到重点,像老师给学生讲课一样把问题回答清晰。你的回答富有逻辑性,遇到复杂问题,你善于一步一步思考。
queryEnhancerobject

query 增强

enableFollowUpboolean

多轮增强

true
enableMultiQueryboolean

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

true
enableOpenQaboolean

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

true
enableQueryRewriteboolean

是否根据领域知识改写问题

true
enableSessionboolean

记录 session

true
localKnowledgeIdstring

知识改写使用的文档库 id

sjdhgfc
withDocumentReferenceboolean

是否带文档引用

true
recallStrategyobject

召回策略

documentRankTypestring

合并&排序策略

model
limitinteger

两路合并总结的结果数

10
textIndexSettingobject

文本索引设置

categorystring

文本索引类型

ElasticSearch
enableboolean

文本索引是否开启

true
indexAnalyzerstring

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

Standard
rankThresholddouble

文本索引排序阈值

0.5
searchAnalyzerstring

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

Standard
topKinteger

文本索引最后总结结果数

50
vectorIndexSettingobject

向量索引设置

categorystring

向量索引来源:建议填写 ADB

ADB
embeddingTypestring

向量索引文本 Embedding 模型

DashScope
enableboolean

是否开启

true
rankThresholddouble

向量索引排序阈值

0.5
topKinteger

向量索引最后总结结果数

10
libraryIdstring

文档库 id

dsfbashdbb
libraryNamestring

文档库名称

测试文档库

返回参数

名称类型描述示例值
object

ResultCode

costlong

耗时

null
datastring

响应数据

null
dataTypestring

数据类型

null
errCodestring

错误码

0
messagestring

错误信息

ok
requestIdstring

请求 id

eb2b6139-ddf1-91a0-a47f-df7617ae9032
successboolean

是否成功

true
timestring

时间戳

2024-04-24 11:54:34

示例

正常返回示例

JSON格式

{
  "cost": 0,
  "data": "null",
  "dataType": "null",
  "errCode": "0",
  "message": "ok",
  "requestId": "eb2b6139-ddf1-91a0-a47f-df7617ae9032",
  "success": true,
  "time": "2024-04-24 11:54:34"
}

错误码

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