Search

The search method is designed to retrieve the most relevant documents from the database, using AI-powered search capabilities. This method supports a variety of options to configure the query to your needs. For more details on how the search algorithm works, please refer to our advanced settings documentation.

The score returned from search requests is a normalized value between 0 and 1, where 1 indicates the highest relevance and 0 the lowest.

Arguments

Payload

SearchCommandPayload

required

Hide child attributes

query

string

required

The search query string.

limit

number

required

The maximum number of results to return. Defaults to 5.

reranking

boolean

Whether to enable AI-powered reranking of results. Disabled by default.

filter

string

A filter for narrowing down the search results based on content fields. See typesafe filtering section for advanced usage.

semanticWeight

number

Optional relevance balance between semantic and keyword search (0-1 range, defaults to 0.75). For instance, 0.2 applies 20% semantic matching with 80% full-text matching. You can learn more about how Upstash Search works from our docs.

inputEnrichment

boolean

Optional boolean to enhance queries before searching (enabled by default).

keepOriginalQueryAfterEnrichment

boolean

Optional boolean to keep the original query alongside the enriched one (false by default).

Response

SearchResult

required

Hide child attributes

results

Document[]

The list of documents matching the search query.

const searchResults = await index.search({
  query: "space opera",
  limit: 2,
});
console.log(searchResults);

​Arguments

​Response

Arguments

Response