// This file was auto-generated by Fern from our API Definition.

import type * as Vapi from "../index.js";

export interface CreateAssistantDto {
    /** These are the options for the assistant's transcriber. */
    transcriber?: Vapi.CreateAssistantDtoTranscriber | undefined;
    /** These are the options for the assistant's LLM. */
    model?: Vapi.CreateAssistantDtoModel | undefined;
    /** These are the options for the assistant's voice. */
    voice?: Vapi.CreateAssistantDtoVoice | undefined;
    /**
     * This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).
     *
     * If unspecified, assistant will wait for user to speak and use the model to respond once they speak.
     */
    firstMessage?: string | undefined;
    firstMessageInterruptionsEnabled?: boolean | undefined;
    /**
     * This is the mode for the first message. Default is 'assistant-speaks-first'.
     *
     * Use:
     * - 'assistant-speaks-first' to have the assistant speak first.
     * - 'assistant-waits-for-user' to have the assistant wait for the user to speak first.
     * - 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points).
     *
     * @default 'assistant-speaks-first'
     */
    firstMessageMode?: Vapi.CreateAssistantDtoFirstMessageMode | undefined;
    /**
     * These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].
     * By default, voicemail detection is disabled.
     */
    voicemailDetection?: Vapi.CreateAssistantDtoVoicemailDetection | undefined;
    /** These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started,assistant.started. You can check the shape of the messages in ClientMessage schema. */
    clientMessages?: Vapi.CreateAssistantDtoClientMessagesItem[] | undefined;
    /** These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,handoff-destination-request,user-interrupted,assistant.started. You can check the shape of the messages in ServerMessage schema. */
    serverMessages?: Vapi.CreateAssistantDtoServerMessagesItem[] | undefined;
    /**
     * This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
     *
     * @default 600 (10 minutes)
     */
    maxDurationSeconds?: number | undefined;
    /**
     * This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'.
     * You can also provide a custom sound by providing a URL to an audio file.
     */
    backgroundSound?: Vapi.CreateAssistantDtoBackgroundSound | undefined;
    /**
     * This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.
     *
     * @default false
     */
    modelOutputInMessagesEnabled?: boolean | undefined;
    /** These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used. */
    transportConfigurations?: Vapi.TransportConfigurationTwilio[] | undefined;
    /**
     * This is the plan for observability of assistant's calls.
     *
     * Currently, only Langfuse is supported.
     */
    observabilityPlan?: Vapi.LangfuseObservabilityPlan | undefined;
    /** These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials. */
    credentials?: Vapi.CreateAssistantDtoCredentialsItem[] | undefined;
    /** This is a set of actions that will be performed on certain events. */
    hooks?: Vapi.CreateAssistantDtoHooksItem[] | undefined;
    /**
     * This is the name of the assistant.
     *
     * This is required when you want to transfer between assistants in a call.
     */
    name?: string | undefined;
    /**
     * This is the message that the assistant will say if the call is forwarded to voicemail.
     *
     * If unspecified, it will hang up.
     */
    voicemailMessage?: string | undefined;
    /**
     * This is the message that the assistant will say if it ends the call.
     *
     * If unspecified, it will hang up without saying anything.
     */
    endCallMessage?: string | undefined;
    /** This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive. */
    endCallPhrases?: string[] | undefined;
    compliancePlan?: Vapi.CompliancePlan | undefined;
    /** This is for metadata you want to store on the assistant. */
    metadata?: Record<string, unknown> | undefined;
    /**
     * This enables filtering of noise and background speech while the user is talking.
     *
     * Features:
     * - Smart denoising using Krisp
     * - Fourier denoising
     *
     * Smart denoising can be combined with or used independently of Fourier denoising.
     *
     * Order of precedence:
     * - Smart denoising
     * - Fourier denoising
     */
    backgroundSpeechDenoisingPlan?: Vapi.BackgroundSpeechDenoisingPlan | undefined;
    /** This is the plan for analysis of assistant's calls. Stored in `call.analysis`. */
    analysisPlan?: Vapi.AnalysisPlan | undefined;
    /** This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`. */
    artifactPlan?: Vapi.ArtifactPlan | undefined;
    /**
     * This is the plan for when the assistant should start talking.
     *
     * You should configure this if you're running into these issues:
     * - The assistant is too slow to start talking after the customer is done speaking.
     * - The assistant is too fast to start talking after the customer is done speaking.
     * - The assistant is so fast that it's actually interrupting the customer.
     */
    startSpeakingPlan?: Vapi.StartSpeakingPlan | undefined;
    /**
     * This is the plan for when assistant should stop talking on customer interruption.
     *
     * You should configure this if you're running into these issues:
     * - The assistant is too slow to recognize customer's interruption.
     * - The assistant is too fast to recognize customer's interruption.
     * - The assistant is getting interrupted by phrases that are just acknowledgments.
     * - The assistant is getting interrupted by background noises.
     * - The assistant is not properly stopping -- it starts talking right after getting interrupted.
     */
    stopSpeakingPlan?: Vapi.StopSpeakingPlan | undefined;
    /**
     * This is the plan for real-time monitoring of the assistant's calls.
     *
     * Usage:
     * - To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`.
     * - To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`.
     * - To attach monitors to the assistant, set `monitorPlan.monitorIds` to the set of monitor ids.
     */
    monitorPlan?: Vapi.MonitorPlan | undefined;
    /** These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this. */
    credentialIds?: string[] | undefined;
    /**
     * This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.
     *
     * The order of precedence is:
     *
     * 1. assistant.server.url
     * 2. phoneNumber.serverUrl
     * 3. org.serverUrl
     */
    server?: Vapi.Server | undefined;
    keypadInputPlan?: Vapi.KeypadInputPlan | undefined;
}
