Getting Started

Prerequisite

You need an Upstash account before creating a search index, create one here.

Create an Index

Once you logged in, you can create a Search Index by clicking on the Create Index button in the Search tab.

Name: Type a name for your index.

Region: Choose the region for your index. For optimal performance, select the region closest to your applications. We plan to support additional regions and cloud providers. Feel free to send your requests to [e-mail]

Type: The type of index: Dense, Sparse or Hybrid. For semantic search, you can prefer dense. For full text (or keyword) search, you can prefer sparse. If you need a combination, you can choose hybrid.

If you choose Dense or Hybrid as index type, you will also be presented with options to select the dimensions and distance metric of your index.

For the purpose of using the code samples on this page, you can create a dense index with dimension: 2. Distance metric can be any of the options.

Once you pick these options, you will choose a plan:

Free: The free plan is suitable for small projects. It has a limit of 10,000 queries and 10,000 updates daily.

Pay as You Go: Pay as you go plan is a flexible plan with per-request-pricing. It is suitable for projects with unpredictable traffic.

Fixed: Fixed plan is suitable for projects with predictable traffic. It has a fixed monthly price with 1M query and 1M updates daily.

Pro: Pro plan is suitable for projects with high traffic and storage needs. It has a fixed monthly price with extra security and isolation features.

Enterprise: If you plan to have over a billion records then Enterprise plan is for you. It has a fixed monthly price with extra security and isolation features. Contact us at [e-mail] for more information.

Insert Index

You can access data in your index using REST API or our SDKs. You can copy the sample code from the Connect section in the console.

Python

# Placeholder for Python example

# Placeholder for Python example

// Placeholder for JavaScript example

// Placeholder for Go example

// Placeholder for PHP example

# Placeholder for curl example

Query Index

You can perform a search by providing a query as a parameter. The dimension of the query must match the dimension of your index. Also, you can query by metadata filtering.

Upstash is eventually consistent, so there may be a delay before the newly inserted or updated records are ready for querying.

Python

# Placeholder for Python query example

# Placeholder for Python query example

// Placeholder for JavaScript query example

// Placeholder for Go query example

// Placeholder for PHP query example