API文档 - 云甲AI中台

📋 云甲AI中台 API 文档

云甲AI中台提供标准化的 REST API 接口，涵盖自然语言处理、智能推荐、图像识别等 AI 能力。所有接口均采用 JSON 数据格式，支持 API Key 和 Token 两种认证方式。

基础地址：http://<host>:8081

🔑 认证说明

平台支持两种认证方式：

API Key 认证 — 适用于 AI 服务接口，通过请求头 X-API-Key: YOUR_KEY 传递
Token 认证 — 适用于管理接口，通过请求头 Authorization: Bearer YOUR_TOKEN 传递（登录后获取）

🌐 系统接口

GET /api/status 服务状态

描述

获取平台整体运行状态，包括数据库和缓存的连接状态。

认证

无需认证

CURL 示例

curl -X GET http://127.0.0.1:8081/api/status

响应示例

{
  "code": 0,
  "data": {
    "status": "ok",
    "version": "1.0.0",
    "time": "2025-01-15T10:30:00+08:00",
    "db": "connected",
    "redis": "connected"
  }
}

GET /api/version 版本信息

描述

获取平台版本号和构建信息。

认证

无需认证

CURL 示例

curl -X GET http://127.0.0.1:8081/api/version

响应示例

{
  "code": 0,
  "data": {
    "version": "1.0.0",
    "build": "20250329",
    "framework": "ThinkPHP 6"
  }
}

GET /api/modules 模块列表

描述

获取所有 AI 模块的列表及其状态信息。

认证

无需认证

CURL 示例

curl -X GET http://127.0.0.1:8081/api/modules

响应示例

{
  "code": 0,
  "data": [
    {"id": 1, "name": "基础NLP", "type": "nlp", "status": "active"},
    {"id": 2, "name": "情感分析", "type": "nlp", "status": "active"}
  ]
}

PUT /api/modules/:id 更新模块

描述

更新指定模块的配置信息，如状态、参数等。

认证

Authorization: Bearer TOKEN

参数	类型	必填	说明
status	string	否	模块状态: active / inactive
config	object	否	模块配置参数

CURL 示例

curl -X PUT http://127.0.0.1:8081/api/modules/1 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status": "active"}'

🔐 认证接口

POST /api/auth/login 用户登录

认证

无需认证

参数	类型	必填	说明
username	string	是	用户名
password	string	是	密码

CURL 示例

curl -X POST http://127.0.0.1:8081/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"123456"}'

响应示例

{
  "code": 0,
  "msg": "登录成功",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIs...",
    "user": {"id": 1, "username": "admin"}
  }
}

POST /api/auth/register 用户注册

认证

无需认证

参数	类型	必填	说明
username	string	是	用户名（3-20字符）
password	string	是	密码（6-30字符）
email	string	否	邮箱地址

CURL 示例

curl -X POST http://127.0.0.1:8081/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{"username":"dev001","password":"pass123","email":"dev@example.com"}'

GET /api/auth/check 验证Token

描述

验证当前 Token 是否有效并返回用户信息。

认证

Authorization: Bearer TOKEN

CURL 示例

curl -X GET http://127.0.0.1:8081/api/auth/check \
  -H "Authorization: Bearer YOUR_TOKEN"

🧠 AI - 自然语言处理

POST /api/ai/nlp/basic 基础NLP

描述

对输入文本进行分词、词性标注、命名实体识别等基础自然语言处理。

认证

X-API-Key: YOUR_KEY

参数	类型	必填	说明
text	string	是	待处理文本

CURL 示例

curl -X POST http://127.0.0.1:8081/api/ai/nlp/basic \
  -H "X-API-Key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"云甲AI助力乡村振兴数字化建设"}'

POST /api/ai/nlp/sentiment 情感分析

描述

分析文本的情感倾向，返回正面、负面或中性及置信度。

认证

X-API-Key: YOUR_KEY

参数	类型	必填	说明
text	string	是	待分析文本

CURL 示例

curl -X POST http://127.0.0.1:8081/api/ai/nlp/sentiment \
  -H "X-API-Key: YOUR_KEY" \
  -d "text=云甲AI让乡村数字化更简单"

响应示例

{
  "code": 0,
  "data": {
    "text": "云甲AI让乡村数字化更简单",
    "sentiment": "positive",
    "confidence": 0.92,
    "scores": {"positive":0.92,"negative":0.03,"neutral":0.05}
  }
}

POST /api/ai/nlp/keywords 关键词提取

描述

从文本中自动提取核心关键词，支持 TF-IDF 和 TextRank 算法。

认证

X-API-Key: YOUR_KEY

参数	类型	必填	说明
text	string	是	待提取文本
count	int	否	返回关键词数量（默认10）

CURL 示例

curl -X POST http://127.0.0.1:8081/api/ai/nlp/keywords \
  -H "X-API-Key: YOUR_KEY" \
  -d "text=乡村振兴战略是新时代做好三农工作的总抓手&count=5"

🎯 AI - 推荐系统

POST /api/ai/recommend/user 用户推荐

描述

基于用户标签进行智能匹配，推荐相关用户、内容或产品。

认证

X-API-Key: YOUR_KEY

参数	类型	必填	说明
tags	string	是	用户标签，逗号分隔（如"乡村,生态"）

CURL 示例

curl -X POST http://127.0.0.1:8081/api/ai/recommend/user \
  -H "X-API-Key: YOUR_KEY" \
  -d "tags=乡村,生态"

POST /api/ai/recommend/content 内容推荐

描述

基于内容相似度进行智能推荐，适用于文章、视频、商品等。

认证

X-API-Key: YOUR_KEY

参数	类型	必填	说明
content_id	int/string	否	参考内容ID
keywords	string	否	内容关键词

CURL 示例

curl -X POST http://127.0.0.1:8081/api/ai/recommend/content \
  -H "X-API-Key: YOUR_KEY" \
  -d "keywords=农业科技,数字乡村"

🖼️ AI - 图像识别

POST /api/ai/image/classify 图像分类

描述

对输入图像进行分类识别，返回分类标签及置信度。

认证

X-API-Key: YOUR_KEY

参数	类型	必填	说明
image	file/url	是	图像文件或URL

CURL 示例

curl -X POST http://127.0.0.1:8081/api/ai/image/classify \
  -H "X-API-Key: YOUR_KEY" \
  -F "image=@/path/to/photo.jpg"

POST /api/ai/image/detect 目标检测

描述

检测图像中的目标物体，返回边界框、标签和置信度。

认证

X-API-Key: YOUR_KEY

参数	类型	必填	说明
image	file/url	是	图像文件或URL

CURL 示例

curl -X POST http://127.0.0.1:8081/api/ai/image/detect \
  -H "X-API-Key: YOUR_KEY" \
  -F "image=@/path/to/photo.jpg"

💬 AI - 智能对话

POST /api/ai/chat 智能对话

描述

与 AI 进行智能对话，支持多轮上下文理解。

认证

X-API-Key: YOUR_KEY

参数	类型	必填	说明
message	string	是	用户消息
context	array	否	对话历史上下文

CURL 示例

curl -X POST http://127.0.0.1:8081/api/ai/chat \
  -H "X-API-Key: YOUR_KEY" \
  -d "message=乡村振兴的核心要素有哪些"

响应示例

{
  "code": 0,
  "data": {
    "reply": "乡村振兴的核心要素包括：产业振兴、人才振兴、文化振兴、生态振兴和组织振兴五个方面...",
    "tokens": 156,
    "model": "yunjia-gpt"
  }
}

📊 统计接口

GET /api/stats/dashboard 统计仪表盘

描述

获取平台整体统计数据，包括调用量、活跃用户、模块使用情况等。

认证

Authorization: Bearer TOKEN

CURL 示例

curl -X GET http://127.0.0.1:8081/api/stats/dashboard \
  -H "Authorization: Bearer YOUR_TOKEN"

响应示例

{
  "code": 0,
  "data": {
    "total_calls": 125632,
    "active_users": 89,
    "today_calls": 3421,
    "modules_usage": {"nlp": 45230, "recommend": 32100, "image": 18402}
  }
}