如何将您的API转化为GPT

OpenAI 最近推出了自定义 GPT 商店,使您能够创建自己定制的 GPT,可以提供自己的指令、知识库或 API 操作。通过新商店,您还可以与其他 ChatGPT 用户分享自己的定制 GPT。在本文中,您将学习如何将现有的 API 转换为一个 GPT,并通过商店与他人共享,只需几个简单的步骤。

步骤1:准备您的API

首先,您将需要我们API的OpenAPI规范。为了简单起见,我将使用此列表上提供的免费演示API。该API支持列出热咖啡和冷咖啡饮料两种操作。

API的OpenAPI规范文件是:

openapi: 3.0.0
info:
title: Coffee API
version: 1.0.0
servers:
- url: https://api.sampleapis.com/coffee
paths:
/hot:
get:
summary: List all hot coffee drinks
description: Returns a list of all the hot coffee drinks available
operationId: getHotCoffee
responses:
'200':
description: A list of hot coffee drinks
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Coffee'
/cold:
get:
summary: List all cold coffee drinks
description: Returns a list of all the cold coffee drinks available
operationId: getColdCoffee
responses:
'200':
description: A list of cold coffee drinks
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Coffee'
components:
schemas:
Coffee:
type: object
properties:
id:
type: integer
title:
type: string
description:
type: string
ingredients:
type: array
items:
type: string
image:
type: string

第二步:创建一个自定义的GPT

现在我们有了我们的OpenAPI规范,让我们创建一个自定义的GPT。

以下是方法:

  • 前往OpenAI的Chat GPT。
  • 在左侧窗格中,选择“探索 GPTs”。
  • 在右上角选择创建。
  • 选择配置以直接设置自定义 GPT 属性。

现在,让我们配置我们的新GPT,帮助我们的用户开始使用可用的API。

我们将称这个新的GPT为GPT Barista,并给它简单的指导,使用以下提示:

您可以管理可能的热咖啡和冷咖啡饮品的清单,帮助用户找到他们想要的饮品。

快速提示:记得禁用GPT的网络浏览和DALL-E,因为你不需要它们。

Barista GPT configuration example

步骤 3:添加 API 动作

现在是最重要的部分。我们将提供API操作,供我们的GPT使用。

以下是方法:

  • 向下滚动并选择“创建新操作”。
  • 在模式字段下,粘贴上面的OpenAPI规范。如果您有自己的可在网上访问的OpenAPI规范,请选择“从URL导入”按钮以导入它。
  • 一旦我们粘贴规格,OpenAI会验证规格并显示任何存在的错误。
  • 保留 HTML 结构,在右上方选择“保存”来保存 GPT。你可以选择仅自己可见(例如,私密),或者你可以选择公开,让所有人都可以通过商店访问。

那就是了!你的GPT已经准备好了,你可以用它来询问关于热饮和冷饮的问题。

Asking Barista GPT for hot coffee drinks that don’t contain milk

使用自定义GPT可以让用户通过自然语言与API进行交互,将用户问题转化为API参数,并转换API的响应。通过将API与GPT集成,您可以利用GPT的所有功能,并且GPT可以理解API返回的数据并与之交互。

在上面的示例中,我要求GPT只列出不使用牛奶的热咖啡饮料。GPT能理解我的提示,调用API列出热饮料,根据成分过滤掉含有牛奶的饮料,然后将JSON响应格式化为一个列表,并从URL获取图像。

第四步:认证

上面的例子使用了一个简单且公开的 API。

但是现实世界的API很可能需要一些身份验证,在用户能够使用API之前需要进行身份验证。您可以在配置GPT操作时指定身份验证模式。

OpenAI支持两种身份验证方案:

  • API密钥。如果您选择使用API密钥,您需要提供密钥值,此密钥将用于您的GPT的所有用户。
  • OAuth。提供对API的更精细访问控制,但您需要一个身份提供者来对用户进行身份验证。在您的身份提供者中创建一个OAuth客户端,并在GPT身份验证配置中提供客户端ID、客户端密钥、授权和令牌端点。最后,定义范围以授权GPT代表用户执行操作一旦他们通过身份验证。

更好的用户体验,更短的时间

使用GPT可以节省开发时间,因为GPT根据用户提示转换输入和输出,而无需为每个用户的需求开发专用的API。通过GPT让用户与API进行交互还可以通过两种方式改善用户体验。首先,用户可以在不编写自己的脚本与API交互的情况下更快地实现他们的目标。其次,他们不再需要为不同的用例设计用户界面,因为GPT可以通过自然语言来支持许多用例。

现在您已经看到了将现有的 API 转换为允许用户与 API 进行交互并从中返回数据的 GPT 是多么简单,希望这里提供的足够信息能让您自行开始探索这个想法。

2024-01-15 04:11:10 AI中文站翻译自原文