文档中心

AgentKit

Knowledge

AddKnowledgeBase - 导入知识库

导入知识库，操作说明和注意事项请参见导入知识库。

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：AddKnowledgeBase

要执行的操作，取值：AddKnowledgeBase。

Version string 必选示例值：2025-10-30

API的版本，取值：2025-10-30。

ClientToken string 可选示例值：23fa21A8823nfasd7f****

保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。

取值：仅支持ASCII字符，且不能超过64个字符。

KnowledgeBases.N.Name string[] 必选示例值：knowledge_viking

待导入知识库名称。

参数 - N：表示知识库的序号，取值范围：1～10。

多个字段名之间用&分隔。

取值：

Viking知识库需填入CollectionName。

KnowledgeBases.N.ProviderKnowledgeId string[] 必选示例值：kb-ye7s2g****

待导入知识库ID。

参数 - N：表示知识库的序号，取值范围：1～10。

多个字段名之间用&分隔。

取值：

Viking知识库需使用ResourceId。

KnowledgeBases.N.ProviderType string[] 必选示例值：VIKINGDB_KNOWLEDGE

待导入知识库平台类型。

参数 - N：表示知识库的序号，取值范围：1～10。

多个字段名之间用&分隔。

取值：

VIKINGDB_KNOWLEDGE：Viking知识库。

KnowledgeBases.N.Description string[] 可选示例值：knowledge-test

待导入知识库的描述。

参数 - N：表示知识库的序号，取值范围：1～10。

不填默认为空。

多个字段名之间用&分隔。

ProjectName string 可选示例值：default

知识库所属项目名称，不填默认为default。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

KnowledgeBases object[] 示例值：--

知识库信息。

KnowledgeId string 示例值：kb-4yds45****

知识库ID。

Message string 示例值：The knowledgebase is not ready.

知识库状态消息，包含额外的状态信息或错误描述。

ProviderKnowledgeId string 示例值：kb-ye7s2g****

已导入的知识库ID。

ProviderType string 示例值：VIKINGDB_KNOWLEDGE

已导入的知识库平台类型。

Status string 示例值：Ready

知识库状态，取值：

Importing：导入中。

ImportFailed：导入失败。

Ready：成功。

Deleting：删除中。

DeleteFailed：删除失败。

Deleted：资源失效。

Error：错误。

请求示例

POST https://agentkit.cn-beijing.volcengineapi.com?Action=AddKnowledgeBase&Version=2025-10-30 HTTP/1.1​
Content-Type: application/json​
{​
  {​
    "KnowledgeBases":[​
      {​
        "ProviderType": "VIKINGDB_KNOWLEDGE",​
        "Name": "name1",​
        "ProviderKnowledgeId": "kb-ye7s2g****"​
      }​
    ],​
    "ClientToken": "abc123def456"​
  }​
}​
​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "202106111445100102252431000052****",​
    "Action": "AddKnowledgeBase",​
    "Version": "2025-10-10",​
    "Service": "agentkit",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "KnowledgeBases": [​
      {​
        "KnowledgeId": "kb-4yds45***",​
        "ProviderKnowledgeId": "kb-ye7s2g****",​
        "ProviderType": "VIKINGDB_KNOWLEDGE",​
        "Status": "Ready",​
        "Message": "Knowledge base is ready"​
      }​
    ]​
  }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidDescription.Malformed	The specified Description is malformed.	指定的描述格式错误。
400	InvalidName.Malformed	The specified Name is malformed.	指定的Name不合法。
400	LimitExceeded.MaximumKnowledgeBases	The number of specified KnowledgeBases exceeds the maximum limit.	指定的KnowledgeBases超过最大限制。
400	LimitExceeded.MinimumKnowledgeBases	The number of specified KnowledgeBases exceeds the minimum limit.	指定的KnowledgeBases超过最小限制。
400	MissingParameter.KnowledgeBases	The required parameter KnowledgeBases is not supplied.	参数KnowledgeBases不能为空。
400	MissingParameter.Name	The required parameter Name is not supplied.	名称不能为空。
400	MissingParameter.ProviderKnowledgeId	The required parameter ProviderKnowledgeId is not supplied.	参数ProviderKnowledgeId不能为空。
400	InvalidParameter.UnsupportedProviderType	The specified provider type is not supported.	指定的提供商类型不支持。

最近更新时间：2026.02.14 11:21:12

这个页面对您有帮助吗？

有用

无用