深入解析OpenAI的Function Calling：原理、應用與實踐

1561字
8分鐘
2024-06-28
- AI

OpenAI的Function Calling功能是一項強大的工具，它使得開發者能夠通過自然語言調用預定義的函數。這篇文章將從what、why、how三個角度詳細介紹這一功能，並結合實際應用場景給出案例代碼和解釋。

什麼是Function Calling？

定義

Function Calling是OpenAI API的一項功能，允許開發者通過自然語言指令觸發預定義的函數。通過這種方式，我們可以將複雜的操作封裝在函數中，然後通過簡單的自然語言調用這些函數。

工作原理

Function Calling功能依賴於OpenAI模型的自然語言理解能力。開發者定義一組函數，並將這些函數的描述傳遞給模型。當用戶提供自然語言指令時，模型會解析這些指令並調用相應的函數。

為什麼使用Function Calling？

簡化複雜操作

Function Calling可以將複雜的操作封裝在簡單的函數調用中，使得用戶無需了解底層實現細節。例如，我們可以定義一個函數來查詢數據庫，然後通過自然語言指令調用該函數。

提高開發效率

通過Function Calling，開發者可以更快速地構建和擴展應用程序。我們只需定義好函數和描述，剩下的工作交給OpenAI模型來完成。

增強用戶體驗

Function Calling使得用戶可以通過自然語言與應用程序進行交互，提供更直觀和友好的用戶體驗。這在構建聊天機器人、虛擬助手等應用中尤為有用。

如何使用Function Calling？

定義函數

首先，我們需要定義要調用的函數，並為每個函數提供描述。這些描述將幫助模型理解函數的用途和參數。

1
export function getWeather(location) {
2
  // 假設這是一個查詢天氣的函數
3
  return `The weather in ${location} is sunny.`;
4
}
5

6
export function getNews(topic) {
7
  // 假設這是一個查詢新聞的函數
8
  return `Here are the latest news about ${topic}.`;
9
}

配置API請求

在API請求中，我們需要傳遞函數描述和用戶輸入。模型將根據用戶輸入調用相應的函數。

1
import { OpenAI } from "openai";
2
import { getWeather, getNews } from "./functions";
3

4
// 配置 OpenAI API
5
const openai = new OpenAI({
6
  apiKey: process.env.OPENAI_API_KEY,
7
});
8

9
// 定義函數映射
10
const functions = {
11
  getWeather,
12
  getNews,
13
};
14

15
// 配置模型
16
async function callOpenAIFunction(prompt) {
17
  const response = await openai.chat.completions.create({
18
    model: "gpt-4-0613", // 使用支持 Function Calling 的模型
19
    messages: [
20
      { role: "system", content: "You are a helpful assistant." },
21
      { role: "user", content: prompt },
22
    ],
23
    functions: [
24
      {
25
        name: "getWeather",
26
        description: "Get the current weather for a given location.",
27
        parameters: {
28
          type: "object",
29
          properties: {
30
            location: {
31
              type: "string",
32
              description: "The name of the location to get the weather for.",
33
            },
34
          },
35
          required: ["location"],
36
        },
37
      },
38
      {
39
        name: "getNews",
40
        description: "Get the latest news for a given topic.",
41
        parameters: {
42
          type: "object",
43
          properties: {
44
            topic: {
45
              type: "string",
46
              description: "The topic to get news about.",
47
            },
48
          },
49
          required: ["topic"],
50
        },
51
      },
52
    ],
53
  });
54

55
  const message = response.choices[0].message;
56

57
  if (message.tool_calls) {
58
    for (const tool_call of message.tool_calls) {
59
      const functionName = tool_call.function.name;
60
      const functionToCall = functions[functionName];
61
      const functionArgs = JSON.parse(tool_call.function.arguments);
62
      const functionResult = functionToCall(...Object.values(functionArgs));
63

64
      console.log(
65
        `Function ${functionName} called with result: ${functionResult}`,
66
      );
67
    }
68
  } else {
69
    console.log(`Model response: ${message.content}`);
70
  }
71
}
72

73
// 調用示例
74
callOpenAIFunction("Get the weather in New York.");
75
callOpenAIFunction("Get the latest news about technology.");

實際應用場景

場景1：智能家居控制

在智能家居系統中，我們可以定義函數來控制各個設備，並通過自然語言指令進行控制。

1
export function turnOnLight(room) {
2
  return `Turning on the light in the ${room}.`;
3
}
4

5
export function setThermostat(temperature) {
6
  return `Setting thermostat to ${temperature} degrees.`;
7
}
8

9
// 配置 OpenAI API
10
const openai = new OpenAI({
11
  apiKey: process.env.OPENAI_API_KEY,
12
});
13

14
// 定義函數映射
15
const functions = {
16
  turnOnLight,
17
  setThermostat,
18
};
19

20
// 配置模型
21
async function callOpenAIFunction(prompt) {
22
  const response = await openai.chat.completions.create({
23
    model: "gpt-4-0613", // 使用支持 Function Calling 的模型
24
    messages: [
25
      { role: "system", content: "You are a helpful assistant." },
26
      { role: "user", content: prompt },
27
    ],
28
    functions: [
29
      {
30
        name: "turnOnLight",
31
        description: "Turn on the light in a specific room.",
32
        parameters: {
33
          type: "object",
34
          properties: {
35
            room: {
36
              type: "string",
37
              description: "The name of the room to turn on the light.",
38
            },
39
          },
40
          required: ["room"],
41
        },
42
      },
43
      {
44
        name: "setThermostat",
45
        description: "Set the thermostat to a specific temperature.",
46
        parameters: {
47
          type: "object",
48
          properties: {
49
            temperature: {
50
              type: "number",
51
              description: "The temperature to set the thermostat to.",
52
            },
53
          },
54
          required: ["temperature"],
55
        },
56
      },
57
    ],
58
  });
59

60
  const message = response.choices[0].message;
61

62
  if (message.tool_calls) {
63
    for (const tool_call of message.tool_calls) {
64
      const functionName = tool_call.function.name;
65
      const functionToCall = functions[functionName];
66
      const functionArgs = JSON.parse(tool_call.function.arguments);
67
      const functionResult = functionToCall(...Object.values(functionArgs));
68

69
      console.log(
70
        `Function ${functionName} called with result: ${functionResult}`,
71
      );
72
    }
73
  } else {
74
    console.log(`Model response: ${message.content}`);
75
  }
76
}
77

78
// 調用示例
79
callOpenAIFunction("Turn on the light in the living room.");
80
callOpenAIFunction("Set the thermostat to 22 degrees.");

場景2：客戶支持

在客戶支持系統中，我們可以定義函數來處理常見問題，並通過自然語言指令進行調用。

1
export function checkOrderStatus(orderId) {
2
  return `Order ${orderId} is currently being processed.`;
3
}
4

5
export function cancelOrder(orderId) {
6
  return `Order ${orderId} has been cancelled.`;
7
}
8

9
// 配置 OpenAI API
10
const openai = new OpenAI({
11
  apiKey: process.env.OPENAI_API_KEY,
12
});
13

14
// 定義函數映射
15
const functions = {
16
  checkOrderStatus,
17
  cancelOrder,
18
};
19

20
// 配置模型
21
async function callOpenAIFunction(prompt) {
22
  const response = await openai.chat.completions.create({
23
    model: "gpt-4-0613", // 使用支持 Function Calling 的模型
24
    messages: [
25
      { role: "system", content: "You are a helpful assistant." },
26
      { role: "user", content: prompt },
27
    ],
28
    functions: [
29
      {
30
        name: "checkOrderStatus",
31
        description: "Check the status of an order.",
32
        parameters: {
33
          type: "object",
34
          properties: {
35
            orderId: {
36
              type: "string",
37
              description: "The ID of the order to check.",
38
            },
39
          },
40
          required: ["orderId"],
41
        },
42
      },
43
      {
44
        name: "cancelOrder",
45
        description: "Cancel an order.",
46
        parameters: {
47
          type: "object",
48
          properties: {
49
            orderId: {
50
              type: "string",
51
              description: "The ID of the order to cancel.",
52
            },
53
          },
54
          required: ["orderId"],
55
        },
56
      },
57
    ],
58
  });
59

60
  const message = response.choices[0].message;
61

62
  if (message.tool_calls) {
63
    for (const tool_call of message.tool_calls) {
64
      const functionName = tool_call.function.name;
65
      const functionToCall = functions[functionName];
66
      const functionArgs = JSON.parse(tool_call.function.arguments);
67
      const functionResult = functionToCall(...Object.values(functionArgs));
68

69
      console.log(
70
        `Function ${functionName} called with result: ${functionResult}`,
71
      );
72
    }
73
  } else {
74
    console.log(`Model response: ${message.content}`);
75
  }
76
}
77

78
// 調用示例
79
callOpenAIFunction("Check the status of order 12345.");
80
callOpenAIFunction("Cancel order 12345.");

最佳實踐

清晰的函數描述：確保每個函數的描述清晰明瞭，讓模型能夠準確理解函數的用途和參數。
適當的錯誤處理：在實際應用中，確保對可能的錯誤情況進行處理，如函數調用失敗或參數不正確。
持續優化：根據用戶反饋和使用情況，不斷優化函數和描述，提高模型的準確性和用戶體驗。

結論

OpenAI的Function Calling功能通過將自然語言指令與預定義函數結合，簡化了複雜操作，提高了開發效率，並增強了用戶體驗。無論是在智能家居、客戶支持還是其他應用場景中，Function Calling都能提供強大的支持。