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

Function tool

  • tool<Schema, UserData, Result>(__namedParameters): FunctionTool<InferToolInput<Schema>, UserData, Result>
  • Create a function tool with inferred parameters from the schema.

    Type Parameters

    • Schema extends ToolInputSchema<any>
    • UserData = unknown
    • Result = unknown

    Parameters

    • __namedParameters: {
          description: string;
          execute: ToolExecuteFunction<InferToolInput<Schema>, UserData, Result>;
          parameters: Schema;
      }
      • description: string
      • execute: ToolExecuteFunction<InferToolInput<Schema>, UserData, Result>
      • parameters: Schema

    Returns FunctionTool<InferToolInput<Schema>, UserData, Result>

    • Defined in llm/tool_context.ts:193
  • tool<UserData, Result>(__namedParameters): FunctionTool<Record<string, never>, UserData, Result>
  • Create a function tool without parameters.

    Type Parameters

    • UserData = unknown
    • Result = unknown

    Parameters

    • __namedParameters: {
          description: string;
          execute: ToolExecuteFunction<Record<string, never>, UserData, Result>;
          parameters?: undefined;
      }
      • description: string
      • execute: ToolExecuteFunction<Record<string, never>, UserData, Result>
      • Optional parameters?: undefined

    Returns FunctionTool<Record<string, never>, UserData, Result>

    • Defined in llm/tool_context.ts:210
  • 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 llm/tool_context.ts:225

Settings

Member Visibility

Theme

LiveKit Agents
  • Loading...

Generated using TypeDoc