ChatBotAI

一款基于 Python 的聊天机器人 AI，能够以最少的代码帮助用户创建 Python 聊天机器人。它不仅提供了 AI 引擎和对话处理器，还支持轻松集成 REST API 和 Python 函数调用，这使得它在功能上更加独特且强大。该 AI 具备学习、记忆、条件切换、基于主题的对话处理等多种功能。

🚀 新增：Ollama 集成

现已支持 Ollama 与 Llama 3.2，提供最先进的 AI 回答！

• 无需训练——直接使用预训练模型
• 对话连贯、接近人类表达
• 本地推理（无 API 费用）
• 请参阅 OLLAMA_SETUP.md 获取安装说明

安装

从 PyPI 安装（包含 Ollama 设置）：

pip install chatbotAI

安装过程中，系统会提示您安装 Ollama 以获取 AI 回答。

从 GitHub 安装（源码）

1. 克隆仓库：

git clone https://github.com/ahmadfaizalbh/Chatbot.git
cd Chatbot

2. 安装依赖项：

pip install -r requirement.txt

3. 安装包：

python setup.py install

演示

>>> from chatbot import demo
>>> demo()
你好，最近怎么样？
> 我很好
很高兴你一切顺利  
> 退出
谢谢你和我聊天。
>>> 

示例代码（集成维基百科搜索 API）

from chatbot import Chat, register_call
import wikipedia


@register_call("whoIs")
def who_is(session, query):
    try:
        return wikipedia.summary(query)
    except Exception:
        for new_query in wikipedia.search(query):
            try:
                return wikipedia.summary(new_query)
            except Exception:
                pass
    return "我不太清楚关于 "+query

first_question="你好，最近怎么样？"
Chat("examples/Example.template").converse(first_question)

有关如何构建 Facebook Messenger 机器人，请查看 Facebook Integration.ipynb。

如需 Jupyter Notebook 聊天机器人示例，请参阅 使用 NLTK 聊天机器人构建的 Infobot。

示例应用

1. 使用 messengerbot、Django 和 NLTK 聊天机器人 构建的 Facebook Messenger 示例机器人可在 Facebook Messenger 机器人 中找到。
2. 使用 Microsoft Bot Connector Rest API - v3.0、Django 和 NLTK 聊天机器人 构建的 Microsoft 示例机器人可在 Microsoft 聊天机器人 中找到。

机器人模板支持的功能列表

1. 记忆
2. 匹配分组
3. 递归
4. 条件
5. 切换主题
6. 与 Python 函数交互
7. REST API 集成
8. 基于主题的分组
9. 学习
10. 转为大写
11. 转为小写
12. 首字母大写
13. 返回上一条

---

记忆

设置记忆

{ 变量 : 值 }

在思考模式下：

{! 变量 : 值 }

获取记忆

{ 变量 }

匹配分组

关于正则表达式中的分组，请参考 Python 正则表达式文档。

获取客户端模式的第 N 个匹配分组

%N

例如，获取第一个匹配：

%1

获取客户端模式的命名分组

%Client_pattern_group_name

例如，获取名为 person 的命名分组：

%person

获取机器人消息模式的第 N 个匹配分组

%!N

例如，获取第一个匹配：

%!1

获取机器人消息模式的命名分组

%!Bot_pattern_group_name

例如，获取名为 region 的命名分组：

%!region

递归

根据客户的新陈述生成响应：

{% chat 陈述 %}

它将对陈述进行模式匹配。

条件

{% if 条件 %} 先执行这个 {% elif 条件 %} 再执行那个 {% else %} 执行其他 {% endif %}

切换主题

{% topic 主题名称 %}

与 Python 函数交互

在 Python 中

@register_call("functionName")
def function_name(session, query):
    return "响应字符串"

在模板中

{% call functionName: 值 %}

REST API 集成

在 API.json 文件中

{
    "APIName":{
        "auth" : {
            "url":"https://your_rest_api_url/login.json",
            "method":"POST",
            "data":{
                "user":"Your_Username",
                "password":"Your_Password"
            }
        },
        "MethodName" : {
            "url":"https://your_rest_api_url/GET_method_Example.json",
            "method":"GET",
            "params":{
                "key1":"value1",
                "key2":"value2",
                ...
            },
            "value_getter":[从 JSON 响应中提取数据的顺序]
        },
        "MethodName1" : {
            "url":"https://your_rest_api_url/GET_method_Example.json",
            "method":"POST",
            "data":{
                "key1":"value1",
                "key2":"value2",
                ...
            },
            "value_getter":[从 JSON 响应中提取数据的顺序]
        },
        "MethodName2" : {
            ...
        },
        ...
    },
    "APIName2":{
        ...
    },
    ...
}

仅当需要身份验证时才需使用 auth 方法。pi.json 文件中定义的 data 和 params 作为默认值，而模板文件中定义的所有键值对都会覆盖这些默认值。value_getter 是一个按顺序排列的键列表，用于从 JSON 响应中提取信息。

在模板文件中

[ API名称:方法名,键1:值1 (,键*:值*) ]

你可以有任意数量的键值对，所有键值对会根据 method 的值来覆盖 data 或 params。如果 method 是 POST，则覆盖 data；如果 method 是 GET，则覆盖 params。

基于主题的分组

{% group 主题名称 %}
  {% block %}
      {% client %}客户端说 {% endclient %}
      {% response %}响应文本{% endresponse %}
  {% endblock %}
  ...
{% endgroup %}

学习

{% learn %}
  {% group 主题名称 %}
    {% block %}
        {% client %}客户端说 {% endclient %}
        {% response %}响应文本{% endresponse %}
    {% endblock %}
    ...
  {% endgroup %}
  ...
{% endlearn %}

转为大写

{% up 字符串 %}

转为小写

{% low 字符串 %}

首字母大写

{% cap 字符串 %}

上一条

{% block %}
    {% client %}客户端的语句模式{% endclient %}
    {% prev %}上一条机器人回复的语句模式{% endprev %}
    {% response %}回复字符串{% endresponse %}
{% endblock %}

AI 框架

该库现在使用 Ollama 和 Llama 3.2 来提供最先进的 AI 回答。

特性

1. 预训练模型: 无需训练，直接使用先进的语言模型。
2. 本地推理: 可在本地运行，无需支付 API 费用，也不依赖互联网。
3. 微调: 使用您自己的训练数据创建自定义模型。
4. 在线学习: 机器人可以动态学习特定的回复。
5. 回退机制: 如果没有匹配的模板模式，Ollama 会生成智能回复。

使用方法

训练

您可以使用文本文件或 URL 对机器人进行训练：

chat = Chat()
# 从书籍或网站训练
chat.train("https://www.gutenberg.org/files/11/11-0.txt", epochs=10)

自我学习

机器人可以从交互中学习：

chat.learn_response("火星的首都是哪里？", "埃隆·马斯克的未来家园。")

AI 回退

AI 集成是自动的。如果用户的问题与任何已定义的模板模式都不匹配，则 converse 方法会调用 ai_converse。

• 如果模型未经过训练，它会回复：“我还没有足够的数据来回答这个问题，请给我训练一下！”
• 一旦经过训练，它就会根据自身的词汇和训练内容生成回复。

---

-0.txt", epochs=10)

#### 自我学习
机器人可以从交互中学习：

```python
chat.learn_response("火星的首都是哪里？", "埃隆·马斯克的未来家园。")

AI 回退

AI 集成是自动的。如果用户的问题与任何已定义的模板模式都不匹配，则 converse 方法会调用 ai_converse。

• 如果模型未经过训练，它会回复：“我还没有足够的数据来回答这个问题，请给我训练一下！”
• 一旦经过训练，它就会根据自身的词汇和训练内容生成回复。

---

ChatbotAI 快速上手指南

ChatbotAI 是一个基于 Python 的聊天机器人框架，支持极简代码构建智能对话。它集成了模板匹配、记忆系统、条件判断、REST API 调用以及最新的 Ollama (Llama 3.2) 本地大模型推理能力，无需训练即可实现类人对话。

环境准备

• 操作系统：Windows, macOS, Linux
• Python 版本：建议 Python 3.8 及以上
• 前置依赖：
  • pip 包管理工具
  • (可选) Ollama：若需使用最新的 Llama 3.2 大模型功能，需预先安装 Ollama。安装过程中脚本会自动提示。

国内开发者提示：建议使用国内镜像源加速安装过程（如清华源或阿里源）。

安装步骤

方式一：通过 PyPI 安装（推荐）

这是最快捷的安装方式，包含基础依赖及 Ollama 配置引导。

# 使用国内镜像源加速安装
pip install chatbotAI -i https://pypi.tuna.tsinghua.edu.cn/simple

注意：安装过程中若提示安装 Ollama，请根据指引操作以启用高级 AI 功能。

方式二：从 GitHub 源码安装

适用于需要最新开发版或自定义修改的场景。

1. 克隆仓库：

git clone https://github.com/ahmadfaizalbh/Chatbot.git
cd Chatbot

2. 安装依赖：

pip install -r requirement.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

3. 安装 package：

python setup.py install

基本使用

1. 快速体验 Demo

运行内置演示程序，立即开始对话测试：

>>> from chatbot import demo
>>> demo()
Hi, how are you?
> i'm fine
Nice to know that you are fine  
> quit
Thank you for talking with me.
>>> 

2. 编写自定义机器人

以下示例展示了如何创建一个简单的聊天机器人，并集成 Wikipedia 搜索功能。

步骤 A：注册自定义函数 在 Python 代码中定义并注册一个处理特定意图的函数。

from chatbot import Chat, register_call
import wikipedia


@register_call("whoIs")
def who_is(session, query):
    try:
        return wikipedia.summary(query)
    except Exception:
        for new_query in wikipedia.search(query):
            try:
                return wikipedia.summary(new_query)
            except Exception:
                pass
    return "I don't know about "+query

步骤 B：加载模板并启动对话 使用 .template 文件定义对话逻辑（需确保 examples/Example.template 存在或自行创建），然后启动会话。

first_question="Hi, how are you?"
Chat("examples/Example.template").converse(first_question)

3. 使用 Ollama 大模型 (进阶)

若已安装 Ollama，库将自动利用 Llama 3.2 处理未匹配模板的复杂问题，无需额外代码配置。

• 自动回退机制：当用户输入不匹配任何预设模板时，系统自动调用 ai_converse 生成智能回复。
• 在线学习：可通过代码动态教机器人新知识。

chat = Chat()

# 动态学习新问答对
chat.learn_response("What is the capital of Mars?", "Elon Musk's future home.")

# 训练数据（可选）：从文本文件或 URL 训练
# chat.train("https://www.gutenberg.org/files/11/11-0.txt", epochs=10)