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

Function defineAgent

  • defineAgent<ProcessUserData>(agent): Agent<ProcessUserData>
  • Helper to define an agent according to the required interface.

    Type Parameters

    • ProcessUserData = Record<string, unknown>

    Parameters

    • agent: Agent<ProcessUserData>

    Returns Agent<ProcessUserData>

    Example: A basic agent with entry and prewarm functions

    export default defineAgent({
    entry: async (ctx: JobContext) => { ... },
    prewarm: (proc: JobProcess) => { ... },
    })
    • Defined in agents/src/generator.ts:36

Settings

Member Visibility

Theme

LiveKit Agents
  • Loading...

Generated using TypeDoc