获取知识库。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
pailangstudio:GetKnowledgeBase |
get |
*全部资源
|
无 | 无 |
请求语法
GET /api/v1/langstudio/knowledgebases/{KnowledgeBaseId} HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| KnowledgeBaseId |
string |
是 |
知识库 ID。 |
d-ksicx823d |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| WorkspaceId |
string |
是 |
工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces 。 |
478** |
| VersionName |
string |
否 |
知识库版本。默认为 v1。 |
v1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
963BD7F9-0C02-5594-9550-BCC6DD43E3C0 |
| WorkspaceId |
string |
知识库所在工作空间 ID。 |
478** |
| Accessibility |
string |
工作空间可见性，可能值为：
|
PRIVATE |
| GmtCreateTime |
string |
知识库创建时间（UTC）。 |
2024-12-15T14:46:23Z |
| GmtModifiedTime |
string |
知识库修改时间（UTC）。 |
2025-12-18T19:32:58Z |
| Name |
string |
知识库名称。 |
myName |
| KnowledgeBaseId |
string |
知识库 ID。 |
d-ksicx823d |
| Description |
string |
知识库描述。 |
This is a description of the knowledge base. |
| KnowledgeBaseType |
string |
知识库类型。
|
TEXT |
| DatasetId |
string |
知识库对应的数据集 ID。 |
d-cupbwkk5us9xpjz870 |
| DataSources |
array<object> |
数据源。 |
|
|
object |
|||
| Uri |
string |
源文件存储路径。 |
oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/ |
| OutputDir |
string |
输出数据的存储路径。 |
oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/ |
| ChunkConfig |
object |
文件切片配置。 |
|
| ChunkSize |
integer |
分块大小。 |
1024 |
| ChunkOverlap |
integer |
分块重叠大小。 |
200 |
| ChunkDuration |
integer |
分块时长，单位秒。 |
30 |
| ChunkStrategy |
string |
分块策略。策略类型如下：
|
Default |
| EmbeddingConfig |
object |
向量索引配置。 |
|
| ConnectionName |
string |
索引服务连接名称。 |
myEmbeddingConn |
| ConnectionId |
string |
索引服务连接 ID。 |
conn-r3o7******38bh |
| Model |
string |
模型名称。 |
text-embedding-v4 |
| VectorDBConfig |
object |
向量库配置。 |
|
| VectorDBType |
string |
向量数据库类型。支持以下取值：
|
Milvus |
| ConnectionName |
string |
向量数据库连接名称。 |
myVectorConn |
| ConnectionId |
string |
向量数据库连接 ID。 |
conn-7y5y******jja7 |
| CollectionName |
string |
向量数据库表或集合名称。 |
my_collection |
| Creator |
string |
创建者用户 ID。 |
2485765****023475 |
| RuntimeId |
string |
运行时 ID。 |
rtime-apje******beaz |
| MetaDataConfig |
object |
元数据配置。 |
|
| CustomMetaData |
array<object> |
自定义元数据。 |
|
|
object |
自定义元数据。 |
||
| Key |
string |
元数据字段名称。 |
author |
| ValueType |
string |
元数据字段类型。 |
String |
| ReferenceCount |
integer |
引用次数。 |
5 |
| ValueCount |
integer |
值的个数。 |
3 |
| AutoUpdateConfig |
object |
知识库自动更新配置。 |
|
| Status |
string |
知识库自动更新开关状态。
枚举值：
|
Enable |
| ResourceId |
string |
资源组 ID。为空或 public-cluster 表示公共资源。 |
quota89**76 |
| MaxRunningTimeInSeconds |
integer |
任务最大运行时间，单位秒。 |
86400 |
| EmbeddingConfig |
object |
向量索引配置。 |
|
| BatchSize |
integer |
索引分批大小。文档和结构化数据类型知识库有效。 |
8 |
| Concurrency |
integer |
索引并发数。图片和视频类型知识库有效。 |
1 |
| UserVpc | UserVpc |
用户 VPC 配置。 |
|
| EcsSpecs |
array<object> |
运行资源配置列表。 |
|
|
object |
运行资源。 |
||
| Type |
string |
节点类型。可能的取值为 Head 和 Worker。 |
Worker |
| InstanceType |
string |
机型名称。 |
ecs.c6.large |
| PodCount |
integer |
副本数量 |
1 |
| GPUType |
string |
GPU 类型。 |
V100 |
| CPU |
integer |
CPU 核数。 |
4 |
| GPU |
integer |
GPU 卡数。 |
1 |
| Memory |
integer |
内存大小，单位 GB。 |
16 |
| SharedMemory |
integer |
共享内存大小，单位 GB。 |
16 |
| Driver |
string |
GPU 驱动版本。 |
550.127.08 |
| VersionName |
string |
知识库版本。默认为 v1。 |
v1 |
| IndexColumnConfig |
object |
列字段配置。结构化数据类型知识库有效。 |
|
| EmbeddingColumns |
array<object> |
向量索引列。该列表中的字段会进行向量化并参与检索。 |
|
|
object |
向量检索列。 |
||
| Key |
string |
列名。 |
column1 |
| ContentColumns |
array<object> |
内容过滤列。该列表中的字段支持按照关键字进行检索。 |
|
|
object |
内容过滤列。 |
||
| Key |
string |
列名。 |
column1 |
| ColumnDefinitions |
array<object> |
所有列名。 |
|
|
object |
|||
| Key |
string |
列名。 |
column1 |
示例
正常返回示例
JSON格式
{
"RequestId": "963BD7F9-0C02-5594-9550-BCC6DD43E3C0",
"WorkspaceId": "478**",
"Accessibility": "PRIVATE",
"GmtCreateTime": "2024-12-15T14:46:23Z",
"GmtModifiedTime": "2025-12-18T19:32:58Z",
"Name": "myName",
"KnowledgeBaseId": "d-ksicx823d",
"Description": "This is a description of the knowledge base.",
"KnowledgeBaseType": "TEXT",
"DatasetId": "d-cupbwkk5us9xpjz870",
"DataSources": [
{
"Uri": "oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/"
}
],
"OutputDir": "oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/",
"ChunkConfig": {
"ChunkSize": 1024,
"ChunkOverlap": 200,
"ChunkDuration": 30,
"ChunkStrategy": "Default"
},
"EmbeddingConfig": {
"ConnectionName": "myEmbeddingConn",
"ConnectionId": "conn-r3o7******38bh",
"Model": "text-embedding-v4"
},
"VectorDBConfig": {
"VectorDBType": "Milvus",
"ConnectionName": "myVectorConn",
"ConnectionId": "conn-7y5y******jja7",
"CollectionName": "my_collection"
},
"Creator": "2485765****023475",
"RuntimeId": "rtime-apje******beaz",
"MetaDataConfig": {
"CustomMetaData": [
{
"Key": "author",
"ValueType": "String",
"ReferenceCount": 5,
"ValueCount": 3
}
]
},
"AutoUpdateConfig": {
"Status": "Enable",
"ResourceId": "quota89**76",
"MaxRunningTimeInSeconds": 86400,
"EmbeddingConfig": {
"BatchSize": 8,
"Concurrency": 1
},
"UserVpc": {
"VpcId": "vpc-m5ec******44cn",
"VSwitchId": "vsw-hp32******z9qo",
"SecurityGroupId": "sg-bp1f******iy9h"
},
"EcsSpecs": [
{
"Type": "Worker",
"InstanceType": "ecs.c6.large",
"PodCount": 1,
"GPUType": "V100",
"CPU": 4,
"GPU": 1,
"Memory": 16,
"SharedMemory": 16,
"Driver": "550.127.08"
}
]
},
"VersionName": "v1",
"IndexColumnConfig": {
"EmbeddingColumns": [
{
"Key": "column1"
}
],
"ContentColumns": [
{
"Key": "column1"
}
],
"ColumnDefinitions": [
{
"Key": "column1"
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。