init

Author: fanweixiao

.env.example

@@ -0,0 +1,4 @@
+YOMO_SFN_NAME=llm_fn_get_weather
+YOMO_SFN_ZIPPER=localhost:9000
+YOMO_SFN_CREDENTIAL=SECRET
+OPENWEATHERMAP_API_KEY=

.gitignore

@@ -19,3 +19,5 @@
 
 # Go workspace file
 go.work
+.env
+*.yomo

README.md

@@ -1,2 +1,61 @@
 # llm-function-get-weather
-OpenAI Function Calling RAG - get weather from API
+
+This example demostrates how to implement OpenAI Function Calling in Strong-typed language, easy to write and maintain. follow the instructions below, you will extend OpenAI gpt-4o with openweathermap.org API.
+
+## Development on local
+
+### Install YoMo
+
+```sh
+curl -fsSL "https://get.yomo.run" | sh
+```
+
+### Add your OpenAI SK to configuration
+
+```sh
+vim yomo.yml
+```
+
+> [!TIP]
+> If you do not have an OpenAI API Key, you can try [vivgrid.com](https://vivgrid.com), it's free for developers with generous OpenAI Token every month.
+
+### Start YoMo
+
+```sh
+yomo serve -c yomo.yml
+```
+
+### Get your api-key from OpenWeatherMap.org
+
+grab your api-key from [openweathermap.org](https://openweathermap.org) free, and add it to your `.env` file:
+
+```sh
+YOMO_SFN_NAME=llm_fn_get_weather
+YOMO_SFN_ZIPPER=localhost:9000
+YOMO_SFN_CREDENTIAL=SECRET
+OPENWEATHERMAP_API_KEY=<ADD_HERE>
+```
+
+### Run your function calling
+
+```sh
+yomo run app.go
+```
+
+### Try it!
+
+```sh
+curl -X POST -H "Content-Type: application/json" -d '{"prompt":"Hows the weather like in Paris today?"}' http://127.0.0.1:9000/invoke |jq    
+{
+  "Content": "The weather in Paris today is clear with a clear sky. Here are the detailed conditions:\n\n- **Temperature:** 9.89°C (feels like 9.02°C)\n- **Humidity:** 91%\n- **Pressure:** 1020 hPa\n- **Wind:** 2.06 m/s coming from the southwest (210°)\n- **Visibility:** 10 km\n- **Cloudiness:** 0% (clear sky)\n- **Sunrise:** 05:27 AM\n- **Sunset:** 08:41 PM\n\nOverall, it's a cool and clear day in Paris.",
+  "ToolCalls": null,
+  "ToolMessages": null,
+  "FinishReason": "stop",
+  "TokenUsage": {
+    "prompt_tokens": 274,
+    "completion_tokens": 125
+  },
+  "AssistantMessage": null
+}
+```
+

app.go

@@ -0,0 +1,69 @@
+package main
+
+import (
+	"fmt"
+	"io"
+	"log/slog"
+	"net/http"
+	"os"
+
+	"github.com/yomorun/yomo/serverless"
+)
+
+// Description defines the Function Calling, this will be combine to prompt automatically. As openweathermap.org does not support request api by `city_name`, we have ask LLM to translate it to Latitude and Longitude.
+func Description() string {
+	return `Get current weather for a giving city. If no city is provided, you should ask to clarify the city. 
+	If the city name is given, you should convert city name to Latitude and Longitude geo coordinates, 
+	keep Latitude and Longitude in decimal format.`
+}
+
+// Param defines the input parameters of the Function Calling, this will be combine to prompt automatically
+type Param struct {
+	City      string  `json:"city" jsonschema:"description=The city name to get the weather for"`
+	Latitude  float64 `json:"latitude" jsonschema:"description=The latitude of the city, in decimal format, range should be in (-90, 90)"`
+	Longitude float64 `json:"longitude" jsonschema:"description=The longitude of the city, in decimal format, range should be in (-180, 180)"`
+}
+
+// InputSchema decalares the type of Function Calling Parameter, required by YoMo
+func InputSchema() any {
+	return &Param{}
+}
+
+// DataTags declares the type of data this stateful serverless observe, required by YoMo
+func DataTags() []uint32 {
+	return []uint32{0x30}
+}
+
+// Handler is the main entry point of the Function Calling when LLM response with `tool_call`
+func Handler(ctx serverless.Context) {
+	var p Param
+	// deserilize the parameters from llm tool_call response
+	ctx.ReadLLMArguments(&p)
+
+	// call the openweathermap api and write the result back to LLM
+	result := requestOpenWeatherMap(p.Latitude, p.Longitude)
+	ctx.WriteLLMResult(result)
+
+	slog.Info("get-weather", "city", p.City, "rag", result)
+}
+
+func requestOpenWeatherMap(lat, lon float64) string {
+	const apiURL = "https://api.openweathermap.org/data/2.5/weather?lat=%f&lon=%f&appid=%s&units=metric"
+	apiKey := os.Getenv("OPENWEATHERMAP_API_KEY")
+	url := fmt.Sprintf(apiURL, lat, lon, apiKey)
+	// send api request to openweathermap.org
+	resp, err := http.Get(url)
+	if err != nil {
+		fmt.Println(err)
+		return "can not get the weather information at the moment"
+	}
+	defer resp.Body.Close()
+
+	body, err := io.ReadAll(resp.Body)
+	if err != nil {
+		fmt.Println(err)
+		return "can not get the weather information at the moment"
+	}
+
+	return string(body)
+}

go.mod

@@ -0,0 +1,15 @@
+module llm-fn-get-weather
+
+go 1.22.3
+
+require (
+	github.com/stretchr/testify v1.9.0
+	github.com/yomorun/yomo v1.18.9
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
+	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
+	github.com/stretchr/objx v0.5.2 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -0,0 +1,14 @@
+github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM=
+github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U=
+github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
+github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/yomorun/yomo v1.18.9 h1:azxCLHYa0bE2odQzKgM7nHm93L359BIJCFxuJbRERZk=
+github.com/yomorun/yomo v1.18.9/go.mod h1:DwomD9J+U7vNgRnqFWoilQCbqlR4X9fBpIiDUX33jO0=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

yomo.yml

@@ -0,0 +1,24 @@
+name: ai-zipper
+host: 0.0.0.0
+port: 9000
+
+auth:
+  type: token
+  token: SECRET
+
+bridge:
+  ai:
+    server:
+      addr: localhost:9000
+      provider: openai
+
+    providers:
+      azopenai:
+        api_endpoint: https://<DEPLOYMENT_NAME>.openai.azure.com
+        deployment_id: <MODEL_NAME>
+        api_key: <API_KEY>
+        api_version: 2024-02-15-preview
+
+      openai:
+        api_key: sk-
+        model: gpt-4o