@elevenlabs/convai-cli
Version:
CLI tool to manage ElevenLabs conversational AI agents
96 lines • 2.96 kB
TypeScript
/**
* Agent configuration template functions
*/
export interface AgentConfig {
name: string;
conversation_config: {
agent: {
prompt: {
prompt: string;
temperature: number;
max_tokens?: number;
[key: string]: unknown;
};
[key: string]: unknown;
};
conversation: {
text_only: boolean;
max_duration_seconds?: number;
[key: string]: unknown;
};
[key: string]: unknown;
};
platform_settings?: {
widget?: {
supports_text_only?: boolean;
text_input_enabled?: boolean;
[key: string]: unknown;
};
call_limits?: {
daily_limit?: number;
[key: string]: unknown;
};
evaluation?: {
criteria?: string[];
[key: string]: unknown;
};
overrides?: {
conversation_config_override?: {
conversation?: {
text_only?: boolean;
[key: string]: unknown;
};
[key: string]: unknown;
};
[key: string]: unknown;
};
[key: string]: unknown;
};
tags: string[];
}
/**
* Returns a complete default agent configuration template with all available fields.
*
* @param name - The name of the agent
* @returns A complete agent configuration template
*/
export declare function getDefaultAgentTemplate(name: string): AgentConfig;
/**
* Returns a minimal agent configuration template with only essential fields.
*
* @param name - The name of the agent
* @returns A minimal agent configuration template
*/
export declare function getMinimalAgentTemplate(name: string): AgentConfig;
/**
* Returns available template options with descriptions.
*
* @returns A map of template names to descriptions
*/
export declare function getTemplateOptions(): Record<string, string>;
/**
* Returns a template optimized for voice-only conversations.
*/
export declare function getVoiceOnlyTemplate(name: string): AgentConfig;
/**
* Returns a template optimized for text-only conversations.
*/
export declare function getTextOnlyTemplate(name: string): AgentConfig;
/**
* Returns a template pre-configured for customer service scenarios.
*/
export declare function getCustomerServiceTemplate(name: string): AgentConfig;
/**
* Returns a general purpose AI assistant template.
*/
export declare function getAssistantTemplate(name: string): AgentConfig;
/**
* Returns a template by name and type.
*
* @param name - The agent name
* @param templateType - The type of template to generate
* @returns An agent configuration template
* @throws {Error} If template_type is not recognized
*/
export declare function getTemplateByName(name: string, templateType?: string): AgentConfig;
//# sourceMappingURL=templates.d.ts.map