Class: Revox::Models::CallCreateResponse::Call::Assistant

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

Overview

See Also:

  • Revox::Models::CallCreateResponse::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_create_response.rb', line 759

Instance Attribute Details

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

Returns:



282
283
284
 
# File 'lib/revox/models/call_create_response.rb', line 282

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


291
 
# File 'lib/revox/models/call_create_response.rb', line 291

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

Returns:



297
298
299
 
# File 'lib/revox/models/call_create_response.rb', line 297

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

#background_sound_volume ⇒ Float

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

Parameters:

  • value (Float)

Returns:

  • (Float) 


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

required :background_sound_volume, Float

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

Parameters:

Returns:



310
 
# File 'lib/revox/models/call_create_response.rb', line 310

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

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

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

Parameters:

Returns:



317
318
319
 
# File 'lib/revox/models/call_create_response.rb', line 317

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


325
 
# File 'lib/revox/models/call_create_response.rb', line 325

required :cartesia_dictionary_pronunciation_id, String, nil?: true

#created_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


330
 
# File 'lib/revox/models/call_create_response.rb', line 330

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

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

The user who created the assistant.

Parameters:

Returns:



590
 
# File 'lib/revox/models/call_create_response.rb', line 590

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

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

Parameters:

Returns:



335
336
337
 
# File 'lib/revox/models/call_create_response.rb', line 335

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


345
 
# File 'lib/revox/models/call_create_response.rb', line 345

required :email_notification_address, String, nil?: true

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

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

Parameters:

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

Returns:



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

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

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

Returns:



359
360
361
 
# File 'lib/revox/models/call_create_response.rb', line 359

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

#end_of_call_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


366
 
# File 'lib/revox/models/call_create_response.rb', line 366

required :end_of_call_sentence, String, nil?: true

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

Returns:



595
596
 
# File 'lib/revox/models/call_create_response.rb', line 595

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

#first_sentence ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


371
 
# File 'lib/revox/models/call_create_response.rb', line 371

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) 


377
 
# File 'lib/revox/models/call_create_response.rb', line 377

required :first_sentence_delay_ms, Integer

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

Parameters:

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

Returns:



382
383
 
# File 'lib/revox/models/call_create_response.rb', line 382

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


390
 
# File 'lib/revox/models/call_create_response.rb', line 390

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

Returns:



397
398
399
 
# File 'lib/revox/models/call_create_response.rb', line 397

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

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#is_realestate_assistant ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


601
 
# File 'lib/revox/models/call_create_response.rb', line 601

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) 


406
 
# File 'lib/revox/models/call_create_response.rb', line 406

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

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

Parameters:

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

Returns:



411
 
# File 'lib/revox/models/call_create_response.rb', line 411

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


418
 
# File 'lib/revox/models/call_create_response.rb', line 418

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) 


425
 
# File 'lib/revox/models/call_create_response.rb', line 425

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) 


433
 
# File 'lib/revox/models/call_create_response.rb', line 433

required :max_duration_end_message, String, nil?: true

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


438
 
# File 'lib/revox/models/call_create_response.rb', line 438

required :name, String

#organization_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :organization_id, String

#pending_faq_count ⇒ Float?

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


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

optional :pending_faq_count, Float

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

Parameters:

Returns:



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

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

#prompt ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :prompt, String

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

Parameters:

Returns:



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

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

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

Parameters:

Returns:



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

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


470
 
# File 'lib/revox/models/call_create_response.rb', line 470

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) 


478
 
# File 'lib/revox/models/call_create_response.rb', line 478

required :sms_template, String, nil?: true

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



485
486
487
 
# File 'lib/revox/models/call_create_response.rb', line 485

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


495
 
# File 'lib/revox/models/call_create_response.rb', line 495

required :structured_output_prompt, String, nil?: true

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



503
 
# File 'lib/revox/models/call_create_response.rb', line 503

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

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

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

Parameters:

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

Returns:



509
 
# File 'lib/revox/models/call_create_response.rb', line 509

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

Returns:



516
517
518
 
# File 'lib/revox/models/call_create_response.rb', line 516

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


525
 
# File 'lib/revox/models/call_create_response.rb', line 525

required :thinking_sound_probability, Float

#thinking_sound_volume ⇒ Float

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

Parameters:

  • value (Float)

Returns:

  • (Float) 


531
 
# File 'lib/revox/models/call_create_response.rb', line 531

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) 


537
 
# File 'lib/revox/models/call_create_response.rb', line 537

required :transfer_phone_number, String, nil?: true

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

Parameters:

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

Returns:



542
 
# File 'lib/revox/models/call_create_response.rb', line 542

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

#updated_at ⇒ Object

Parameters:

  • value (top)

Returns:

  • (Object) 


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

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

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

Parameters:

Returns:



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

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


559
 
# File 'lib/revox/models/call_create_response.rb', line 559

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) 


566
 
# File 'lib/revox/models/call_create_response.rb', line 566

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) 


573
 
# File 'lib/revox/models/call_create_response.rb', line 573

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) 


579
 
# File 'lib/revox/models/call_create_response.rb', line 579

required :webhook_url, String, nil?: true

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

Parameters:

Returns:



584
 
# File 'lib/revox/models/call_create_response.rb', line 584

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


400
 
# File 'sig/revox/models/call_create_response.rbs', line 400

def to_hash: -> {