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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::AI::Conversations::InsightCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/ai/conversations/insight_create_params.rb

Overview

See Also:

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

Defined Under Namespace

Modules: JsonSchema

Instance Attribute Summary

• #instructions ⇒ String
• #json_schema ⇒ String, ...

  If specified, the output will follow the JSON schema.

• #name ⇒ String
• #webhook ⇒ String^?

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(instructions:, name:, json_schema: nil, webhook: nil, request_options: {}) ⇒ Object constructor

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, 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)
• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

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

Instance Attribute Details

#instructions ⇒ String

Returns:

• (String)

# 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)

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

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

#name ⇒ String

Returns:

• (String)

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

required :name, String

#webhook ⇒ String^?

Returns:

• (String, nil)

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

optional :webhook, String