开放平台概述
AIS 开放平台帮助您把企业知识的采集、管理、检索和问答接入自己的业务系统,也支持渠道商为客户自动开通租户、同步组织员工并配置访问权限。
首次接入建议从 完成第一次知识检索 开始。以下按业务目标选择路径,不需要从头实现所有接口。
文档阅读路径
| 你现在需要完成什么 | 阅读顺序 | 完成标志 |
|---|---|---|
| 第一次调用 AIS | 快速接入 → 鉴权 → 请求与响应约定 | 使用测试知识库得到一条可识别的检索结果 |
| 把资料接入知识引擎 | 知识库 → 文件/文本或 QA → 文件状态 → 检索 | 数据已入库、处理完成且能命中来源 |
| 构建智能问答 | 标准 Chat 或应用对话 → 会话历史 | 能续聊、展示引用并处理流式中断 |
| 为网站/App 关联访客 | 访客注册 → 应用对话 → 会话查询 | 外部用户与 AIS 编码及会话稳定关联 |
| 为客户自动开通服务 | 渠道流程 → 平台 Token → 租户管理 → 用户契约 → 组织授权 | 租户、用户与资源权限均验证通过 |
各接口包含用途、凭据、请求字段、响应字段、示例和失败边界。共享对象放在 响应数据字典,协议规则集中在 通用约定,无需从示例猜测完整字段含义。
选择接入方式
能力索引
| 能力 | 文档 | 主要入口 |
|---|---|---|
| 检索 | 知识检索 | POST /openapi/paas/v1/knowledge/retrieval |
| 元数据过滤 | 元数据字段与过滤 | GET /openapi/paas/v1/knowledge/metadata/fields |
| 标准对话 | Chat Completion | POST /openapi/api/v1/chat/completions |
| 应用对话 | Chat 兼容接口与模型列表 | /openapi/community/v1 |
| 知识管理 | 知识库、文件与文本、QA、分类 | /openapi/paas/v1/knowledge |
| 外部检索与 SQL | Dify 适配与数据库查询 | /openapi/paas/dify/v1/retrieval、/openapi/paas/v1/knowledge/sql/execute |
| 文件读取 | 精确查询与分片列表 | /openapi/paas/v1/knowledge/file/query、/chunk/list |
| 用户 | 访客注册与用户查询 | /openapi/paas/v1/user |
| 会话 | 主题、历史与记录查询 | /openapi/paas/chat/topic、/openapi/paas/v1/message/list |
| 租户信息 | 当前租户信息 | GET /openapi/paas/v1/tenant/get |
| 渠道租户管理 | 开户、查询、延期、充值 | /openapi/partner/account |
| 租户用户契约 | 认证与登录兑换 | Authorization: Bearer ais-channel-user:... |
| 组织集成 | 组织、员工与知识库授权 | /kb/department、/user/api/sysUser、/kb/space/permission |
通用约定
示例中的 BASE_URL 是 AIS 部署方提供的服务地址,不包含接口路径。示例凭据及业务编码均为占位值,应替换为对接环境的实际值。
export BASE_URL="https://ais.example.com"
export AIS_API_KEY="tk-REPLACE_WITH_YOUR_KEY"
JSON 业务接口通常返回 code、message、data;分页接口将 pageNo、pageSize、total、totalPage 放在顶层,data 为数组。业务成功码为 8200,对话成功响应及 SSE 不使用这一包装。详见 响应与错误编码。
id 通常是记录主键,code 是业务编码。检索、文件接口中的 containerId 使用知识库 code,不能直接代入知识库数字主键。用户关联使用注册响应的 data.code,并同时保存对话返回的 conversationId。
接口权限和知识访问权限分别校验。取得 Token 不代表可以读取任意知识库,也不代表访客自动获得员工角色或登录能力。
能力与版本范围
本文档按 2026-09-05 的服务端实现核对。接口是否可用取决于交付版本、部署配置、授权范围和用户权限。未在当前环境开通的渠道协议、知识地图或模型能力,不能仅凭文档存在就直接启用。
需要支持时,请提供:部署版本、接口方法与路径、请求时间、脱敏业务参数、HTTP 状态及业务 code。不要提交完整 Token、共享密钥、密码或敏感文档正文。