Class: Revox::Models::AssistantCreateResponse::Assistant

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

Overview

See Also:

  • Revox::Models::AssistantCreateResponse#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_create_response.rb', line 504

Instance Attribute Details

#after_call_sms_outcomes ⇒ Array<Symbol, Revox::Models::AssistantCreateResponse::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::AssistantCreateResponse::Assistant::after_call_sms_outcome], nil)

Returns:



27
28
29
 
# File 'lib/revox/models/assistant_create_response.rb', line 27

required :after_call_sms_outcomes,
-> { Revox::Internal::Type::ArrayOf[enum: Revox::Models::AssistantCreateResponse::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) 


36
 
# File 'lib/revox/models/assistant_create_response.rb', line 36

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::AssistantCreateResponse::Assistant::background_sound, nil)

Returns:



42
43
44
 
# File 'lib/revox/models/assistant_create_response.rb', line 42

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

#background_sound_volume ⇒ Float

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

Parameters:

  • value (Float)

Returns:

  • (Float) 


50
 
# File 'lib/revox/models/assistant_create_response.rb', line 50

required :background_sound_volume, Float

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

Parameters:

Returns:



55
 
# File 'lib/revox/models/assistant_create_response.rb', line 55

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

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

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

Parameters:

Returns:



62
63
64
 
# File 'lib/revox/models/assistant_create_response.rb', line 62

required :call_retry_config,
-> { Revox::Models::AssistantCreateResponse::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) 


70
 
# File 'lib/revox/models/assistant_create_response.rb', line 70

required :cartesia_dictionary_pronunciation_id, String, nil?: true

#created_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


75
 
# File 'lib/revox/models/assistant_create_response.rb', line 75

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

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

The user who created the assistant.

Parameters:

Returns:



335
 
# File 'lib/revox/models/assistant_create_response.rb', line 335

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

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

Parameters:

Returns:



80
81
82
 
# File 'lib/revox/models/assistant_create_response.rb', line 80

required :custom_tools,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantCreateResponse::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) 


90
 
# File 'lib/revox/models/assistant_create_response.rb', line 90

required :email_notification_address, String, nil?: true

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

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

Parameters:

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

Returns:



96
97
 
# File 'lib/revox/models/assistant_create_response.rb', line 96

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

#email_notification_outcomes ⇒ Array<Symbol, Revox::Models::AssistantCreateResponse::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::AssistantCreateResponse::Assistant::email_notification_outcome], nil)

Returns:



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

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

#end_of_call_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


111
 
# File 'lib/revox/models/assistant_create_response.rb', line 111

required :end_of_call_sentence, String, nil?: true

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

Returns:



340
341
 
# File 'lib/revox/models/assistant_create_response.rb', line 340

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

#first_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


116
 
# File 'lib/revox/models/assistant_create_response.rb', line 116

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) 


122
 
# File 'lib/revox/models/assistant_create_response.rb', line 122

required :first_sentence_delay_ms, Integer

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

Parameters:

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

Returns:



127
128
 
# File 'lib/revox/models/assistant_create_response.rb', line 127

required :first_sentence_mode,
enum: -> { Revox::Models::AssistantCreateResponse::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) 


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

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::AssistantCreateResponse::Assistant::human_transfer_mode, nil)

Returns:



142
143
144
 
# File 'lib/revox/models/assistant_create_response.rb', line 142

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

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


20
 
# File 'lib/revox/models/assistant_create_response.rb', line 20

required :id, String

#is_realestate_assistant ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


346
 
# File 'lib/revox/models/assistant_create_response.rb', line 346

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) 


151
 
# File 'lib/revox/models/assistant_create_response.rb', line 151

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

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

Parameters:

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

Returns:



156
 
# File 'lib/revox/models/assistant_create_response.rb', line 156

required :llm_model, union: -> { Revox::Models::AssistantCreateResponse::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) 


163
 
# File 'lib/revox/models/assistant_create_response.rb', line 163

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) 


170
 
# File 'lib/revox/models/assistant_create_response.rb', line 170

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) 


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

required :max_duration_end_message, String, nil?: true

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


183
 
# File 'lib/revox/models/assistant_create_response.rb', line 183

required :name, String

#organization_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


188
 
# File 'lib/revox/models/assistant_create_response.rb', line 188

required :organization_id, String

#pending_faq_count ⇒ Float?

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


351
 
# File 'lib/revox/models/assistant_create_response.rb', line 351

optional :pending_faq_count, Float

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

Parameters:

Returns:



193
 
# File 'lib/revox/models/assistant_create_response.rb', line 193

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

#prompt ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


198
 
# File 'lib/revox/models/assistant_create_response.rb', line 198

required :prompt, String

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

Parameters:

Returns:



203
 
# File 'lib/revox/models/assistant_create_response.rb', line 203

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

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

Parameters:

Returns:



208
 
# File 'lib/revox/models/assistant_create_response.rb', line 208

required :slack, -> { Revox::Models::AssistantCreateResponse::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) 


215
 
# File 'lib/revox/models/assistant_create_response.rb', line 215

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) 


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

required :sms_template, String, nil?: true

#structured_output_config ⇒ Array<Revox::Models::AssistantCreateResponse::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:



230
231
232
 
# File 'lib/revox/models/assistant_create_response.rb', line 230

required :structured_output_config,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantCreateResponse::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) 


240
 
# File 'lib/revox/models/assistant_create_response.rb', line 240

required :structured_output_prompt, String, nil?: true

#stt_context ⇒ Revox::Models::AssistantCreateResponse::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:



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

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

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

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

Parameters:

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

Returns:



254
 
# File 'lib/revox/models/assistant_create_response.rb', line 254

required :stt_model, enum: -> { Revox::Models::AssistantCreateResponse::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::AssistantCreateResponse::Assistant::thinking_sound, nil)

Returns:



261
262
263
 
# File 'lib/revox/models/assistant_create_response.rb', line 261

required :thinking_sound,
enum: -> { Revox::Models::AssistantCreateResponse::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) 


270
 
# File 'lib/revox/models/assistant_create_response.rb', line 270

required :thinking_sound_probability, Float

#thinking_sound_volume ⇒ Float

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

Parameters:

  • value (Float)

Returns:

  • (Float) 


276
 
# File 'lib/revox/models/assistant_create_response.rb', line 276

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) 


282
 
# File 'lib/revox/models/assistant_create_response.rb', line 282

required :transfer_phone_number, String, nil?: true

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

Parameters:

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

Returns:



287
 
# File 'lib/revox/models/assistant_create_response.rb', line 287

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

#updated_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


292
 
# File 'lib/revox/models/assistant_create_response.rb', line 292

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

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

Parameters:

Returns:



297
 
# File 'lib/revox/models/assistant_create_response.rb', line 297

required :voice, -> { Revox::Models::AssistantCreateResponse::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) 


304
 
# File 'lib/revox/models/assistant_create_response.rb', line 304

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) 


311
 
# File 'lib/revox/models/assistant_create_response.rb', line 311

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) 


318
 
# File 'lib/revox/models/assistant_create_response.rb', line 318

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) 


324
 
# File 'lib/revox/models/assistant_create_response.rb', line 324

required :webhook_url, String, nil?: true

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

Parameters:

Returns:



329
 
# File 'lib/revox/models/assistant_create_response.rb', line 329

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


241
 
# File 'sig/revox/models/assistant_create_response.rbs', line 241

def to_hash: -> {