如需查看完整的文档索引,请参阅 llms.txt。在文档页面的 URL 末尾加上 .md 即可查看该页面的 Markdown 版本。
主导航
主题

数据与连接

保存记录、连接应用,并为您的站点添加登录功能

您的站点可能需要保存请求、记录进度或显示已连接应用中的信息。请告诉 ChatGPT 要保存哪些内容、信息来自哪里,以及哪些人应有权访问。

选择存储和登录功能

对于新项目,站点工作流可以使用推荐的站点模板作为起点。对于现有项目,请先让 ChatGPT 确认项目可以生成兼容的部署产物,再请求部署。

请描述您希望站点实现的功能,以便 ChatGPT 选择所需的存储和用户身份功能:

站点需求 应向站点工作流提出的要求
以内容为主的网站或着陆页 仅在用户体验需要时才持久保存应用状态
保存记录、用户进度或游戏分数 使用 D1 关系数据库持久保存结构化数据
图片、文档、音频、视频或其他上传内容 使用 R2 对象存储保存文件
上传文件并支持搜索其元数据 使用 D1 保存元数据,使用 R2 保存文件内容
内部站点需要识别当前工作空间用户 使用经工作空间验证的用户身份
提供公开登录入口或使用外部身份提供方 创建启用身份验证的站点

主题选择、横幅是否已关闭等临时界面状态无需使用持久存储。如果用户期望托管站点能记住某些产品数据,请要求站点持久保存这些数据。

添加“使用 ChatGPT 登录”功能

公开站点可以向所有人开放,同时允许访客选择使用 ChatGPT 登录,以使用依赖用户身份的功能,例如保存进度、查看个性化视图或访问个人记录。仅限工作空间访问的站点已使用 ChatGPT 身份来执行共享设置中的访问限制。

请让站点工作流添加登录功能:

为这个公开站点添加“使用 ChatGPT 登录”功能。让未登录的访客也能访问站点,并向他们显示“使用 ChatGPT 登录”选项。访客登录后,如果能获取其全名,就在问候语中使用全名,否则使用其电子邮件地址。添加“退出登录”选项,并在服务端代码中判断用户是否有权执行操作。
工作原理

站点通过平台提供的路径处理登录和退出登录流程,随后将访客带回您的站点:

<a href="/signin-with-chatgpt">Sign in with ChatGPT</a>
<a href="/signout-with-chatgpt">Sign out</a>

访客登录后,站点会通过以下请求头将其身份信息传递给服务器:

  • oai-authenticated-user-email 包含已验证的电子邮件地址。
  • oai-authenticated-user-full-name 可能包含个人资料中的非空姓名。请将其视为可选值,没有姓名时使用电子邮件地址。

请在服务端代码中做出授权决定,不要依赖分别传递姓和名的请求头。

使用 SIWC 旁路令牌调用私有站点

当脚本或服务需要调用必须登录才能访问的站点时,可以使用“使用 ChatGPT 登录”(SIWC)旁路令牌。凭此令牌,请求无需建立交互式浏览器会话即可通过站点的登录检查。

作为站点所有者,您可以让 ChatGPT 工作或 Codex 为您的站点生成令牌:

为这个站点生成一个“使用 ChatGPT 登录”旁路令牌,让我的服务无需通过浏览器登录就能调用该站点。

智能体会调用 generate_siwc_bypass_token 并返回 siwc_bypass_bearer_token。生成新令牌会替换该站点现有的令牌,因此请更新所有使用旧令牌的服务。

通过以下 HTTP 请求头发送令牌:

OAI-Sites-Authorization: Bearer <siwc_bypass_bearer_token>

站点平台会读取并移除这个请求头,再将请求转发到您的站点。如果您的站点还要求提供自己的 API 凭据,请通过标准的 Authorization 请求头单独发送该凭据。站点平台在转发时会保留这个请求头。

使用旁路令牌的请求不具备已登录访客的身份,因此不会携带上述已验证用户的请求头,也无权访问访客已连接的应用。请在站点的服务端代码中执行其他必要的授权检查。对于依赖访客身份或插件权限的功能,请使用常规登录流程。

请妥善保管令牌,任何持有它的人都可以通过该站点的登录检查。请将令牌保存在服务的机密信息存储中,不要将其写入浏览器端代码、URL 或版本控制系统。如果令牌泄露,请生成新令牌,并更新所有调用方。新令牌立即生效,但旧令牌在缓存的配置过期前可能仍然有效,最长可达 5 分钟。

使用插件将用户数据引入站点

使用插件构建站点时,可以让站点从每位访客自己连接的应用中加载数据。例如,在同一个问题跟踪面板上,您可以看到分配给您的问题,队友则可以看到分配给他们的问题。每位访客使用 ChatGPT 登录后,可自行选择允许站点使用哪些已连接的账号,以及授予哪些访问权限。

工作空间必须启用插件,且站点必须仅对该工作空间开放。访客必须是工作空间成员,并使用自己已有的应用权限。管理员可参阅在站点中启用插件,查看各插件的权限和租户限制。

使用已连接应用的数据构建站点

  1. 请 ChatGPT 工作或 Codex 构建站点。说明要使用哪个插件连接器,以及希望它执行什么操作,也可以询问有哪些可用的插件。
  2. 使用真实数据预览站点。智能体在构建和预览站点时会使用您可用的连接。
  3. 请智能体为您的工作空间发布站点,并与队友分享站点链接。

例如:

使用我已连接的问题跟踪工具构建一个站点,按优先级分组显示分配给我的问题。添加按项目筛选的功能、指向原始问题的链接和“刷新”按钮。

您还可以构建文档查找工具,提供指向原始文档的链接,或创建汇总工单和消息的项目概览。

加载数据

页面加载时,站点会使用访客的连接和权限读取已连接应用中的数据。站点负责管理缓存和重新加载数据。如需手动刷新,可请 ChatGPT 工作或 Codex 添加相应操作。

默认情况下,如果连接器返回游标,站点会提供加载更多操作,用于获取下一页数据。

技术参考:插件发现

站点使用 getContext() 查找插件提供的操作。该方法返回已缓存的工具名称、说明和模式定义,不会重新执行插件发现。

有关已连接应用支持的操作及其可用范围,请参阅帮助中心的创建和使用 ChatGPT 站点。

让访客选择自己的连接

要使用依赖应用连接的功能,访客需使用 ChatGPT 登录,查看站点请求的应用访问权限,选择允许站点使用的已连接账号及授予的权限,然后返回站点。分享站点不会让他人获得您已连接账号的访问权限。站点只会从每位访客允许访问的应用中获取该访客的数据。

访客可以在不授予应用访问权限的情况下继续使用站点,但需要相应权限的功能将无法使用。如果某个应用不可用,请检查它是否已连接到正确的工作空间,以及工作空间设置是否允许使用该应用。