Class: Revox::Models::AssistantRetrieveResponse

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

Overview

See Also:

  • Revox::Resources::Assistants#retrieve

Defined Under Namespace

Modules: AfterCallSMSOutcome, BackgroundSound, EmailNotificationOutcome, FirstSentenceMode, HumanTransferMode, LlmModel, SttModel, ThinkingSound, Type Classes: Calendly, CallRetryConfig, CreatedBy, CustomTool, FaqItem, Position, PromptFlow, Slack, StructuredOutputConfig, SttContext, TransferDestination, 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_retrieve_response.rb', line 496

Instance Attribute Details

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

Returns:



17
18
19
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 17

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


26
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 26

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

Returns:



32
33
34
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 32

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

#background_sound_volume ⇒ Float

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

Parameters:

  • value (Float)

Returns:

  • (Float) 


40
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 40

required :background_sound_volume, Float

#calendly ⇒ Revox::Models::AssistantRetrieveResponse::Calendly?

Parameters:

Returns:



45
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 45

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

#call_retry_config ⇒ Revox::Models::AssistantRetrieveResponse::CallRetryConfig?

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

Parameters:

Returns:



52
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 52

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

#cartesia_dictionary_pronunciation_id ⇒ String?

Optional Cartesia pronunciation dictionary ID linked to this assistant.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :cartesia_dictionary_pronunciation_id, String, nil?: true

#created_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


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

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

#created_by ⇒ Revox::Models::AssistantRetrieveResponse::CreatedBy?

The user who created the assistant.

Parameters:

Returns:



323
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 323

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

#custom_tools ⇒ Array<Revox::Models::AssistantRetrieveResponse::CustomTool>?

Parameters:

Returns:



68
69
70
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 68

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


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

required :email_notification_address, String, nil?: true

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

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

Parameters:

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

Returns:



85
86
87
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 85

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

#end_of_call_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


92
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 92

required :end_of_call_sentence, String, nil?: true

#faq_items ⇒ Array<Revox::Models::AssistantRetrieveResponse::FaqItem>?

Returns:



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

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

#first_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

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) 


103
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 103

required :first_sentence_delay_ms, Integer

#first_sentence_mode ⇒ Symbol, Revox::Models::AssistantRetrieveResponse::FirstSentenceMode

Parameters:

  • value (Revox::Models::AssistantRetrieveResponse::first_sentence_mode)

Returns:



108
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 108

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


115
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 115

required :from_phone_number, String, nil?: true

#human_transfer_mode ⇒ Symbol, ...

Warm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.

Parameters:

  • value (Revox::Models::AssistantRetrieveResponse::human_transfer_mode, nil)

Returns:



122
123
124
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 122

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

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


10
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 10

required :id, String

#is_inbound_receptionist ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


334
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 334

optional :is_inbound_receptionist, Revox::Internal::Type::Boolean

#is_realestate_assistant ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


339
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 339

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) 


131
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 131

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

#llm_model ⇒ Revox::Models::AssistantRetrieveResponse::LlmModel::UnionMember0, ...

Parameters:

  • value (Revox::Models::AssistantRetrieveResponse::llm_model)

Returns:



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

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


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

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) 


150
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 150

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) 


158
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 158

required :max_duration_end_message, String, nil?: true

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :name, String

#organization_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


168
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 168

required :organization_id, String

#pending_faq_count ⇒ Float?

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


344
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 344

optional :pending_faq_count, Float

#position ⇒ Revox::Models::AssistantRetrieveResponse::Position?

Parameters:

Returns:



173
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 173

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

#precall_lookup_url ⇒ String?

URL fetched before an inbound call is answered to resolve the assistant's prompt variables. Null when no lookup is configured.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


180
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 180

required :precall_lookup_url, String, nil?: true

#prompt ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


185
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 185

required :prompt, String

#prompt_flow ⇒ Revox::Models::AssistantRetrieveResponse::PromptFlow?

Parameters:

Returns:



190
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 190

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

#slack ⇒ Revox::Models::AssistantRetrieveResponse::Slack?

Parameters:

Returns:



195
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 195

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


202
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 202

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) 


210
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 210

required :sms_template, String, nil?: true

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



217
218
219
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 217

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


227
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 227

required :structured_output_prompt, String, nil?: true

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



235
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 235

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

#stt_model ⇒ Symbol, Revox::Models::AssistantRetrieveResponse::SttModel

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

Parameters:

  • value (Revox::Models::AssistantRetrieveResponse::stt_model)

Returns:



241
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 241

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

Returns:



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

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


255
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 255

required :thinking_sound_probability, Float

#thinking_sound_volume ⇒ Float

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

Parameters:

  • value (Float)

Returns:

  • (Float) 


261
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 261

required :thinking_sound_volume, Float

#transfer_destinations ⇒ Array<Revox::Models::AssistantRetrieveResponse::TransferDestination>?

Where calls can be transferred to when users ask to speak to a human. Null or empty when transfer is not configured.

Parameters:

Returns:



268
269
270
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 268

required :transfer_destinations,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::AssistantRetrieveResponse::TransferDestination] },
nil?: true

#type ⇒ Symbol, Revox::Models::AssistantRetrieveResponse::Type

Parameters:

  • value (Revox::Models::AssistantRetrieveResponse::type_)

Returns:



275
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 275

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

#updated_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


280
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 280

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

#voice ⇒ Revox::Models::AssistantRetrieveResponse::Voice?

Parameters:

Returns:



285
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 285

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


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

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) 


299
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 299

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) 


306
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 306

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) 


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

required :webhook_url, String, nil?: true

#zoho ⇒ Revox::Models::AssistantRetrieveResponse::Zoho?

Parameters:

Returns:



317
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 317

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


233
 
# File 'sig/revox/models/assistant_retrieve_response.rbs', line 233

def to_hash: -> {