• Preparing search index...
  • The search index is not available
LiveKit Agents
  • LiveKit Agents
  • agents
  • llm
  • tool

Function tool

  • tool<Parameters, UserData, Result>(__namedParameters): FunctionTool<Parameters, UserData, Result>
  • Create a function tool.

    Type Parameters

    • Parameters extends JSONObject = Record<string, never>
    • UserData = unknown
    • Result = unknown

    Parameters

    • __namedParameters: {
          description: string;
          execute: ToolExecuteFunction<Parameters, UserData, Result>;
          parameters?: ToolInputSchema<Parameters>;
      }
      • description: string
      • execute: ToolExecuteFunction<Parameters, UserData, Result>
      • Optional parameters?: ToolInputSchema<Parameters>

    Returns FunctionTool<Parameters, UserData, Result>

    • Defined in agents/src/llm/tool_context.ts:166
  • tool(__namedParameters): ProviderDefinedTool
  • Create a provider-defined tool.

    Parameters

    • __namedParameters: {
          config: Record<string, unknown>;
          id: string;
      }
      • config: Record<string, unknown>
      • id: string

    Returns ProviderDefinedTool

    • Defined in agents/src/llm/tool_context.ts:186

Settings

Member Visibility

Theme

LiveKit Agents
  • Loading...

Generated using TypeDoc