Skip to content

README.zh_CN.md

Latest commit

 

History

History
70 lines (49 loc) · 1.61 KB

README.zh_CN.md

File metadata and controls

70 lines (49 loc) · 1.61 KB

CozeLoop Python SDK

English | 简体中文

概述

CozeLoop SDK 是一个用于与 CozeLoop 平台 进行交互的 Python 客户端。 主要功能：

  • Trace上报
  • Prompt拉取
  • 执行Prompt as a Service (PTaaS)

要求

  • Python 3.8 或更高版本

安装

pip install CozeLoop

用法

初始化

首先，访问 https://www.coze.cn/open/oauth/apps 并创建一个 OAuth 应用， 获取应用所有者的 AppID、公钥和私钥。

设置环境变量

export COZELOOP_WORKSPACE_ID=your workspace id
export COZELOOP_JWT_OAUTH_CLIENT_ID=your client id
export COZELOOP_JWT_OAUTH_PRIVATE_KEY=your private key
export COZELOOP_JWT_OAUTH_PUBLIC_KEY_ID=your public key id

Trace上报

def main():
    span = cozeloop.start_span("root", "custom")

    span.set_input("Hello") 
    span.set_output("World") 
	
    span.finish()
	
    cozeloop.close()

Prompt拉取

def main():
    prompt = cozeloop.get_prompt(prompt_key="your_prompt_key")
    messages = cozeloop.prompt_format(
        prompt,
        {"var1": "your content"},
    )

你可以在 这里 查看更多示例。

贡献

如需了解更多详细信息，请查看 Contributing。

安全

如果你发现本项目中存在潜在的安全问题，或者认为自己可能发现了安全问题，请通过我们的 安全中心 或 漏洞报告邮箱 通知字节跳动安全团队。 请不要创建公开的 GitHub 问题。

License

本项目采用 MIT License。