在当今数字化的时代，RESTful API已经成为互联网的重要支持力量。API使得不同的应用程序可以相互通信，为用户提供各种服务和功能。然而，如何让计算机理解和智能地调用API，一直是一个具有挑战性的问题。本教程将向您展示如何使用OpenAPI规范和GPT（生成式预训练转换）模型智能地调用API，从而开启了一个充满可能性的世界。
格式
如何将OpenAPI规范转化为函数定义
在本教程的第一部分，我们将详细介绍如何将一个示例OpenAPI规范转化为可以用于聊天完成API的函数定义。我们将解释如何解析规范、提取函数名称、描述和参数，以及如何构建函数定义的列表。
如何使用GPT调用这些函数
在本教程的第二部分，我们将展示如何利用GPT来智能调用这些函数。我们将解释如何设置GPT环境，处理用户指令，调用函数并将结果返回给用户。
标题
智能API调用教程：利用OpenAPI和GPT实现智能API调用
步骤1：将OpenAPI规范转化为函数定义
首先，让我们介绍如何将OpenAPI规范转化为函数定义，以便后续使用GPT进行智能调用。
解析OpenAPI规范
OpenAPI规范是一种描述RESTful API的标准，它以一种机器可读和解释的格式提供了有关API端点、操作、参数和响应的详细信息。在我们的示例中，我们使用了一个包含了事件管理API的OpenAPI规范。
JSON Schema
OpenAPI规范包含有关API端点的详细信息，包括每个端点支持的操作、接受的参数、处理的请求和返回的响应。规范是以JSON格式定义的，它包括了JSON模式（JSON Schema）来定义参数的数据类型和结构。
解析JSON引用
在OpenAPI规范中，通常使用JSON引用（也称为$ref）来避免重复定义。这些引用指向在多个地方使用的定义。我们需要解析和替换这些引用，以便获得完整的规范信息。
生成函数定义
为了将OpenAPI规范转化为函数定义，我们需要按以下步骤进行操作：
-
解析JSON引用：首先，我们需要解析OpenAPI规范中的JSON引用，并将其替换为引用的内容。这将有助于我们获取完整的规范信息。
-
提取函数名称：规范中的每个操作都有一个
operationId字段，我们将使用它作为函数的名称。 -
提取描述和参数：我们将遍历规范中的
description、summary、requestBody和parameters字段，以获取函数的描述和参数信息。
下面是将OpenAPI规范转化为函数定义的示例代码：
def openapi_to_functions(openapi_spec):
functions = []
for path, methods in openapi_spec["paths"].items():
for method, spec_with_ref in methods.items():
# 1. 解析JSON引用
spec = jsonref.replace_refs(spec_with_ref)
# 2. 提取函数名称
function_name = spec.get("operationId")
# 3. 提取描述和参数
desc = spec.get("description") or spec.get("summary", "")
schema = {"type": "object", "properties": {}}
req_body = (
spec.get("requestBody", {})
.get("content", {})
.get("application/json", {})
.get("schema")
)
if req_body:
schema["properties"]["requestBody"] = req_body
params = spec.get("parameters", [])
if params:
param_properties = {
param["name"]: param["schema"]
for param in params
if "schema" in param
}
schema["properties"]["parameters"] = {
"type": "object",
"properties": param_properties,
}
functions.append(
{"name": function_name, "description": desc, "parameters": schema}
)
return functions步骤2：使用GPT调用函数
在本教程的第二部分，我们将介绍如何使用GPT智能地调用这些函数。这一部分将展示如何设置GPT环境、处理用户指令、调用函数并将结果返回给用户。
设置GPT环境
首先，我们需要设置GPT环境，以便与GPT模型进行交互。我们将使用OpenAI的ChatCompletion API来实现这一点。以下是设置GPT环境的示例代码：
import openai
# 设置OpenAI API密钥
openai.api_key = os.environ["OPENAI_API_KEY"]处理用户指令
用户将通过提供指令来与GPT进行交互。指令将告诉GPT要执行哪些操作。以下是处理用户指令的示例代码：
SYSTEM_MESSAGE = """
You are a helpful assistant.
Respond to the following prompt by using function_call and then summarize actions.
Ask for clarification if a user request is ambiguous.
"""
# 用户指令示例
USER_INSTRUCTION = """
Instruction: Get all the events.
Then create a new event named AGI Party.
Then delete event with id 2456.
"""调用函数并返回结果
接下来，我们将使用GPT来调用函数，并将结果返回给用户。这一过程可以迭代多次，直到满足用户的需求。以下是调用函数并返回结果的示例代码：
# 最大允许的函数调用次数，以防止无限循环或长时间的操作
MAX_CALLS = 5
def get_openai_response(functions, messages):
return openai.ChatCompletion.create(
model="gpt-3.5-turbo-16k-0613",
functions=functions,
function_call="auto",
temperature=0,
messages=messages,
)
def process_user_instruction(functions, instruction):
num_calls = 0
messages = [
{"content": SYSTEM_MESSAGE, "role": "system"},
{"content": instruction, "role": "user"},
]
while num_calls < MAX_CALLS:
response = get_openai_response(functions, messages)
message = response["choices"][0]["message"]
if message.get("function_call"):
print(f"\n>> Function call #: {num_calls + 1}\n")
pp(message["function_call"])
messages.append(message)
# 此处我们简单地添加一条消息以模拟成功。
# 通常情况下，您将在这里调用函数，并将结果附加到messages中。
messages.append(
{
"role": "function",
"content": "success",
"name": message["function_call"]["name"],
}
)
num_calls += 1
else:
print("\n>> Message:\n")
print(message["content"])
break
if num_calls >= MAX_CALLS:
print(f"Reached max chained function calls: {MAX_CALLS}")
# 处理用户指令
process_user_instruction(functions, USER_INSTRUCTION)结论
通过本教程，我们展示了如何将OpenAPI规范转化为函数定义，并使用GPT智能地调用这些函数。这使得计算机能够理解用户的指令，并执行相应的操作，从而开启了一个充满可能性的世界。您可以根据您的需求扩展这一系统，处理更复杂的用户指令、与实际API集成以执行实际操作，以及改进错误处理和验证，以确保指令可行且函数调用成功。
无论您是开发人员、数据科学家还是对人工智能感兴趣的任何人，本教程都将帮助您了解如何利用OpenAPI和GPT来实现智能API调用，从而为各种应用场景提供更多可能性。开始探索并创造属于您自己的智能应用程序吧！
