mirror of https://github.com/Tencent/WeKnora.git synced 2026-06-04 13:30:32 +08:00

Files

wizardchen daa9ef500c feat: add agent management functionality

- Introduced a new package for managing custom agents, including CRUD operations for agent creation, retrieval, updating, and deletion.
- Implemented API endpoints for listing agents and retrieving agent placeholders.
- Added data structures for agent configuration and requests, enhancing the overall agent management capabilities.
- Enhanced the client with methods to interact with the new agent management features, improving user experience in managing agents.

These changes significantly expand the application's functionality for handling custom agents, providing users with a comprehensive toolset for agent management.

2026-03-09 17:34:13 +08:00

2.9 KiB

Raw Blame History

WeKnora API 文档

概述

WeKnora 提供了一系列 RESTful API，用于创建和管理知识库、检索知识，以及进行基于知识的问答。本文档详细描述了这些 API 的使用方式。

基础信息

基础 URL: /api/v1
响应格式: JSON
认证方式: API Key

认证机制

所有 API 请求需要在 HTTP 请求头中包含 X-API-Key 进行身份认证：

X-API-Key: your_api_key

为便于问题追踪和调试，建议每个请求的 HTTP 请求头中添加 X-Request-ID：

X-Request-ID: unique_request_id

获取 API Key

在 web 页面完成账户注册后，请前往账户信息页面获取您的 API Key。

请妥善保管您的 API Key，避免泄露。API Key 代表您的账户身份，拥有完整的 API 访问权限。

错误处理

所有 API 使用标准的 HTTP 状态码表示请求状态，并返回统一的错误响应格式：

{
  "success": false,
  "error": {
    "code": "错误代码",
    "message": "错误信息",
    "details": "错误详情"
  }
}

API 概览

WeKnora API 按功能分为以下几类：

分类	描述	文档链接
认证管理	用户注册、登录、令牌管理	auth.md
租户管理	创建和管理租户账户	tenant.md
知识库管理	创建、查询和管理知识库	knowledge-base.md
知识管理	上传、检索和管理知识内容	knowledge.md
模型管理	配置和管理各种AI模型	model.md
分块管理	管理知识的分块内容	chunk.md
标签管理	管理知识库的标签分类	tag.md
FAQ管理	管理FAQ问答对	faq.md
智能体管理	创建和管理自定义智能体	agent.md
会话管理	创建和管理对话会话	session.md
知识搜索	在知识库中搜索内容	knowledge-search.md
聊天功能	基于知识库和 Agent 进行问答	chat.md
消息管理	获取和管理对话消息	message.md
评估功能	评估模型性能	evaluation.md
初始化管理	知识库模型配置与 Ollama 管理	initialization.md
系统管理	系统信息、解析引擎、存储引擎	system.md
MCP 服务	MCP 工具服务管理	mcp-service.md
组织管理	组织、成员、知识库/智能体共享	organization.md
Skills	预装智能体技能	skill.md
网络搜索	网络搜索服务商	web-search.md

2.9 KiB Raw Blame History Unescape Escape