Files
WeKnora/docs/api/system.md
T
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

5.0 KiB

系统管理 API

返回目录

方法 路径 描述
GET /system/info 获取系统信息
GET /system/parser-engines 获取解析引擎列表
POST /system/parser-engines/check 检查解析引擎可用性
POST /system/docreader/reconnect 重连文档解析服务
GET /system/storage-engine-status 获取存储引擎状态
POST /system/storage-engine-check 检查存储引擎连通性
GET /system/minio/buckets 获取 MinIO 桶列表

GET /system/info - 获取系统信息

请求:

curl --location 'http://localhost:8080/api/v1/system/info' \
--header 'X-API-Key: sk-xxxxx' \
--header 'Content-Type: application/json'

响应:

{
    "data": {
        "version": "1.2.0",
        "edition": "community",
        "commit_id": "a1b2c3d",
        "build_time": "2025-08-12T08:00:00Z",
        "go_version": "go1.21.5",
        "keyword_index_engine": "bleve",
        "vector_store_engine": "milvus",
        "graph_database_engine": "neo4j",
        "minio_enabled": true,
        "db_version": "20250810_001"
    },
    "success": true
}

GET /system/parser-engines - 获取解析引擎列表

请求:

curl --location 'http://localhost:8080/api/v1/system/parser-engines' \
--header 'X-API-Key: sk-xxxxx' \
--header 'Content-Type: application/json'

响应:

{
    "data": [
        {
            "name": "docreader",
            "label": "DocReader",
            "description": "高精度文档解析引擎",
            "available": true
        },
        {
            "name": "tika",
            "label": "Apache Tika",
            "description": "通用文档解析引擎",
            "available": false
        }
    ],
    "connected": true,
    "success": true
}

POST /system/parser-engines/check - 检查解析引擎可用性

请求:

curl --location 'http://localhost:8080/api/v1/system/parser-engines/check' \
--header 'X-API-Key: sk-xxxxx' \
--header 'Content-Type: application/json' \
--data '{
    "addr": "http://docreader:8000"
}'

响应:

{
    "data": [
        {
            "name": "docreader",
            "label": "DocReader",
            "description": "高精度文档解析引擎",
            "available": true
        }
    ],
    "success": true
}

POST /system/docreader/reconnect - 重连文档解析服务

请求:

curl --location 'http://localhost:8080/api/v1/system/docreader/reconnect' \
--header 'X-API-Key: sk-xxxxx' \
--header 'Content-Type: application/json' \
--data '{
    "addr": "http://docreader:8000"
}'

响应:

{
    "success": true
}

GET /system/storage-engine-status - 获取存储引擎状态

请求:

curl --location 'http://localhost:8080/api/v1/system/storage-engine-status' \
--header 'X-API-Key: sk-xxxxx' \
--header 'Content-Type: application/json'

响应:

{
    "data": {
        "engines": [
            {
                "name": "minio",
                "available": true,
                "description": "MinIO 对象存储"
            },
            {
                "name": "cos",
                "available": false,
                "description": "腾讯云 COS 对象存储"
            },
            {
                "name": "s3",
                "available": false,
                "description": "AWS S3 对象存储"
            }
        ],
        "minio_env_available": true
    },
    "success": true
}

POST /system/storage-engine-check - 检查存储引擎连通性

请求:

curl --location 'http://localhost:8080/api/v1/system/storage-engine-check' \
--header 'X-API-Key: sk-xxxxx' \
--header 'Content-Type: application/json' \
--data '{
    "provider": "minio",
    "minio": {
        "endpoint": "localhost:9000",
        "access_key": "minioadmin",
        "secret_key": "minioadmin",
        "bucket": "weknora",
        "use_ssl": false
    }
}'

响应:

{
    "data": {
        "ok": true,
        "message": "连接成功",
        "bucket_created": false
    },
    "success": true
}

GET /system/minio/buckets - 获取 MinIO 桶列表

请求:

curl --location 'http://localhost:8080/api/v1/system/minio/buckets' \
--header 'X-API-Key: sk-xxxxx' \
--header 'Content-Type: application/json'

响应:

{
    "data": {
        "buckets": [
            {
                "name": "weknora",
                "policy": "read-write",
                "created_at": "2025-08-01T10:00:00+08:00"
            },
            {
                "name": "weknora-backup",
                "policy": "read-only",
                "created_at": "2025-08-05T14:00:00+08:00"
            }
        ]
    },
    "success": true
}