Metadata-Version: 2.4
Name: cnllm
Version: 0.3.0
Summary: 统一的中文大模型适配库，将主流中国大模型 API 输出封装为 OpenAI 格式，无缝协作openai、langchain等大多数openai结构适配的python库
Author-email: kanchengw <wangkancheng1122@163.com>
License: MIT
Project-URL: Homepage, https://github.com/kanchengw/cnllm
Project-URL: Documentation, https://github.com/kanchengw/cnllm#readme
Project-URL: Repository, https://github.com/kanchengw/cnllm
Project-URL: Issues, https://github.com/kanchengw/cnllm/issues
Keywords: ai,llm,openai,langchain,minimax,chinese-llm,adapter,doubao,kimi
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.25.0
Requires-Dist: python-dotenv>=0.19.0
Requires-Dist: langchain-core>=0.3.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: black>=23.0.0; extra == "dev"
Requires-Dist: flake8>=6.0.0; extra == "dev"
Requires-Dist: mypy>=1.0.0; extra == "dev"
Dynamic: license-file

# CNLLM - Chinese LLM Adapter

[English](README_en.md) | 中文

[![PyPI Version](https://img.shields.io/pypi/v/cnllm null)](https://pypi.org/project/cnllm/)
[![Python Versions](https://img.shields.io/pypi/pyversions/cnllm null)](https://pypi.org/project/cnllm/)
[![License](https://img.shields.io/github/license/kanchengw/cnllm null)](LICENSE)

***

统一的中文大模型适配库，将各种国产大模型API 输出转换为统一的 OpenAI 格式，无痛接入 LangChain 等主流 AI 框架。

## 更新日志

### v0.4.0 (规划中)

- 🔧 模型适配开发（如豆包、Kimi 等）
- 🔧 框架适配验证和深度集成（LlamaIndex、Pydantic、LiteLLM、Instructor）

### v0.3.0 (2026-03-28) ✨

- ✨ **LangChain深度适配**
  - Runnable 适配器作为核心功能，一个函数接入Langchain chain
  - Runnable 流式输出、批量调用、异步调用支持
- ✨ **chat.create() 流式输出** - `stream=True` 参数支持
- ✨ **Fallback 机制** - 主模型失败时自动切换到备用模型
- ✨ **简化参数验证** - 统一为 required/supported 两类参数
- 🔧 **适配器重构** - 模型适配器（中文大模型 MiniMax 等）+ 框架适配器（LangChain 等）双层架构

### v0.2.0 (2026-03-27)

- ✨ __call__ 极简调用、prompt 参数、模型覆盖机制

### v0.4.0 (规划中)

- 🔧 模型适配开发（如豆包、Kimi 等）
- 🔧 框架适配验证和深度集成（LlamaIndex、Pydantic、LiteLLM、Instructor）

## 特性

- **OpenAI 兼容** - 模型输出对齐 OpenAI API 标准格式
- **框架集成** - 适配 LangChain、LlamaIndex 等主流机器学习库
- **统一接口** - 一套代码，无缝切换不同国产大模型
- **简洁调用** - 支持多种调用方式，最简只需一行代码

## 支持的模型

- **已验证**：MiniMax-M2.7、MiniMax-M2.5、MiniMax-M2.1、MiniMax-M2
- **更多厂商、模型支持正在开发中**

## 安装

```bash
pip install cnllm
```

## 快速开始

### 初始化接口

```python
from cnllm import CNLLM, MINIMAX_API_KEY

client = CNLLM(model="minimax-m2.7", api_key=MINIMAX_API_KEY)
```

### 三种调用入口

**1. 极简调用** **`client("提示词")`**

```python
resp = client("用一句话介绍自己")
print(resp["choices"][0]["message"]["content"])
```

**2. 标准调用** **`client.chat.create(prompt="提示词")`**

```python
resp = client.chat.create(prompt="用一句话介绍自己")
print(resp["choices"][0]["message"]["content"])
```

**3. 完整调用** **`client.chat.create(messages=[...])`**

```python
resp = client.chat.create(
    messages=[
        {"role": "user", "content": "用一句话介绍自己"}
    ]
)
print(resp["choices"][0]["message"]["content"])
```

### 模型覆盖

支持调用时覆盖默认模型：

```python
resp = client.chat.create(
    prompt="介绍自己",
    model="minimax-m2.5"
)
```

## 统一接口参数

### CNLLM 客户端接口

| 参数                | 类型    | 必填 | 默认值      | 说明                                                                     |
| ----------------- | ----- | -- | -------- | ---------------------------------------------------------------------- |
| `model`           | str   | ✅  | -        | 模型名称：minimax-m2.7、minimax-m2.5                                         |
| `api_key`         | str   | ✅  | -        | API 密钥                                                                 |
| `base_url`        | str   | -  | API 默认地址 | 自定义 API 地址                                                             |
| `timeout`         | int   | -  | 30       | 请求超时（秒）                                                                |
| `max_retries`     | int   | -  | 3        | 最大重试次数                                                                 |
| `retry_delay`     | float | -  | 1.0      | 重试延迟（秒）                                                                |
| `fallback_models` | dict | - | {} | 备用模型配置，格式：`{"备用模型": "api_key", ...}`，api_key 为 None 时与主模型共用API key，接受多个备用模型 |

### 两种调用接口

#### client.chat.create() 参数

| 参数 | 类型 | 必填 | 默认值 | 说明 |
| --- | --- | --- | --- | --- |
| `messages` | list\[dict] | ⚠️ | - | OpenAI 格式消息列表（与 prompt 二选一） |
| `prompt` | str | ⚠️ | - | 简写参数（与 messages 二选一） |
| `model` | str | - | None | 覆盖默认模型 |
| `temperature` | float | - | 0.7 | 生成随机性，0-2 |
| `max_tokens` | int | - | None | 最大生成 token 数 |
| `stream` | bool | - | False | 流式响应 |
| 其他参数 | Any | - | - | 其他 supported 参数（如 group_id）会直接传递给 API，不支持的参数会警告并忽略 |

#### 极简调用 client()

直接传入提示词字符串，无额外参数。

## 返回格式

所有 API 返回均为 OpenAI 标准格式：

```python
{
    "id": "chatcmpl-xxx",
    "object": "chat.completion",
    "created": 1234567890,
    "model": "minimax-m2.7",
    "choices": [{
        "index": 0,
        "message": {
            "role": "assistant",
            "content": "我是 MiniMax-M2.7..."
        },
        "finish_reason": "stop"
    }],
    "usage": {
        "prompt_tokens": 10,
        "completion_tokens": 20,
        "total_tokens": 30
    }
}
```

输出适配 LangChain 库（已验证，并深度集成Runnable组件），其他库如 Pydantic、LlamaIndex、Instructor 等都可直接使用（未验证）。

## LangChainRunnable实现

```python
from cnllm import CNLLM
from cnllm.adapters.framework import LangChainRunnable
from langchain_core.prompts import ChatPromptTemplate
import asyncio

client = CNLLM(model="minimax-m2.7", api_key="your_key")

# 使用LangChainRunnable 包裹客户端
runnable = LangChainRunnable(client)

prompt = ChatPromptTemplate.from_messages([
    ("system", "你是一个热心的智能助手"),("human", "{input}")])

# 构建LangChain chain
chain = prompt | runnable
result = chain.invoke({"input": "2+2等于几？"})
print(result.content)

# 同步流式输出
for chunk in runnable.stream("数到5"):
    print(chunk, end="", flush=True)

# 异步流式输出
async def async_stream_test():
    async for chunk in runnable.astream("数到3"):
        print(chunk, end="", flush=True)

asyncio.run(async_stream_test())

# 批量调用
results = runnable.batch(["Hello", "How are you?"])
for r in results:
    print(r.content)
```

## 许可证

MIT License - 详见 [LICENSE](LICENSE) 文件

## 联系方式

- GitHub Issues: <https://github.com/kanchengw/cnllm/issues>
