A tool that can be called from an LLM during the conversation.

Example Usage

import { ToolDefinition } from "syllable-sdk/models/components";

let value: ToolDefinition = {
  tool: {
    function: {
      name: "<value>",
      description: "dilate uh-huh pluck slowly trek what selfishly",
      parameters: {},
    },
  },
};

Fields

FieldTypeRequiredDescription
typecomponents.TypeFALSEThe action to take when the LLM calls the tool.
toolcomponents.InternalToolTRUEA tool definition to be used by the OpenAI API.
endpointcomponents.ToolHttpEndpointFALSEThe configuration for an HTTP API call.
defaultscomponents.DefaultsFALSEThe default values for the parameters of the function/tool call.
resultcomponents.ResultFALSEThe optional result of the tool call. Only used for context tools.