Skip to content

docs: quickstart#120

Open
JJuprising wants to merge 1 commit into
Tencent-Hunyuan:rhinobird2026from
JJuprising:jj-work
Open

docs: quickstart#120
JJuprising wants to merge 1 commit into
Tencent-Hunyuan:rhinobird2026from
JJuprising:jj-work

Conversation

@JJuprising

Copy link
Copy Markdown

概述

新增 Hy3 云端 API(tokenhub.tencentmaas.com/v1)的完整接入文档,提供从快速上手到生产级错误处理的一站式参考,覆盖基础对话、流式、工具调用、思考模式及重试策略等典型场景。

变更内容

新增:api-docs/quickstart.md

单页快速入门指南,覆盖开发者接入所需的全部基础信息:

  • 基本信息:Base URL、API Key 获取方式、模型名、速率限制
  • 最小可运行示例curl + Python openai SDK,各附预期输出
  • 完整参数说明temperaturetop_pmax_tokensstopstreamseedtoolstool_choice——含类型、默认值及注意事项
  • 消息格式:role / content / tool_calls / tool_call_id 逐字段说明
  • 思考模式no_think vs high 对比,含代码示例及 max_tokens 注意事项
  • 常见报错排查:401 / 429 / 400(模型名错误、max_tokens 超限)/ 500 / ConnectionError / Stream 断连——每条附错误信息、原因及解决方案

新增:api-docs/examples/(6 个独立可运行示例)

# 文件 内容
01 01-basic-chat.md 单轮请求 + response 对象结构详解;多轮对话与历史管理
02 02-streaming.md 基础流式逐字打印;进阶版含 TTFT 测量、chunk 计数、usage 统计;chunk 各字段出现时机对照表
03 03-streaming-vs-non-streaming.md 非流式 vs 流式并排对比(TTFT、总耗时、用户体感加速比),含预热和格式化结果表
04 04-tool-calling.md 单次工具调用解析;完整多轮工具循环(用户提问 → 工具调用 → 执行 → 返回 → 最终回复);流式 tool_call 增量累积
05 05-reasoning-mode.md no_think vs high 在数学证明题上的对比实验,含 token 消耗和回复质量分析
06 06-error-handling-retry.md 错误类型速查表;基础 try/except;指数退避 + 随机抖动;生产级 RetryHandler 类封装(含日志)

每个示例统一结构:完整请求代码 → response 解析 → 注释示例输出 → 关键要点总结表

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant