TypeChat 將自然語言轉成定義好的物件

前言

我們可以透過 Prompt 來讓 LLM 產生我們需要的Json內容，
例如 請假、訂 Pizza … 。
現在我們可以透過TypeChat.NET來幫我們做到這件事。

實作

以下使用 Calendar 範例來測試，

1.加入以下 Nuget 套件，

Microsoft.Extensions.Configuration.Binder
Microsoft.Extensions.Configuration.Json
Microsoft.TypeChat
Microsoft.TypeChat.Schema

2.將Config.cs及CalendarActionsSchema.cs加到專案之中

3.在appsettings.json中加入 LLM 的設定值，如下，

// For Azure OpenAI service
{
  "OpenAI": {
    "Azure": true,
    "ApiKey": "YOUR API KEY",
    "Endpoint": "https://YOUR_RESOURCE_NAME.openai.azure.com",
    "Model": "gpt-35-turbo"  // Name of Azure deployment
  }
}

// For OpenAI Service:
{
  "OpenAI": {
    "Azure": false,
    "ApiKey": "YOUR API KEY",
    "Endpoint": "https://api.openai.com/v1/chat/completions",
    "Model": "gpt-3.5-turbo"  // Name of OpenAI model
  }
}

4.因為是關於日期，所以在轉換時，要在最後加上現在的時間，再一起透過JsonTranslator來轉換，如下，

//載入 LLM Config
var config = Config.LoadOpenAI();
//建立 Translator
var translator = new JsonTranslator<CalendarActions>(new LanguageModel(config));
//SubscribeAllEvents(translator);
string[] inputs = [
        "我需要在 2024 年 7 月 15 日星期五中午 12:00 到下午 2:00 更換輪胎",
        "為週五下午 6 點舉辦名為 Jeffs 披薩派對的活動",
        "請在下週四將 Jennifer 添加到 scrum 中",
        "您可以在上午 9 點與 Jerri Skinner 預約2個小時嗎？",
        "我下週的行程是什麼？",
        "預訂下週五上午 8:30 與 Sonali 和 Marc 就 GPU 效能舉行會議",
    ];

await TranslateCalendarActions(translator, inputs);

async Task TranslateCalendarActions(JsonTranslator<CalendarActions> translator, string[] inputs)
{
    var dateTimeNow = DateTime.Now;
    int daysUntilMonday = ((int)DayOfWeek.Monday - (int)dateTimeNow.DayOfWeek + 7) % 7;
    DateTime thisWeekMonday = dateTimeNow.AddDays(daysUntilMonday);
    // 計算下週的星期一
    DateTime nextWeekMonday = thisWeekMonday.AddDays(7);
    var nowDate = $"{dateTimeNow:yyyy/MM/dd}";
    var nowTime = $"{dateTimeNow:HH:mm:ss}";
    var nextWeek = $"{nextWeekMonday:yyyy/MM/dd} {nextWeekMonday:HH:mm:ss}";
    var nextMonth = $"{new DateTime(dateTimeNow.Year, dateTimeNow.Month, 1).AddMonths(1):yyyy/MM/dd} {dateTimeNow:HH:mm:ss}";
    string now = $"使用相對於當前日期的精確日期和時間: {nowDate} 現在時間: {nowTime}\n";
    //now += $"將下週和下個月等範圍轉換為精確日期";
    now += $"將下週({nextWeek})和下個月({nextMonth})等範圍轉換為精確日期";
    foreach (var input in inputs)
    {
        Console.WriteLine($"=== Q:{input} ================================================");
        string request = $"{input}\n{now}";
        var actions = await translator.TranslateAsync(request);
        var jsonString = Microsoft.TypeChat.Json.Stringify(actions);
        string deserializedJson = UnicodeToChinese(jsonString);
        Console.WriteLine(deserializedJson);
        PrintUnknown(actions);
    }
}

bool PrintUnknown(CalendarActions calendarActions)
{
    int countUnknown = 0;
    foreach (var action in calendarActions.Actions)
    {
        if (action is UnknownAction unknown)
        {
            ++countUnknown;
            if (countUnknown == 1)
            {
                Console.WriteLine("I didn't understand the following:");
            }
            Console.WriteLine(unknown.Text);
        }
    }
    return countUnknown > 0;
}

static string UnicodeToChinese(string input)
{
    return Regex.Unescape(input);
}

測試日期為 2024/07/02，輸出結果如下，

=== Q:我需要在 2024 年 7 月 15 日星期五中午 12:00 到下午 2:00 更換輪胎 ================================================
{
  "actions": [
    {
      "$type": "AddEventAction",
      "event": {
        "day": "2024/07/15",
        "timeRange": {
          "startTime": "12:00",
          "endTime": "14:00"
        },
        "description": "更換輪胎"
      }
    }
  ]
}
=== Q:為週五下午 6 點舉辦名為 Jeffs 披薩派對的活動 ================================================
{
  "actions": [
    {
      "$type": "AddEventAction",
      "event": {
        "day": "2024/07/05",
        "timeRange": {
          "startTime": "18:00"
        },
        "description": "Jeffs 披薩派對"
      }
    }
  ]
}
=== Q:請在下週四將 Jennifer 添加到 scrum 中 ================================================
{
  "actions": [
    {
      "$type": "AddParticipantsAction",
      "eventReference": {
        "day": "2024/07/18",
        "description": "scrum"
      },
      "participants": [
        "Jennifer"
      ]
    }
  ]
}
=== Q:您可以在上午 9 點與 Jerri Skinner 預約2個小時嗎？ ================================================
{
  "actions": [
    {
      "$type": "AddEventAction",
      "event": {
        "day": "2024/07/09",
        "timeRange": {
          "startTime": "09:00",
          "duration": "2 hours"
        },
        "description": "Meeting with Jerri Skinner"
      }
    }
  ]
}
=== Q:我下週的行程是什麼？ ================================================
{
  "actions": [
    {
      "$type": "FindEventsAction",
      "eventReference": {
        "dayRange": "2024/07/15 14:11:02 to 2024/07/21 14:11:02"
      }
    }
  ]
}
=== Q:預訂下週五上午 8:30 與 Sonali 和 Marc 就 GPU 效能舉行會議 ================================================
{
  "actions": [
    {
      "$type": "AddEventAction",
      "event": {
        "day": "2024/07/12",
        "timeRange": {
          "startTime": "08:30"
        },
        "description": "與 Sonali 和 Marc 就 GPU 效能舉行會議",
        "participants": [
          "Sonali",
          "Marc"
        ]
      }
    }
  ]
}

所以，透過TypeChat.NET可以很方便用戶輸入的內容，
轉成所需要的物件。

參考資源

TypeChat.NET