Class: Revox::Models::CallSearchResponse::Call::Assistant

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

Overview

See Also:

  • Revox::Models::CallSearchResponse::Call#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/call_search_response.rb', line 769

Instance Attribute Details

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

Returns:



292
293
294
 
# File 'lib/revox/models/call_search_response.rb', line 292

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


301
 
# File 'lib/revox/models/call_search_response.rb', line 301

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

Returns:



307
308
309
 
# File 'lib/revox/models/call_search_response.rb', line 307

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

#background_sound_volume ⇒ Float

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

Parameters:

  • value (Float)

Returns:

  • (Float) 


315
 
# File 'lib/revox/models/call_search_response.rb', line 315

required :background_sound_volume, Float

#calendly ⇒ Revox::Models::CallSearchResponse::Call::Assistant::Calendly?

Parameters:

Returns:



320
 
# File 'lib/revox/models/call_search_response.rb', line 320

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

#call_retry_config ⇒ Revox::Models::CallSearchResponse::Call::Assistant::CallRetryConfig?

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

Parameters:

Returns:



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

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


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

required :cartesia_dictionary_pronunciation_id, String, nil?: true

#created_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


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

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

#created_by ⇒ Revox::Models::CallSearchResponse::Call::Assistant::CreatedBy?

The user who created the assistant.

Parameters:

Returns:



600
 
# File 'lib/revox/models/call_search_response.rb', line 600

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

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

Parameters:

Returns:



345
346
347
 
# File 'lib/revox/models/call_search_response.rb', line 345

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


355
 
# File 'lib/revox/models/call_search_response.rb', line 355

required :email_notification_address, String, nil?: true

#email_notification_language ⇒ Symbol, Revox::Models::CallSearchResponse::Call::Assistant::EmailNotificationLanguage

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

Parameters:

  • value (Revox::Models::CallSearchResponse::Call::Assistant::email_notification_language)

Returns:



361
362
 
# File 'lib/revox/models/call_search_response.rb', line 361

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

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

Returns:



369
370
371
 
# File 'lib/revox/models/call_search_response.rb', line 369

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

#end_of_call_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


376
 
# File 'lib/revox/models/call_search_response.rb', line 376

required :end_of_call_sentence, String, nil?: true

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

Returns:



605
606
 
# File 'lib/revox/models/call_search_response.rb', line 605

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

#first_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


381
 
# File 'lib/revox/models/call_search_response.rb', line 381

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) 


387
 
# File 'lib/revox/models/call_search_response.rb', line 387

required :first_sentence_delay_ms, Integer

#first_sentence_mode ⇒ Symbol, Revox::Models::CallSearchResponse::Call::Assistant::FirstSentenceMode

Parameters:

  • value (Revox::Models::CallSearchResponse::Call::Assistant::first_sentence_mode)

Returns:



392
393
 
# File 'lib/revox/models/call_search_response.rb', line 392

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


400
 
# File 'lib/revox/models/call_search_response.rb', line 400

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

Returns:



407
408
409
 
# File 'lib/revox/models/call_search_response.rb', line 407

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

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#is_realestate_assistant ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


611
 
# File 'lib/revox/models/call_search_response.rb', line 611

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) 


416
 
# File 'lib/revox/models/call_search_response.rb', line 416

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

#llm_model ⇒ Revox::Models::CallSearchResponse::Call::Assistant::LlmModel::UnionMember0, ...

Parameters:

  • value (Revox::Models::CallSearchResponse::Call::Assistant::llm_model)

Returns:



421
 
# File 'lib/revox/models/call_search_response.rb', line 421

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


428
 
# File 'lib/revox/models/call_search_response.rb', line 428

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) 


435
 
# File 'lib/revox/models/call_search_response.rb', line 435

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) 


443
 
# File 'lib/revox/models/call_search_response.rb', line 443

required :max_duration_end_message, String, nil?: true

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


448
 
# File 'lib/revox/models/call_search_response.rb', line 448

required :name, String

#organization_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


453
 
# File 'lib/revox/models/call_search_response.rb', line 453

required :organization_id, String

#pending_faq_count ⇒ Float?

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


616
 
# File 'lib/revox/models/call_search_response.rb', line 616

optional :pending_faq_count, Float

#position ⇒ Revox::Models::CallSearchResponse::Call::Assistant::Position?

Parameters:

Returns:



458
 
# File 'lib/revox/models/call_search_response.rb', line 458

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

#prompt ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


463
 
# File 'lib/revox/models/call_search_response.rb', line 463

required :prompt, String

#prompt_flow ⇒ Revox::Models::CallSearchResponse::Call::Assistant::PromptFlow?

Parameters:

Returns:



468
 
# File 'lib/revox/models/call_search_response.rb', line 468

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

#slack ⇒ Revox::Models::CallSearchResponse::Call::Assistant::Slack?

Parameters:

Returns:



473
 
# File 'lib/revox/models/call_search_response.rb', line 473

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


480
 
# File 'lib/revox/models/call_search_response.rb', line 480

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) 


488
 
# File 'lib/revox/models/call_search_response.rb', line 488

required :sms_template, String, nil?: true

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



495
496
497
 
# File 'lib/revox/models/call_search_response.rb', line 495

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


505
 
# File 'lib/revox/models/call_search_response.rb', line 505

required :structured_output_prompt, String, nil?: true

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



513
 
# File 'lib/revox/models/call_search_response.rb', line 513

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

#stt_model ⇒ Symbol, Revox::Models::CallSearchResponse::Call::Assistant::SttModel

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

Parameters:

  • value (Revox::Models::CallSearchResponse::Call::Assistant::stt_model)

Returns:



519
 
# File 'lib/revox/models/call_search_response.rb', line 519

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

Returns:



526
527
528
 
# File 'lib/revox/models/call_search_response.rb', line 526

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


535
 
# File 'lib/revox/models/call_search_response.rb', line 535

required :thinking_sound_probability, Float

#thinking_sound_volume ⇒ Float

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

Parameters:

  • value (Float)

Returns:

  • (Float) 


541
 
# File 'lib/revox/models/call_search_response.rb', line 541

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) 


547
 
# File 'lib/revox/models/call_search_response.rb', line 547

required :transfer_phone_number, String, nil?: true

#type ⇒ Symbol, Revox::Models::CallSearchResponse::Call::Assistant::Type

Parameters:

  • value (Revox::Models::CallSearchResponse::Call::Assistant::type_)

Returns:



552
 
# File 'lib/revox/models/call_search_response.rb', line 552

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

#updated_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


557
 
# File 'lib/revox/models/call_search_response.rb', line 557

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

#voice ⇒ Revox::Models::CallSearchResponse::Call::Assistant::Voice?

Parameters:

Returns:



562
 
# File 'lib/revox/models/call_search_response.rb', line 562

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


569
 
# File 'lib/revox/models/call_search_response.rb', line 569

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) 


576
 
# File 'lib/revox/models/call_search_response.rb', line 576

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) 


583
 
# File 'lib/revox/models/call_search_response.rb', line 583

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) 


589
 
# File 'lib/revox/models/call_search_response.rb', line 589

required :webhook_url, String, nil?: true

#zoho ⇒ Revox::Models::CallSearchResponse::Call::Assistant::Zoho?

Parameters:

Returns:



594
 
# File 'lib/revox/models/call_search_response.rb', line 594

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


416
 
# File 'sig/revox/models/call_search_response.rbs', line 416

def to_hash: -> {