初始化json-rpc文档项目
This commit is contained in:
12
zh-cn/ai_function.md
Normal file
12
zh-cn/ai_function.md
Normal file
@ -0,0 +1,12 @@
|
||||
# 🤖 接口功能说明
|
||||
|
||||
### 📋 接口功能概览
|
||||
|
||||
| 图标 | 方法名称 | 功能描述 |
|
||||
|------|-----------------------------------|--------------------------|
|
||||
| 🗣 | `aiChatPost` | 实时AI对话交互 |
|
||||
| 📜 | `aiChatHistoryPost` | 获取历史对话记录 |
|
||||
| 📑 | `aiContractRiskAnalysisPost` | 合同文件风险分析 |
|
||||
| 🔍 | `aiContractRiskAnalysisResultPost` | 获取风险分析结果 |
|
||||
| 💾 | `aiQuerySqlPost` | 自然语言转数据库查询语句 |
|
||||
| 🗑️ | `aiChatDelete` | 删除指定对话记录 |
|
||||
87
zh-cn/ai_service.md
Normal file
87
zh-cn/ai_service.md
Normal file
@ -0,0 +1,87 @@
|
||||
# 🤖 AI 服务模块
|
||||
|
||||
## 🛠 服务接口列表
|
||||
|
||||
```php
|
||||
<?php
|
||||
/**
|
||||
* AI 服务接口契约
|
||||
* @author ykxiao <yk_9001@hotmail.com>
|
||||
* @since 2025/4/7
|
||||
* @version 1.0.0
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\JsonRpc;
|
||||
|
||||
interface AiServiceInterface
|
||||
{
|
||||
/**
|
||||
* 🗣 AI 智能对话
|
||||
* @param array $params 对话参数 {
|
||||
* @type string $session_id 会话ID
|
||||
* @type string $user_input 用户输入
|
||||
* @type int $model_type 模型类型
|
||||
* }
|
||||
* @return void
|
||||
*/
|
||||
public function aiChatPost(array $params): void;
|
||||
|
||||
/**
|
||||
* 📜 获取AI对话历史记录
|
||||
* @param array $params 查询参数 {
|
||||
* @type string $user_id 用户ID
|
||||
* @type int $page 页码
|
||||
* @type int $page_size 每页数量
|
||||
* }
|
||||
* @return array {
|
||||
* @type array $list 对话记录列表
|
||||
* @type int $total 总记录数
|
||||
* }
|
||||
*/
|
||||
public function aiChatHistoryPost(array $params): array;
|
||||
|
||||
/**
|
||||
* 📑 智能合同风险分析
|
||||
* @param array $params 合同参数 {
|
||||
* @type string $contract_id 合同ID
|
||||
* @type string $file_url 合同文件URL
|
||||
* }
|
||||
* @return void
|
||||
*/
|
||||
public function aiContractRiskAnalysisPost(array $params): void;
|
||||
|
||||
/**
|
||||
* 🔍 获取合同风险分析结果
|
||||
* @param array $params 查询参数 {
|
||||
* @type string $task_id 分析任务ID
|
||||
* }
|
||||
* @return array {
|
||||
* @type int $risk_level 风险等级
|
||||
* @type array $risk_items 风险条目
|
||||
* }
|
||||
*/
|
||||
public function aiContractRiskAnalysisResultPost(array $params): array;
|
||||
|
||||
/**
|
||||
* 💾 生成数据库查询语句
|
||||
* @param array $params 生成参数 {
|
||||
* @type string $question 自然语言问题
|
||||
* @type string $db_schema 数据库结构
|
||||
* }
|
||||
* @return void
|
||||
*/
|
||||
public function aiQuerySqlPost(array $params): void;
|
||||
|
||||
/**
|
||||
* 🗑️ 删除AI对话记录
|
||||
* @param array $params 删除参数 {
|
||||
* @type string $record_id 记录ID
|
||||
* @type string $user_id 用户ID
|
||||
* }
|
||||
* @return void
|
||||
*/
|
||||
public function aiChatDelete(array $params): void;
|
||||
}
|
||||
```
|
||||
95
zh-cn/guide.md
Normal file
95
zh-cn/guide.md
Normal file
@ -0,0 +1,95 @@
|
||||
# JSON-RPC 接口规范文档
|
||||
|
||||
## 📌 目录
|
||||
- [协议基础信息](#协议基础信息)
|
||||
- [请求格式规范](#请求格式规范)
|
||||
- [响应格式规范](#响应格式规范)
|
||||
|
||||
## 协议基础信息
|
||||
|
||||
> 🌐 **JSON-RPC 通信规范**
|
||||
|
||||
| 项目 | 值 | 说明 |
|
||||
|-----------------|---------------------|--------------------------|
|
||||
| 🔖 协议版本 | JSON-RPC 2.0 | 遵循最新2.0协议规范 |
|
||||
| 📤 传输协议 | HTTP POST | 仅支持POST方法 |
|
||||
| 🚪 服务端点 | `127.0.0.1:8848` | 生产环境请替换为实际地址 |
|
||||
| 🕒 超时时间 | 5000ms | 建议客户端设置超时 |
|
||||
| 📝 Content-Type | `application/json` | 必须严格设置此请求头 |
|
||||
|
||||
---
|
||||
|
||||
## 请求格式规范
|
||||
|
||||
### 📦 请求示例
|
||||
```json
|
||||
{
|
||||
"jsonrpc": "2.0",
|
||||
"method": "ServiceName.method",
|
||||
"params": {
|
||||
"company_info": {
|
||||
"id": 5,
|
||||
"name": "德木智造",
|
||||
"full_name": "苏州德木智造科技有限公司",
|
||||
"domain": "drp",
|
||||
"owner": "ykxiao",
|
||||
"mobile": "13712279001",
|
||||
"address": "江苏省苏州市太仓市太仓港港口开发区北环路20号809室",
|
||||
"org_code": "91320585MAE1L3233J",
|
||||
"email": "yk_9001@icloud.com"
|
||||
},
|
||||
"userInfo": {
|
||||
"id": 8,
|
||||
"company_id": 5,
|
||||
"user_type": 2,
|
||||
"login_name": "ykk"
|
||||
}
|
||||
},
|
||||
"id": "req_123456"
|
||||
}
|
||||
```
|
||||
|
||||
## 响应格式规范
|
||||
|
||||
### ✅ 成功响应
|
||||
```json
|
||||
{
|
||||
"jsonrpc": "2.0",
|
||||
"result": {
|
||||
"status": "success",
|
||||
"data": {
|
||||
"request_id": "req_123456",
|
||||
"processed_at": "2023-08-20 15:30:45"
|
||||
}
|
||||
},
|
||||
"id": "req_123456"
|
||||
}
|
||||
```
|
||||
|
||||
### ❌ 错误响应
|
||||
```json
|
||||
{
|
||||
"jsonrpc": "2.0",
|
||||
"error": {
|
||||
"code": -32000,
|
||||
"message": "企业信息验证失败",
|
||||
"data": {
|
||||
"field": "org_code",
|
||||
"reason": "统一信用代码格式不正确"
|
||||
}
|
||||
},
|
||||
"id": "req_123456"
|
||||
}
|
||||
```
|
||||
|
||||
### 🚨 错误码说明
|
||||
|
||||
| 错误码 | HTTP状态码 | 说明 | 解决方案 |
|
||||
|---------|------------|-----------------------|-------------------------|
|
||||
| -32700 | 400 | 解析错误 | 检查JSON格式 |
|
||||
| -32600 | 400 | 无效请求 | 验证请求参数 |
|
||||
| -32601 | 404 | 方法不存在 | 检查method名称 |
|
||||
| -32602 | 400 | 无效参数 | 检查params参数 |
|
||||
| -32603 | 500 | 内部错误 | 联系技术支持 |
|
||||
| -32000 | 200 | 业务逻辑错误 | 查看error.data详情 |
|
||||
| -32001 | 401 | 未授权访问 | 检查认证信息 |
|
||||
Reference in New Issue
Block a user