Skip to main content

Table.add(docs: list) -> int

Ingest documents. Each item is a str or dict with a text field.

Table.add_arrow(arrow_table) -> int

Ingest a PyArrow table via the C Data interface. Requires pyarrow.

Table.search(query, top_k=None, offset=None, strategy=None, explain=None, graph_expand=None, depth=None, query_vector=None) -> SearchResults

str
required
Query text (and metadata filter syntax when supported).
int
default:"20"
Maximum hits to return.
int
default:"0"
Skip first N results.
str
sparse, dense, diskann, hyde, crag, distributed, hybrid, etc.
bool
default:"false"
Attach explain text to results.
bool
default:"false"
Expand results via graph neighbors.
int
default:"2"
Graph expansion depth.
list[float]
Dense query embedding for ANN strategies.

stream_search(table, query, batch_size=128, ...)

Module helper in toradb.table — yields SearchResults batches.
See Search strategies.