Search - Upstash Documentation

Search Command for Python SDK

The search method is designed to retrieve the most relevant documents from the database, using AI-powered search capabilities. For more details on how the search algorithm works, please refer to our advanced settings documentation.

Arguments

Payload

dict

required

Hide child attributes

query

string

required

The search query string.

limit

int

required

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

reranking

bool

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.

semantic_weight

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.

input_enrichment

boolean

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

Response

Documents

List[DocumentScore]

required

This field is null if no document with the specified ID is found.

Hide child attributes

string | number

required

The ID of the resulting document.

content

Record<string, unknown>

The main content of the document.

metadata

Record<string, unknown>

Additional metadata for the document.

score

float

required

Similarity score of the document

results = index.search(
    query="space opera",
    limit=2
)
print(results)

results = index.search(
    query="space opera",
    limit=2,
    reranking=True
)
print(results)

results = index.search(
    query="space", 
    limit=2, 
    filter="category = 'classic'"
)
print(results)

​Search Command for Python SDK

​Arguments

​Response

Search Command for Python SDK

Arguments

Response