文章目录
一. 介绍
OpenAI可以根据用户的要求输出一个符合用户要求的入参值。然后用户拿到入参值之后,可以调用函数执行。那如何按照用户的要求,生成指定格式,并符合入参值逻辑?
可以使用Function Calling
将自然语言转换为API调用或数据库查询
。
最新的模型(gpt-4o、gpt-4-turbo 和 gpt-3.5-turbo)已经训练成能够检测何时应该调用函数(取决于输入),并以比以前的模型更接近被调用函数的参数返回 JSON。
注意:
尽管具备了这种能力,但也伴随着潜在的风险。我们强烈建议在代表用户采取影响世界的行动之前,构建用户确认流程(发送电子邮件、在网上发布内容、进行购买等)。
二. 常见用例与Function Calling调用逻辑
函数调用可让您更可靠地从模型中获取结构化数据。例如,您可以:
- 创建
调用外部 API 来回答问题的助手
;- 将自然语言
转换为 API 调用
例如,将“谁是我的顶级客户?”转换为get_customers(min_revenue: int, created_before: string, limit: int)并调用您的内部 API。- 从文本中提取结构化数据:例如定义一个名为的函数extract_data(name: string, birthday: string)等等。
函数调用的基本步骤顺序如下:
- 定义函数调用规范,调用openAI返回
函数调用参数,以json的形式返回
; - 解析
返回的调用参数
获取入参并调用函数; - 将函数响应作为新消息附加到模型中,并让模型将结果总结回用户。
三. 调用细节
1. 调用行为:tool_choice
tool_choice的默认行为是"auto"
。这让模型决定是否调用函数以及如果调用,要调用哪些函数。另外,如下提供了三种函数调用的行为:
- 强制模型始终调用函数,可以设置
tool_choice: "required"
。然后,模型将选择要调用的函数。- 强制模型仅调用一个特定的函数,您可以设置
tool_choice: {"type": "function", "function": {"name": "myfunction"}}
。- 要禁用函数调用并强制模型仅生成面向用户的消息,您可以设置
tool_choice: "none"
。
如下调用行为,
response = client.chat.completions.create(
model="gpt-4o",
messages=messages,
tools=tools,
tool_choice="auto", # auto is default, but we'll be explicit
)
2. 调用规定:functions
函数定义需要作为函数对象数组传递。下表列出了函数对象的详细信息。
字段名称 | 类型 | 描述 |
---|---|---|
name | string(必填) | 函数名 |
description | string | 函数描述 |
parameters | object | 函数所需的参数,这些参数将从JSON Schema格式进行描述 |
举个例子:如下规定了调用函数的细节,
- 函数名是find_product,作用是从一个sql中查询产品,
- 参数是:sql_query:字段类型:string,表示一个sql
- 必须传递的参数是:sql_query
functions = [
{
"name": "find_product",