Search spaces

Overview

Returns state and a search function for finding spaces by natural language query. Matches against space name, description, and other text fields using vector similarity. For integration guidance, see Semantic Search.

Only public spaces are returned. unlisted and private spaces are never surfaced in search results for non-members. Hidden spaces stay indexed but filtered out, so re-listing a space (setting it back to "public") makes it searchable again immediately. See Space visibility.

Usage Example

import { useSearchSpaces } from "@sublay/react-js";

function SpaceSearch() {
  const { results, loading, search } = useSearchSpaces();

  return (
    <div>
      <button onClick={() => search({ query: "photography communities", limit: 10 })}>
        Search
      </button>
      {results.map((r) => (
        <div key={r.record.id}>{r.record.name} — {r.similarity.toFixed(3)}</div>
      ))}
    </div>
  );
}

Parameters

Call search with:

query

string

required

The natural language query string.

limit

number

Maximum number of results to return.

Returns

results

SpaceSearchResult[]

Ranked space results.

Show SpaceSearchResult properties

similarity

number

Cosine similarity score (0–1).

record

Space

The matched space. See Space data model.

boolean

true while a search is in progress.

error

string | null

Error message if the last search failed.

(props) => Promise<void>

Executes the search and updates results.

reset

() => void

Clears results and error.

Search users Ask content

Overview

Auth Hooks

Current User

User Profiles

Entities

Entity Lists

Spaces

Spaces — Rules

Space Lists

Events

Comments

Reactions

Follows

Connections

Collections

App Notifications

Push Notifications

Chat — Conversations

Chat — Messages

Chat — Core

Search

Reports

Storage

Crypto

Project

Custom Tables

Overview

Usage Example

Parameters

Returns

​Overview

​Usage Example

​Parameters

​Returns

Overview

Usage Example

Parameters

Returns