Class: Zavudev::Models::Senders::AgentCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/zavudev/models/senders/agent_create_params.rb

Overview

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(sender_id:, model:, name:, provider:, system_prompt:, api_key: nil, context_window_messages: nil, include_contact_metadata: nil, max_tokens: nil, temperature: nil, trigger_on_channels: nil, trigger_on_message_types: nil, request_options: {}) ⇒ Object

Parameters:

  • sender_id (String)
  • model (String)
  • name (String)
  • provider (Symbol, Zavudev::Models::Senders::AgentProvider)

    LLM provider for the AI agent.

  • system_prompt (String)
  • api_key (String) (defaults to: nil)

    API key for the LLM provider. Required unless provider is ‘zavu’.

  • context_window_messages (Integer) (defaults to: nil)
  • include_contact_metadata (Boolean) (defaults to: nil)
  • max_tokens (Integer) (defaults to: nil)
  • temperature (Float) (defaults to: nil)
  • trigger_on_channels (Array<String>) (defaults to: nil)
  • trigger_on_message_types (Array<String>) (defaults to: nil)
  • request_options (Zavudev::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})


# File 'lib/zavudev/models/senders/agent_create_params.rb', line 77

Instance Attribute Details

#api_keyString?

API key for the LLM provider. Required unless provider is ‘zavu’.

Returns:

  • (String, nil)


41
# File 'lib/zavudev/models/senders/agent_create_params.rb', line 41

optional :api_key, String, api_name: :apiKey

#context_window_messagesInteger?

Returns:

  • (Integer, nil)


46
# File 'lib/zavudev/models/senders/agent_create_params.rb', line 46

optional :context_window_messages, Integer, api_name: :contextWindowMessages

#include_contact_metadataBoolean?

Returns:

  • (Boolean, nil)


51
52
53
# File 'lib/zavudev/models/senders/agent_create_params.rb', line 51

optional :include_contact_metadata,
Zavudev::Internal::Type::Boolean,
api_name: :includeContactMetadata

#max_tokensInteger?

Returns:

  • (Integer, nil)


58
# File 'lib/zavudev/models/senders/agent_create_params.rb', line 58

optional :max_tokens, Integer, api_name: :maxTokens

#modelString

Returns:

  • (String)


19
# File 'lib/zavudev/models/senders/agent_create_params.rb', line 19

required :model, String

#nameString

Returns:

  • (String)


24
# File 'lib/zavudev/models/senders/agent_create_params.rb', line 24

required :name, String

#providerSymbol, Zavudev::Models::Senders::AgentProvider

LLM provider for the AI agent.



30
# File 'lib/zavudev/models/senders/agent_create_params.rb', line 30

required :provider, enum: -> { Zavudev::Senders::AgentProvider }

#sender_idString

Returns:

  • (String)


14
# File 'lib/zavudev/models/senders/agent_create_params.rb', line 14

required :sender_id, String

#system_promptString

Returns:

  • (String)


35
# File 'lib/zavudev/models/senders/agent_create_params.rb', line 35

required :system_prompt, String, api_name: :systemPrompt

#temperatureFloat?

Returns:

  • (Float, nil)


63
# File 'lib/zavudev/models/senders/agent_create_params.rb', line 63

optional :temperature, Float

#trigger_on_channelsArray<String>?

Returns:

  • (Array<String>, nil)


68
# File 'lib/zavudev/models/senders/agent_create_params.rb', line 68

optional :trigger_on_channels, Zavudev::Internal::Type::ArrayOf[String], api_name: :triggerOnChannels

#trigger_on_message_typesArray<String>?

Returns:

  • (Array<String>, nil)


73
74
75
# File 'lib/zavudev/models/senders/agent_create_params.rb', line 73

optional :trigger_on_message_types,
Zavudev::Internal::Type::ArrayOf[String],
api_name: :triggerOnMessageTypes