Getting Started

Prerequisite

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

Create an Index

Once you logged in, you can create a Vector Index by clicking on the Create Index button in the Vector 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]

Dimensions: Select the dimensions and distance metric depending on your model.

Free: The free plan is suitable for small projects. It has a limit of 10,000 queries and 10,000 updates limit 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 update limit 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 vectors 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
• JavaScript
• Go
• cURL

from upstash_vector import Index

index = Index(url="<UPSTASH_VECTOR_REST_URL>", token="<UPSTASH_VECTOR_REST_TOKEN>")

index.upsert(
  vectors=[
    ("1", [0.6, 0.8], {"metadata_field": "metadata_value"}),
  ]
)

Query Index

You can perform a similarity search by providing a query vector as a parameter. The dimension of the query vector must match the dimension of your index. Currently, querying by metadata is not supported, but we will be adding this feature (pre-filtering) soon.

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

• Python
• JavaScript
• Go
• cURL

from upstash_vector import Index

index = Index(url="<UPSTASH_VECTOR_REST_URL>", token="<UPSTASH_VECTOR_REST_TOKEN>")

index.query(
    vector=[0.6, 0.8],
    top_k=3,
    include_vectors=True,
    include_metadata=True,
)

Charts and Query Browser

In Upstash console, you can see the charts of your index and query your index with a simple UI. There are following charts:

• Daily Requests: The number of queries and updates to your index in the last 5 days.
• Throughput: The number of queries and updates to your index in the selected time period.
• Latency: The mean and P99 latency of queries and updates to your index in the selected time period.
• Vector Count: The number of vectors in your index in the selected time period.
• Data Size: The size of your index in the selected time period.