VectrixDB (version 1.1.2)

Results: Search Results Collection

Description

Collection of search results with convenient accessors

Public fields

items

List of Result objects

query

Search query

mode

Search mode

time_ms

Execution time in ms

Methods

Public methods

• Results$new()

• Results$length()

• Results$texts()

• Results$ids()

• Results$scores()

• Results$top()

• Results$get()

• Results$foreach()

• Results$print()

• Results$clone()

---

Method new()

Create a new Results object

Usage

Results$new(items = list(), query = "", mode = "hybrid", time_ms = 0)

Arguments

items

List of Result objects

query

Search query string

mode

Search mode used

time_ms

Execution time in milliseconds

---

Method length()

Get number of results

Usage

Results$length()

---

Method texts()

Get all result texts

Usage

Results$texts()

Returns

Character vector of texts

---

Method ids()

Get all result IDs

Usage

Results$ids()

Returns

Character vector of IDs

---

Method scores()

Get all scores

Usage

Results$scores()

Returns

Numeric vector of scores

---

Method top()

Get top result

Usage

Results$top()

Returns

Result object or NULL if empty

---

Method get()

Get result by index

Usage

Results$get(i)

Arguments

i

Index

Returns

Result object

---

Method foreach()

Iterate over results

Usage

Results$foreach(fn)

Arguments

fn

Function to apply to each result

---

Method print()

Print results summary

Usage

Results$print()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Results$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.