The function description should clearly explain the purpose of the function, what it does, and how it interacts with other components or systems. It should provide an understanding of the function's role in the overall process, including any key features, processes, or actions it performs. Additionally, the description may include details on input parameters (what kind of data it accepts), expected outputs (what the function returns), and any important behaviors or edge cases to consider while using the function. A good description ensures that anyone using or maintaining the function can quickly understand its purpose and how to use it effectively, even without detailed technical knowledge.
Most Popular Articles
How do I specify the type of agent?
Description: To specify the type of agent, you can choose from the following options:...
What information should be mentioned in the agent description field?
Agent's Purpose: Clearly define what the agent is designed to do. For example, if the...
How do I specify the agent's name?
To specify the agent's name, you should enter a clear and meaningful identifier that accurately...
What information should be in the prompt text field for the agent?
The Prompt Text/Agent Instructions field is where you provide detailed instructions to guide...
Why Do I Need an OpenAI API Key?
Authentication: The API key is used to authenticate your requests to OpenAI’s...