Skip to main content

Overview

Returns state and a search function for finding users by natural language query. Matches against user profile text (name, username, bio, etc.) using vector similarity. For integration guidance, see Semantic Search.

Usage Example

Parameters

Call search with:
string
required
The natural language query string.
number
Maximum number of results to return.

Returns

UserSearchResult[]
Ranked user results.
boolean
true while a search is in progress.
string | null
Error message if the last search failed.
Executes the search and updates results.
() => void
Clears results and error.