重要提示：

本项目已超过一个月未维护，目前无法正常工作。详情请参阅问题 #231。

Python Poe API

这是一个针对 Quora 的 Poe 的逆向工程 API 封装，它允许你免费访问 OpenAI 的 ChatGPT 和 GPT-4，以及 Anthropic 的 Claude。

功能特性：

使用令牌登录
代理请求 + WebSocket
下载机器人列表
发送消息
流式传输机器人响应
清除对话上下文
下载对话历史
删除消息
清除整个对话
创建自定义机器人
编辑你的自定义机器人
使用预先存在的第三方机器人

安装：

你可以通过运行以下命令来安装这个库：

pip3 install poe-api

这个库依赖于 quickjs，而 quickjs 没有为 Python 3.11 提供预编译二进制文件。Pip 将尝试编译它，但如果没有安装 python-dev，则会失败。

在 Linux 上，你可以按照这里列出的说明安装：https://stackoverflow.com/questions/21530577/fatal-error-python-h-no-such-file-or-directory

在 Windows 和 MacOS 上，python-dev 应该包含在你现有的 Python 安装中。

文档：

示例可以在 /examples 目录中找到。要运行这些示例，请将你的令牌作为命令行参数传入。

python3 examples/temporary_message.py "在此处填入令牌"

查找你的令牌：

在任何桌面网络浏览器上登录 Poe，然后打开浏览器的开发者工具（也称为"检查"），在以下菜单中查找 p-b cookie 的值：

Chromium：开发者工具 > 应用程序 > Cookies > poe.com
Firefox：开发者工具 > 存储 > Cookies
Safari：开发者工具 > 存储 > Cookies

请注意，过度使用此库可能导致你的账户被封禁。建议你设置自己的速率限制，并使用一个你不太看重的备用账户。详情请参阅问题 #118。如果你的请求不频繁，被封禁的风险很低。

使用客户端：

要使用这个库，只需导入 poe 并创建一个 poe.Client 实例。Client 类接受以下参数：

token - 要使用的令牌。
proxy = None - 要使用的代理，格式为 protocol://host:port。推荐使用 socks5h 协议，因为它也会代理 DNS 查询。
device_id = None - 要使用的设备 ID。如果未指定，将随机生成并存储在磁盘上。
headers = headers - 要使用的头部。默认为 poe.headers 中指定的头部。
client_identifier = client_identifier - 将传递给 TLS 客户端库的客户端标识符。默认为 poe.client_identifier 中指定的值。
formkey = None - 要使用的 formkey。只有在初始化客户端失败时才提供此选项。你可以通过进入浏览器的开发者工具，在网络标签中查找 gql_POST 请求，并获取 poe-formkey 请求头的值来找到此值。你使用的 formkey 必须来自与你在 poe.headers 中设置的头部匹配的浏览器。请记住，默认浏览器是 Chromium 112。

常规示例：

import poe
client = poe.Client("在此处填入令牌")

使用代理的示例：

import poe
client = poe.Client("在此处填入令牌", proxy="socks5h://178.62.100.151:59166")

请注意，以下示例假设 client 是你的 poe.Client 实例的名称。如果令牌无效，将引发 RuntimeError。

下载可用的机器人：

客户端在初始化时下载所有可用的机器人，并将它们存储在 client.bots 中。将机器人代号映射到其显示名称的字典可以在 client.bot_names 中找到。如果你想刷新这些值，可以调用 client.get_bots。此函数接受以下参数：

download_next_data = True - 是否重新下载 __NEXT_DATA__，如果机器人列表已更改，则需要此参数。

print(json.dumps(client.bot_names, indent=2))
"""
{
  "chinchilla": "ChatGPT",
  "a2": "Claude-instant",
  "capybara": "Assistant",
  "a2_100k": "Claude-instant-100k",
  "llama_2_7b_chat": "Llama-2-7b",
  "llama_2_13b_chat": "Llama-2-13b",
  "a2_2": "Claude-2-100k",
  "llama_2_70b_chat": "Llama-2-70b",
  "agouti": "ChatGPT-16k",
  "beaver": "GPT-4",
  "vizcacha": "GPT-4-32k",
  "acouchy": "Google-PaLM"
}
"""

请注意，在免费账户上，Claude+（a2_2）每天限制 3 条消息，GPT-4（beaver）每天限制 1 条消息。免费账户完全无法访问 Claude-instant-100k（c2_100k）。对于所有其他聊天机器人，似乎有每分钟 10 条消息的速率限制。

使用第三方机器人：

要获取第三方机器人列表，使用 client.explore_bots，它接受以下参数：

end_cursor = None - 获取列表时使用的游标。
count = 25 - 返回的机器人数量。

该函数将返回一个包含机器人列表和下一页游标的字典：

print(json.dumps(client.explore_bots(count=1), indent=2))
"""
{
  "bots": [
    {
      "id": "Qm90OjEwMzI2MDI=",
      "displayName": "leocooks",
      "deletionState": "not_deleted",
      "image": {
        "__typename": "UrlBotImage",
        "url": "https://qph.cf2.quoracdn.net/main-thumb-pb-1032602-200-uorvomwowfgmatdvrtwajtwwqlujmmgu.jpeg"
      },
      "botId": 1032602,
      "followerCount": 1922,
      "description": "世界知名厨师 Leonardo 为普通厨师提供的高于平均水平的简单菜肴",
      "__typename": "Bot"
    }
  ],
  "end_cursor": "1000172"
}
"""

要获取特定的第三方机器人，你可以使用 client.get_bot_by_codename，它只接受机器人的代号作为唯一参数。

client.get_bot_by_codename("JapaneseTutor")

由于自定义机器人的显示名称与代号相同，你可以简单地将机器人的显示名称传递给 client.send_message 来向它发送消息。

创建新机器人：

你可以使用 client.create_bot 函数创建一个新的机器人，该函数接受以下参数：

handle - 新机器人的句柄。
prompt = "" - 新机器人的提示。
display_name = None - 新机器人的显示名称。
base_model = "chinchilla" - 新机器人使用的模型。必须是 "chinchilla" (ChatGPT) 或 "a2" (Claude)。如果你已订阅，可以使用 "beaver" (ChatGPT4) 或 "a2_2" (Claude-2-100k)。
description = "" - 新机器人的描述。
intro_message = "" - 新机器人的介绍消息。如果为空字符串，则机器人不会有介绍消息。
prompt_public = True - 提示是否应该公开可见。
pfp_url = None - 机器人头像的URL。目前，使用此库无法上传自定义图片。
linkification = False - 机器人是否应将回复中的某些文本转换为可点击的链接。
markdown_rendering = True - 是否为机器人的回复启用markdown渲染。
suggested_replies = False - 机器人是否应在每次回复后提供建议回复。
private = False - 机器人是否应该是私密的。
temperature = None - 新机器人的温度设置。

如果你想让新机器人使用你自己的API（详见此处），请使用这些参数：

api_key = None - 新机器人的API密钥。
api_bot = False - 机器人是否启用API功能。
api_url = None - 新机器人的API URL。

创建和编辑机器人的完整示例位于 examples/create_bot.py。

new_bot = client.create_bot(bot_name, "prompt goes here", base_model="a2")

编辑机器人：

你可以使用 client.edit_bot 函数编辑自定义机器人，该函数接受以下参数：

bot_id - 要编辑的机器人的 botId。也可以设置为 None。
handle - 你正在编辑的机器人的句柄。
prompt - 机器人的新提示。
new_handle = None - 机器人的新句柄。默认情况下句柄不会改变。
display_name = None - 机器人的新显示名称。
base_model = "chinchilla" - 机器人使用的新模型。必须是 "chinchilla" (ChatGPT) 或 "a2" (Claude)。如果你已订阅，可以使用 "beaver" (ChatGPT4) 或 "a2_2" (Claude-2-100k)。
description = "" - 机器人的新描述。
intro_message = "" - 机器人的新介绍消息。如果为空字符串，则机器人不会有介绍消息。
prompt_public = True - 提示是否应该公开可见。
pfp_url = None - 机器人头像的URL。目前，使用此库无法上传自定义图片。
linkification = False - 机器人是否应将回复中的某些文本转换为可点击的链接。
markdown_rendering = True - 是否为机器人的回复启用markdown渲染。
suggested_replies = False - 机器人是否应在每次回复后提供建议回复。
private = False - 机器人是否应该是私密的。
temperature = None - 此机器人的新温度设置。

机器人API相关参数：

api_key = None - 机器人的新API密钥。
api_url = None - 机器人的新API URL。

创建和编辑机器人的完整示例位于 examples/create_bot.py。

edit_result = client.edit_bot(1086981, "bot_handle_here", base_model="a2")

发送消息：

你可以使用 client.send_message 函数向聊天机器人发送消息，该函数接受以下参数：

chatbot - 聊天机器人的代号。（例如：capybara）
message - 要发送给聊天机器人的消息。
with_chat_break = False - 是否应清除对话上下文。
timeout = 20 - 在收到的块之间引发 RuntimeError 之前的最大秒数。
async_recv = True - 是否异步进行 receive_POST 请求。如果禁用，则在消息完成后会有额外约3秒的等待。
suggest_callback = None - 建议回复的回调函数。有关如何使用的示例，请参见 examples/send_message.py。

该函数是一个生成器，每当生成的消息更新时，它都会返回最新版本。

流式示例：

message = "Summarize the GNU GPL v3"
for chunk in client.send_message("capybara", message):
  print(chunk["text_new"], end="", flush=True)

非流式示例：

message = "Summarize the GNU GPL v3"
for chunk in client.send_message("capybara", message):
  pass
print(chunk["text"])

你还可以使用 threading 并行发送多条消息，并分别接收它们的回复，如 /examples/parallel_messages.py 中所示。请注意，如果你发送消息过快，服务器会给出错误，但请求最终会成功。

client.is_busy 函数可用于检查当前是否正在接收消息。

清除对话上下文：

如果你想在不发送消息的情况下清除对话的上下文，可以使用 client.send_chat_break。唯一的参数是要清除上下文的机器人的代号。

client.send_chat_break("capybara")

该函数返回代表聊天中断的消息。

下载对话历史：

要下载对话中的过去消息，请使用 client.get_message_history 函数，该函数接受以下参数：

chatbot - 聊天机器人的代号。
count = 25 - 要下载的消息数量。
cursor = None - 从哪条消息ID开始，而不是最新的一条。

请注意，如果你不指定光标，客户端将需要执行额外的请求以确定最新的光标是什么。

返回的消息按从旧到新的顺序排列。

message_history = client.get_message_history("capybara", count=10)
print(json.dumps(message_history, indent=2))
"""
[
  {
    "node": {
      "id": "TWVzc2FnZToxMDEwNzYyODU=",
      "messageId": 101076285,
      "creationTime": 1679298157718888,
      "text": "",
      "author": "chat_break",
      "linkifiedText": "",
      "state": "complete",
      "suggestedReplies": [],
      "vote": null,
      "voteReason": null,
      "__typename": "Message"
    },
    "cursor": "101076285",
    "id": "TWVzc2FnZUVkZ2U6MTAxMDc2Mjg1OjEwMTA3NjI4NQ=="
  },
  ...
]
"""

删除消息：

要删除消息，请使用 client.delete_message 函数，该函数接受一个参数。你可以传入一个消息ID来删除单条消息，也可以传入一个消息ID列表来一次性删除多条消息。

#删除单条消息
client.delete_message(96105719)

#一次性删除多条消息
client.delete_message([96105719, 96097108, 96097078, 96084421, 96084402])

清除对话：

要清除整个对话或仅最后几条消息，可以使用 client.purge_conversation 函数。该函数接受以下参数：

chatbot - 聊天机器人的代号。
count = -1 - 要删除的消息数量，从最新的消息开始。默认行为是删除所有消息。

#仅清除最后10条消息
client.purge_conversation("capybara", count=10)

#清除整个对话
client.purge_conversation("capybara")

清除所有对话：

要清除你账户中的每个对话，请使用 client.purge_all_conversations 函数。此函数不需要任何参数。

>>> client.purge_all_conversations()

获取剩余消息数：

要获取对话配额中剩余的消息数，请使用 client.get_remaining_messages 函数。该函数接受以下参数：

chatbot - 聊天机器人的代号。

该函数将返回剩余的消息数，如果机器人没有配额，则返回 None。

>>> client.get_remaining_messages("beaver")
1

杂项：

更改日志级别：

如果你想显示调试消息，只需调用 poe.logger.setLevel。

import poe
import logging
poe.logger.setLevel(logging.INFO)

设置自定义用户代理：

如果你想更改被伪造的头部信息，请在导入库后设置 poe.headers。

要使用你浏览器自己的头部信息，请访问此网站，并复制粘贴其内容。

import poe
poe.headers = {
  "User-Agent": "Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Firefox/102.0",
  'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*q=0.8,application/signed-exchange;v=b3;q=0.7',
  "Accept-Encoding": "gzip, deflate, br",
  'Accept-Language': 'zh-CN,zh;q=0.9,en;q=0.8,en-GB;q=0.7,en-US;q=0.6',
  "Upgrade-Insecure-Requests": "1"
}

以下头部信息将被忽略并覆盖：

{
  "Referrer": "https://poe.com/",
  "Origin": "https://poe.com",
  "Host": "poe.com",
  "Cache-Control": "no-cache",
  "Sec-Fetch-Dest": "document",
  "Sec-Fetch-Mode": "navigate",
  "Sec-Fetch-Site": "same-origin",
  "Sec-Fetch-User": "?1",
}

之前这是通过 poe.user_agent 完成的，但现在该变量完全被忽略。

你还需要更改 poe.client_identifier 以匹配你设置的用户代理。查看 Python-TLS-Client 文档以获取一些示例值。请注意，伪造 Chrome/Firefox 版本 >= 110 可能会被检测到。

poe.client_identifier = "chrome_107"

设置自定义设备 ID：

如果你想更改被伪造的设备 ID，可以使用 poe.set_device_id，它接受以下参数：

user_id - 你想更改设备 ID 的账户的用户 ID。用户 ID 可以在 client.viewer["poeUser"]["id"] 中找到。
device_id - 新的设备 ID。这是一个 32 字符的 UUID 字符串，格式如下：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

poe.set_device_id("UGMlVXqlcLYyMOATMDsKNTMz", "6d659b04-043a-41f8-97c7-fb7d7fe9ad34")

设备 ID 保存在类 Unix 系统的 ~/.config/poe-api/device_id.json 中，在 Windows 上保存在 C:\Users\<user>\AppData\Roaming\poe-api\device_id.json 中。

此外，poe.get_device_id 函数或 client.device_id 可用于检索保存的设备 ID。

>>> poe.get_device_id("UGMlVXqlcLYyMOATMDsKNTMz")
#6d659b04-043a-41f8-97c7-fb7d7fe9ad34

>>> client.device_id
#6d659b04-043a-41f8-97c7-fb7d7fe9ad34

版权：

本程序根据 GNU GPL v3 许可。除 GraphQL 查询外，大部分代码均由我 ading2210 编写。

poe-tag-id 头部的逆向工程由 xtekky 在 PR #39 中完成。

client.get_remaining_messages 函数由 Snowad14 在 PR #46 中编写。

检测规避和获取第三方机器人的功能由 acheong08 在 PR #79 中完成。

大多数 GraphQL 查询来自 muharamdani/poe，该项目基于 ISC 许可。

版权声明：

ading2210/poe-api：Quora 的 Poe 的逆向工程 Python API 封装
版权所有 (C) 2023 ading2210

本程序是自由软件：你可以根据自由软件基金会发布的 GNU 通用公共许可证的条款，即许可证的第 3 版或（按你的选择）任何后来的版本重新发布它和/或修改它。

发布这一程序是希望它有用，但没有任何担保；甚至没有适销性或特定用途适用性的隐含担保。详情请参阅 GNU 通用公共许可证。

你应该已经收到一份 GNU 通用公共许可证的副本。如果没有，请参阅 <https://www.gnu.org/licenses/>。