跳转到内容

向 AI 提供哪些内容

查看 Markdown

Sudomimus 以多种机器可读形式发布文档。向助手提供哪种内容,取决于可用的上下文容量,以及需要操作说明还是正式 API 契约。

三个纯文本端点遵循 llmstxt.org 约定:

URL 它是什么
https://docs.sudomimus.com/llms.txt 索引 —— 简短清单,包含 AI 接入入口和下面两份语料的链接;它不会列出每篇页面。
https://docs.sudomimus.com/llms-full.txt 完整语料 —— 所有英文文档页拼接成的单个文件。
https://docs.sudomimus.com/llms-small.txt Small 语料 —— 英文文档的另一种生成表示,不是人工筛选的摘要。

full 和 small 两份聚合语料只包含英文内容。如需让助手读取中文文档,请提供对应 /zh-cn/ 页面追加 .md 后的链接。

当前 llms-full.txt 与 llms-small.txt 包含相同的英文实质内容,包括详细规则表和边界情况说明。两者字节数不同,但 small 并没有大幅缩减内容范围。不要仅根据文件名推断 token 数或固定的大小比例。

接入任务请从 AI 接入入口或对应的流程页面开始,读取该页的 Markdown,再按需访问相关链接。只有助手需要跨接入路径的广泛背景且上下文容量足够时,才使用聚合语料。应根据当前输出和所用模型核算上下文预算;完成接入仍需要实际配置与验证。

在任意文档页 URL 后面追加 .md,即可只抓取这一页的原始 Markdown —— 例如 /zh-cn/connect/three-key-model.md。这是「只给助手一页、而非整套语料」的精确做法。

要拿到 Sudomimus 产品 API 的正式请求/响应契约,把助手指向 OpenAPI 3.1 参考,它直接由已发布的规范生成:

  • Connect API —— Inquiry 端点(/establish、/status-poll、/redeem、/info),每个 operation 都有独立页面。
  • Session API —— 普通应用会话端点(/refresh、/introspect、/logout、/revoke-all)。
  • Native API —— 面向原生客户端的 direct-issue 端点(/direct-issue/steam-ticket、/direct-issue/access-key、/direct-issue/public-key)。
  • Device API —— 面向公开客户端的 device authorization 端点(/device-authorize、/device-token)。

这些页面是精确路径、参数、请求体与状态码的权威来源。生成强类型客户端代码时,请将对应页面提供给助手。

OIDC 使用自身原生的机器可读契约,不重复提供 OpenAPI schema。请向助手提供 issuer https://oidc.sudomimus.com,让它使用 OIDC 库读取 discovery,并附上 OIDC 接入指南以确认 Sudomimus 支持的 profile 与平台约束。 底层协议语义仍由 OpenID Connect 和 OAuth 标准定义。

llms*.txt 端点和 OpenAPI 参考都会随文档每次更新一起重建 —— 没有滞后的「AI 版本」。如果助手缓存了旧版本,让它重新抓一次即可。