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

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

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:



46
47
48
 
# File 'lib/openai/resources/responses/input_items.rb', line 46

def initialize(client:)
  @client = client
end

Instance Method Details

#list(response_id, after: nil, before: nil, include: nil, limit: nil, order: nil, request_options: {}) ⇒ OpenAI::Internal::CursorPage<OpenAI::Models::Responses::ResponseInputMessageItem, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseItem::LocalShellCall, OpenAI::Models::Responses::ResponseItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseItem::McpListTools, OpenAI::Models::Responses::ResponseItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseItem::McpCall>

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

Returns a list of input items for a given response.

Parameters:

  • response_id (String) —

    The ID of the response to retrieve input items for.

  • after (String) —

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

  • before (String) —

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

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

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

  • limit (Integer) —

    A limit on the number of objects to be returned. Limit can range between

  • order (Symbol, OpenAI::Models::Responses::InputItemListParams::Order) —

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

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

Returns:

See Also:



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/openai/resources/responses/input_items.rb', line 31

def list(response_id, params = {})
  parsed, options = OpenAI::Responses::InputItemListParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["responses/%1$s/input_items", response_id],
    query: parsed,
    page: OpenAI::Internal::CursorPage,
    model: OpenAI::Responses::ResponseItem,
    options: options
  )
end