Enhance API documentation by adding new endpoints for ASR preview, assistant configuration retrieval, and knowledge base management. Update existing assistant and tool definitions for improved clarity and functionality. Remove outdated sections from history records documentation, ensuring a streamlined reference for users.
This commit is contained in:
Xin Wang
@@ -20,24 +20,31 @@ interface Assistant {
|
||||
id: string; // 助手唯一标识 (8位UUID)
|
||||
user_id: number; // 所属用户ID
|
||||
name: string; // 助手名称
|
||||
call_count: number; // 调用次数
|
||||
opener: string; // 开场白
|
||||
callCount: number; // 调用次数
|
||||
firstTurnMode: string; // 首轮模式: "bot_first" | "user_first"
|
||||
opener: string; // 开场白
|
||||
generatedOpenerEnabled: boolean; // 是否启用生成式开场白
|
||||
openerAudioEnabled: boolean; // 是否启用预生成开场音频
|
||||
openerAudioReady: boolean; // 开场音频是否已生成
|
||||
openerAudioDurationMs: number; // 开场音频时长(ms)
|
||||
prompt: string; // 系统提示词/人格设定
|
||||
knowledge_base_id?: string; // 关联知识库ID
|
||||
knowledgeBaseId?: string; // 关联知识库ID
|
||||
language: string; // 语言: "zh" | "en"
|
||||
voice?: string; // 声音ID
|
||||
voiceOutputEnabled: boolean; // 是否启用语音输出
|
||||
voice?: string; // 声音ID
|
||||
speed: number; // 语速 (0.5-2.0)
|
||||
hotwords: string[]; // 热词列表
|
||||
tools: string[]; // 启用的工具ID列表
|
||||
interruption_sensitivity: number; // 打断灵敏度 (ms)
|
||||
config_mode: string; // 配置模式: "platform" | "dify" | "fastgpt" | "none"
|
||||
api_url?: string; // 外部API URL
|
||||
api_key?: string; // 外部API Key
|
||||
// 模型关联 (新增)
|
||||
llm_model_id?: string; // LLM模型ID
|
||||
asr_model_id?: string; // ASR模型ID
|
||||
embedding_model_id?: string; // Embedding模型ID
|
||||
rerank_model_id?: string; // Rerank模型ID
|
||||
hotwords: string[]; // 热词列表
|
||||
tools: string[]; // 启用的工具ID列表
|
||||
botCannotBeInterrupted: boolean; // 是否禁止打断
|
||||
interruptionSensitivity: number; // 打断灵敏度 (ms)
|
||||
configMode: string; // 配置模式: "platform" | "dify" | "fastgpt" | "none"
|
||||
apiUrl?: string; // 外部API URL
|
||||
apiKey?: string; // 外部API Key
|
||||
// 模型关联
|
||||
llmModelId?: string; // LLM模型ID
|
||||
asrModelId?: string; // ASR模型ID
|
||||
embeddingModelId?: string; // Embedding模型ID
|
||||
rerankModelId?: string; // Rerank模型ID
|
||||
created_at: string;
|
||||
updated_at: string;
|
||||
}
|
||||
@@ -219,22 +226,109 @@ DELETE. 删除助手
|
||||
|
||||
---
|
||||
|
||||
### 6. 获取助手调用统计
|
||||
### 6. 获取助手引擎配置
|
||||
|
||||
```http
|
||||
GET /api/v1/assistants/{id}/stats
|
||||
GET /api/v1/assistants/{id}/config
|
||||
```
|
||||
|
||||
获取助手的运行时引擎配置，包含 LLM、ASR、TTS、知识库等服务的完整配置信息。
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"assistantId": "abc12345",
|
||||
"configVersionId": "asst_abc12345_20240115103000",
|
||||
"assistant": {
|
||||
"systemPrompt": "你是一个专业的客服人员...",
|
||||
"firstTurnMode": "bot_first",
|
||||
"greeting": "您好，请问有什么可以帮助您？",
|
||||
"generatedOpenerEnabled": false,
|
||||
"output": {"mode": "audio"},
|
||||
"bargeIn": {"enabled": true, "minDurationMs": 500},
|
||||
"services": {
|
||||
"llm": {"provider": "openai", "model": "gpt-4o", "apiKey": "...", "baseUrl": "..."},
|
||||
"asr": {"provider": "openai_compatible", "model": "paraformer-realtime-v2", "apiKey": "..."},
|
||||
"tts": {"enabled": true, "provider": "dashscope", "model": "qwen3-tts-flash-realtime", "voice": "Cherry", "speed": 1.0}
|
||||
},
|
||||
"tools": [...],
|
||||
"knowledgeBaseId": "kb_001",
|
||||
"openerAudio": {"enabled": true, "ready": true, "pcmUrl": "/api/assistants/abc12345/opener-audio/pcm"}
|
||||
},
|
||||
"sessionStartMetadata": {...},
|
||||
"sources": {
|
||||
"llmModelId": "llm_001",
|
||||
"asrModelId": "asr_001",
|
||||
"voiceId": "voice_001",
|
||||
"knowledgeBaseId": "kb_001"
|
||||
},
|
||||
"warnings": []
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 7. 获取助手开场音频状态
|
||||
|
||||
```http
|
||||
GET /api/v1/assistants/{id}/opener-audio
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"assistant_id": "abc12345",
|
||||
"total_calls": 128,
|
||||
"connected_calls": 120,
|
||||
"missed_calls": 8,
|
||||
"avg_duration_seconds": 180,
|
||||
"today_calls": 15
|
||||
"enabled": true,
|
||||
"ready": true,
|
||||
"encoding": "pcm_s16le",
|
||||
"sampleRateHz": 16000,
|
||||
"channels": 1,
|
||||
"durationMs": 2500,
|
||||
"textHash": "abc123...",
|
||||
"ttsFingerprint": "def456...",
|
||||
"updatedAt": "2024-01-15T10:30:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 8. 下载开场音频 PCM 文件
|
||||
|
||||
```http
|
||||
GET /api/v1/assistants/{id}/opener-audio/pcm
|
||||
```
|
||||
|
||||
返回 PCM 音频文件 (application/octet-stream)。
|
||||
|
||||
---
|
||||
|
||||
### 9. 生成开场音频
|
||||
|
||||
```http
|
||||
POST /api/v1/assistants/{id}/opener-audio/generate
|
||||
```
|
||||
|
||||
**Request Body:**
|
||||
|
||||
```json
|
||||
{
|
||||
"text": "您好，请问有什么可以帮助您？"
|
||||
}
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"enabled": true,
|
||||
"ready": true,
|
||||
"encoding": "pcm_s16le",
|
||||
"sampleRateHz": 16000,
|
||||
"channels": 1,
|
||||
"durationMs": 2500,
|
||||
"textHash": "abc123...",
|
||||
"ttsFingerprint": "def456..."
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user