Components
ToolDefinition
A tool that can be called from an LLM during the conversation. See https://docs.syllable.ai/Resources/Tools.
Example Usage
Fields
Field | Type | Required | Description |
---|---|---|---|
type | components.Type | FALSE | The action to take when the LLM calls the tool. |
tool | components.InternalTool | TRUE | A tool definition to be used by the OpenAI API. |
endpoint | components.ToolHttpEndpoint | FALSE | The configuration for an HTTP API call. |
defaults | components.Defaults | FALSE | The default values for the parameters of the function/tool call. |
staticParameters | components.StaticToolParameter[] | FALSE | Parameters for the tool whose values should be set at config time (i.e., not provided by the LLM). |
result | any | FALSE | The optional result of the tool call. Only used for context tools. |