> ## Documentation Index
> Fetch the complete documentation index at: https://docs.playapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 示例索引与学习路径

> 按接入目标找到 API、完整脚本和验证边界。

先通过[快速开始](/zh/quickstart)验证地址、凭据与模型，再按目标选择一个完整示例。示例源码位于文档目录 `examples/`，环境变量从对应指南复制。Node 示例在文档目录执行 `npm ci`；Python 依赖安装见 [Python 指南](/zh/guides/python)，完整本地校验命令见文档目录的 `README.md`。

| 目标 | 指南 / 可运行入口 | 关键验收点 |
| - | - | - |
| 最小文本 | [Python](/zh/guides/python) / [TypeScript](/zh/guides/typescript) | Base URL、模型、完整输出 |
| 框架接入 | [Vercel AI SDK](/zh/guides/ai-sdk) | 实际协议路径、SDK 重试与完成状态 |
| 对话记忆 | [多轮对话](/zh/guides/conversations) | 完整历史与协议一致性 |
| 客户端工具 | [工具调用](/zh/guides/tool-calling) / [流式工具](/zh/guides/streaming-tools) | 调用 ID、参数、结果关联与轮数上限 |
| JSON 结果 | [结构化输出](/zh/guides/structured-output) | schema 校验与非完成状态 |
| 文档检索 | [RAG](/zh/guides/rag) | Embeddings、Rerank、来源引用 |
| 图片与音频 | [视觉](/zh/guides/vision) / [图片生成](/zh/guides/image-generation) / [语音](/zh/guides/speech) / [转写](/zh/guides/speech-to-text) | 模型能力、文件类型和完整下载 |
| 视频与异步任务 | [视频](/zh/guides/video-generation) / [任务](/zh/guides/tasks) | 已有任务 ID、终态、轮询上限 |
| 长连接 | [Responses WebSocket](/zh/guides/responses-websocket) / [Realtime](/zh/guides/realtime) | 握手、事件关联、音频格式、关闭行为 |
| 原生协议 | [Claude SSE](/zh/guides/native-claude-streaming) / [Gemini SSE](/zh/guides/native-gemini-streaming) | 原生内容块、签名与终止事件 |
| 运维诊断 | [限流与重试](/zh/guides/rate-limits) / [请求观测](/zh/guides/observability) | 只读探测、有界重试、脱敏日志 |

## 从示例到生产

1. 用本地 fixture 跑通文档校验，确认代码与页面一致。
2. 用隔离的测试配置，对目标部署执行一次最小请求，再分别验证需要的扩展能力。
3. 检查业务失败路径、超时、流式中断及重复提交处理，再设置队列、并发与日志策略。
4. 按[生产验收清单](/zh/guides/production)记录目标服务的结果；本地通过不替代线上模型验证。

接口字段集中在 [API 参考](/zh/api-reference/overview)，是否支持某个接口先查[覆盖范围](/zh/guides/api-coverage)。这些是可独立保存的脚本，不依赖 Mintlify 运行时；以后迁移文档平台可保留相同示例和 OpenAPI 文件。

[Read in English](/en/guides/recipes)

[提示词缓存](/zh/guides/prompt-caching) · [推理模型](/zh/guides/reasoning-models) · [上下文管理](/zh/guides/context-management)

## 文件、搜索与生成参数

| 任务 | 指南 | 可运行脚本 |
| - | - | - |
| 内联 PDF 摘要 | [文件输入](/zh/guides/file-inputs) | `examples/file-input.mjs` |
| 原生联网搜索与 URL 引用 | [搜索](/zh/guides/web-search) | `examples/web-search.mjs` |
| 观察 token 对数概率 | [生成参数](/zh/guides/generation-parameters) | `examples/logprobs.mjs` |

运行前确认模型和原生渠道支持，另见 [数据控制](/zh/guides/data-controls)。

## 音视频输入与文本修改

| 目标 | 指南 | 脚本 |
| - | - | - |
| 根据录音回答问题 | [音频输入](/zh/guides/audio-input) | `examples/audio-input.mjs` |
| 分析已有视频 | [视频理解](/zh/guides/video-understanding) | `examples/video-input.mjs` |
| 提示保留原文的局部修改 | [预测输出](/zh/guides/predicted-outputs) | `examples/predicted-output.mjs` |

这些示例发起一次请求；使用目标模型验证实际效果，排错见 [常见问题](/zh/guides/troubleshooting)。

## 工具策略与 JSON 校验

* [工具选择与并行控制](/zh/guides/tool-controls)：`examples/tool-policy.mjs`，四种选择策略、最多两轮、单个只读调用。
* [JSON 模式](/zh/guides/json-mode)：`examples/json-mode.mjs`，Chat / Responses 两种协议，完成状态与业务字段独立检查。

## Gemini 原生内置工具

[三模式示例](/zh/guides/gemini-builtins)：`examples/gemini-builtins.mjs` 选择搜索、URL 上下文或上游代码执行。每次运行只发一个请求，同时检查完成状态与工具证据。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.