Class: Telnyx::Models::AI::Conversations::InsightCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/ai/conversations/insight_create_params.rb,
sig/telnyx/models/ai/conversations/insight_create_params.rbs

Overview

See Also:

  • Telnyx::Resources::AI::Conversations::Insights#create

Defined Under Namespace

Modules: JsonSchema

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(instructions:, name:, json_schema: nil, webhook: nil, idempotency_key: nil, request_options: {}) ⇒ Object

Parameters:

  • instructions (String)
  • name (String)
  • json_schema (String, Hash{Symbol=>Object}) (defaults to: nil) —

    If specified, the output will follow the JSON schema.

  • webhook (String) (defaults to: nil)
  • idempotency_key (String) (defaults to: nil)
  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/telnyx/models/ai/conversations/insight_create_params.rb', line 38

Instance Attribute Details

#idempotency_key ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


36
 
# File 'lib/telnyx/models/ai/conversations/insight_create_params.rb', line 36

optional :idempotency_key, String

#instructions ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/telnyx/models/ai/conversations/insight_create_params.rb', line 15

required :instructions, String

#json_schema ⇒ String, ...

If specified, the output will follow the JSON schema.

Returns:

  • (String, Hash{Symbol=>Object}, nil) 


26
 
# File 'lib/telnyx/models/ai/conversations/insight_create_params.rb', line 26

optional :json_schema, union: -> { Telnyx::AI::Conversations::InsightCreateParams::JsonSchema }

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


20
 
# File 'lib/telnyx/models/ai/conversations/insight_create_params.rb', line 20

required :name, String

#webhook ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


31
 
# File 'lib/telnyx/models/ai/conversations/insight_create_params.rb', line 31

optional :webhook, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


46
 
# File 'sig/telnyx/models/ai/conversations/insight_create_params.rbs', line 46

def to_hash: -> {