View the example code here. The code is based on the guide on how to build an agent from the OpenAI Cookbook.
Overview
In this tutorial, you will learn how to create an agent with 2 functions to enable function calling for your agent. The 2 functions we will implement are:
getLocation() - Get the current location (latitude, longitude) based on the IP of the worker node if no location is described in the user prompt.
getWeatherData(latitude, longitude) - Get the current weather data based on the latitude and longitude retrieved from getLocation().
These two functions will be described for your agent to understand the purpose of the functions. Then we will set the system prompt for the agent with:
You are a helpful assistant. Only use the functions you have been provided with.
Getting Started
Prepare
Clone git repo or use degit to get the source code.
In this step, we will create our 2 functions getLocation() and getWeatherData(latitude, longitude) then we will describe our functions for the agent to understand how to use the functions.
Go to your src/index.ts file, your initial file should look like the following.
For the getLocation() function, we will need to call an API to get the location based on https://ipapi.co/. Traditionally, devs will not have access to the internet, but with Phala's AI Agent Contracts, devs now can make async HTTP calls to bring more data for fine tuning their agents.
The implementation is simple and we will add this following code.
For our OpenAI agent to understand the purpose of these functions, we need to describe them using a specific schema. We'll create an array called tools that contains one object per function. Each object will have two keys: type, function, and the function key has three subkeys: name, description, and parameters.
consttools= [ { type:"function", function: { name:"getCurrentWeather", description:"Get the current weather in a given location", parameters: { type:"object", properties: { latitude: { type:"string", }, longitude: { type:"string", }, }, required: ["longitude","latitude"], }, } }, { type:"function", function: { name:"getLocation", description:"Get the user's location based on their IP address", parameters: { type:"object", properties: {}, }, } },];constavailableTools= { getCurrentWeather, getLocation,};
Add Agent Functionality
Setup Messages for Agent
We need to define a messages array. This will keep track of all of the messages back and forth between our app and OpenAI. Here we create a type MessageInfo that will be the fields that may be included in the messages array.
The first object in the array should always have the role property set to "system", which tells OpenAI that this is how we want it to behave.
typeMessageInfo= { role:any, content:any, name?:any,}constmessages:MessageInfo[] = [ { role:"system", content:`You are a helpful assistant. Only use the functions you have been provided with.`, },];
Create Agent Function For User Input
We are now ready to build the logic of our app, which lives in the agent function. It is asynchronous and takes one argument: the userInput.
We start by pushing the userInput to the messages array. This time, we set the role to "user", so that OpenAI knows that this is the input from the user.
Next, we'll send a request to the Chat completions endpoint via the chat.completions.create() method in the Node SDK. This method takes a configuration object as an argument. In it, we'll specify three properties:
model - Decides which AI model we want to use (in our case, GPT-4).
messages - The entire history of messages between the user and the AI up until this point.
tools - A list of tools the model may call. Currently, only functions are supported as a tool., we'll we use the tools array we created earlier.
Turn OpenAI Agent Response into Functions
Now that we have the name of the function as a string, we'll need to translate that into a function call. To help us with that, we'll gather both of our functions in an object called availableTools:
This is handy because we'll be able to access the getLocation function via bracket notation and the string we got back from OpenAI, like this: availableTools["getLocation"].
We're also grabbing ahold of any arguments OpenAI wants us to pass into the function: message.tool_calls[0].function.arguments. However, we won't need any arguments for this first function call.
If we run the code again with the same input ("Where am I located right now?"), we'll see that functionResponse is an object filled with location about where the user is located right now. In my case, that is Oslo, Norway.
We'll add this data to a new item in the messages array, where we also specify the name of the function we called.
messages.push({ role:"function", name: functionName, content:`The result of the last function was this: ${JSON.stringify( functionResponse )} `,});
Notice that the role is set to "function". This tells OpenAI that the content parameter contains the result of the function call and not the input from the user.
At this point, we need to send a new request to OpenAI with this updated messages array. However, we don’t want to hard code a new function call, as our agent might need to go back and forth between itself and GPT several times until it has found the final answer for the user.
This can be solved in several different ways, e.g. recursion, a while-loop, or a for-loop. We'll use a good old for-loop for the sake of simplicity.
Creating The Loop
At the top of the agent function, we'll create a loop that lets us run the entire procedure up to five times.
If we get back finish_reason: "tool_calls" from GPT, we'll just push the result of the function call to the messages array and jump to the next iteration of the loop, triggering a new request.
If we get finish_reason: "stop" back, then GPT has found a suitable answer, so we'll return the function and cancel the loop.
for (let i =0; i <5; i++) {constresponse=awaitopenai.chat.completions.create({ model:"gpt-4o", messages: messages, tools: tools, });const { finish_reason,message } =response.choices[0];if (finish_reason ==="tool_calls"&&message.tool_calls) {constfunctionName=message.tool_calls[0].function.name;constfunctionToCall= availableTools[functionName];constfunctionArgs=JSON.parse(message.tool_calls[0].function.arguments);constfunctionArgsArr=Object.values(functionArgs);constfunctionResponse=awaitfunctionToCall.apply(null, functionArgsArr);messages.push({ role:"function", name: functionName, content:` The result of the last function was this: ${JSON.stringify( functionResponse )} `, }); } elseif (finish_reason ==="stop") {messages.push(message);returnmessage.content; }}return"The maximum number of iterations has been met without a suitable answer. Please try again with a more specific input.";
If we don't see a finish_reason: "stop" within our five iterations, we'll return a message saying we couldn’t find a suitable answer.
Update GET() and POST()
Now we need to call our agent(openai, userInput) in our GET and POST calls that will pass in a users prompt that can be accessed in the chatQuery property. The code change is minimial and our functions look like the following.
Now that we have the code implemented to interact with APIs and call the functions, let's test the code locally.
Create .env file with the default ThirdWeb API key for publishing your Agent Contract to IPFS
cp .env.local .env
In ./secrets/default.json file replace YOUR_OPENAI_KEY with your API Key
{"openaiApiKey":"YOUR_OPENAI_API_KEY"}
In your ./tests/test.ts file. Add your API Key manually to have a functional test.
let getResult =awaitexecute({ method:'GET', path:'/ipfs/CID', queries: { chatQuery: ["Who are you?"] }, secret: { openaiApiKey:"YOUR_OPENAI_API_KEY" }, headers: {},})
Build your Agent
npm run build
Test your Agent locally
npm run test
Expected output:
INPUT:{"method":"GET","path":"/ipfs/CID","queries":{},"secret":{"openaiApiKey":"OPENAI_API_KEY"},"headers":{}}[0]chat[1]chat[2]chatGETRESULT:{status:200, body: `{"message":"There's a lot to do in Austin, Texas! Here are some activities you might consider based on the current weather and various interests:\\n\\n### Outdoor Activities\\n1. **Lady Bird Lake & Zilker Park**\\n - **Kayaking/Paddleboarding**: Enjoy a relaxing paddle on Lady Bird Lake.\\n - **Hiking/Biking**: Explore the trails around Zilker Park and Barton Springs.\\n\\n2. **Barton Springs Pool**\\n - A perfect spot for a swim and to cool off from the summer heat.\\n\\n3. **Mount Bonnell**\\n - For those who love scenic views and a bit of hiking, head to Mount Bonnell for a panoramic view of the city.\\n\\n### Cultural Activities\\n1. **Blanton Museum of Art**\\n - Explore a variety of art collections ranging from contemporary to ancient.\\n\\n2. **Bullock Texas State History Museum**\\n - Learn about the rich history of Texas through exhibits and films.\\n\\n3. **South Congress Avenue (SoCo)**\\n - Wander through boutique shops, galleries, and enjoy some street performances.\\n\\n### Music & Nightlife\\n1. **Live Music**\\n - Check out iconic venues like the Continental Club or Antone’s for some live performances.\\n\\n2. **Rainey Street Historic District**\\n - Explore a variety of bars and food trucks in this lively area.\\n\\n### Food & Beverage\\n1. **BBQ Heaven**\\n - Visit Franklin Barbecue or la Barbecue for some of the best BBQ in the city.\\n \\n2. **Food Trucks**\\n - Explore the diverse array of food trucks offering a variety of cuisines.\\n\\n### Weather Considerations\\n- The apparent temperature during the day can reach up to 37.2°C (98.96°F) with some moments going as high as 38.9°C (102.02°F). Ensure you stay hydrated and take breaks in shaded or air-conditioned areas.\\n\\nNo matter what your interests are, Austin has a variety of activities to make your day enjoyable. Make sure to check local event listings as well for any special events or festivals happening today."}`,
headers:{'Content-Type':'application/json','Access-Control-Allow-Origin':'*' }}INPUT:{"method":"GET","path":"/ipfs/CID","queries":{"chatQuery":["What are some activities based in Brussels today?"]},"secret":{"openaiApiKey":"OPENAI_API_KEY"},"headers":{}}[0]chat[1]chat[2]chat[3]chatGETRESULT:{status:200, body: `{"message":"Brussels is a vibrant city with a lot of things to offer on any given day. Here are some activities you can enjoy today:\\n\\n### Outdoor Activities\\n1. **Grand Place**\\n - Visit the heart of Brussels and marvel at the stunning architecture. You might catch some street performances as well.\\n\\n2. **Parc du Cinquantenaire**\\n - Take a relaxing stroll or have a picnic in this beautiful park.\\n\\n3. **Atomium**\\n - Explore this unique building and enjoy panoramic views of the city.\\n\\n### Cultural Activities\\n1. **Royal Museums of Fine Arts of Belgium**\\n - Explore Belgian art and various exhibitions ranging from ancient to modern art.\\n\\n2. **Magritte Museum**\\n - Dive into the surreal world of René Magritte, one of Belgium's most famous artists.\\n\\n3. **Belgian Comic Strip Center**\\n - Discover the rich history of comic strips in Belgium, including famous characters like Tintin.\\n\\n### Gourmet Experiences\\n1. **Chocolate and Beer Tours**\\n - Take a guided tour to sample some of Brussels' best chocolates and beers.\\n\\n2. **Waffles and Frites**\\n - Enjoy traditional Belgian waffles and fries at local eateries.\\n\\n### Shopping and Markets\\n1. **Galeries Royales Saint-Hubert**\\n - Explore this beautiful shopping arcade filled with boutique shops and cafes.\\n\\n2. **Marolles Flea Market**\\n - Hunt for unique items and antiques at this bustling market.\\n\\n### Theatre and Music\\n1. **Ancienne Belgique**\\n - Check out the schedule for any concerts or performances happening today.\\n\\n2. **La Monnaie/De Munt**\\n - Attend an opera or a ballet performance if available.\\n\\n### Historical Sites\\n1. **Manneken Pis**\\n - Visit this famous statue, which often gets dressed up in various costumes.\\n\\n2. **Palais de Justice**\\n - Visit this impressive courthouse and enjoy the views from its location.\\n\\n### Weather Considerations\\n- The apparent temperature in Brussels today ranges from 15.9°C (60.62°F) in the early morning to a high of around 31.6°C (88.88°F) in the late afternoon. Thus, it is quite pleasant for outdoor activities.\\n\\nWhatever your interests, Brussels has something to offer for everyone. Make sure to check local event listings as well for any special events or festivals happening today. Enjoy your day!"}`,
headers:{'Content-Type':'application/json','Access-Control-Allow-Origin':'*' }}Nowyouarereadytopublishyouragent,addsecrets,andinteractwithyouragentinthefollowingsteps:-Execute:'npm run publish-agent'-Setsecrets:'npm run set-secrets'-Gototheurlproducedbysettingthesecrets (e.g. https://wapo-testnet.phala.network/ipfs/QmPQJD5zv3cYDRM25uGAVjLvXGNyQf9Vonz7rqkQB52Jae?key=b092532592cbd0cf)
Publish & Interact with Agent
With our test passing and everything working as expected, now we can build and publish our agent code to IPFS. Then we will set our secrets and access our deployed agent via the Phala Gateway at https://wapo-testnet.phala.network/ipfs/<cid>?key=<key_id>&chatQuery=<chat_query>.
Upload your compiled AI Agent code to IPFS.
npmrunpublish-agent
Upon a successful upload, the command should show the URL to access your AI Agent.
✓ Compiled successfully.
78.19 KB dist/index.js
Running command: npx thirdweb upload dist/index.js
This may require you to log into thirdweb and will take some time to publish to IPFS...
$$\ $$\ $$\ $$\ $$\
$$ | $$ | \__| $$ | $$ |
$$$$$$\ $$$$$$$\ $$\ $$$$$$\ $$$$$$$ |$$\ $$\ $$\ $$$$$$\ $$$$$$$\
\_$$ _| $$ __$$\ $$ |$$ __$$\ $$ __$$ |$$ | $$ | $$ |$$ __$$\ $$ __$$\
$$ | $$ | $$ |$$ |$$ | \__|$$ / $$ |$$ | $$ | $$ |$$$$$$$$ |$$ | $$ |
$$ |$$\ $$ | $$ |$$ |$$ | $$ | $$ |$$ | $$ | $$ |$$ ____|$$ | $$ |
\$$$$ |$$ | $$ |$$ |$$ | \$$$$$$$ |\$$$$$\$$$$ |\$$$$$$$\ $$$$$$$ |
\____/ \__| \__|\__|\__| \_______| \_____\____/ \_______|\_______/
💎 thirdweb v0.14.12 💎
- Uploading file to IPFS. This may take a while depending on file sizes.
✔ Successfully uploaded file to IPFS.
✔ Files stored at the following IPFS URI: ipfs://QmQZYAkEz8RnX9phpWscDLsv1u7uBATaAYHb1prpFGvD4n
✔ Open this link to view your upload: https://b805a9b72767504353244e0422c2b5f9.ipfscdn.io/ipfs/bafybeibbasdv4xt32ea74ga77rpr5kgnkxcgqbtoslgxagzhmmujcjwkym/
Agent Contract deployed at: https://wapo-testnet.phala.network/ipfs/QmQZYAkEz8RnX9phpWscDLsv1u7uBATaAYHb1prpFGvD4n
If your agent requires secrets, ensure to do the following:
1) Edit the ./secrets/default.json file or create a new JSON file in the ./secrets folder and add your secrets to it.
2) Run command: 'npm run set-secrets' or 'npm run set-secrets [path-to-json-file]'
Logs folder created.
Deployment information updated in ./logs/latestDeployment.json
Note that your latest deployment information will be logged to in file ./logs/latestDeployment.json. This file is updated every time you publish a new Agent Contract to IPFS. This file is also used to get the IPFS CID of your Agent Contract when setting secrets for your Agent Contract.
If ThirdWeb fails to publish, please signup for your own ThirdWeb account to publish your Agent Contract to IPFS. Signup or login at https://thirdweb.com/dashboard/
Whenever you log into ThirdWeb, create a new API key and replace the default API Key with yours in the .env file.
THIRDWEB_API_KEY="YOUR_THIRDWEB_API_KEY"
Add Secrets
By default, all the compiled JS code is visible for anyone to view if they look at IPFS CID. This makes private info like API keys, signer keys, etc. vulnerable to be stolen. To protect devs from leaking keys, we have added a field called secret in the Request object. It allows you to store secrets in a vault for your AI Agent to access.
To add your secrets,
Edit the default.json file or create a new JSON file in the ./secrets folder and add your secrets to it.
{
"openaiApiKey": "YOUR_OPENAI_API_KEY"
}
Run command to set the secrets
npm run set-secrets
# or if you have a custom JSON file
npm run set-secrets <path-to-json-file>
Note that all your secrets will be logged in file ./logs/secrets.log. This file is updated every time you add new secrets to your Agent Contract. If you have not published an Agent Contract, yet, this command will fail since there is not a CID to map the secrets to.
The API returns a token and a key. The key is the id of your secret. It can be used to specify which secret you are going to pass to your frame. The token can be used by the developer to access the raw secret. You should never leak the token.
To verify the secret, run the following command where key and token are replaced with the values from adding your secret to the vault.
To help create custom logic, we have an array variable named queries that can be accessed in the Request class. To access the queries array variable chatQuery value at index 0, the syntax will look as follows:
const query = req.queries.chatQuery[0] as string;
Here is an example of adding a URL query named chatQuery with a value of When did humans land on the moon. queries can have any field name, so chatQuery is just an example of a field name and not a mandatory name, but remember to update your index.ts file logic to use your expected field name.
Now that your agent is deployed, you can access the agent through a curl request or insert the url with the key and chatQuery defined. Here is an example of the code from the tutorial we just walked through.