phonic
Version:
[](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FPhonic-Co%2Fphonic-node) [ • 3.24 kB
TypeScript
/**
* This file was auto-generated by Fern from our API Definition.
*/
export interface ConfigPayload {
type: "config";
/** Agent name to use for conversation */
agent?: string;
/** Project name */
project?: string;
/** STS model to use */
model?: "merritt";
/** System prompt for AI assistant */
system_prompt?: string;
/** Audio playback speed */
audio_speed?: number;
/** Background noise level for the conversation */
background_noise_level?: number;
/** Background noise type for the conversation */
background_noise?: ConfigPayload.BackgroundNoise | null;
/** When `true`, the welcome message will be automatically generated and the `welcome_message` field will be ignored. */
generate_welcome_message?: boolean;
/** Message to play when conversation starts. Ignored when `generate_welcome_message` is `true`. */
welcome_message?: string | null;
/** Voice ID to use for speech synthesis */
voice_id?: string;
/** Audio input format */
input_format?: ConfigPayload.InputFormat;
/** Audio output format */
output_format?: ConfigPayload.OutputFormat;
/** Voice activity detection prebuffer duration */
vad_prebuffer_duration_ms?: number;
/** Minimum speech duration for VAD */
vad_min_speech_duration_ms?: number;
/** Minimum silence duration for VAD */
vad_min_silence_duration_ms?: number;
/** Voice activity detection threshold */
vad_threshold?: number;
/** Enable document RAG */
enable_documents_rag?: boolean;
/** Enable transcript RAG */
enable_transcripts_rag?: boolean;
/** Seconds of silence before poke message */
no_input_poke_sec?: number | null;
/** Poke message text */
no_input_poke_text?: string;
/** Seconds of silence before ending conversation */
no_input_end_conversation_sec?: number;
/** Array of ISO 639-1 language codes that the agent should be able to recognize */
recognized_languages?: string[];
/** Keywords to boost in speech recognition */
boosted_keywords?: string[];
/** Tools available to the assistant */
tools?: string[];
/** Template variables for system prompt and welcome message */
template_variables?: Record<string, string>;
}
export declare namespace ConfigPayload {
/**
* Background noise type for the conversation
*/
type BackgroundNoise = "office" | "call-center" | "coffee-shop";
const BackgroundNoise: {
readonly Office: "office";
readonly CallCenter: "call-center";
readonly CoffeeShop: "coffee-shop";
};
/**
* Audio input format
*/
type InputFormat = "pcm_44100" | "pcm_16000" | "pcm_8000" | "mulaw_8000";
const InputFormat: {
readonly Pcm44100: "pcm_44100";
readonly Pcm16000: "pcm_16000";
readonly Pcm8000: "pcm_8000";
readonly Mulaw8000: "mulaw_8000";
};
/**
* Audio output format
*/
type OutputFormat = "pcm_44100" | "pcm_16000" | "pcm_8000" | "mulaw_8000";
const OutputFormat: {
readonly Pcm44100: "pcm_44100";
readonly Pcm16000: "pcm_16000";
readonly Pcm8000: "pcm_8000";
readonly Mulaw8000: "mulaw_8000";
};
}