Class: OpenAI::Models::Conversations::ItemCreateParams

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

Overview

See Also:

  • OpenAI::Resources::Conversations::Items#create

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Attributes inherited from Internal::Type::BaseModel

#last_response

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

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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(conversation_id:, items:, include: nil, request_options: {}) ⇒ Object

Parameters:

  • items —

    The items to add to the conversation. You may add up to 20 items at a time.

  • include (defaults to: nil) —

    Additional fields to include in the response. See the include parameter for listing Conversation items above for more information.




# File 'lib/openai/models/conversations/item_create_params.rb', line 30

Instance Attribute Details

#conversation_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/openai/models/conversations/item_create_params.rb', line 14

required :conversation_id, String

#include ⇒ ::Array[OpenAI::Models::Responses::response_includable]?

Additional fields to include in the response. See the include parameter for listing Conversation items above for more information.

Returns:

  • (::Array[OpenAI::Models::Responses::response_includable], nil) 


28
 
# File 'lib/openai/models/conversations/item_create_params.rb', line 28

optional :include, -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Responses::ResponseIncludable] }

#items ⇒ ::Array[OpenAI::Models::Responses::response_input_item]

The items to add to the conversation. You may add up to 20 items at a time.

Returns:

  • (::Array[OpenAI::Models::Responses::response_input_item]) 


20
 
# File 'lib/openai/models/conversations/item_create_params.rb', line 20

required :items, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseInputItem] }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


46
 
# File 'sig/openai/models/conversations/item_create_params.rbs', line 46

def to_hash: -> {