1. 简介
deep.py 是一个用于与 DeepSeek API 交互的 Python 客户端封装。它提供了简单易用的接口，支持对话历史管理、日志记录等功能，使得与 DeepSeek API 的交互更加便捷和可靠。
2. 功能特点
- 简单的接口设计
- 自动管理对话历史
- 完整的日志记录
- 灵活的配置选项
- 异常处理机制
3. 安装依赖
pip install openai
4. 配置环境
在项目根目录创建 .env 文件：
# Windows
set DEEPSEEK_API_KEY=your_api_key_here# Linux/Mac
export DEEPSEEK_API_KEY=your_api_key_here
5. 代码结构
5.1 主要组件
class DeepSeekChat:def __init__(self, api_key: str, base_url: str = "https://api.deepseek.com")def send_message(self, message: str, ...) -> strdef clear_history(self)
5.2 日志配置
logging.basicConfig(level=logging.INFO,format='%(asctime)s - %(levelname)s - %(message)s',handlers=[logging.FileHandler('deepseek.log'),logging.StreamHandler()]
)
6. 使用示例
6.1 基本使用
from deep import DeepSeekChat# 创建客户端实例
chat = DeepSeekChat(api_key="your_api_key")# 发送消息
response = chat.send_message("Hello")
print("Assistant:", response)
6.2 高级配置
# 自定义系统提示词和其他参数
response = chat.send_message(message="Tell me a joke",system_prompt="You are a funny assistant",temperature=0.8,max_tokens=150,save_history=True
)# 清除对话历史
chat.clear_history()
7. API 参数说明
7.1 DeepSeekChat 类初始化参数
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| api_key | str | 必填 | DeepSeek API 密钥 |
| base_url | str | “https://api.deepseek.com” | API 基础 URL |
7.2 send_message 方法参数
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| message | str | 必填 | 用户消息内容 |
| system_prompt | str | “You are a helpful assistant” | 系统提示词 |
| model | str | “deepseek-chat” | 使用的模型名称 |
| stream | bool | False | 是否使用流式响应 |
| save_history | bool | True | 是否保存对话历史 |
| temperature | float | 可选 | 控制回复的随机性 |
| max_tokens | int | 可选 | 限制回复长度 |
8. 日志记录
日志文件 deepseek.log 记录以下信息：
- 请求发送时间和内容
- 响应接收时间和处理时长
- 错误信息（如果有）
9. 错误处理
代码包含完整的错误处理机制：
- API 调用错误捕获
- 环境变量检查
- 详细的错误日志记录
10. 最佳实践
-
环境变量管理
- 使用
.env文件管理 API 密钥 - 不要在代码中硬编码密钥
- 使用
-
错误处理
- 始终使用 try-except 块包装 API 调用
- 检查并记录错误信息
-
对话历史
- 根据需要保存或清除对话历史
- 长对话时注意 token 限制
-
性能优化
- 适当设置 max_tokens 参数
- 必要时使用流式响应
11. 注意事项
-
API 密钥安全
- 不要将 API 密钥提交到版本控制系统
- 使用环境变量或配置文件管理密钥
-
错误处理
- 注意处理网络超时等异常
- 记录详细的错误日志
-
资源管理
- 及时清理不需要的对话历史
- 注意 API 调用频率限制
12. 完整代码
import os
from typing import List, Dict, Optional
from openai import OpenAI
import logging
from datetime import datetime# 配置日志记录
logging.basicConfig(level=logging.INFO,format='%(asctime)s - %(levelname)s - %(message)s',handlers=[logging.FileHandler('deepseek.log'),logging.StreamHandler()]
)
logger = logging.getLogger(__name__)class DeepSeekChat:"""DeepSeek API 聊天客户端"""def __init__(self, api_key: str, base_url: str = "https://api.deepseek.com"):"""初始化 DeepSeek 聊天客户端Args:api_key: DeepSeek API密钥base_url: DeepSeek API基础URL"""self.client = OpenAI(api_key=api_key, base_url=base_url)self.conversation_history: List[Dict[str, str]] = []def send_message(self, message: str,system_prompt: str = "You are a helpful assistant",model: str = "deepseek-chat",stream: bool = False,save_history: bool = True,**kwargs) -> str:"""发送消息并获取回复Args:message: 用户消息内容system_prompt: 系统提示词model: 使用的模型名称stream: 是否使用流式响应save_history: 是否保存对话历史**kwargs: 其他API参数Returns:str: 助手的回复内容Raises:Exception: API调用失败时抛出异常"""try:# 构建消息列表messages = [{"role": "system", "content": system_prompt}]if save_history:messages.extend(self.conversation_history)messages.append({"role": "user", "content": message})# 记录请求logger.info(f"Sending message: {message[:100]}...")# 发送请求start_time = datetime.now()response = self.client.chat.completions.create(model=model,messages=messages,stream=stream,**kwargs)# 获取响应内容assistant_message = response.choices[0].message.content# 计算响应时间response_time = (datetime.now() - start_time).total_seconds()logger.info(f"Got response in {response_time:.2f} seconds")# 保存对话历史if save_history:self.conversation_history.append({"role": "user", "content": message})self.conversation_history.append({"role": "assistant", "content": assistant_message})return assistant_messageexcept Exception as e:logger.error(f"Error in send_message: {str(e)}")raisedef clear_history(self):"""清除对话历史"""self.conversation_history.clear()logger.info("Conversation history cleared")def main():"""示例用法"""try:# 从环境变量获取API密钥api_key = os.getenv("DEEPSEEK_API_KEY")if not api_key:raise ValueError("Please set DEEPSEEK_API_KEY environment variable")# 创建聊天客户端chat = DeepSeekChat(api_key=api_key)# 发送消息并获取回复response = chat.send_message(message="Hello",temperature=0.7, # 可选：控制回复的随机性max_tokens=100 # 可选：限制回复长度)print("Assistant:", response)except Exception as e:logger.error(f"Error in main: {str(e)}")raiseif __name__ == "__main__":main()
.env
# Windows
set DEEPSEEK_API_KEY=your_api_key_here# Linux/Mac
export DEEPSEEK_API_KEY=your_api_key_here
