AAI SDK
    Preparing search index...

    Type Alias PipelineAgentParams<S>

    PipelineAgentParams: SharedAgentParams<S> & Partial<
        Pick<AgentDef<S>, PipelineOnlyField>,
    > & { llm?: LlmProvider | string; s2s?: undefined; stt?: SttProvider } & (
        | {
            tts: TtsProvider;
            voice?: "`voice` picks the default pipeline's TTS voice — an explicit `tts` descriptor owns its own voice (e.g. `assemblyAITts({ voice })`); set it there or remove `tts`";
        }
        | { tts?: undefined; voice?: AssemblyAITtsVoice }
    )

    Pipeline-mode params: any subset of the provider triple (unset stages run on the default all-AssemblyAI pipeline), never s2s. The voice shorthand picks the default pipeline's TTS voice; an explicit tts descriptor owns its voice, so combining the two is a compile error naming the rule.

    Type Parameters

    Type Declaration

    • Optionalllm?: LlmProvider | string

      See AgentDef.llm; a string is gateway model-id shorthand. Unset → the default AssemblyAI LLM Gateway model.

    • Optionals2s?: undefined
    • Optionalstt?: SttProvider

      See AgentDef.stt. Unset → the default AssemblyAI STT.

    • {
          tts: TtsProvider;
          voice?: "`voice` picks the default pipeline's TTS voice — an explicit `tts` descriptor owns its own voice (e.g. `assemblyAITts({ voice })`); set it there or remove `tts`";
      }
      • tts: TtsProvider

        See AgentDef.tts. The voice rides on the descriptor.

      • Optionalvoice?: "`voice` picks the default pipeline's TTS voice — an explicit `tts` descriptor owns its own voice (e.g. `assemblyAITts({ voice })`); set it there or remove `tts`"
    • { tts?: undefined; voice?: AssemblyAITtsVoice }
      • Optionaltts?: undefined
      • Optionalvoice?: AssemblyAITtsVoice

        TTS voice for the default AssemblyAI pipeline — shorthand for tts: assemblyAITts({ voice }). See ASSEMBLYAI_TTS_VOICES (from @alexkroman1/aai/tts) for the catalog; a name outside it fails in-band after connect and leaves the agent silent.

    Settings
    Member Visibility