News

org.llm4s.toolapi.builtin.search.BraveSearchCategory.News

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
News.type

Members list

Type members

Inherited types

type MirroredElemLabels = EmptyTuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Singleton
type MirroredElemTypes = EmptyTuple

Attributes

Inherited from:
Singleton
type MirroredMonoType = Singleton.this.type

The mirrored *-type

The mirrored *-type

Attributes

Inherited from:
Singleton
type MirroredType = Singleton.this.type

Attributes

Inherited from:
Singleton

Inherited and Abstract types

type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def mapSafeSearch(safeSearch: SafeSearch): String

Map a SafeSearch level to the string expected by this category's API endpoint.

Map a SafeSearch level to the string expected by this category's API endpoint.

Some categories (e.g. Image) do not support all levels and remap them.

Value parameters

safeSearch

The requested safe-search level

Attributes

def parseResults(json: Value, query: String): BraveNewsSearchResult

Parse the raw Brave API response JSON into a typed result.

Parse the raw Brave API response JSON into a typed result.

Value parameters

json

The parsed API response body

query

The original search query (included in the result for traceability)

Attributes

Inherited methods

def fromProduct(p: Product): MirroredMonoType

Create a new instance of type T with elements taken from product p.

Create a new instance of type T with elements taken from product p.

Attributes

Inherited from:
Singleton
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

val description: String

Natural-language description shown to the LLM.

Natural-language description shown to the LLM.

Attributes

val endpoint: String

API path segment appended to the Brave Search base URL.

API path segment appended to the Brave Search base URL.

Attributes

val toolName: String

Name used to register this tool with a org.llm4s.toolapi.ToolRegistry.

Name used to register this tool with a org.llm4s.toolapi.ToolRegistry.

Attributes