@deepgram/sdk/src/lib/types/AgentLiveSchema.ts

Isomorphic Javascript client for Deepgram

type Provider = { type: string } & Record<string, unknown>;

/**
 * @see https://developers.deepgram.com/reference/voicebot-api-phase-preview#settingsconfiguration
 */
interface AgentLiveSchema extends Record<string, unknown> {
  /**
   * Set to true to enable experimental features.
   * @default false
   */
  experimental?: boolean;
  audio: {
    input?: {
      /**
       * @default "linear16"
       */
      encoding: string;
      /**
       * @default 16000
       */
      sample_rate: number;
    };
    /**
     * @see https://developers.deepgram.com/docs/tts-media-output-settings#audio-format-combinations
     */
    output?: {
      encoding?: string;
      sample_rate?: number;
      bitrate?: number;
      /**
       * @default "none"
       */
      container?: string;
    };
  };
  agent: {
    /**
     * ISO 639-1 language code for agent language.
     * @default "en"
     */
    language?: string;
    listen?: {
      provider: Provider;
    };
    speak?: {
      provider: Provider;
      endpoint?: {
        url: string;
        headers?: Record<string, string>;
      };
    };
    /**
     * @see https://developers.deepgram.com/reference/voicebot-api-phase-preview#supported-llm-providers-and-models
     */
    think?: {
      provider: Provider;
      /**
       * Optional ONLY if LLM provider is OpenAI or Anthropic.
       */
      endpoint?: {
        url: string;
        headers?: Record<string, string>;
      };
      functions?: {
        name?: string;
        description?: string;
        parameters?: Record<string, unknown>;
        endpoint?: {
          url?: string;
          method?: string;
          headers?: Record<string, string>;
        };
      }[];
      prompt?: string;
      context_length?: number | "max";
    };
    /**
     * Optional message the agent will say at the start of the connection.
     */
    greeting?: string;
  };
}

export type { AgentLiveSchema };