> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sublay.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Search
> Semantic search across content, users, and spaces, plus streaming AI Q&A
export const SpaceReputationParams = ({variant = "context", field = "path"}) => {
const isUser = variant === "user";
return <>
Opt-in. Adds a spaceReputation number to each returned user,
scoped to a single space. Requires the reputation bundle.
The reputation total is always present regardless;{" "}
spaceReputation is purely additive and only appears when you
pass this object. This object is the primary form — it
replaces the deprecated flat props below. See the{" "}
Reputation data model for the
full contract.
{isUser ?
Which bucket to read. A space <uuid> reads that
space's bucket; "none" reads the
project-general (space-less) bucket.{" "}
"context" is rejected (400) on this
endpoint — there is no space context to derive. The empty string
and the legacy general / null aliases are
also rejected. Missing buckets read as 0.
:
Which bucket to read. One of: a space <uuid>{" "}
(that space's bucket), "none" (the
project-general, space-less bucket), or{" "}
"context" (the space derived from the
request context — resolved per-row on lists, or the single space on
member/team/conversation surfaces). The empty string and the legacy{" "}
general / null aliases are rejected (400).
Missing buckets read as 0.
}
Only honored when spaceId is an explicit space <uuid>.
When true, spaceReputation is the{" "}
subtree sum — the named space plus all of its
descendant spaces (the root space's own bucket included). Ignored for{" "}
"none"; not allowed with "context".
{isUser ?
Deprecated — use the spaceReputation{" "}
object instead. The flat form of spaceReputation.spaceId.
Still accepted (the object wins if both are passed); removal is a later
major version. Accepts a space <uuid> or "none" only —{" "}
"context" is rejected (400) on this endpoint.
:
Deprecated — use the spaceReputation{" "}
object instead. The flat form of spaceReputation.spaceId.
Still accepted (the object wins if both are passed); removal is a later
major version. Accepts a space <uuid>, "none", or{" "}
"context".
}
Deprecated — use{" "}
spaceReputation.includeDescendants instead. The flat form,
only honored alongside an explicit spaceReputationId <uuid>.
;
};
The `search` module runs semantic (vector) search over your project's content and powers a streaming, RAG-style question-answering endpoint.
These features require semantic search to be enabled for your project. See the
[Semantic Search & AI](/v8/semantic-search-ai) guide for setup.
The three `search*` functions return **raw arrays** of similarity-ranked results
(not a `PaginatedResponse`); each element is `{ similarity, record }`. `askContent`
is different — it **streams** its answer (see below).
***
### searchContent
Semantic search over content — entities, comments, and chat messages.
```typescript theme={null}
const results = await sublay.search.searchContent({
query: "getting started guide",
sourceTypes: ["entity", "comment"],
spaceId: "spc_abc123",
limit: 10,
});
for (const { sourceType, similarity, record } of results) {
console.log(sourceType, similarity, record);
}
```
The search query string.
Which content types to search. Defaults to all.
Scope the search to a specific space.
Only applies with `spaceId`. When `true`, the search also covers every space nested under it — the whole subtree at any depth — not just the named space. Ignored without `spaceId`.
Scope the search to a specific conversation.
Maximum number of results to return.
**Returns** — `Promise`, where each element is
`{ sourceType: "entity" | "comment" | "message"; similarity: number; record: Entity | Comment | ChatMessage }`.
***
### searchUsers
Semantic search over the project's users.
```typescript theme={null}
const results = await sublay.search.searchUsers({ query: "alice", limit: 10 });
// results: [{ similarity, record: User }, ...]
```
The search query string.
Maximum number of results to return.
**Returns** — `Promise`, where each element is
`{ similarity: number; record: User }`.
***
### searchSpaces
Semantic search over the project's spaces.
```typescript theme={null}
const results = await sublay.search.searchSpaces({ query: "photography", limit: 10 });
// results: [{ similarity, record: Space }, ...]
```
The search query string.
Maximum number of results to return.
**Returns** — `Promise`, where each element is
`{ similarity: number; record: Space }`.
***
### askContent
Asks a natural-language question over your content and **streams** the answer back
as it is generated. Unlike every other SDK function, `askContent` is an **async
generator** over Server-Sent Events — you `for await` over it rather than awaiting
a single result.
`askContent` streams via `fetch` rather than axios, so it does **not** get the
automatic token-refresh-on-`403` retry that other calls have. In SDK-managed
mode, make sure a fresh access token is in place before starting a long stream.
```typescript theme={null}
const controller = new AbortController();
const stream = sublay.search.askContent({
query: "What are the best practices for error handling?",
spaceId: "spc_abc123",
signal: controller.signal,
});
let answer = "";
let sources = [];
for await (const event of stream) {
switch (event.type) {
case "token":
answer += event.content; // append streamed text
break;
case "sources":
sources = event.sources; // ContentSearchResult[] the answer draws on
break;
case "done":
break; // the stream is complete
case "error":
console.error(event.error);
break;
}
}
// Cancel early with controller.abort() — or simply `break` out of the loop.
```
The natural-language question to answer.
Which content types to draw from. Defaults to all.
Scope the answer to content within a specific space.
Only applies with `spaceId`. When `true`, the context lookup also covers every space nested under it — the whole subtree at any depth — so you can ask across a community and all of its channels at once. Ignored without `spaceId`.
Scope the answer to a specific conversation.
Maximum number of sources to draw from.
Aborts the in-flight stream (e.g. when the user navigates away). You can also
stop consuming by `break`ing out of the `for await` loop.
**Returns** — `AsyncGenerator`. Each yielded event
is one of:
```typescript theme={null}
type AskContentEvent =
| { type: "token"; content: string } // a chunk of answer text
| { type: "sources"; sources: ContentSearchResult[] } // the cited sources
| { type: "done" } // stream finished
| { type: "error"; error: string }; // a stream/server error
```
Completion and errors are signalled **in-band** as `done` / `error` events — the
generator itself returns `void` and does not throw on a server-reported error.
***
### matchUsers
Matches people by **activity-derived interest facets**, in `passive` mode (against the current user's own facets) or `directed` mode (against a free-text topic). See the [Interest Matching](/v8/interest-matching) guide for setup and the model.
Requires a paid plan, the `ai-search` and `interest-matching` bundles, and `interestMatching.enabled` on the project. `passive` requires an identified user; `directed` requires one too.
```typescript theme={null}
const { results } = await sublay.search.matchUsers({
mode: "passive",
limit: 10,
});
// results: [{ user, score, matchedFacets: [{ similarity, candidateFacet, askerFacet?, sampleContent? }] }]
```
`"passive"` or `"directed"`.
The topic to match against. Required in `directed` mode; rejected in `passive` mode.
Maximum number of matched users. Maximum `50`.
Restrict candidates to users active in this space.
With `spaceId`, also include users active in the space's subtree.
Request illustrative sample content per matched facet. Only honored when the project has `interestMatching.exposeSampleContent` on; otherwise returns `403 match/sample-content-disabled`.
Exclude the current user from results.
**Returns** — `Promise<{ results: UserMatchResult[] }>`. Unlike `searchContent`/`searchUsers`/`searchSpaces` (which return bare arrays), match returns the `{ results }` envelope, ordered by descending `score`.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.