Class: Cerca::Resources::Events

Inherits:
Object
  • Object
show all
Defined in:
lib/cerca/resources/events.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Events

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

Parameters:



264
265
266
 
# File 'lib/cerca/resources/events.rb', line 264

def initialize(client:)
  @client = client
end

Instance Method Details

#list_for_agent(agent_id, cursor: nil, events: nil, history: nil, limit: nil, request_options: {}) ⇒ Cerca::Internal::EventsCursorPage<Cerca::Models::SubscriptionEvent>

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

List events

Parameters:

  • agent_id (String)
  • cursor (String) —

    Opaque pagination cursor returned by a previous request.

  • events (String) —

    Comma-separated event type filter.

  • history (Symbol, Cerca::Models::EventListForAgentParams::History) —

    When true, starts from the beginning of the retained buffer.

  • limit (String) —

    Maximum number of items to return. Defaults to 20 and preserves parseInt semanti

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

Returns:

See Also:



28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/cerca/resources/events.rb', line 28

def list_for_agent(agent_id, params = {})
  parsed, options = Cerca::EventListForAgentParams.dump_request(params)
  query = Cerca::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["agents/%1$s/events", agent_id],
    query: query,
    page: Cerca::Internal::EventsCursorPage,
    model: Cerca::SubscriptionEvent,
    options: options
  )
end

#list_for_fleet(fleet_id, cursor: nil, events: nil, history: nil, limit: nil, request_options: {}) ⇒ Cerca::Internal::EventsCursorPage<Cerca::Models::SubscriptionEvent>

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

List events

Parameters:

  • fleet_id (String)
  • cursor (String) —

    Opaque pagination cursor returned by a previous request.

  • events (String) —

    Comma-separated event type filter.

  • history (Symbol, Cerca::Models::EventListForFleetParams::History) —

    When true, starts from the beginning of the retained buffer.

  • limit (String) —

    Maximum number of items to return. Defaults to 20 and preserves parseInt semanti

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

Returns:

See Also:



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/cerca/resources/events.rb', line 63

def list_for_fleet(fleet_id, params = {})
  parsed, options = Cerca::EventListForFleetParams.dump_request(params)
  query = Cerca::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["fleets/%1$s/events", fleet_id],
    query: query,
    page: Cerca::Internal::EventsCursorPage,
    model: Cerca::SubscriptionEvent,
    options: options
  )
end

#list_for_thread(agent_id, thread_id, cursor: nil, events: nil, history: nil, limit: nil, request_options: {}) ⇒ Cerca::Internal::EventsCursorPage<Cerca::Models::SubscriptionEvent>

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

List events

Parameters:

  • agent_id (String)
  • thread_id (String)
  • cursor (String) —

    Opaque pagination cursor returned by a previous request.

  • events (String) —

    Comma-separated event type filter.

  • history (Symbol, Cerca::Models::EventListForThreadParams::History) —

    When true, starts from the beginning of the retained buffer.

  • limit (String) —

    Maximum number of items to return. Defaults to 20 and preserves parseInt semanti

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

Returns:

See Also:



100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/cerca/resources/events.rb', line 100

def list_for_thread(agent_id, thread_id, params = {})
  parsed, options = Cerca::EventListForThreadParams.dump_request(params)
  query = Cerca::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["agents/%1$s/threads/%2$s/events", agent_id, thread_id],
    query: query,
    page: Cerca::Internal::EventsCursorPage,
    model: Cerca::SubscriptionEvent,
    options: options
  )
end

#stream_for_agent_streaming(agent_id, cursor: nil, events: nil, history: nil, last_event_id: nil, request_options: {}) ⇒ Cerca::Internal::Stream<Cerca::Models::SubscriptionEvent>

Server-Sent Events stream. Each SSE data frame is JSON matching this response schema.

Parameters:

  • agent_id (String) —

    Path param

  • cursor (String) —

    Query param: Opaque pagination cursor returned by a previous request.

  • events (String) —

    Query param: Comma-separated event type filter.

  • history (Symbol, Cerca::Models::EventStreamForAgentParams::History) —

    Query param: When true, starts from the beginning of the retained buffer.

  • last_event_id (String) —

    Header param: Resume an event-log stream after the last received SSE event id.

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

Returns:

See Also:



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/cerca/resources/events.rb', line 133

def stream_for_agent_streaming(agent_id, params = {})
  query_params = [:cursor, :events, :history]
  parsed, options = Cerca::EventStreamForAgentParams.dump_request(params)
  query = Cerca::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :get,
    path: ["agents/%1$s/events/stream", agent_id],
    query: query,
    headers: {
      "accept" => "text/event-stream",
      "accept-encoding" => "identity",
      **parsed.except(*query_params)
    }.transform_keys(
      last_event_id: "last-event-id"
    ),
    stream: Cerca::Internal::Stream,
    model: Cerca::SubscriptionEvent,
    options: options
  )
end

#stream_for_fleet_streaming(fleet_id, cursor: nil, events: nil, history: nil, last_event_id: nil, request_options: {}) ⇒ Cerca::Internal::Stream<Cerca::Models::SubscriptionEvent>

Server-Sent Events stream. Each SSE data frame is JSON matching this response schema.

Parameters:

  • fleet_id (String) —

    Path param

  • cursor (String) —

    Query param: Opaque pagination cursor returned by a previous request.

  • events (String) —

    Query param: Comma-separated event type filter.

  • history (Symbol, Cerca::Models::EventStreamForFleetParams::History) —

    Query param: When true, starts from the beginning of the retained buffer.

  • last_event_id (String) —

    Header param: Resume an event-log stream after the last received SSE event id.

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

Returns:

See Also:



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/cerca/resources/events.rb', line 174

def stream_for_fleet_streaming(fleet_id, params = {})
  query_params = [:cursor, :events, :history]
  parsed, options = Cerca::EventStreamForFleetParams.dump_request(params)
  query = Cerca::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :get,
    path: ["fleets/%1$s/events/stream", fleet_id],
    query: query,
    headers: {
      "accept" => "text/event-stream",
      "accept-encoding" => "identity",
      **parsed.except(*query_params)
    }.transform_keys(
      last_event_id: "last-event-id"
    ),
    stream: Cerca::Internal::Stream,
    model: Cerca::SubscriptionEvent,
    options: options
  )
end

#stream_for_thread_events_streaming(agent_id, thread_id, cursor: nil, events: nil, history: nil, last_event_id: nil, request_options: {}) ⇒ Cerca::Internal::Stream<Cerca::Models::SubscriptionEvent>

Server-Sent Events stream. Each SSE data frame is JSON matching this response schema.

Parameters:

  • agent_id (String) —

    Path param

  • thread_id (String) —

    Path param

  • cursor (String) —

    Query param: Opaque pagination cursor returned by a previous request.

  • events (String) —

    Query param: Comma-separated event type filter.

  • history (Symbol, Cerca::Models::EventStreamForThreadEventsParams::History) —

    Query param: When true, starts from the beginning of the retained buffer.

  • last_event_id (String) —

    Header param: Resume an event-log stream after the last received SSE event id.

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

Returns:

See Also:



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/cerca/resources/events.rb', line 240

def stream_for_thread_events_streaming(agent_id, thread_id, params = {})
  query_params = [:cursor, :events, :history]
  parsed, options = Cerca::EventStreamForThreadEventsParams.dump_request(params)
  query = Cerca::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :get,
    path: ["agents/%1$s/threads/%2$s/events/stream", agent_id, thread_id],
    query: query,
    headers: {
      "accept" => "text/event-stream",
      "accept-encoding" => "identity",
      **parsed.except(*query_params)
    }.transform_keys(
      last_event_id: "last-event-id"
    ),
    stream: Cerca::Internal::Stream,
    model: Cerca::SubscriptionEvent,
    options: options
  )
end

#stream_for_thread_streaming(agent_id, thread_id, request_options: {}) ⇒ Cerca::Internal::Stream<Cerca::Models::ThreadStreamEvent::ThreadStreamStatusMessage, Cerca::Models::ThreadStreamEvent::ThreadStreamContentMessage, Cerca::Models::ThreadStreamEvent::ThreadStreamProgressMessage, Cerca::Models::ThreadStreamEvent::ThreadStreamTurnStartedMessage, Cerca::Models::ThreadStreamEvent::ThreadStreamTurnCompletedMessage, Cerca::Models::ThreadStreamEvent::ThreadStreamItemStartedMessage, Cerca::Models::ThreadStreamEvent::ThreadStreamItemCompletedMessage, Cerca::Models::ThreadStreamEvent::ThreadStreamTokenUsageMessage, Cerca::Models::ThreadStreamEvent::ThreadStreamApprovalRequestedMessage, Cerca::Models::ThreadStreamEvent::ThreadStreamApprovalResolvedMessage>

Server-Sent Events stream. Each SSE data frame is JSON matching this response schema.

Parameters:

  • agent_id (String)
  • thread_id (String)
  • request_options (Cerca::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/cerca/resources/events.rb', line 207

def stream_for_thread_streaming(agent_id, thread_id, params = {})
  @client.request(
    method: :get,
    path: ["agents/%1$s/threads/%2$s/stream", agent_id, thread_id],
    headers: {"accept" => "text/event-stream", "accept-encoding" => "identity"},
    stream: Cerca::Internal::Stream,
    model: Cerca::ThreadStreamEvent,
    options: params[:request_options]
  )
end