VECTOR.INFO - Upstash Documentation

Use VECTOR.INFO to read the dimension and metric an index was created with.

Both values are fixed at creation, so this is how a client discovers the shape a vector must have before writing to an index it did not create. The reply is null when the index does not exist, which makes it the command to check existence with, since VECTOR.COUNT reports 0 for both a missing index and an empty one.

Vector indexes are an Upstash extension. See the vector command overview for how an index is created, written to, and queried.

Syntax#

VECTOR.INFO <index>

Arguments#

Argument	Required	Repeatable	Description
`<index>`	Yes	No	Key holding the vector index.

Response#

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

Protocol	Reply
RESP2	Flat array of alternating field names and values, or Null array
RESP3	Map, or Null

Fields#

Field	Description
`dimension`	Number of elements in every vector in the index.
`metric`	Similarity metric: `COSINE`, `EUCLIDEAN`, or `DOT`.

Note

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples#

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

VECTOR.INFO my-index

@upstash/redis

Note

This command is not supported yet in @upstash/redis.

upstash_redis

Note

This command is not supported yet in upstash_redis.

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.call("VECTOR.INFO", "my-index");console.log(result);

node-redis

import { createClient } from "redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const result = await client.sendCommand(["VECTOR.INFO", "my-index"]);console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.execute_command("VECTOR.INFO", "my-index")print(result)

go-redis

package mainimport (    "context"    "fmt"    "os"    "github.com/redis/go-redis/v9")func main() {    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))    if err != nil {        panic(err)    }    client := redis.NewClient(opts)    result, err := client.Do(context.Background(), "VECTOR.INFO", "my-index").Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.Jedis;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.sendCommand(() -> "VECTOR.INFO".getBytes(), "my-index");  System.out.println(result);}

redis-rs

fn main() -> redis::RedisResult<()> {    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");    let client = redis::Client::open(url)?;    let mut connection = client.get_connection()?;    let mut command = redis::cmd("VECTOR.INFO");    command.arg("my-index");    let result: redis::Value = command.query(&mut connection)?;    println!("{result:?}");    Ok(())}