Class: OpenAI::Models::Conversations::ItemRetrieveParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Conversations::ItemRetrieveParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/conversations/item_retrieve_params.rb

Overview

See Also:

• Resources::Conversations::Items#retrieve

Instance Attribute Summary

• #conversation_id ⇒ String
• #include ⇒ Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>^?

  Additional fields to include in the response.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(conversation_id:, include: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ItemRetrieveParams 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(conversation_id:, include: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Conversations::ItemRetrieveParams for more details.

Parameters:

• conversation_id (String)
• include (Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>) (defaults to: nil) —

  Additional fields to include in the response. See the ‘include`

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

# File 'lib/openai/models/conversations/item_retrieve_params.rb', line 24

Instance Attribute Details

#conversation_id ⇒ String

Returns:

• (String)

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

required :conversation_id, String

#include ⇒ Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>^?

Additional fields to include in the response. See the ‘include` parameter for [listing Conversation items above](platform.openai.com/docs/api-reference/conversations/list-items#conversations_list_items-include) for more information.

Returns:

• (Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil)

# File 'lib/openai/models/conversations/item_retrieve_params.rb', line 22

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