查看文档库的详细配置，包括文档库名称、描述以及索引等详细配置信息。
接口说明
前提条件
- 已开通阿里云百炼服务和通义点金服务。
- 获取到 workspaceId：获取 workspace 标识。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
-
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dianjin:GetLibrary | get | *全部资源 * |
| 无 |
请求语法
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| workspaceId | string | 否 | 路径参数，业务空间 id。 | llm-xxxxx |
| libraryId | string | 是 | 文档库 id | cjshcxxxx |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object | 返回数据 | ||
| cost | long | 耗时 | null |
| data | object | 返回数据 | |
| description | string | 文档库描述 | 文档库的描述 |
| documentCount | long | 文档数量 | 10 |
| gmtCreate | string | 创建时间 | 2024-01-01 00:00:00 |
| gmtModified | string | 修改时间 | 2024-01-01 00:00:00 |
| id | string | 文档库 id | 19386728376 |
| indexSetting | object | 文档库索引设置 | |
| chunkStrategy | object | 分块策略 | |
| docTreeSplit | boolean | 版面切分 | true |
| docTreeSplitSize | integer | 版面切分大小 | 160 |
| enhanceGraph | boolean | 是否增强图片 | true |
| enhanceTable | boolean | 是否增强表格 | true |
| overlap | integer | chunk 重叠长度 | 40 |
| sentenceSplit | boolean | 按句子切分 | true |
| sentenceSplitSize | integer | 按句子切分大小 | 160 |
| size | integer | chunk 大小 | 256 |
| split | boolean | 是否切块 | true |
| modelConfig | object | 模型配置 | |
| temperature | double | 温度 | 0.8 |
| topP | double | topP | 0.8 |
| promptRoleStyle | string | prompt 角色风格 | 你是一个信息处理专家。 |
| queryEnhancer | object | query 增强 | |
| enableFollowUp | boolean | 多轮增强 | true |
| enableMultiQuery | boolean | 是否利用大模型知识拆解问题 | true |
| enableOpenQa | boolean | 是否利用大模型知识回答问题 | true |
| enableQueryRewrite | boolean | 是否根据领域知识改写问题 | true |
| enableSession | boolean | 记录 session | true |
| localKnowledgeId | string | 知识改写使用的文档库 id | 2836482634 |
| withDocumentReference | boolean | 是否带文档引用 | true |
| recallStrategy | object | 召回策略 | |
| documentRankType | string | 合并&排序策略 | model |
| limit | integer | 两路合并总结的结果数 | 10 |
| textIndexSetting | object | 文本索引设置 | |
| category | string | 文本索引类型 | ElasticSearch |
| enable | boolean | 文本索引是否开启 | true |
| indexAnalyzer | string | 文本索引的索引分析器: (Standard, IkMaxWord, IkSmart) | IkMaxWord |
| rankThreshold | double | 文本索引排序阈值 | null |
| searchAnalyzer | string | 文本索引的搜索分析器: (Standard, IkMaxWord, IkSmart) | Standard |
| topK | integer | 文本索引最后总结结果数 | 10 |
| vectorIndexSetting | object | 向量索引设置 | |
| category | string | 向量索引来源：建议填写 ADB | ADB |
| embeddingType | string | 向量索引文本 Embedding 模型 | DashScope |
| enable | boolean | 是否开启 | true |
| rankThreshold | double | 向量索引排序阈值 | null |
| topK | integer | 向量索引最后总结结果数 | 10 |
| libraryName | string | 文档库名称 | 测试文档库 |
| dataType | string | 数据类型 | null |
| errCode | string | 错误码 | 0 |
| message | string | 错误类型 | ok |
| requestId | string | 请求 id | 44BD277A-87F9-5310-8D63-3E6645F1DA85 |
| success | boolean | 是否成功 | true |
| time | string | 时间戳 | 2024-01-01 00:00:00 |
示例
正常返回示例
JSON格式