Coze SDK工具包:全面指南
前言
哈喽大家好,我是船长团队的缪斯,感谢关注和阅读!就在本周二,10月15日,扣子官方悄悄放出了一条让开发者们振奋的好消息——扣子的官方SDK工具包正式上线了!这次更新不仅支持了所有的扣子接口,还覆盖了各种鉴权方式,给开发者带来了更便捷、更强大的开发体验。以下是Coze Python SDK的详细安装和使用教程。
SDK是什么?为何重要?
什么是SDK?
SDK,全称是Software Development Kit,即软件开发工具包。简而言之,它是一组工具、库、文档和示例代码的集合,帮助开发者在特定平台上更轻松地构建应用程序。
为何使用SDK?
通过SDK,开发者不需要从零开始构建复杂功能,只需调用现有的接口,就能快速集成各种服务和功能,从而大大节省了开发时间和精力。对于扣子来说,这次推出的Coze Python SDK工具包让开发者们能够方便地使用Python代码来调用扣子的各种API接口,进行智能体的开发、数据交互、以及各种鉴权方式的处理,并且集成到我们自己的应用中。
如何安装Coze Python SDK?
步骤一:检查Python版本
在安装Coze Python SDK之前,确保你的Python版本为3.7及以上。通过以下命令检查:
bash
python –version
输出示例:已安装3.10.15版本。
步骤二:安装Coze Python SDK
打开命令行终端,输入以下命令:
bash
pip install cozepy
如果安装成功,终端会显示Successfully installed
字样。
如何配置访问密钥?
为什么要配置密钥?
在使用Coze Python SDK调用扣子的智能体之前,必须进行身份认证和权限校验,配置访问密钥是实现该功能的关键步骤。
如何获取个人访问密钥?
扣子提供了两种方式来获得访问密钥:
- 个人访问密钥:直接获取,适合个人项目。
- OAuth 鉴权:适合复杂的业务场景,安全性更高。
获取个人秘钥步骤:
- 访问申请链接:申请个人秘钥
- 添加名称、过期时间及权限。
- 注意:秘钥令牌只会显示一次,记得保存。
如何使用Coze SDK进行开发?
准备工作
创建一个测试SDK的Bot。在发布配置界面勾选”Agent as API“。
编写代码示例
以下是一个简单的代码示例,演示如何使用Coze SDK创建一个聊天Bot:
python
import os
import time
from cozepy import Coze, TokenAuth, Message, ChatStatus
通过个人访问密钥或 OAuth 获取 access_token
api_coze_token = “你的实际 PAT 密钥”
使用 access_token 初始化 Coze 客户端
coze = Coze(auth=TokenAuth(token=api_coze_token))
在 Coze 中创建一个 bot 实例
bot_id = “你的实际 bot ID”
user_id = “Muse”
调用 coze.chat.create 方法来创建一个聊天
chat = coze.chat.create(bot_id=bot_id, user_id=user_id)
设置超时时间为10分钟。轮询聊天状态
start = int(time.time())
timeout = 600
while chat.status ChatStatus.IN_PROGRESS:
if int(time.time()) – start > timeout:
coze.chat.cancel(conversation_id=chat.conversation_id, chat_id=chat.id)
print(“Chat has been cancelled due to timeout.”)
break
time.sleep(1)
chat = coze.chat.retrieve(conversation_id=chat.conversation_id, chat_id=chat.id)
获取聊天消息
messages = coze.chat.messages.list(conversation_id=chat.conversation_id, chat_id=chat.id)
for message in messages:
print(f”role={message.role}, content={message.content}”)
效果展示
通过此代码,你可以与Bot进行互动,获取相关消息。
我认为: SDK的出现,尤其是像Coze这种易于使用的工具包,大大降低了开发者的技术门槛,让更多人有机会在复杂的技术领域中尝试新东西。正如鲁迅所说,学习要有一个过程,但工具可以让这个过程变得更加高效。, , ,