Class: Revox::Models::AssistantUpdateResponse::Assistant

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/revox/models/assistant_update_response.rb,
sig/revox/models/assistant_update_response.rbs

Overview

See Also:

  • Revox::Models::AssistantUpdateResponse#assistant

Defined Under Namespace

Modules: AfterCallSMSOutcome, BackgroundSound, EmailNotificationLanguage, EmailNotificationOutcome, FirstSentenceMode, HumanTransferMode, LlmModel, SttModel, ThinkingSound, Type Classes: Calendly, CallRetryConfig, CreatedBy, CustomTool, FaqItem, Position, PromptFlow, Slack, StructuredOutputConfig, SttContext, Voice, Zoho

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, email:, first_name:, last_name:) ⇒ Object

The user who created the assistant.

Parameters:

  • id (String) —

    The database user id of the creator.

  • email (String)
  • first_name (String, nil)
  • last_name (String, nil) 



# File 'lib/revox/models/assistant_update_response.rb', line 512

Instance Attribute Details

#after_call_sms_outcomes ⇒ Array<Symbol, Revox::Models::AssistantUpdateResponse::Assistant::AfterCallSMSOutcome>?

Which call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. Use "none" when outcome is null.

Parameters:

  • value (::Array[Revox::Models::AssistantUpdateResponse::Assistant::after_call_sms_outcome], nil)

Returns:



35
36
37
 
# File 'lib/revox/models/assistant_update_response.rb', line 35

required :after_call_sms_outcomes,
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::AssistantUpdateResponse::Assistant::AfterCallSMSOutcome] },
nil?: true

#after_call_sms_prompt ⇒ String?

Prompt / instructions for the after-call SMS. Supports {variable} placeholders. When null, no after-call SMS is sent.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


44
 
# File 'lib/revox/models/assistant_update_response.rb', line 44

required :after_call_sms_prompt, String, nil?: true

#background_sound ⇒ Symbol, ...

Ambient background sound to play during the call. null disables it.

Parameters:

  • value (Revox::Models::AssistantUpdateResponse::Assistant::background_sound, nil)

Returns:



50
51
52
 
# File 'lib/revox/models/assistant_update_response.rb', line 50

required :background_sound,
enum: -> { Revox::Models::AssistantUpdateResponse::Assistant::BackgroundSound },
nil?: true

#background_sound_volume ⇒ Float

Volume of the ambient background sound (0 = silent, 1 = max).

Parameters:

  • value (Float)

Returns:

  • (Float) 


58
 
# File 'lib/revox/models/assistant_update_response.rb', line 58

required :background_sound_volume, Float

#calendly ⇒ Revox::Models::AssistantUpdateResponse::Assistant::Calendly?

Parameters:

Returns:



63
 
# File 'lib/revox/models/assistant_update_response.rb', line 63

required :calendly, -> { Revox::Models::AssistantUpdateResponse::Assistant::Calendly }, nil?: true

#call_retry_config ⇒ Revox::Models::AssistantUpdateResponse::Assistant::CallRetryConfig?

Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

Parameters:

Returns:



70
71
72
 
# File 'lib/revox/models/assistant_update_response.rb', line 70

required :call_retry_config,
-> { Revox::Models::AssistantUpdateResponse::Assistant::CallRetryConfig },
nil?: true

#cartesia_dictionary_pronunciation_id ⇒ String?

Optional Cartesia pronunciation dictionary ID linked to this assistant.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


78
 
# File 'lib/revox/models/assistant_update_response.rb', line 78

required :cartesia_dictionary_pronunciation_id, String, nil?: true

#created_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


83
 
# File 'lib/revox/models/assistant_update_response.rb', line 83

required :created_at, Revox::Internal::Type::Unknown

#created_by ⇒ Revox::Models::AssistantUpdateResponse::Assistant::CreatedBy?

The user who created the assistant.

Parameters:

Returns:



343
 
# File 'lib/revox/models/assistant_update_response.rb', line 343

optional :created_by, -> { Revox::Models::AssistantUpdateResponse::Assistant::CreatedBy }, nil?: true

#custom_tools ⇒ Array<Revox::Models::AssistantUpdateResponse::Assistant::CustomTool>?

Parameters:

Returns:



88
89
90
 
# File 'lib/revox/models/assistant_update_response.rb', line 88

required :custom_tools,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantUpdateResponse::Assistant::CustomTool] },
nil?: true

#email_notification_address ⇒ String?

Email address(es) to receive notifications when a call ends with a matching outcome. Accepts a single email or a comma-separated list (e.g. "alice@x.com, bob@y.com").

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


98
 
# File 'lib/revox/models/assistant_update_response.rb', line 98

required :email_notification_address, String, nil?: true

#email_notification_language ⇒ Symbol, Revox::Models::AssistantUpdateResponse::Assistant::EmailNotificationLanguage

The language used for the notification email content. One of "en" or "fr".

Parameters:

  • value (Revox::Models::AssistantUpdateResponse::Assistant::email_notification_language)

Returns:



104
105
 
# File 'lib/revox/models/assistant_update_response.rb', line 104

required :email_notification_language,
enum: -> { Revox::Models::AssistantUpdateResponse::Assistant::EmailNotificationLanguage }

#email_notification_outcomes ⇒ Array<Symbol, Revox::Models::AssistantUpdateResponse::Assistant::EmailNotificationOutcome>?

Which call outcomes trigger an email notification. E.g. ["interested", "completed", "none"]. Use "none" when outcome is null.

Parameters:

  • value (::Array[Revox::Models::AssistantUpdateResponse::Assistant::email_notification_outcome], nil)

Returns:



112
113
114
 
# File 'lib/revox/models/assistant_update_response.rb', line 112

required :email_notification_outcomes,
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::AssistantUpdateResponse::Assistant::EmailNotificationOutcome] },
nil?: true

#end_of_call_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


119
 
# File 'lib/revox/models/assistant_update_response.rb', line 119

required :end_of_call_sentence, String, nil?: true

#faq_items ⇒ Array<Revox::Models::AssistantUpdateResponse::Assistant::FaqItem>?

Returns:



348
349
 
# File 'lib/revox/models/assistant_update_response.rb', line 348

optional :faq_items,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantUpdateResponse::Assistant::FaqItem] }

#first_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


124
 
# File 'lib/revox/models/assistant_update_response.rb', line 124

required :first_sentence, String, nil?: true

#first_sentence_delay_ms ⇒ Integer

Delay in milliseconds before speaking the first sentence. Default: 400.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


130
 
# File 'lib/revox/models/assistant_update_response.rb', line 130

required :first_sentence_delay_ms, Integer

#first_sentence_mode ⇒ Symbol, Revox::Models::AssistantUpdateResponse::Assistant::FirstSentenceMode

Parameters:

  • value (Revox::Models::AssistantUpdateResponse::Assistant::first_sentence_mode)

Returns:



135
136
 
# File 'lib/revox/models/assistant_update_response.rb', line 135

required :first_sentence_mode,
enum: -> { Revox::Models::AssistantUpdateResponse::Assistant::FirstSentenceMode }

#from_phone_number ⇒ String?

Override the default outbound phone number for calls placed with this assistant. When null, the organization's default phone number is used.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


143
 
# File 'lib/revox/models/assistant_update_response.rb', line 143

required :from_phone_number, String, nil?: true

#human_transfer_mode ⇒ Symbol, ...

Warm or cold transfer when transfer_phone_number is set; null when transfer is not configured.

Parameters:

  • value (Revox::Models::AssistantUpdateResponse::Assistant::human_transfer_mode, nil)

Returns:



150
151
152
 
# File 'lib/revox/models/assistant_update_response.rb', line 150

required :human_transfer_mode,
enum: -> { Revox::Models::AssistantUpdateResponse::Assistant::HumanTransferMode },
nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


28
 
# File 'lib/revox/models/assistant_update_response.rb', line 28

required :id, String

#is_realestate_assistant ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


354
 
# File 'lib/revox/models/assistant_update_response.rb', line 354

optional :is_realestate_assistant, Revox::Internal::Type::Boolean

#ivr_navigation_enabled ⇒ Boolean

Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and skip turns to navigate phone menus.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


159
 
# File 'lib/revox/models/assistant_update_response.rb', line 159

required :ivr_navigation_enabled, Revox::Internal::Type::Boolean

#llm_model ⇒ Revox::Models::AssistantUpdateResponse::Assistant::LlmModel::UnionMember0, ...

Parameters:

  • value (Revox::Models::AssistantUpdateResponse::Assistant::llm_model)

Returns:



164
 
# File 'lib/revox/models/assistant_update_response.rb', line 164

required :llm_model, union: -> { Revox::Models::AssistantUpdateResponse::Assistant::LlmModel }

#logo_url ⇒ String?

Public URL of the brand logo shown on the assistant's demo page. Null when unset.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


171
 
# File 'lib/revox/models/assistant_update_response.rb', line 171

required :logo_url, String, nil?: true

#max_call_duration_secs ⇒ Float

The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.

Parameters:

  • value (Float)

Returns:

  • (Float) 


178
 
# File 'lib/revox/models/assistant_update_response.rb', line 178

required :max_call_duration_secs, Float

#max_duration_end_message ⇒ String?

Optional message the agent will say, without being interruptible, when the call reaches its max duration. Kept short so it fits inside the farewell buffer. If null, the call ends silently.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


186
 
# File 'lib/revox/models/assistant_update_response.rb', line 186

required :max_duration_end_message, String, nil?: true

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


191
 
# File 'lib/revox/models/assistant_update_response.rb', line 191

required :name, String

#organization_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


196
 
# File 'lib/revox/models/assistant_update_response.rb', line 196

required :organization_id, String

#pending_faq_count ⇒ Float?

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


359
 
# File 'lib/revox/models/assistant_update_response.rb', line 359

optional :pending_faq_count, Float

#position ⇒ Revox::Models::AssistantUpdateResponse::Assistant::Position?

Parameters:

Returns:



201
 
# File 'lib/revox/models/assistant_update_response.rb', line 201

required :position, -> { Revox::Models::AssistantUpdateResponse::Assistant::Position }, nil?: true

#prompt ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


206
 
# File 'lib/revox/models/assistant_update_response.rb', line 206

required :prompt, String

#prompt_flow ⇒ Revox::Models::AssistantUpdateResponse::Assistant::PromptFlow?

Parameters:

Returns:



211
 
# File 'lib/revox/models/assistant_update_response.rb', line 211

required :prompt_flow, -> { Revox::Models::AssistantUpdateResponse::Assistant::PromptFlow }, nil?: true

#slack ⇒ Revox::Models::AssistantUpdateResponse::Assistant::Slack?

Parameters:

Returns:



216
 
# File 'lib/revox/models/assistant_update_response.rb', line 216

required :slack, -> { Revox::Models::AssistantUpdateResponse::Assistant::Slack }, nil?: true

#sms_enabled ⇒ Boolean

Enable SMS tool during calls. When enabled, the agent can send SMS messages to the user on the call.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


223
 
# File 'lib/revox/models/assistant_update_response.rb', line 223

required :sms_enabled, Revox::Internal::Type::Boolean

#sms_template ⇒ String?

Hardcoded SMS template to send during calls. When set, this exact text is sent instead of letting the agent generate the message. Supports {variable} placeholders.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


231
 
# File 'lib/revox/models/assistant_update_response.rb', line 231

required :sms_template, String, nil?: true

#structured_output_config ⇒ Array<Revox::Models::AssistantUpdateResponse::Assistant::StructuredOutputConfig>?

The structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).

Parameters:

Returns:



238
239
240
 
# File 'lib/revox/models/assistant_update_response.rb', line 238

required :structured_output_config,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantUpdateResponse::Assistant::StructuredOutputConfig] },
nil?: true

#structured_output_prompt ⇒ String?

Custom prompt for structured data extraction. If not provided, a default prompt is used. Available variables: {transcript}, {call_direction}, {user_phone_number}, {agent_phone_number}.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


248
 
# File 'lib/revox/models/assistant_update_response.rb', line 248

required :structured_output_prompt, String, nil?: true

#stt_context ⇒ Revox::Models::AssistantUpdateResponse::Assistant::SttContext?

Assistant-level speech-to-text context: structured general key/value pairs plus a list of domain terms. Prompt-derived context is merged in without replacing existing entries.

Parameters:

Returns:



256
 
# File 'lib/revox/models/assistant_update_response.rb', line 256

required :stt_context, -> { Revox::Models::AssistantUpdateResponse::Assistant::SttContext }, nil?: true

#stt_model ⇒ Symbol, Revox::Models::AssistantUpdateResponse::Assistant::SttModel

Transcriber (speech-to-text) model used for the assistant.

Parameters:

  • value (Revox::Models::AssistantUpdateResponse::Assistant::stt_model)

Returns:



262
 
# File 'lib/revox/models/assistant_update_response.rb', line 262

required :stt_model, enum: -> { Revox::Models::AssistantUpdateResponse::Assistant::SttModel }

#thinking_sound ⇒ Symbol, ...

Audio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.

Parameters:

  • value (Revox::Models::AssistantUpdateResponse::Assistant::thinking_sound, nil)

Returns:



269
270
271
 
# File 'lib/revox/models/assistant_update_response.rb', line 269

required :thinking_sound,
enum: -> { Revox::Models::AssistantUpdateResponse::Assistant::ThinkingSound },
nil?: true

#thinking_sound_probability ⇒ Float

Probability [0..1] that the thinking sound plays on any given turn; otherwise the agent is silent while thinking.

Parameters:

  • value (Float)

Returns:

  • (Float) 


278
 
# File 'lib/revox/models/assistant_update_response.rb', line 278

required :thinking_sound_probability, Float

#thinking_sound_volume ⇒ Float

Volume of the thinking sound (0 = silent, 1 = max).

Parameters:

  • value (Float)

Returns:

  • (Float) 


284
 
# File 'lib/revox/models/assistant_update_response.rb', line 284

required :thinking_sound_volume, Float

#transfer_phone_number ⇒ String?

Phone number to transfer calls to when users request to speak to a human agent.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


290
 
# File 'lib/revox/models/assistant_update_response.rb', line 290

required :transfer_phone_number, String, nil?: true

#type ⇒ Symbol, Revox::Models::AssistantUpdateResponse::Assistant::Type

Parameters:

  • value (Revox::Models::AssistantUpdateResponse::Assistant::type_)

Returns:



295
 
# File 'lib/revox/models/assistant_update_response.rb', line 295

required :type, enum: -> { Revox::Models::AssistantUpdateResponse::Assistant::Type }

#updated_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


300
 
# File 'lib/revox/models/assistant_update_response.rb', line 300

required :updated_at, Revox::Internal::Type::Unknown

#voice ⇒ Revox::Models::AssistantUpdateResponse::Assistant::Voice?

Parameters:

Returns:



305
 
# File 'lib/revox/models/assistant_update_response.rb', line 305

required :voice, -> { Revox::Models::AssistantUpdateResponse::Assistant::Voice }, nil?: true

#voicemail_message ⇒ String?

If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


312
 
# File 'lib/revox/models/assistant_update_response.rb', line 312

required :voicemail_message, String, nil?: true

#voicemail_sms_prompt ⇒ String?

Prompt / instructions for the voicemail SMS. Supports {variable} placeholders. When null, no SMS is sent on voicemail.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


319
 
# File 'lib/revox/models/assistant_update_response.rb', line 319

required :voicemail_sms_prompt, String, nil?: true

#warm_transfer_summary_instructions ⇒ String?

Warm transfer only: instructions for the supervisor handoff summary; null when not configured or cold transfer.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


326
 
# File 'lib/revox/models/assistant_update_response.rb', line 326

required :warm_transfer_summary_instructions, String, nil?: true

#webhook_url ⇒ String?

The webhook URL to call when the call is completed.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


332
 
# File 'lib/revox/models/assistant_update_response.rb', line 332

required :webhook_url, String, nil?: true

#zoho ⇒ Revox::Models::AssistantUpdateResponse::Assistant::Zoho?

Parameters:

Returns:



337
 
# File 'lib/revox/models/assistant_update_response.rb', line 337

required :zoho, -> { Revox::Models::AssistantUpdateResponse::Assistant::Zoho }, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


252
 
# File 'sig/revox/models/assistant_update_response.rbs', line 252

def to_hash: -> {