Class: OpenAI::Resources::Beta::Responses::InputItems

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/beta/responses/input_items.rb,
sig/openai/resources/beta/responses/input_items.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ InputItems

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 InputItems.

Parameters:



51
52
53
# File 'lib/openai/resources/beta/responses/input_items.rb', line 51

def initialize(client:)
  @client = client
end

Instance Method Details

#list(response_id, after: nil, include: nil, limit: nil, order: nil, betas: nil, request_options: {}) ⇒ OpenAI::Internal::CursorPage<OpenAI::Models::Beta::BetaResponseInputMessageItem, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCallItem, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseItem::AgentMessage, OpenAI::Models::Beta::BetaResponseItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseItem::Program, OpenAI::Models::Beta::BetaResponseItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseItem::McpListTools, OpenAI::Models::Beta::BetaResponseItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallItem, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem>

Some parameter documentations has been truncated, see Models::Beta::Responses::InputItemListParams for more details.

Returns a list of input items for a given response.

Parameters:

Returns:

See Also:



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/openai/resources/beta/responses/input_items.rb', line 32

def list(response_id, params = {})
  query_params = [:after, :include, :limit, :order]
  parsed, options = OpenAI::Beta::Responses::InputItemListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :get,
    path: ["responses/%1$s/input_items?beta=true", response_id],
    query: query,
    headers: parsed.except(*query_params).transform_keys(betas: "openai-beta"),
    page: OpenAI::Internal::CursorPage,
    model: OpenAI::Beta::BetaResponseItem,
    security: {bearer_auth: true},
    options: options
  )
end