Search & Retrieval

search is BM25-only by default; pass metric and/or weights to route through the server's hybrid fusion. The typed SearchClient.query door exposes rank-by, filters, facets, and consistency controls without raw SQL.

3 methods across this domain. Signatures, parameters (incl. keyword-only tunable defaults), and the three SDK spellings are ported from the live SDK source; flagship methods carry a hand-written When to use + example.

RelataClient

multi_search(queries)

When to use. Federate one query across multiple object types in a single round-trip.

  • Python — client.relataclient.multi_search(queries)
  • TypeScript — multiSearch(queries)
  • Go — MultiSearch(queries)

Parameters: queries

Example

res = relata.multi_search([{"type": "Person", "query": "ahmed"},
                          {"type": "Company", "query": "shell"}])

search(query, type, limit=None, facets=None, highlight=False, filters=None, matching_strategy=None, typo_tolerance=None, metric=None, weights=None)

When to use. BM25 full-text search; add metric/weights to fuse with graph + vector channels (hybrid).

  • Python — client.relataclient.search(query, type, limit=None, facets=None, highlight=False, filters=None, matching_strategy=None, typo_tolerance=None, metric=None, weights=None)
  • TypeScript — search(params)
  • Go — Search(query, objectType)

Parameters: query, type, limit=None, facets=None, highlight=False, filters=None, matching_strategy=None, typo_tolerance=None, metric=None, weights=None

Example

hits = relata.search("shell company", "IntelChunk", limit=10, highlight=True,
                metric="cosine", weights=[0.0, 0.5, 0.5])  # [graph, bm25, vector]

SearchClient

query(namespace, text=None, match_column='*', rank_by=None, filters=None, limit=20, include_attributes=None, consistency=None, compute_attributes=None, purpose=None)

query(namespace, text=None, match_column='*', rank_by=None, filters=None, limit=20, include_attributes=None, consistency=None, compute_attributes=None, purpose=None)`

  • Python — client.searchclient.query(namespace, text=None, match_column='*', rank_by=None, filters=None, limit=20, include_attributes=None, consistency=None, compute_attributes=None, purpose=None)
  • Go — Query(req)

Parameters: namespace, text=None, match_column='*', rank_by=None, filters=None, limit=20, include_attributes=None, consistency=None, compute_attributes=None, purpose=None