豆包 API 调用示例代码详解-Python版

豆包 API 调用示例代码详解-Python版

在本文中，我们将详细介绍如何使用 Python 调用豆包 API，并提供相关的事前准备和代码执行步骤。

一、事前准备

1. 密钥申请：
   • 要使用豆包 API，首先需要申请一个授权密钥。在上述代码中，密钥存储在 headers 字典的 Authorization 值中，格式为 Bearer pat_DhYQxAFQpXLeH8uyu0i1K7PSOvTXkQI****。具体的申请流程可能因豆包 API 的提供商而异，需要根据相关文档进行操作。
2. Bot创建：
   • 确保已经创建了Bot，并发布以 bot as api方式发布。这个机器人将用于处理用户的请求并返回响应。

二、所需 Python 包

执行上述 demo 代码需要安装以下 Python 包：

1. requests：用于发送 HTTP 请求与 API 进行交互。
2. json：用于处理 JSON 数据。

可以使用以下命令通过 pip 安装这些包：

pip install requests

三、代码详解

1. do_chat 函数：
   • 该函数用于发起与豆包的对话。它向 https://api.coze.cn/v3/chat 发送 POST 请求，传递对话相关的数据，包括机器人 ID、用户 ID、是否流式响应、是否自动保存历史会话以及用户的消息。
   • 请求头中包含了授权信息和内容类型。
   • 函数返回响应中的数据。
2. do_retrieve 函数：
   • 此函数用于查询会话是否输出完毕。它向 https://api.coze.cn/v3/chat/retrieve 发送 GET 请求，通过传递会话 ID 和聊天 ID 来获取会话的状态。
   • 函数返回会话的状态。
3. get_msg 函数：
   • 该函数用于获取豆包输出的消息。它向 https://api.coze.cn/v3/chat/message/list 发送 GET 请求，同样通过会话 ID 和聊天 ID 来获取消息列表。
   • 函数返回最近的一条消息内容。
4. call_doubao 函数：
   • 这是主要的调用函数。它首先调用 do_chat 发起对话，获取会话 ID 和聊天 ID。
   • 然后使用 do_retrieve 不断查询会话状态，直到状态变为 completed，表示豆包说完话。
   • 最后，使用 get_msg 获取豆包的回复消息。
5. if __name__ == '__main__' 部分：
   • 这是主程序入口，示例了如何调用 call_doubao 函数与豆包进行交互，并打印出用户的输入和豆包的回复。

五、源码下载

Python源码

四、总结

通过以上步骤，我们可以成功地使用 Python 调用豆包 API 进行对话。在实际应用中，可以根据需要进一步扩展和优化代码，以满足具体的业务需求。

希望这篇文章对您理解和使用豆包 API 有所帮助。如果您在实践过程中遇到任何问题，欢迎随时提问。

豆包官方API文档

https://www.coze.cn/docs/developer_guides/coze_api_overview