Class: Riffer::StreamEvents::WebSearchDone

Inherits:
Base
  • Object
show all
Defined in:
lib/riffer/stream_events/web_search_done.rb,
sig/generated/riffer/stream_events/web_search_done.rbs

Overview

The result of a completed server-side web search during streaming.

Instance Attribute Summary collapse

Attributes inherited from Base

#role

Instance Method Summary collapse

Constructor Details

#initialize(query, sources: [], role: :assistant) ⇒ WebSearchDone

-- : (String, ?sources: Array[Hash[Symbol, String?]], ?role: Symbol) -> void

Parameters:

  • (String)
  • sources: (Array[Hash[Symbol, String?]]) (defaults to: [])
  • role: (Symbol) (defaults to: :assistant) 


14
15
16
17
18
 
# File 'lib/riffer/stream_events/web_search_done.rb', line 14

def initialize(query, sources: [], role: :assistant)
  super(role: role)
  @query = query
  @sources = sources
end

Instance Attribute Details

#query ⇒ String (readonly)

The search query used.

Returns:

  • (String) 


7
8
9
 
# File 'lib/riffer/stream_events/web_search_done.rb', line 7

def query
  @query
end

#sources ⇒ Array[Hash[Symbol, String?]] (readonly)

The search result sources with title and url.

Returns:

  • (Array[Hash[Symbol, String?]]) 


10
11
12
 
# File 'lib/riffer/stream_events/web_search_done.rb', line 10

def sources
  @sources
end

Instance Method Details

#to_h ⇒ Hash[Symbol, untyped]

-- : () -> Hash[Symbol, untyped]

Returns:

  • (Hash[Symbol, untyped]) 


22
23
24
 
# File 'lib/riffer/stream_events/web_search_done.rb', line 22

def to_h
  {role: @role, query: @query, sources: @sources}
end