我们首先定义了规范的版本、标题、描写和版本号。ChatGPT 在运行查询时会查看信息部份中定义的描写，以肯定插件会不会与用户查询相关。您可以在写作说明部份浏览更多关于提示的信息。

在编写 OpenAPI 规范时，请记住以下限制，这些限制可能会变化：

• API 规范中每一个 API Endpoint（指具体的某个 API）节点的描写字段最多 200 个字符
• API 规范中每一个 API 参数描写字段最多 200 个字符

接下来，我们将服务器设置为指向本地主机 URL，由于我们要在本地运行此示例。OpenAPI 规范的其余部份遵守传统的 OpenAPI 格式，您可以通过各种在线资源了解有关 OpenAPI 格式的更多信息。还有许多类似 Apifox 这样的工具可以自动生成 OpenAPI 规范文档。

在为 API 创建了 manifest 文件和 OpenAPI 规范后，您现在可以通过 ChatGPT UI 连接插件了。您的插件可以运行在本地开发环境或远程服务器上。

如果您在本地运行 API 的版本，则可以将插件接口指向本地设置。要连接插件和 ChatGPT，请导航到插件市场，然后选择“Install an unverified plugin（安装未经验证的插件）”。

如果插件在远程服务器上运行，则需要首先选择“Develop your own plugin（开发自己的插件）”，然后选择“Install an unverified plugin（安装未经验证的插件）”。您只需将插件 manifest 文件添加到 ./well-known 路径，并开始测试您的 API。但是，如果您对清单文件进行了更改，则一定要将新更改部署到您的公共站点，这可能需要很长时间。在这类情况下，我们建议设置一个本地服务器作为您的 API 的代理。这样，您可以快速对 OpenAPI 规范和清单文件的更改进行原型设计。

以下是一个使用 Python 代码设置公共 API 代理的示例：

```python
import requests
import os

import yaml
from flask import Flask, jsonify, Response, request, send_from_directory
from flask_cors import CORS

app = Flask(__name__)

PORT = 3333
CORS(app, origins=[f"http://localhost:{PORT}", "https://chat.openai.com"])

api_url = 'https://example'

@app.route('/.well-known/ai-plugin.json')
def serve_manifest():
return send_from_directory(os.path.dirname(__file__), 'ai-plugin.json')

@app.route('/openapi.yaml')
def serve_openapi_yaml():
with open(os.path.join(os.path.dirname(__file__), 'openapi.yaml'), 'r') as f:
yaml_data = f.read()
yaml_data = yaml.load(yaml_data, Loader=yaml.FullLoader)
return jsonify(yaml_data)

@app.route('/openapi.json')
def serve_openapi_json():
return send_from_directory(os.path.dirname(__file__), 'openapi.json')

@app.route('/', methods=['GET', 'POST'])
def wrapper(path):
headers = {
'Content-Type': 'application/json',
}

url = f'{api_url}/{path}'
print(f'Forwarding call: {request.method} {path} -> {url}')

if request.method == 'GET':
response = requests.get(url, headers=headers, params=request.args)
elif request.method == 'POST':
print(request.headers)
response = requests.post(url, headers=headers, params=request.args, json=request.json)
else:
raise NotImplementedError(f'Method {request.method} not implemented in wrapper for {path=}')
return response.content

if __name__ == '__main__':
app.run(port=PORT)
```

与模型交互

当用户发出多是对插件的潜伏要求的查询时，模型会根据 OpenAPI 规范中的 Endpoint 描写和 manifest 文件中的 description_for_model 进行判断。与其他语言模型的提示一样，您需要测试多个提示和描写，看看哪一个会有最好效果。

OpenAPI 规范本身是一个很好的地方，可以为模型提供有关 API 各种细节的信息，如可用的功能和参数。除对每一个字段使用富有表达力、信息丰富的名称外，规范还可以包括对每一个属性进行“描写”的字段。例如，它们可用于提供关于功能的功能或关于查询字段期望的信息的自然语言描写。该模型将能够看到这些描写，并根据它们使用 API。如果一个字段被限制为仅接受某些值，您还可以提供一个带有描写性种别名称的“枚举”。

属性 “description_for_model” 可以让您自由地指点模型怎样使用您的插件。整体而言，ChatGPT 背后的语言模型能够高度理解自然语言并遵守指令。因此，这是一个很好的地方，可以放置有关插件功能和模型应如何正确使用它的一般说明。使用自然语言时，最好使用简洁但具有描写性和客观性的语气。您可以查看一些示例以了解这应当是甚么模样。我们建议以“Plugin for …”开头，然后枚举您的 API 提供的所有功能。

以下是在 OpenAPI 规范中编写 description_for_model 和描写时的一些最好实践：

• 您的描写不应试图控制 ChatGPT 的情绪、个性或确切反应。ChatGPT 旨在为插件编写适当的响应。
• 当用户没有明确要求使用您的插件的特定服务种别时，您的描写不应鼓励 ChatGPT 使用该插件。
• 您的描写不应规定 ChatGPT 使用该插件的特定触发器。ChatGPT 旨在在适当的时候自动使用您的插件。
• 插件 API 的响应应返回原始数据而不是自然语言响应（除非确切有必要）。ChatGPT 将使用返回的数据提供自己的自然语言响应。

注意，默许情况下，用户不会看到插件调用和其他未向用户显示的信息。要更全面地了解模型如何与插件交互，您可以点击屏幕左下角的“Debug”按钮打开调试窗口。这将显示到目前为止对话的原始文本，包括插件调用和响应。

对插件的模型调用通常以消息的情势进行，其中包括了类似 JSON 的参数发送到插件，并以插件返回的信息为模型所用。

在某些情况下，例如在插件安装期间，毛病可能会出现在浏览器的 JavaScript 控制台中。

请确保所有改写都符合上述准则。

openai和openapi的常见问答Q&A

import openai
    
    # 设置 API 密钥
    openai.api_key = "YOUR_API_KEY"
    
    # 构造 API 要求
    response = openai.Completion.create(
        engine="davinci",
        prompt="Once upon a time",
        max_tokens=100
    )
    
    # 处理 API 响应
    completion = response.choices[0]
    print(completion.text)

import openai
    
    # 创建 OpenAI 对象
    openai = openai.OpenAICreate(key)
    
    # 构造 API 要求
    response = openai.Completion.create(
        engine="davinci",
        prompt="Once upon a time",
        max_tokens=100
    )
    
    # 处理 API 响应
    completion = response.choices[0]
    print(completion.text)