使用方法

更新时间：2024-10-21

通过以下命令使用千帆命令行CLI工具，更多介绍请参考命令列表。

qianfan [OPTIONS] <COMMAND> [ARGS]...
# 例如：
# qianfan --version
# qianfan --help

基础参数OPTIONS

注意：基础参数必须在 command 命令之前，否则会被识别成命令参数无法生效。

参数	描述
`--access-key TEXT`	百度智能云安全认证 Access Key。获取方式参考文档
`--secret-key TEXT`	百度智能云安全认证 Secret Key。获取方式参考文档
`--ak TEXT`（过时）	过时的千帆平台应用的 API Key，仅能用于模型推理部分 API。获取方式参考文档
`--sk TEXT`（过时）	过时的千帆平台应用的 Secret Key，仅能用于模型推理部分 API。获取方式参考文档
`--enable-traceback`	打印完整的错误堆栈信息，仅在发生异常时有效。
`--version -v`	打印版本信息。
`--install-shell-autocomplete`	为当前 shell 安装自动补全脚本。
`--show-shell-autocomplete`	展示自动补全脚本。
`--help -h`	打印帮助文档。

支持的COMMAND命令列表如下，更多命令使用请参考命令列表

命令	类别	描述	文档
chat	对话Chat	创建对话Chat，用于发起一次对话。	chat 对话
completion	续写Completions	创建completion，用于发起一次续写请求，不支持多轮会话等。	completion 补全
txt2img	文生图	根据输入文本生成图片。	txt2img 文生图
dataset	数据集	用于训练和测试模型的数据集，通常包含多个样本和标签，用于机器学习和深度学习任务。	dataset 数据集
trainer	训练trainer	支持对数据集进行自定义训练。	trainer 训练
evaluation	评估	运行评估任务。	evaluation 评估
plugin	插件应用	插件相关。	plugin 插件

更多介绍详见chat 对话使用文档。

qianfan chat [OPTIONS]   
# 例如：
# # qianfan chat --model ERNIE-Bot-4

更多介绍详见completion 补全使用文档。

qianfan completion [OPTIONS]
# 例如：
# qianfan completion 大模型的优势

更多介绍详见txt2img 文生图使用文档。

qianfan txt2img [OPTIONS] 
# 例如：
# qianfan txt2img "a tall man in black shirt"

qianfan dataset [OPTIONS] <COMMAND> 

# 例如
# qianfan plugin [OPTIONS]

qianfan dataset [OPTIONS] <COMMAND> 

# 例如
# qianfan dataset view 46685

qianfan trainer [OPTIONS] COMMAND [ARGS]...