Class: OpenAI::Resources::Beta::Agents::Sessions::Subagents::Turns::Items

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/beta/agents/sessions/subagents/turns/items.rb,
sig/openai/resources/beta/agents/sessions/subagents/turns/items.rbs

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:



72
73
74
 
# File 'lib/openai/resources/beta/agents/sessions/subagents/turns/items.rb', line 72

def initialize(client:)
  @client = client
end

Instance Method Details

#list(turn_id, session_id:, subagent_id:, after: nil, limit: nil, order: nil, request_options: {}) ⇒ OpenAI::Internal::CursorPage<OpenAI::Models::Beta::AgentSessionMessage, OpenAI::Models::Beta::AgentReasoningItem, OpenAI::Models::Beta::AgentFunctionCallItem, OpenAI::Models::Beta::AgentSessionItem::FunctionCallOutput, OpenAI::Models::Beta::AgentSessionItem::AgentMessage, OpenAI::Models::Beta::AgentMcpCallItem, OpenAI::Models::Beta::AgentWebSearchCallItem, OpenAI::Models::Beta::AgentCommandExecutionItem, OpenAI::Models::Beta::AgentCreateSubagentCallItem, OpenAI::Models::Beta::AgentSendSubagentInputCallItem, OpenAI::Models::Beta::AgentResumeSubagentCallItem, OpenAI::Models::Beta::AgentWaitForSubagentsCallItem, OpenAI::Models::Beta::AgentInterruptSubagentCallItem, OpenAI::Models::Beta::AgentCloseSubagentCallItem>

Lists items belonging to one turn of this subagent. See subagent workflows.

Parameters:

  • turn_id (String) —

    Path param: The ID of a turn belonging to this subagent.

  • session_id (String) —

    Path param: The ID of the session.

  • subagent_id (String) —

    Path param: The ID of the subagent in this session.

  • after (String) —

    Query param: Return resources after this resource ID in the selected order.

  • limit (Integer) —

    Query param: The maximum number of resources to return, between 1 and 100. Defaults to 20.

  • order (Symbol, OpenAI::Models::Beta::Agents::Sessions::Subagents::Turns::ItemListParams::Order) —

    Query param: The order in which resources are returned. Defaults to desc.

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

Returns:

See Also:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/openai/resources/beta/agents/sessions/subagents/turns/items.rb', line 40

def list(turn_id, params)
  parsed, options = OpenAI::Beta::Agents::Sessions::Subagents::Turns::ItemListParams.dump_request(
    params
  )
  session_id = parsed.delete(:session_id) do
    raise ArgumentError.new("missing required path argument #{_1}")
  end

  subagent_id = parsed.delete(:subagent_id) do
    raise ArgumentError.new("missing required path argument #{_1}")
  end

  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: [
      "agents/sessions/%1$s/subagents/%2$s/turns/%3$s/items",
      session_id,
      subagent_id,
      turn_id
    ],
    query: query,
    page: OpenAI::Internal::CursorPage,
    model: OpenAI::Beta::AgentSessionItem,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
  )
end