tldr-pages 中的 openai 速查页全解析：用 `openai` 命令行工具调用 OpenAI API 的实践指南

文档教程知识库【免费下载链接】tldrCollaborative cheatsheets for console commands .项目地址https://gitcode.com/GitHub_Trending/tl/tldr点击查看免费下载本文以 tldr-pages 仓库中的openai页面为骨架逐条拆解其四个核心命令示例列出模型、文本补全、对话补全、DALL·E 图像生成并结合本仓库的页面规范、占位符语法、多语言翻译规则与客户端使用方式帮助读者快速掌握openaiCLI 的常见用法同时理解这份速查页是如何被编写、校验与渲染的。页面速览这张速查页讲了什么openai是一个提供 OpenAI API 访问能力的命令行工具其速查页被收录在 tldr-pages 的common平台目录下英文原版意味着该命令在多个平台上用法一致不绑定任何特定操作系统。页面在标题下方的描述行中明确写道CLI tool providing access to the OpenAI API一个提供 OpenAI API 访问能力的 CLI 工具并在 More information 行中指向openai-python项目——也就是说这里的openai命令指的就是官方 Python SDK 附带的可执行入口而不是其他同名工具。整个页面仅用一个 H1 标题、一段描述和四条示例命令构成了完整的速查信息功能命令形式说明列出可用模型openai api models.list查询当前账号可调用的模型清单文本补全openai api completions.create --model {{ada}} --prompt {{Hello world}}针对给定提示生成续写文本对话补全openai api chat_completions.create --model {{gpt-3.5-turbo}} --message {{user Hello world}}以多轮消息结构进行对话式生成DALL·E 图像生成openai api image.create --prompt {{...}} --num-images {{1}}依据提示词生成图像命令逐条详解四类常见 API 调用列出可用模型openai api models.listmodels.list对应 OpenAI API 的模型列表端点是最简单的探测性命令。执行后终端会返回账号有权访问的模型标识列表可用于确认账号权限、核对可用模型名称为后续--model参数提供取值依据。创建文本补全openai api completions.create --model {{ada}} --prompt {{Hello world}}completions.create用于创建文本补全。这里有两个关键参数--model指定使用的模型页面示例以{{ada}}作为占位符——它是 OpenAI 早期系列中成本较低、速度较快的模型之一适合作为快速验证用法的示例值--prompt传入的提示文本被{{Hello world}}占位符包裹。按 tldr 规范接收字符串的占位符建议整体放进引号内即{{Hello world}}保证提示文本中的空格等字符被正确传递。创建对话补全openai api chat_completions.create --model {{gpt-3.5-turbo}} --message {{user Hello world}}chat_completions.create面向对话式场景页面示例使用{{gpt-3.5-turbo}}作为模型占位符。与文本补全不同的是对话补全需要以角色 内容的结构传入消息示例中的{{user Hello world}}即表示用户角色说了一句 Hello world——user指定消息来源角色后跟该角色的消息内容。熟悉这一结构后就可以扩展出多轮消息例如追加assistant角色的历史回复从而构造真正的多轮对话。通过 DALL·E API 生成图像openai api image.create --prompt {{كلبان يلعبان الشطرنج، كرتوني}} --num-images {{1}}image.create调用 DALL·E 图像生成接口--prompt传入图像描述--num-images指定生成张数示例为 1。值得注意的是阿拉伯语版本中的提示词占位符使用了本地化文本كلبان يلعبان الشطرنج، كرتوني两只狗在下国际象棋卡通风格对应的英文原版则是{{two dogs playing chess, cartoon}}——提示词本身是面向模型的自然语言因此翻译页面会将其本地化以便母语读者直观理解可用什么样的描述。多语言版本与阿拉伯语翻译的特殊规则openai页面在本仓库中目前存有三个版本分别位于pages/common/openai.md英文原版pages.ar/common/openai.md阿拉伯语pages.ko/common/openai.md韩语其中阿拉伯语版是本篇关联文档。根据仓库的通用占位符对照表中的明确提示阿拉伯语ar和波斯语fa页面中的占位符不应被翻译以防止阅读时出现反向文本RTL 语言下占位符翻转导致的可读性问题。观察 pages.ar/common/openai.md 可以看到{{ada}}、{{gpt-3.5-turbo}}、{{Hello world}}等占位符均保留英文原样这与该规则完全一致阿拉伯语样式指南也强调不要将{{path/to/file}}之类的占位符翻译为{{المسار/إلى/الملف}}以免造成混淆。速查页背后的格式规范这张页面严格遵循仓库通用样式指南的模板页面首行为# 命令名且文件名与命令名保持一致全部小写开头的行承载描述与 More information 链接每条示例由一行动词开头的祈使句描述和一行反引号包裹的命令组成整个页面最多 8 条示例。占位符是 tldr 页面最核心的语法元素语法含义{{value}}用户需要自行替换的占位值{{path/to/file}}文件/目录路径占位{{[-o\|--output]}}长短选项占位由客户端决定展示哪种形式{{user Hello world}}带引号的字符串占位{{1..5}}取值区间客户端会将这些{{ }}包裹的部分高亮显示帮助用户一眼定位需要替换的位置。仓库还通过tldr-lint见 package.json 中的依赖与 lint 脚本在每次提交时自动校验页面格式读者也可以在本地安装后检查任意页面npm install --global tldr-lint tldr-lint pages/common/openai.md如何实际使用这张速查页仓库 README.md 提供了多种官方客户端安装方式例如pipx install tldr # Python 客户端 brew install tlrc # Rust 客户端macOS/Linux cargo install tlrc --locked winget install tldr-pages.tlrc # Windows 上的 Rust 客户端 npm install -g tldr # Node.js 客户端安装完成后直接执行tldr openai即可在终端看到本文所述的速查页内容。客户端还会根据当前平台自动选择最合适的页面变体由于openai位于common目录它会在所有平台上被展示。此外按客户端规范tldr --platform common openai # 强制使用 common 平台的页面 tldr --render pages/common/openai.md # 在本地预览某个页面文件 tldr -l # 列出当前平台的所有页面其中--render对贡献者尤其有用——修改页面后可以先本地预览再提交。仓库中的其他 AI 命令行工具页面在 tldr-pages 仓库中openai页面并非孤例common目录下还有若干与 AI 工具相关的速查页可以对照阅读llm通过远程 API 与本地模型交互的通用 LLM 工具其页面包含llm keys set openai设置 OpenAI API Key、llm prompt等示例tgpt无需 API Key 即可对话的 AI 聊天工具页面列出了openai、opengpts、llama2等 provider并演示了如何通过--provider openai --key ... --model gpt-3.5-turbo显式指定 OpenAI 后端。这些页面与openai页面共同构成了仓库中通过命令行使用大模型的速查矩阵读者可以横向对比不同工具的调用方式差异。结语openai速查页虽然只有四条示例却完整覆盖了 OpenAI API 最常用的三类能力模型查询、文本/对话生成与图像生成。它既是 tldr-pages 页面格式规范的一个典型范本占位符、祈使句描述、More information 链接一应俱全也是阿拉伯语等 RTL 语言翻译规则的实际体现。通过本篇文章读者既能直接上手tldr openai完成 API 调用也能理解这份速查页在仓库中的编写逻辑进而举一反三地阅读与贡献其他 tldr 页面。赞分享文档教程知识库【免费下载链接】tldrCollaborative cheatsheets for console commands .项目地址https://gitcode.com/GitHub_Trending/tl/tldr点击查看免费下载相关推荐深入解析 tldr-pages 中的 Go 命令速查页go 工具链七大高频命令全解深入解析 tldr pages 中的 Go 命令速查页go 工具链七大高频命令全解 本文以 tldr pages 仓库中阿拉伯语版的 go 命令速查页 pa文档教程知识库Duix.Avatar终极指南零成本打造专属AI数字分身实战手册Duix.Avatar终极指南零成本打造专属AI数字分身实战手册 想象一下只需一段10秒视频就能拥有一个能说会道、表情生动的数字分身而且完全免费、完全离人工智能AI 应用数字人媒体生成桌面应用PaddleSpeech 集成 OpenAI Whisper 实战指南安装、命令行与 Python API 使用全解析PaddleSpeech 集成 OpenAI Whisper 实战指南安装、命令行与 Python API 使用全解析 导读 Whisper 是 OpenAI人工智能语音音频NLP媒体生成创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考