Class: Cerca::Models::ThreadCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Cerca::Models::ThreadCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/cerca/models/thread_create_params.rb

Overview

See Also:

• Resources::Threads#create

Instance Attribute Summary

• #agent_id ⇒ String
• #instructions ⇒ String^?
• #message ⇒ String^?
• #model ⇒ String^?
• #system_prompt ⇒ String^?

  Deprecated alias for ‘instructions`; accepted for backwards compatibility.

• #tools ⇒ Array<String>^?

  Per-thread tool subset.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(agent_id:, instructions: nil, message: nil, model: nil, system_prompt: nil, tools: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ThreadCreateParams for more details.

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(agent_id:, instructions: nil, message: nil, model: nil, system_prompt: nil, tools: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Cerca::Models::ThreadCreateParams for more details.

Parameters:

• agent_id (String)
• instructions (String) (defaults to: nil)
• message (String) (defaults to: nil)
• model (String) (defaults to: nil)
• system_prompt (String) (defaults to: nil) —

  Deprecated alias for ‘instructions`; accepted for backwards compatibility.

• tools (Array<String>) (defaults to: nil) —

  Per-thread tool subset. Omit to inherit the agent’s full effective tools; pass [

• request_options (Cerca::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/cerca/models/thread_create_params.rb', line 44

Instance Attribute Details

#agent_id ⇒ String

Returns:

• (String)

# File 'lib/cerca/models/thread_create_params.rb', line 13

required :agent_id, String

#instructions ⇒ String^?

Returns:

• (String, nil)

# File 'lib/cerca/models/thread_create_params.rb', line 18

optional :instructions, String

#message ⇒ String^?

Returns:

• (String, nil)

# File 'lib/cerca/models/thread_create_params.rb', line 23

optional :message, String

#model ⇒ String^?

Returns:

• (String, nil)

# File 'lib/cerca/models/thread_create_params.rb', line 28

optional :model, String

#system_prompt ⇒ String^?

Deprecated alias for ‘instructions`; accepted for backwards compatibility.

Returns:

• (String, nil)

# File 'lib/cerca/models/thread_create_params.rb', line 34

optional :system_prompt, String, api_name: :systemPrompt

#tools ⇒ Array<String>^?

Per-thread tool subset. Omit to inherit the agent’s full effective tools; pass

to run with no configurable tools. Provided entries can only narrow the

agent’s effective tools.

Returns:

• (Array<String>, nil)

# File 'lib/cerca/models/thread_create_params.rb', line 42

optional :tools, Cerca::Internal::Type::ArrayOf[String]