llmakits 0.6.54

A powerful Python toolkit for simplifying LLM integration and management with multi-model scheduling, fault tolerance, and load balancing support

llmakits

用于简化大语言模型(LLM)的集成和管理。支持多模型调度、故障转移、负载均衡等功能。

支持通过YAML配置实现不同业务场景的模型组管理，日均承载数万次LLM调用（含多模态图文请求），将多模型运维复杂度降低约70%。

功能特性

• 🚀 多模型支持: 支持OpenAI、智谱AI、DashScope、ModelScope等多个主流LLM平台；
• 🔄 智能调度: 内置多层故障转移和负载均衡机制；
  • 自动切换：当模型失败时，自动切换到下个可用模型；
  • 负载均衡：Token 或 请求次数 达到上限后，自动切换到下个api_key；
  • 密钥检测：自动检测并移除API密钥用尽的模型；
  • 图片处理：支持图片URL自动转base64、多图批量处理、失败域名智能降级（自动转为单图重试）、LRU缓存避免重复下载；
• 📊 消息处理: 强大的消息格式化、结果验证和提取功能；
• 🛡️ 错误处理: 完善的LLM重试机制和异常处理；
• 🎯 电商工具: 内置电商场景专用工具集，提供带验证器的闭环工作流；
  • 标题生成：支持长度/单词数约束检查，不合格自动修改，支持程序化缩减；
  • 类目预测：支持直接预测和逐级预测两种模式，带JSON格式修复和结果验证；
  • 属性填充：支持从候选值中自动验证并填充商品属性；
  • HTML生成：自动生成商品描述HTML，自动检测并修复非法标签，支持中文过滤；
  • 选项翻译：支持商品选项多语言翻译，自动验证返回列表长度一致性；
• 📝 流式输出: 支持流式响应，自动转静态处理；
• 💡 状态保持: 模型实例缓存，避免重复实例化，保持API密钥切换状态。
• ⏱️ 性能监控: 支持设置耗时警告阈值，监控模型响应性能，并输出响应报告；

安装/更新

pip install --upgrade llmakits

快速开始

1. 配置模型和API密钥

模型配置文件 (config/models_config.yaml):

• 支持按业务场景分组配置
• 每个组可以配置多个模型，实现故障转移
• 模型会按配置顺序依次尝试，直到成功

# 标题生成专用模型组
generate_title:
  - sdk_name: "dashscope"
    model_name: "qwen3-max-preview"

  - sdk_name: "zhipu"
    model_name: "glm-4-plus"

# 翻译专用模型组
translate_box:
  - sdk_name: "modelscope"
    model_name: "Qwen/Qwen3-32B"

  - sdk_name: "modelscope"
    model_name: "deepseek-ai/DeepSeek-V3"

密钥配置文件 (config/keys_config.yaml):

• 支持多密钥配置，自动负载均衡
• 当密钥达到每日使用限制时，自动切换到下一个密钥
• 支持不同平台的独立配置

# 阿里云DashScope平台
dashscope:
  base_url: "https://dashscope.aliyuncs.com/compatible-mode/v1"
  api_keys: ["your-api-key-1", "your-api-key-2"]

# ModelScope平台
modelscope:
  base_url: "https://api-inference.modelscope.cn/v1/"
  api_keys: ["your-api-key-1", "your-api-key-2"]

错误处理和故障转移

1. 模型级别故障转移: 当前模型失败时，自动切换到同组的下一个模型
2. API密钥用尽检测: 自动检测 API_KEY_EXHAUSTED 异常，并移除对应的模型
3. 结果验证: 支持自定义验证函数，验证失败时自动尝试下一个模型
4. 状态保持: 模型实例在dispatcher中缓存，保持API密钥切换状态

配置优化建议

1. 使用模型组: 推荐使用 execute_with_group 方法，避免重复实例化
2. 合理配置模型顺序: 将性能更好、更稳定的模型放在前面
3. 适当设置重试: 根据业务需求配置模型数量和密钥数量
4. 监控切换次数: 通过 model_switch_count 监控模型切换频率

全局模型配置

详见 doc/global_model_config.md。

2. 加载模型

from llmakits import load_models

# 方式1：传入配置文件路径（字符串）
models = load_models('config/models_config.yaml', 'config/keys_config.yaml')

# 方式2：直接传入配置字典
models_config = {
    "my_models": [
        {"model_name": "gpt-3.5-turbo", "sdk_name": "openai"}
    ]
}
model_keys = {
    "openai": {
        "base_url": "https://api.openai.com/v1",
        "api_keys": ["your-api-key"]
    }
}
models = load_models(models_config, model_keys)

# 方式3：使用全局配置（支持高级参数配置）
models = load_models(
    'config/models_config.yaml',
    'config/keys_config.yaml',
    global_config='config/global_model_config.csv'  # 可选：全局模型配置
)

# 获取模型组
my_models = models['my_models']

3. 发送消息（多模型调度）

使用 ModelDispatcher（推荐）

ModelDispatcher 提供了两种使用方式，推荐使用 execute_with_group 方法：

方式一：使用模型组（execute_with_group）

from llmakits import ModelDispatcher

# 创建调度器实例并加载配置
dispatcher = ModelDispatcher('config/models_config.yaml', 'config/keys_config.yaml')

# 准备消息
message_info = {
    "system_prompt": "你是一个 helpful 助手",
    "user_text": "请介绍一下Python编程语言"
}

# 使用模型组执行任务 - 自动管理模型状态和故障转移
result, tokens = dispatcher.execute_with_group(message_info, group_name="generate_title")
print(f"结果: {result}")
print(f"使用token数: {tokens}")
print(f"模型切换次数: {dispatcher.model_switch_count}")

消息格式说明

message_info 参数支持以下字段：

• system_prompt: 系统提示词（可选）
• user_text: 用户输入文本（可选）
• include_img: 是否包含图片（可选，默认False）
• img_list: 图片URL列表（可选，默认为空列表）

基本使用示例：

# 简单文本对话
message_info = {
    "system_prompt": "你是一个 helpful 助手",
    "user_text": "请介绍一下Python编程语言"
}

# 带图片的对话
message_info = {
    "system_prompt": "你是一个图像分析专家",
    "user_text": "请分析这张图片",
    "include_img": True,
    "img_list": ["https://example.com/image.jpg"]
}
# 如果include_img = True 同时 img_list 是空的，此时会报出错误。

方式二：手动传入模型列表（execute_task）

from llmakits import ModelDispatcher

# 创建调度器实例
dispatcher = ModelDispatcher()

# 准备消息和模型列表
message_info = {
    "system_prompt": "你是一个 helpful 助手",
    "user_text": "请介绍一下Python编程语言"
}

# 执行任务
result, tokens = dispatcher.execute_task(message_info, my_models)

高级用法

• 结果验证和格式化
• 获取详细执行结果
• 耗时警告监控
• 指定起始模型索引

增强版调度策略：dispatcher_with_repair

from llmakits import dispatcher_with_repair

# 创建调度器
from llmakits import ModelDispatcher
dispatcher = ModelDispatcher('config/models_config.yaml', 'config/keys_config.yaml')

# 准备消息
message_info = {
    "system_prompt": "你是一个JSON数据生成专家",
    "user_text": "请生成一个包含产品信息的JSON对象"
}

# 使用增强版调度策略 - 自动修复JSON错误
try:
    result, tokens = dispatcher_with_repair(
        dispatcher=dispatcher,
        message_info=message_info,
        group_name="generate_json",  # 主模型组名称
        validate_func=None,  # 可选：自定义验证函数
        fix_json_config={
            "group_name": "fix_json",  # 修复模型组名称
            "system_prompt": "你是一个JSON修复专家，请修复下面错误的JSON格式",
            "example_json": '{"name": "产品名称", "price": 99.99}'  # 可选：JSON示例
        }
    )
    print(f"修复后的结果: {result}")
    print(f"使用token数: {tokens}")
except Exception as e:
    print(f"所有模型和修复尝试均失败: {e}")

增强版调度策略特点：

1. 自动修复JSON错误：当主模型返回格式错误的JSON时，自动调用修复模型组进行修复
2. 多模型支持：每个失败的模型都会尝试修复，确保所有主模型都有机会尝试
3. 独立修复流程：使用独立的修复调度器，避免状态混乱
4. 详细错误处理：区分JSON错误和其他类型错误，采取不同的处理策略

使用场景：

• 需要生成结构化JSON数据的任务
• 对JSON格式要求严格的场景
• 希望提高任务成功率的自动化流程

4. 直接使用模型客户端

from llmakits import BaseOpenai

# 创建模型客户端
model = BaseOpenai(
    platform="openai",
    base_url="https://api.openai.com/v1",
    api_keys=["your-api-key"],
    model_name="gpt-3.5-turbo"
)

# 方法1: 使用消息列表格式（兼容OpenAI格式）
messages = [
    {"role": "system", "content": "你是一个 helpful 助手"},
    {"role": "user", "content": "Hello!"}
]
result, tokens = model.send_message(messages)
print(f"回复: {result}")

# 方法2: 使用message_info格式（推荐）
message_info = {
    "system_prompt": "你是一个 helpful 助手",
    "user_text": "Hello!"
}
result, tokens = model.send_message([], message_info)
print(f"回复: {result}")

高级配置选项

from llmakits import BaseOpenai

# 创建带高级配置的客户端
client = BaseOpenai(
    platform="openai",
    base_url="https://api.openai.com/v1",
    api_keys=["your-api-key"],
    model_name="gpt-4o",
    stream=True,              # 启用流式输出
    stream_real=False,        # 真实流式输出
    request_timeout=60,       # 请求超时时间（秒）
    max_retries=3            # 最大重试次数
)

获取模型信息

# 获取模型列表（DataFrame格式，包含创建时间等信息）
models_df = client.models_df()
print(f"模型列表:")
print(models_df)

高级功能

JSON字符串转换，字段提取

from llmakits.message import extract_field, convert_to_json

# 提取并转换为JSON
json_str = '{"name": "test"} some text'
result = convert_to_json(json_str)

# 提取字段
field_value = extract_field(json_str, "name")
print(field_value)  # 输出: test

# 提取多个字段
name, age = extract_field(json_str, "name", "age")
print(name)  # 输出: test
print(age)  # 输出: None

电商工具

详见 doc/e_commerce.md。

功能	说明
基础工具函数	中文字符检测、字符长度检测、HTML 验证
优化商品标题	支持长度/单词数约束检查，不合格自动修改
预测商品类目	直接预测，支持 JSON 修复
梯度预测商品类目	逐级预测，支持 JSON 修复
翻译商品选项	多语言翻译，自动验证返回列表长度一致性
生成 HTML 商品描述	自动生成 HTML，自动检测并修复非法标签
填充属性值	从候选值中自动验证并填充商品属性

许可证

Apache 2.0 License