vapi4k-core/com.vapi4k.dtos.model/CustomLLMModelDto

CustomLLMModelDto

@Serializable

data class CustomLLMModelDto(var model: String = "", var url: String = "", var temperature: Double = -1.0, var maxTokens: Int = -1, var emotionRecognitionEnabled: Boolean? = null, var numFastTurns: Int = -1, var knowledgeBaseDto: KnowledgeBaseDto? = null, val messages: MutableList<RoleMessageDto> = mutableListOf(), val tools: MutableList<ToolDto> = mutableListOf(), val toolIds: MutableSet<String> = mutableSetOf(), val functions: MutableList<FunctionDto> = mutableListOf(), var metadataSendMode: MetaDataSendModeType = MetaDataSendModeType.UNSPECIFIED) : CustomLLMModelProperties, CommonModelDto(source)

Constructors

CustomLLMModelDto

constructor(model: String = "", url: String = "", temperature: Double = -1.0, maxTokens: Int = -1, emotionRecognitionEnabled: Boolean? = null, numFastTurns: Int = -1, knowledgeBaseDto: KnowledgeBaseDto? = null, messages: MutableList<RoleMessageDto> = mutableListOf(), tools: MutableList<ToolDto> = mutableListOf(), toolIds: MutableSet<String> = mutableSetOf(), functions: MutableList<FunctionDto> = mutableListOf(), metadataSendMode: MetaDataSendModeType = MetaDataSendModeType.UNSPECIFIED)

Properties

emotionRecognitionEnabled

open override var emotionRecognitionEnabled: Boolean?

This determines whether we detect user's emotion while they speak and send it as an additional info to model.
Default `false` because the model is usually good at understanding the user's emotion from text.

functions

open override val functions: MutableList<FunctionDto>

knowledgeBaseDto

@SerialName(value = "knowledgeBase")

open override var knowledgeBaseDto: KnowledgeBaseDto?

maxTokens

open override var maxTokens: Int

This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250.

messages

open override val messages: MutableList<RoleMessageDto>

metadataSendMode

open override var metadataSendMode: MetaDataSendModeType

This determines whether metadata is sent in requests to the custom provider.

off will not send any metadata. Payload will look like { messages }

variable will send assistant.metadata as a variable on the payload. Payload will look like { messages, metadata }

destructured will send assistant.metadata fields directly on the payload. Payload will look like { messages, ...metadata }
Further, variable and destructured will send call, phoneNumber, and customer objects in the payload.
Default is variable.

model

open override var model: String

This is the name of the model.

numFastTurns

open override var numFastTurns: Int

This sets how many turns at the start of the conversation to use a smaller, faster model from the same provider before switching to the primary model. Example, gpt-3.5-turbo if provider is openai. Default is 0.

provider

@EncodeDefault

open override val provider: ModelType

temperature

open override var temperature: Double

This is the temperature that will be used for calls.

toolIds

open override val toolIds: MutableSet<String>

These are the tools that the assistant can use during the call. To use transient tools, use tools. Both tools and toolIds can be used together.

tools

open override val tools: MutableList<ToolDto>

url

open override var url: String

This is the URL we'll use for the OpenAI client's baseURL.

Functions

verifyValues

fun verifyValues()