OpenAI CLI 速查表
OpenAI 官方 CLI 是操作 OpenAI API 最直接的工具。安装 `openai` Python 包后即可使用,支持聊天补全、图片生成(DALL-E)、音频转录/合成(Whisper/TTS)、嵌入向量、文件管理和模型微调等全部 API 能力。设置环境变量 `OPENAI_API_KEY` 后即可开始使用。
快速开始
``bash
# 安装
pip install openai
# 设置 API Key export OPENAI_API_KEY=sk-proj-xxx
# 列出可用模型 openai api models.list
# 基本聊天 openai api chat.completions.create -m gpt-4o -g user "你好!"
# 流式输出 openai api chat.completions.create -m gpt-4o -g user "讲个故事" --stream
# 生成图片
openai api images.generate -p "在火星上的宇航猫"
`
身份认证
CLI 通过 OPENAI_API_KEY 环境变量认证。也可用 -k 参数临时覆盖。Azure OpenAI 用户使用 -t azure 配合 Azure 专属参数。
聊天补全
核心功能。使用 openai api chat.completions.create,-m 指定模型,-g 指定消息(可多次使用实现多轮对话)。系统提示词:-g system '指令'。流式输出:加 --stream。
图片生成(DALL-E)
使用 openai api images.generate,-p 指定提示词,-n 指定数量(1-10),-s 指定尺寸。图片编辑用 openai api images.edit。
音频(Whisper 和 TTS)
转录:openai api audio.transcriptions.create -f audio.mp3。翻译:openai api audio.translations.create -f chinese.mp3。语音合成:openai api audio.speech.create --input "你好" --voice alloy。
嵌入向量
为 RAG 和语义搜索创建文本嵌入:openai api embeddings.create -m text-embedding-3-small -i "你的文本"。
模型微调
上传训练数据 → 创建微调任务 → 监控状态 → 像其他模型一样使用微调后的模型 ID。
文件管理
文件用于微调和批处理。使用 openai api files.list、files.create、files.retrieve、files.delete` 管理。
启动模式(12)
| 命令 | 难度 | ||
|---|---|---|---|
openai --help显示帮助信息 | 基础 | openai --help | |
openai -k指定 API Key(临时覆盖环境变量) | 基础 | openai -k sk-xxx api models.list | |
openai -b指定 API 基础 URL(兼容第三方 API) | 中级 | openai -b https://api.openai.com/v1 api models.list | |
openai -o指定组织 ID | 中级 | openai -o org-xxx api models.list | |
export OPENAI_API_KEY设置 API Key 环境变量 | 基础 | export OPENAI_API_KEY=sk-proj-xxx | |
export OPENAI_BASE_URL设置自定义 API 端点(兼容第三方) | 中级 | export OPENAI_BASE_URL=https://api.example.com/v1 | |
openai api models.list列出所有可用的模型 | 基础 | openai api models.list | |
openai api models.retrieve查看指定模型的详细信息 | 基础 | openai api models.retrieve gpt-4o | |
openai api moderations.create检查内容是否符合政策 | 中级 | openai api moderations.create -i 'I want to harm someone' | |
openai api completions.create创建文本补全(旧版 API) | 中级 | openai api completions.create -m gpt-3.5-turbo-instruct -p 'Once upon a time' -M 100 | |
curl -X POST https://api.openai.com/v1/chat/completions使用 curl 调用 Chat Completions API | 中级 | curl -s https://api.openai.com/v1/chat/completions -H 'Content-Type: application/json' -H 'Authorization: Bearer $OPENAI_API_KEY' -d '{"model":"gpt-4o","messages":[{"role":"user","content":"Hello"}]}'
| |
openai -V查看 openai CLI 版本 | 基础 | openai -V |
会话命令(8)
| 命令 | 难度 | ||
|---|---|---|---|
openai api chat.completions.create创建聊天补全(需指定模型和消息) | 基础 | openai api chat.completions.create -m gpt-4o -g user 'Hello!' | |
openai api chat.completions.create -m指定模型进行聊天 | 基础 | openai api chat.completions.create -m gpt-4o -g user 'What is AI?' | |
openai api chat.completions.create -g添加多轮对话消息(可多次使用) | 基础 | openai api chat.completions.create -m gpt-4o -g user 'Hi' -g assistant 'Hello!' -g user 'How are you?' | |
openai api chat.completions.create -g system设置系统提示词(system message) | 中级 | openai api chat.completions.create -m gpt-4o -g system 'You are a helpful assistant' -g user 'Hello' | |
openai api chat.completions.create --stream流式输出聊天补全 | 中级 | openai api chat.completions.create -m gpt-4o -g user 'Tell me a story' --stream | |
openai api chat.completions.create -t设置温度参数(0-2,默认1) | 中级 | openai api chat.completions.create -m gpt-4o -g user 'Explain quantum' -t 0.3 | |
openai api chat.completions.create -M设置最大输出 token 数 | 中级 | openai api chat.completions.create -m gpt-4o -g user 'Write essay' -M 2048 | |
openai api chat.completions.create -n生成多个回复供选择 | 中级 | openai api chat.completions.create -m gpt-4o -g user 'Solve math' -n 3 |
ai-image(4)
| 命令 | 难度 | ||
|---|---|---|---|
openai api images.generate根据文字描述生成图片(DALL-E) | 基础 | openai api images.generate -p 'A cat astronaut on Mars' -n 1 -s 1024x1024 | |
openai api images.generate -p指定图片描述提示词 | 基础 | openai api images.generate -p 'Cyberpunk city at night, neon lights' -n 2 | |
openai api images.generate -s指定图片尺寸 | 基础 | openai api images.generate -p 'Mountain landscape' -s 1792x1024 | |
openai api images.edit编辑已有图片(基于蒙版) | 高级 | openai api images.edit -i input.png -m mask.png -p 'Add a flower' |
ai-audio(3)
| 命令 | 难度 | ||
|---|---|---|---|
openai api audio.transcriptions.create将音频转录为文字(Whisper) | 基础 | openai api audio.transcriptions.create -f recording.mp3 -m whisper-1 | |
openai api audio.translations.create将非英文音频翻译为英文 | 基础 | openai api audio.translations.create -f chinese_speech.mp3 -m whisper-1 | |
openai api audio.speech.create将文字转为语音(TTS) | 基础 | openai api audio.speech.create --input 'Hello world' --voice alloy --model tts-1 |
ai-embedding(1)
| 命令 | 难度 | ||
|---|---|---|---|
openai api embeddings.create创建文本嵌入向量 | 中级 | openai api embeddings.create -m text-embedding-3-small -i 'Hello world' |
文件管理(4)
| 命令 | 难度 | ||
|---|---|---|---|
openai api files.list列出已上传的文件 | 基础 | openai api files.list | |
openai api files.create上传文件(用于微调或批处理) | 中级 | openai api files.create -f training_data.jsonl -p fine-tune | |
openai api files.retrieve查看文件详情 | 基础 | openai api files.retrieve file-xxx | |
openai api files.delete删除已上传的文件 | 基础 | openai api files.delete file-xxx |
ai-training(6)
| 命令 | 难度 | ||
|---|---|---|---|
openai api fine_tuning.jobs.create创建微调任务 | 高级 | openai api fine_tuning.jobs.create -t file-xxx -m gpt-4o-mini | |
openai api fine_tuning.jobs.list列出所有微调任务 | 中级 | openai api fine_tuning.jobs.list | |
openai api fine_tuning.jobs.retrieve查看微调任务状态 | 中级 | openai api fine_tuning.jobs.retrieve ftjob-xxx | |
openai api fine_tuning.jobs.cancel取消正在运行的微调任务 | 中级 | openai api fine_tuning.jobs.cancel ftjob-xxx | |
openai api fine_tuning.jobs.list_events查看微调任务的事件日志 | 中级 | openai api fine_tuning.jobs.list_events ftjob-xxx | |
openai tools fine_tunes.prepare_data验证并准备微调数据文件 | 高级 | openai tools fine_tunes.prepare_data -f training_data.jsonl |