Update quickstart.mdx - outdated example for tool call. #192
Conversation
The given example doesn’t work anymore because the “parameters” field is now required.
|
seratch
left a comment
seratch
left a comment
There was a problem hiding this comment.
Thank you for sending this PR! Left a few comments
| properties: {}, | ||
| required: [], | ||
| additionalProperties: false | ||
| } |
There was a problem hiding this comment.
comma is missing:
| } | |
| }, |
There was a problem hiding this comment.
If you have more time to tweak this, we prefer a slightly simpler one like:
import { Agent, run, tool } from '@openai/agents';
import { z } from 'zod';
const historyFunFact = tool({
// The name of the tool will be used by the agent to tell what tool to use.
name: 'history_fun_fact',
// The description is used to describe **when** to use the tool by telling it **what** it does.
description: 'Give a fun fact about a historical event',
// This agent takes no parameters, so we provide an empty JSON schema.
parameters: z.object({}),
execute: async () => {
// The output will be returned back to the Agent to use
return 'Sharks are older than trees.';
},
});There was a problem hiding this comment.
Hi @seratch, thanks for your response. I had already tried it as you suggested, using an empty Zod object, but I wasn’t able to get it running.
There was a problem hiding this comment.
Probably, it is due to #187, which is zod compat issue that we're going to apply workaround soon
There was a problem hiding this comment.
Should i then go with the empty zod object or keep the json schema ?
There was a problem hiding this comment.
we consistently use zod as the primary option in the docs and examples, so please go ahead with an empty zod object here.
There was a problem hiding this comment.
@seratch alright done ! Thank you very much :)
seratch
added
dependencies
Co-authored-by: Kazuhiro Sera <[email protected]>
2 participants
The given example doesn’t work anymore because the “parameters” field is now required.
I wasent able to run it without providing a JSON Schema for parameters.