hugging-chat-api

英语 | 简体中文

非官方的 HuggingChat Python API，可扩展用于聊天机器人等。它支持：

• 基本聊天
• 助手（图像生成器，等等）
• 网络搜索
• 记忆上下文
• 切换 LLM
• ...

注意

由于个人原因，本仓库的更新将会放缓，但我们会确保最基本的功能能够正常使用。欢迎任何 PR！

安装

pip3 install hugchat

使用

API

最小示例

from hugchat import hugchat
from hugchat.login import Login

# 登录 Hugging Face 并授权给 hugchat
# 请勿在代码中暴露您的邮箱和密码，建议使用环境变量或配置文件
EMAIL = "您的邮箱"
PASSWD = "您的密码"
cookie_path_dir = "./cookies/" # 注意：必须以斜杠结尾，否则会出错
sign = Login(EMAIL, PASSWD)
cookies = sign.login(cookie_dir_path=cookie_path_dir, save_cookies=True)

chatbot = hugchat.ChatBot(cookies=cookies.get_dict())

print(chatbot.chat("Hi!").wait_until_done())

以下是本仓库的所有常见用法，您不一定需要全部使用，可以根据需求增减 :)

from hugchat import hugchat
from hugchat.login import Login

# 登录 Hugging Face 并授权给 hugchat
EMAIL = "您的邮箱"
PASSWD = "您的密码"
cookie_path_dir = "./cookies/" # 注意：必须以斜杠结尾，否则会出错
sign = Login(EMAIL, PASSWD)
cookies = sign.login(cookie_dir_path=cookie_path_dir, save_cookies=True)

# 创建您的 ChatBot
chatbot = hugchat.ChatBot(cookies=cookies.get_dict())  # 或者 cookie_path="usercookies/<email>.json"

message_result = chatbot.chat("Hi!") # 注意：message_result 是一个生成器，该方法会立即返回。

# 选项 1：非流式
message_str: str = message_result.wait_until_done()
# 获取文件（如图片）
file_list = message_result.get_files_created() # 必须先调用 wait_until_done()!

# 选项 2：流式响应
for resp in chatbot.chat(
    "Hello",
    stream=True
):
    print(resp)

# 网络搜索
query_result = chatbot.chat("Hugging Face 上有多少模型？", web_search=True).wait_until_done()
print(query_result)
# 您可以从查询结果中获取网络搜索结果
for source in query_result.get_search_sources():
    print(source.link, source.title)

# 创建新对话
chatbot.new_conversation(switch_to = True) # 切换到新对话

# 获取服务器上不属于当前会话的对话（您在 Hugging Chat 中的所有对话）
conversation_list = chatbot.get_remote_conversations(replace_conversation_list=True)
# 获取本地对话列表
conversation_list = chatbot.get_conversation_list()

# 获取可用模型
models = chatbot.get_available_llm_models()
# 根据索引切换模型
chatbot.switch_llm(0) # 切换到第一个模型
chatbot.switch_llm(1) # 切换到第二个模型

# 获取当前对话的信息
info = chatbot.get_conversation_info()
print(info.id, info.title, info.model, info.system_prompt, info.history)

# 助手
ASSISTANT_ID = "66017fca58d60bd7d5c5c26c" # 从 https://huggingface.co/chat/assistants 获取助手 ID
chatbot.new_conversation(assistant=ASSISTANT_ID, switch_to=True) # 创建带有助手的新对话

# [危险] 删除登录用户的所有对话
chatbot.delete_all_conversations()

CLI

只需在终端运行以下命令即可启动 CLI 模式

python -m hugchat.cli

CLI 参数：

• -u <您的 Hugging Face 邮箱>：提供账户邮箱进行登录。
• -p：强制请求密码登录，忽略已保存的 cookies。
• -s：在 CLI 中启用流式输出。
• -c：在 CLI 中继续之前的对话。

CLI 模式下的命令：

• /new：创建并切换到新对话。

• /ids：显示当前会话中所有 ID 号码和 ID 字符串的列表。

• /switch：显示当前会话中所有对话的信息列表，然后您可以选择其中一个切换。

• /switch all：显示您账户中所有对话的信息列表，然后您可以选择其中一个切换。（如果您的账户有很多对话，不建议使用此选项）

• /del <index>：删除与传入索引关联的对话。不会删除当前活动的会话。

• /delete-all：删除登录用户的所有对话。

• /clear：清空终端。

• /llm：获取您可以切换的可用模型。

• /llm <index>：根据 /llm 列表切换到指定索引的模型。

• /share：切换与模型作者共享数据的设置。默认为开启。

• /exit：关闭 CLI 环境。

• /stream：切换是否流式输出响应。

• /web：切换是否启用网络搜索。

• /web-hint：切换是否显示网络搜索提示。

• 人工智能是一个活跃的研究领域，存在偏见生成和错误信息等已知问题。请勿将此应用用于高风险决策或咨询。

• 服务器资源宝贵，不建议高频次调用本 API。

捐赠

❤

免责声明

本项目并非 Hugging Face 的官方产品。这是一个个人项目，与 Hugging Face 无任何关联。请勿起诉我们。

星标历史

hugging-chat-api 快速上手指南

hugging-chat-api 是一个非官方的 HuggingChat Python API，支持基础对话、助手功能（如图像生成）、联网搜索、上下文记忆以及切换大语言模型等功能，非常适合用于构建聊天机器人等应用。

环境准备

• 操作系统：Windows / macOS / Linux
• Python 版本：3.6 及以上
• 前置依赖：
  • 有效的 Hugging Face 账号（需邮箱和密码）
  • 稳定的网络连接（访问 Hugging Face 服务）

注意：请勿在代码中硬编码邮箱和密码，建议使用环境变量或配置文件管理敏感信息。

安装步骤

使用 pip 直接安装：

pip3 install hugchat

国内加速建议：如果遇到下载速度慢的问题，可以使用国内镜像源安装：

pip3 install hugchat -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

以下是最简化的使用示例，实现登录并发送一条消息：

from hugchat import hugchat
from hugchat.login import Login

# 登录 Hugging Face 并授权 huggingchat
# 请将 your email 和 your password 替换为你的真实账号信息
EMAIL = "your email"
PASSWD = "your password"
cookie_path_dir = "./cookies/" # 注意：路径末尾必须包含斜杠 (/)

sign = Login(EMAIL, PASSWD)
cookies = sign.login(cookie_dir_path=cookie_path_dir, save_cookies=True)

# 创建聊天机器人实例
chatbot = hugchat.ChatBot(cookies=cookies.get_dict())

# 发送消息并等待回复完成
print(chatbot.chat("Hi!").wait_until_done())

运行上述代码后，程序会自动在当前目录下生成 cookies 文件夹保存登录凭证，后续运行无需重复登录（除非凭证过期）。