An object that can appear in AgentSession options (a turn detector, a model) and wants the session report to show its configuration.

Return the options worth reporting, keyed by name; values can be primitives, plain objects or arrays of them. Leave secrets and endpoints out: the report is uploaded. Objects without this method are reported by class name alone.

interface DescribesOptions {
    describeOptions(): Readonly<Record<string, unknown>>;
}

Methods

  • The options worth reporting, keyed by name. Never credentials or endpoints.

    Returns Readonly<Record<string, unknown>>