获取知识库。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| pailangstudio:GetKnowledgeBase | get | *全部资源 * |
| 无 |
请求语法
GET /api/v1/langstudio/knowledgebases/{KnowledgeBaseId} HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces 。 | 478** |
| KnowledgeBaseId | string | 是 | 知识库 ID。 | d-ksicx823d |
| VersionName | string | 否 | 知识库版本。默认为 v1。 | v1 |
返回参数
示例
正常返回示例
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"
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2026-01-08 | OpenAPI 返回结构发生变更 | 查看变更详情 |