Function Calling
Simple guide to understanding and implementing function calling.
Installing the SDK
Automatic Tool Calling
Here we define the tool function in json
import { RunnableToolFunction } from 'propulsionai/lib/RunnableFunction';
const tools: RunnableToolFunction<any>[] = [
{
type: 'function',
function: {
name: 'list',
description: 'list queries books by genre, and returns a list of names of books',
parameters: {
type: 'object',
properties: {
genre: { type: 'string', enum: ['mystery', 'nonfiction', 'memoir', 'romance', 'historical'] },
},
},
function: list,
parse: JSON.parse,
},
} as RunnableToolFunction<{ genre: string }>,
{
type: 'function',
function: {
name: 'search',
description: 'search queries books by their name and returns a list of book names and their ids',
parameters: {
type: 'object',
properties: {
name: { type: 'string' },
},
},
function: search,
parse: JSON.parse,
},
} as RunnableToolFunction<{ name: string }>,
{
type: 'function',
function: {
name: 'get',
description:
"get returns a book's detailed information based on the id of the book. Note that this does not accept names, and only IDs, which you can get by using search.",
parameters: {
type: 'object',
properties: {
id: { type: 'string' },
},
},
function: get,
parse: JSON.parse,
},
} as RunnableToolFunction<{ id: string }>,
];
async function list({ genre }: { genre: string }) {
console.log('calling list: ', genre);
return db.filter((item) => item.genre === genre).map((item) => ({ name: item.name, id: item.id }));
}
async function search({ name }: { name: string }) {
console.log('calling search: ', name);
return db.filter((item) => item.name.includes(name)).map((item) => ({ name: item.name, id: item.id }));
}
async function get({ id }: { id: string }) {
console.log('calling get: ', id);
return db.find((item) => item.id === id);
}
Using run_tools
for automatic function calling with or without streaming.
async function main() {
const runner = await client.chat.completions
.runTools({
deployment: '<deployment_id>',
stream: true, // can be false
tools, // as defined earlier
messages: [
{
role: 'system',
content:
'Please use our book database, which you can access using functions to answer the following questions.',
},
{
role: 'user',
content:
'I really enjoyed reading Where the Crawdads Sing, could you recommend me a book that is similar and tell me why?',
},
],
})
.on('message', (msg) => console.log('msg', msg))
.on('functionCallResult', (functionCallResult) => console.log('functionCallResult', functionCallResult))
.on('content', (diff) => process.stdout.write(diff))
.on('totalUsage', (totalUsage) => console.log('totalUsage', totalUsage))
.on('task_id', (task_id) => console.log('task_id', task_id));
const result = await runner.finalChatCompletion();
console.log();
console.log('messages');
console.log(JSON.stringify(runner.messages));
console.log();
console.log('final chat completion');
console.dir(result, { depth: null });
}
main()
Manualy manage function calling
// TODO
Last updated