API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(MilvusKnowledgeBase/2026-06-04)的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

API目录

API

标题

API概述

AddDocuments 添加文档到知识库 把已上传到知识库存储的文件注册为知识库文档并**自动触发解析**(切片、embedding)。支持两类导入: - `LOCAL_UPLOAD`:配合 `GetKnowledgeBasePreSignedUrl` 直传流程(本接口只注册,不再校验文件是否已真实上传,因此必须先完成 PUT 上传); - `OSS_IMPORT`:从外部 OSS 导入,接口先创建异步导入任务,返回 `knowledge_import_task_id`,由系统后台执行下载与注册。 单次最多 100 个文件。
GetKnowledgeBasePreSignedUrl 获取知识库文件预签名 URL 为 `Documents` 中的每个文件生成一个指向知识库专属存储的 **OSS 预签名 PUT URL**,调用方用该 URL 直接把文件内容上传到对象存储,随后调用 `AddDocuments` 完成注册。单次最多 100 个文件。
SearchKnowledgeBase 检索知识库 检索知识库