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

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Turns

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

Parameters:



81
82
83
 
# File 'lib/openai/resources/beta/agents/sessions/turns.rb', line 81

def initialize(client:)
  @client = client
end

Instance Method Details

#list(session_id, after: nil, limit: nil, order: nil, request_options: {}) ⇒ OpenAI::Internal::CursorPage<OpenAI::Models::Beta::Agents::Sessions::Turn>

Lists turns by creation time and turn ID. The after cursor is exclusive in the selected order. See session turns.

Parameters:

  • session_id (String) —

    The ID of the session.

  • after (String) —

    Return resources after this resource ID in the selected order.

  • limit (Integer) —

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

  • order (Symbol, OpenAI::Models::Beta::Agents::Sessions::TurnListParams::Order) —

    The order in which resources are returned. Defaults to desc.

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

Returns:

See Also:



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/openai/resources/beta/agents/sessions/turns.rb', line 64

def list(session_id, params = {})
  parsed, options = OpenAI::Beta::Agents::Sessions::TurnListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["agents/sessions/%1$s/turns", session_id],
    query: query,
    page: OpenAI::Internal::CursorPage,
    model: OpenAI::Beta::Agents::Sessions::Turn,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
  )
end

#retrieve(turn_id, session_id:, request_options: {}) ⇒ OpenAI::Models::Beta::Agents::Sessions::Turn

Retrieves a turn's current status, timestamps, usage, and error. Returns 404 if the turn does not belong to the session. See session turns.

Parameters:

  • turn_id (String) —

    The ID of the turn.

  • session_id (String) —

    The ID of the session that owns the turn.

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

Returns:

See Also:



26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/openai/resources/beta/agents/sessions/turns.rb', line 26

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

  @client.request(
    method: :get,
    path: ["agents/sessions/%1$s/turns/%2$s", session_id, turn_id],
    model: OpenAI::Beta::Agents::Sessions::Turn,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
  )
end