Class: OpenAI::Resources::Conversations::Items

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/conversations/items.rb,
sig/openai/resources/conversations/items.rbs

Overview

Manage conversations and conversation items.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Items

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Items.

Parameters:



175
176
177
 
# File 'lib/openai/resources/conversations/items.rb', line 175

def initialize(client:)
  @client = client
end

Instance Method Details

#create(conversation_id, items:, include: nil, request_options: {}) ⇒ OpenAI::Models::Conversations::ConversationItemList

Create items in a conversation with the given ID.

Parameters:

Returns:

See Also:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/openai/resources/conversations/items.rb', line 30

def create(conversation_id, params)
  query_params = [:include]
  parsed, options = OpenAI::Conversations::ItemCreateParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :post,
    path: ["conversations/%1$s/items", conversation_id],
    query: query,
    body: parsed.except(*query_params),
    model: OpenAI::Conversations::ConversationItemList,
    security: {bearer_auth: true},
    options: options
  )
end

#delete(item_id, conversation_id:, request_options: {}) ⇒ OpenAI::Models::Conversations::Conversation

Delete an item from a conversation with the given IDs.

Parameters:

  • item_id (String) —

    The ID of the item to delete.

  • conversation_id (String) —

    The ID of the conversation that contains the item.

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

Returns:

See Also:



157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/openai/resources/conversations/items.rb', line 157

def delete(item_id, params)
  parsed, options = OpenAI::Conversations::ItemDeleteParams.dump_request(params)
  conversation_id = parsed.delete(:conversation_id) do
    raise ArgumentError.new("missing required path argument #{_1}")
  end

  @client.request(
    method: :delete,
    path: ["conversations/%1$s/items/%2$s", conversation_id, item_id],
    model: OpenAI::Conversations::Conversation,
    security: {bearer_auth: true},
    options: options
  )
end

#list(conversation_id, after: nil, include: nil, limit: nil, order: nil, request_options: {}) ⇒ OpenAI::Internal::ConversationCursorPage<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Conversations::ConversationItem::AdditionalTools, OpenAI::Models::Responses::ResponseConfigurationUpdateItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Conversations::ConversationItem::Program, OpenAI::Models::Conversations::ConversationItem::ProgramOutput, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>

List all items for a conversation with the given ID.

Parameters:

  • conversation_id (String) —

    The ID of the conversation to list items for.

  • after (String) —

    An item ID to list items after, used in pagination.

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

    Specify additional output data to include in the model response. Currently supported values are:

    • web_search_call.action.sources: Include the sources of the web search tool call.
    • code_interpreter_call.outputs: Includes the outputs of python code execution in code interpreter tool call items.
    • computer_call_output.output.image_url: Include image urls from the computer call output.
    • file_search_call.results: Include the search results of the file search tool call.
    • message.input_image.image_url: Include image urls from the input message.
    • message.output_text.logprobs: Include logprobs with assistant messages.
    • reasoning.encrypted_content: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the store parameter is set to false, or when an organization is enrolled in the zero data retention program).
  • limit (Integer) —

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

  • order (Symbol, OpenAI::Models::Conversations::ItemListParams::Order) —

    The order to return the input items in. Default is desc.

    • asc: Return the input items in ascending order.
    • desc: Return the input items in descending order.
  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/openai/resources/conversations/items.rb', line 128

def list(conversation_id, params = {})
  parsed, options = OpenAI::Conversations::ItemListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["conversations/%1$s/items", conversation_id],
    query: query,
    page: OpenAI::Internal::ConversationCursorPage,
    model: OpenAI::Conversations::ConversationItem,
    security: {bearer_auth: true},
    options: options
  )
end

#retrieve(item_id, conversation_id:, include: nil, request_options: {}) ⇒ OpenAI::Models::Conversations::Message, ...

Get a single item from a conversation with the given IDs.

Parameters:

Returns:

See Also:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/openai/resources/conversations/items.rb', line 66

def retrieve(item_id, params)
  parsed, options = OpenAI::Conversations::ItemRetrieveParams.dump_request(params)
  conversation_id = parsed.delete(:conversation_id) do
    raise ArgumentError.new("missing required path argument #{_1}")
  end

  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["conversations/%1$s/items/%2$s", conversation_id, item_id],
    query: query,
    model: OpenAI::Conversations::ConversationItem,
    security: {bearer_auth: true},
    options: options
  )
end