2024年8月28日

GPT Actions 库 - Retool 工作流

简介

本页面为开发者提供构建特定应用GPT Action的说明与指南。在继续之前,请确保您已熟悉以下信息:

这个特定的GPT操作概述了如何连接到Retool工作流。该操作接收用户输入,并通过webhook触发器将其发送到Retool中的工作流。然后Retool执行配置好的工作流,并将响应以JSON对象的形式返回给ChatGPT。

价值与示例商业应用场景

价值: 用户现在可以利用ChatGPT的自然语言能力直接连接到Retool中的任何工作流。

示例用例:

  • 您希望在GPT中集成在Retool工作流中运行的自定义代码。
  • 数据科学家维护一个外部向量数据库(使用Retool Vector或其他向量数据库),并希望将向量搜索的结果发送回ChatGPT。
  • Retool 被用作连接内部服务的中间件,您希望利用 Retool 的 webhooks 功能向 ChatGPT 提供这些服务的访问权限。

应用信息

在开始之前,请查看应用程序中的这些链接:

应用前提条件

在开始之前,请确保您已在Retool环境中完成以下步骤:

  • 设置一个Retool账户
  • 创建一个简单的工作流

应用工作流程步骤

以下是一个基础的Retool工作流示例。该工作流接收2个输入值,将它们相加,并通过webhook触发器返回计算结果。

注意: 您的工作流必须先部署,才能从您的GPT访问。

ChatGPT 步骤

自定义GPT指令

创建自定义GPT后,您应该为其添加指令,说明该GPT的角色背景及其可执行的操作。有疑问?查看入门示例了解该步骤的详细运作方式。

OpenAPI 规范

创建自定义GPT后,在操作面板中复制以下文本。有问题吗?查看入门示例了解此步骤的详细操作方式。

注意: 您需要将下方OpenAPI规范中的值替换为您工作流的ID。

openapi: 3.1.0
info:
  title: Retool Workflow API
  description: API for interacting with Retool workflows.
  version: 1.0.0
servers:
  - url: https://api.retool.com/v1
    description: Main (production) server
paths:
  /workflows/<WORKFLOW_ID>/startTrigger:
    post:
      operationId: add_numbers
      summary: Takes 2 numbers and adds them.
      description: Initiates a workflow in Retool by triggering a specific workflow ID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                first:
                  type: integer
                  description: First parameter for the workflow.
                second:
                  type: integer
                  description: Second parameter for the workflow.
      responses:
        "200":
          description: Workflow triggered successfully.
        "400":
          description: Bad Request - Invalid parameters or missing data.
        "401":
          description: Unauthorized - Invalid or missing API key.
      security:
        - apiKeyAuth: []

认证说明

以下是设置与这个第三方应用程序进行身份验证的说明。有问题吗?查看入门示例以更详细地了解此步骤的工作原理。

预操作步骤

在ChatGPT中设置身份验证之前,请先在应用程序中执行以下步骤。

  • 从Webhook配置面板获取您的API密钥

retool_api_key.png

在ChatGPT中

在ChatGPT中,点击"身份验证"并选择"API密钥"。输入以下信息。

  • API密钥: (粘贴由Retool工作流Webhook触发器提供的API密钥)
  • 认证类型: 自定义
  • 自定义请求头名称: X-Workflow-Api-Key

常见问题与故障排除

  • 认证错误: 请确保您正确设置了自定义标头名称。
  • 无效工作流错误: 确保您已在Retool中部署了工作流。

是否有您希望我们优先考虑的集成方案?我们的集成是否存在错误?请在GitHub上提交PR或问题,我们会尽快查看。