Class: OpenAI::Models::Beta::ThreadCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openai/models/beta/thread_create_params.rb

Overview

See Also:

Defined Under Namespace

Classes: Message, ToolResources

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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, 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(type: :file_search) ⇒ Object

Parameters:

  • type (Symbol, :file_search) (defaults to: :file_search) —

    The type of tool being defined: ‘file_search`




# File 'lib/openai/models/beta/thread_create_params.rb', line 179

Instance Attribute Details

#messages ⇒ Array<OpenAI::Models::Beta::ThreadCreateParams::Message>?

A list of [messages](platform.openai.com/docs/api-reference/messages) to start the thread with.

Returns:



16
 
# File 'lib/openai/models/beta/thread_create_params.rb', line 16

optional :messages, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::ThreadCreateParams::Message] }

#metadata ⇒ Hash{Symbol=>String}?

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Returns:

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


27
 
# File 'lib/openai/models/beta/thread_create_params.rb', line 27

optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true

#tool_resources ⇒ OpenAI::Models::Beta::ThreadCreateParams::ToolResources?

A set of resources that are made available to the assistant’s tools in this thread. The resources are specific to the type of tool. For example, the ‘code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.

Returns:



36
 
# File 'lib/openai/models/beta/thread_create_params.rb', line 36

optional :tool_resources, -> { OpenAI::Beta::ThreadCreateParams::ToolResources }, nil?: true