BCE-Qianfan SDK 使用教程

BCE-Qianfan SDK 使用教程

bce-qianfan-sdk项目地址:https://gitcode.com/gh_mirrors/bc/bce-qianfan-sdk

1. 项目目录结构及介绍

项目目录结构:

.
├── cookbook            # 示例代码和最佳实践
├── docs                 # 文档资料
├── go                   # Go 语言SDK源码
├── java                 # Java 语言SDK源码
├── javascript           # JavaScript 语言SDK源码
├── python               # Python 语言SDK源码
├── .gitignore           # Git 忽略规则文件
├── README.md            # 项目简介
├── dotenv_config_sample.env  # 配置示例文件
└── Makefile             # Makefile构建脚本

目录解释:

• cookbook: 提供使用SDK的实际例子和最佳实践。
• docs: 包含项目的详细文档。
• <编程语言>: SDK的源代码，如Go、Java、JavaScript和Python。
• .gitignore: 规定在Git中忽略哪些文件。
• README.md: 对项目的基本介绍和快速入门指南。
• dotenv_config_sample.env: 示例配置文件，用于设置SDK的环境变量。
• Makefile: 用于构建项目的脚本。

2. 项目的启动文件介绍

由于该项目是SDK，通常不会有单一的“启动”文件。不过，开发人员会创建自己的应用程序或脚本来利用SDK的功能。例如，在Python环境下，一个简单的启动点可能是导入qianfan模块并初始化所需的服务，如ChatCompletion()来进行对话：

import os
import qianfan

os.environ['QIANFAN_ACCESS_KEY'] = "your_access_key"
os.environ['QIANFAN_SECRET_KEY'] = "your_secret_key"

chat = qianfan.ChatCompletion()
response = chat.do(messages=[{"role": "user", "content": "你好，千帆"}])

在这个例子中，qianfan(ChatCompletion())表示创建了一个用于聊天完成的对象，然后调用do()方法发起请求。

3. 项目的配置文件介绍

配置文件主要用于存储敏感信息，如Access Key和Secret Key。虽然这里提供的样例文件是.dotenv_config_sample.env，但实际部署时应将此文件重命名为.env并放置于项目根目录下，以隐藏这些关键信息。

.env 文件样本:

QIANFAN_ACCESS_KEY=your_access_key
QIANFAN_SECRET_KEY=your_secret_key

在你的代码中，可以通过os.environ来读取这些环境变量，例如上面Python示例中的做法。这样可以避免直接在代码中硬编码敏感信息，提高安全性。

在执行任何操作前，请确保替换上述your_access_key和your_secret_key为从百度智能云控制台获取的真实凭证。更多关于配置和使用SDK的信息，建议查阅官方文档。

bce-qianfan-sdk项目地址:https://gitcode.com/gh_mirrors/bc/bce-qianfan-sdk