Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Upstash
  3. API Docs
  4. VectorIndex
Upstash v0.3.14 published on Friday, Aug 9, 2024 by Upstash
upstash/pulumi-upstash

upstash.VectorIndex

Explore with Pulumi AI

upstash logo
Upstash v0.3.14 published on Friday, Aug 9, 2024 by Upstash
upstash/pulumi-upstash

    Example Usage

    using Pulumi;
using Upstash = Pulumi.Upstash;

class MyStack : Stack
{
    public MyStack()
    {
        var vectorResource = new Upstash.VectorIndex("vectorResource", new Upstash.VectorIndexArgs
        {
            DimensionCount = 1536,
            Region = "us-east-1",
            SimilarityFunction = "COSINE",
            Type = "fixed",
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/upstash/pulumi-upstash/sdk/go/upstash"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := upstash.NewVectorIndex(ctx, "vectorResource", &upstash.VectorIndexArgs{
			DimensionCount:     pulumi.Int(1536),
			Region:             pulumi.String("us-east-1"),
			SimilarityFunction: pulumi.String("COSINE"),
			Type:               pulumi.String("fixed"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var vectorResource = new VectorIndex("vectorResource", VectorIndexArgs.builder()        
            .dimensionCount(1536)
            .region("us-east-1")
            .similarityFunction("COSINE")
            .type("fixed")
            .build());

    }
}

    import pulumi
import upstash_pulumi as upstash

vector_resource = upstash.VectorIndex("vectorResource",
    dimension_count=1536,
    region="us-east-1",
    similarity_function="COSINE",
    type="fixed")

    import * as pulumi from "@pulumi/pulumi";
import * as upstash from "@pulumi/upstash";

const vectorResource = new upstash.VectorIndex("vectorResource", {
    dimensionCount: 1536,
    region: "us-east-1",
    similarityFunction: "COSINE",
    type: "fixed",
});

    resources:
  vectorResource:
    type: upstash:VectorIndex
    properties:
      dimensionCount: 1536
      region: us-east-1
      similarityFunction: COSINE
      type: fixed

    Create VectorIndex Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VectorIndex(name: string, args: VectorIndexArgs, opts?: CustomResourceOptions);
    @overload
def VectorIndex(resource_name: str,
                args: VectorIndexArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def VectorIndex(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                dimension_count: Optional[int] = None,
                region: Optional[str] = None,
                similarity_function: Optional[str] = None,
                type: Optional[str] = None,
                name: Optional[str] = None,
                reserved_price: Optional[float] = None)
    func NewVectorIndex(ctx *Context, name string, args VectorIndexArgs, opts ...ResourceOption) (*VectorIndex, error)
    public VectorIndex(string name, VectorIndexArgs args, CustomResourceOptions? opts = null)
    public VectorIndex(String name, VectorIndexArgs args)
public VectorIndex(String name, VectorIndexArgs args, CustomResourceOptions options)

    type: upstash:VectorIndex
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VectorIndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VectorIndexArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VectorIndexArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VectorIndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VectorIndexArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var vectorIndexResource = new Upstash.VectorIndex("vectorIndexResource", new()
{
    DimensionCount = 0,
    Region = "string",
    SimilarityFunction = "string",
    Type = "string",
    Name = "string",
    ReservedPrice = 0,
});

    example, err := upstash.NewVectorIndex(ctx, "vectorIndexResource", &upstash.VectorIndexArgs{
	DimensionCount:     pulumi.Int(0),
	Region:             pulumi.String("string"),
	SimilarityFunction: pulumi.String("string"),
	Type:               pulumi.String("string"),
	Name:               pulumi.String("string"),
	ReservedPrice:      pulumi.Float64(0),
})

    var vectorIndexResource = new VectorIndex("vectorIndexResource", VectorIndexArgs.builder()
    .dimensionCount(0)
    .region("string")
    .similarityFunction("string")
    .type("string")
    .name("string")
    .reservedPrice(0)
    .build());

    vector_index_resource = upstash.VectorIndex("vectorIndexResource",
    dimension_count=0,
    region="string",
    similarity_function="string",
    type="string",
    name="string",
    reserved_price=0)

    const vectorIndexResource = new upstash.VectorIndex("vectorIndexResource", {
    dimensionCount: 0,
    region: "string",
    similarityFunction: "string",
    type: "string",
    name: "string",
    reservedPrice: 0,
});

    type: upstash:VectorIndex
properties:
    dimensionCount: 0
    name: string
    region: string
    reservedPrice: 0
    similarityFunction: string
    type: string

    VectorIndex Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VectorIndex resource accepts the following input properties:

    DimensionCount int
    Size of the vector array.
    Region string
    The region where your index is deployed.
    SimilarityFunction string
    Associated distance metric to calculate the similarity.
    Type string
    Associated plan of the index. Either free, paid, fixed or pro.
    Name string
    Name of the index.
    ReservedPrice double
    Monthly pricing of your index. Only available for fixed and pro plans.
    DimensionCount int
    Size of the vector array.
    Region string
    The region where your index is deployed.
    SimilarityFunction string
    Associated distance metric to calculate the similarity.
    Type string
    Associated plan of the index. Either free, paid, fixed or pro.
    Name string
    Name of the index.
    ReservedPrice float64
    Monthly pricing of your index. Only available for fixed and pro plans.
    dimensionCount Integer
    Size of the vector array.
    region String
    The region where your index is deployed.
    similarityFunction String
    Associated distance metric to calculate the similarity.
    type String
    Associated plan of the index. Either free, paid, fixed or pro.
    name String
    Name of the index.
    reservedPrice Double
    Monthly pricing of your index. Only available for fixed and pro plans.
    dimensionCount number
    Size of the vector array.
    region string
    The region where your index is deployed.
    similarityFunction string
    Associated distance metric to calculate the similarity.
    type string
    Associated plan of the index. Either free, paid, fixed or pro.
    name string
    Name of the index.
    reservedPrice number
    Monthly pricing of your index. Only available for fixed and pro plans.
    dimension_count int
    Size of the vector array.
    region str
    The region where your index is deployed.
    similarity_function str
    Associated distance metric to calculate the similarity.
    type str
    Associated plan of the index. Either free, paid, fixed or pro.
    name str
    Name of the index.
    reserved_price float
    Monthly pricing of your index. Only available for fixed and pro plans.
    dimensionCount Number
    Size of the vector array.
    region String
    The region where your index is deployed.
    similarityFunction String
    Associated distance metric to calculate the similarity.
    type String
    Associated plan of the index. Either free, paid, fixed or pro.
    name String
    Name of the index.
    reservedPrice Number
    Monthly pricing of your index. Only available for fixed and pro plans.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VectorIndex resource produces the following output properties:

    CreationTime int
    The creation time of the vector index in UTC as unix timestamp.
    CustomerId string
    The unique ID associated to the owner of this index.
    Endpoint string
    Associated endpoint of your index.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxDailyQueries int
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    MaxDailyUpdates int
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    MaxMonthlyBandwidth int
    The maximum amount of monthly bandwidth for the index. Unit is bytes. -1 if the limit is unlimited.
    MaxQueryPerSecond int
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    MaxReadsPerRequest int
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    MaxTotalMetadataSize int
    The amount of maximum size for the total metadata sizes in your index.
    MaxVectorCount int
    The number of maximum that your index can contain.
    MaxWritesPerRequest int
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    MaxWritesPerSecond int
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    ReadOnlyToken string
    Readonly REST token to send request to the related index. You can't perform update operation with this token.
    Token string
    REST token to send request to the related index.
    CreationTime int
    The creation time of the vector index in UTC as unix timestamp.
    CustomerId string
    The unique ID associated to the owner of this index.
    Endpoint string
    Associated endpoint of your index.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxDailyQueries int
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    MaxDailyUpdates int
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    MaxMonthlyBandwidth int
    The maximum amount of monthly bandwidth for the index. Unit is bytes. -1 if the limit is unlimited.
    MaxQueryPerSecond int
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    MaxReadsPerRequest int
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    MaxTotalMetadataSize int
    The amount of maximum size for the total metadata sizes in your index.
    MaxVectorCount int
    The number of maximum that your index can contain.
    MaxWritesPerRequest int
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    MaxWritesPerSecond int
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    ReadOnlyToken string
    Readonly REST token to send request to the related index. You can't perform update operation with this token.
    Token string
    REST token to send request to the related index.
    creationTime Integer
    The creation time of the vector index in UTC as unix timestamp.
    customerId String
    The unique ID associated to the owner of this index.
    endpoint String
    Associated endpoint of your index.
    id String
    The provider-assigned unique ID for this managed resource.
    maxDailyQueries Integer
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    maxDailyUpdates Integer
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    maxMonthlyBandwidth Integer
    The maximum amount of monthly bandwidth for the index. Unit is bytes. -1 if the limit is unlimited.
    maxQueryPerSecond Integer
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    maxReadsPerRequest Integer
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    maxTotalMetadataSize Integer
    The amount of maximum size for the total metadata sizes in your index.
    maxVectorCount Integer
    The number of maximum that your index can contain.
    maxWritesPerRequest Integer
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    maxWritesPerSecond Integer
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    readOnlyToken String
    Readonly REST token to send request to the related index. You can't perform update operation with this token.
    token String
    REST token to send request to the related index.
    creationTime number
    The creation time of the vector index in UTC as unix timestamp.
    customerId string
    The unique ID associated to the owner of this index.
    endpoint string
    Associated endpoint of your index.
    id string
    The provider-assigned unique ID for this managed resource.
    maxDailyQueries number
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    maxDailyUpdates number
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    maxMonthlyBandwidth number
    The maximum amount of monthly bandwidth for the index. Unit is bytes. -1 if the limit is unlimited.
    maxQueryPerSecond number
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    maxReadsPerRequest number
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    maxTotalMetadataSize number
    The amount of maximum size for the total metadata sizes in your index.
    maxVectorCount number
    The number of maximum that your index can contain.
    maxWritesPerRequest number
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    maxWritesPerSecond number
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    readOnlyToken string
    Readonly REST token to send request to the related index. You can't perform update operation with this token.
    token string
    REST token to send request to the related index.
    creation_time int
    The creation time of the vector index in UTC as unix timestamp.
    customer_id str
    The unique ID associated to the owner of this index.
    endpoint str
    Associated endpoint of your index.
    id str
    The provider-assigned unique ID for this managed resource.
    max_daily_queries int
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    max_daily_updates int
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    max_monthly_bandwidth int
    The maximum amount of monthly bandwidth for the index. Unit is bytes. -1 if the limit is unlimited.
    max_query_per_second int
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    max_reads_per_request int
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    max_total_metadata_size int
    The amount of maximum size for the total metadata sizes in your index.
    max_vector_count int
    The number of maximum that your index can contain.
    max_writes_per_request int
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    max_writes_per_second int
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    read_only_token str
    Readonly REST token to send request to the related index. You can't perform update operation with this token.
    token str
    REST token to send request to the related index.
    creationTime Number
    The creation time of the vector index in UTC as unix timestamp.
    customerId String
    The unique ID associated to the owner of this index.
    endpoint String
    Associated endpoint of your index.
    id String
    The provider-assigned unique ID for this managed resource.
    maxDailyQueries Number
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    maxDailyUpdates Number
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    maxMonthlyBandwidth Number
    The maximum amount of monthly bandwidth for the index. Unit is bytes. -1 if the limit is unlimited.
    maxQueryPerSecond Number
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    maxReadsPerRequest Number
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    maxTotalMetadataSize Number
    The amount of maximum size for the total metadata sizes in your index.
    maxVectorCount Number
    The number of maximum that your index can contain.
    maxWritesPerRequest Number
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    maxWritesPerSecond Number
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    readOnlyToken String
    Readonly REST token to send request to the related index. You can't perform update operation with this token.
    token String
    REST token to send request to the related index.

    Look up Existing VectorIndex Resource

    Get an existing VectorIndex resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VectorIndexState, opts?: CustomResourceOptions): VectorIndex
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        creation_time: Optional[int] = None,
        customer_id: Optional[str] = None,
        dimension_count: Optional[int] = None,
        endpoint: Optional[str] = None,
        max_daily_queries: Optional[int] = None,
        max_daily_updates: Optional[int] = None,
        max_monthly_bandwidth: Optional[int] = None,
        max_query_per_second: Optional[int] = None,
        max_reads_per_request: Optional[int] = None,
        max_total_metadata_size: Optional[int] = None,
        max_vector_count: Optional[int] = None,
        max_writes_per_request: Optional[int] = None,
        max_writes_per_second: Optional[int] = None,
        name: Optional[str] = None,
        read_only_token: Optional[str] = None,
        region: Optional[str] = None,
        reserved_price: Optional[float] = None,
        similarity_function: Optional[str] = None,
        token: Optional[str] = None,
        type: Optional[str] = None) -> VectorIndex
    func GetVectorIndex(ctx *Context, name string, id IDInput, state *VectorIndexState, opts ...ResourceOption) (*VectorIndex, error)
    public static VectorIndex Get(string name, Input<string> id, VectorIndexState? state, CustomResourceOptions? opts = null)
    public static VectorIndex get(String name, Output<String> id, VectorIndexState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreationTime int
    The creation time of the vector index in UTC as unix timestamp.
    CustomerId string
    The unique ID associated to the owner of this index.
    DimensionCount int
    Size of the vector array.
    Endpoint string
    Associated endpoint of your index.
    MaxDailyQueries int
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    MaxDailyUpdates int
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    MaxMonthlyBandwidth int
    The maximum amount of monthly bandwidth for the index. Unit is bytes. -1 if the limit is unlimited.
    MaxQueryPerSecond int
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    MaxReadsPerRequest int
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    MaxTotalMetadataSize int
    The amount of maximum size for the total metadata sizes in your index.
    MaxVectorCount int
    The number of maximum that your index can contain.
    MaxWritesPerRequest int
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    MaxWritesPerSecond int
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    Name string
    Name of the index.
    ReadOnlyToken string
    Readonly REST token to send request to the related index. You can't perform update operation with this token.
    Region string
    The region where your index is deployed.
    ReservedPrice double
    Monthly pricing of your index. Only available for fixed and pro plans.
    SimilarityFunction string
    Associated distance metric to calculate the similarity.
    Token string
    REST token to send request to the related index.
    Type string
    Associated plan of the index. Either free, paid, fixed or pro.
    CreationTime int
    The creation time of the vector index in UTC as unix timestamp.
    CustomerId string
    The unique ID associated to the owner of this index.
    DimensionCount int
    Size of the vector array.
    Endpoint string
    Associated endpoint of your index.
    MaxDailyQueries int
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    MaxDailyUpdates int
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    MaxMonthlyBandwidth int
    The maximum amount of monthly bandwidth for the index. Unit is bytes. -1 if the limit is unlimited.
    MaxQueryPerSecond int
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    MaxReadsPerRequest int
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    MaxTotalMetadataSize int
    The amount of maximum size for the total metadata sizes in your index.
    MaxVectorCount int
    The number of maximum that your index can contain.
    MaxWritesPerRequest int
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    MaxWritesPerSecond int
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    Name string
    Name of the index.
    ReadOnlyToken string
    Readonly REST token to send request to the related index. You can't perform update operation with this token.
    Region string
    The region where your index is deployed.
    ReservedPrice float64
    Monthly pricing of your index. Only available for fixed and pro plans.
    SimilarityFunction string
    Associated distance metric to calculate the similarity.
    Token string
    REST token to send request to the related index.
    Type string
    Associated plan of the index. Either free, paid, fixed or pro.
    creationTime Integer
    The creation time of the vector index in UTC as unix timestamp.
    customerId String
    The unique ID associated to the owner of this index.
    dimensionCount Integer
    Size of the vector array.
    endpoint String
    Associated endpoint of your index.
    maxDailyQueries Integer
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    maxDailyUpdates Integer
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    maxMonthlyBandwidth Integer
    The maximum amount of monthly bandwidth for the index. Unit is bytes. -1 if the limit is unlimited.
    maxQueryPerSecond Integer
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    maxReadsPerRequest Integer
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    maxTotalMetadataSize Integer
    The amount of maximum size for the total metadata sizes in your index.
    maxVectorCount Integer
    The number of maximum that your index can contain.
    maxWritesPerRequest Integer
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    maxWritesPerSecond Integer
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    name String
    Name of the index.
    readOnlyToken String
    Readonly REST token to send request to the related index. You can't perform update operation with this token.
    region String
    The region where your index is deployed.
    reservedPrice Double
    Monthly pricing of your index. Only available for fixed and pro plans.
    similarityFunction String
    Associated distance metric to calculate the similarity.
    token String
    REST token to send request to the related index.
    type String
    Associated plan of the index. Either free, paid, fixed or pro.
    creationTime number
    The creation time of the vector index in UTC as unix timestamp.
    customerId string
    The unique ID associated to the owner of this index.
    dimensionCount number
    Size of the vector array.
    endpoint string
    Associated endpoint of your index.
    maxDailyQueries number
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    maxDailyUpdates number
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    maxMonthlyBandwidth number
    The maximum amount of monthly bandwidth for the index. Unit is bytes. -1 if the limit is unlimited.
    maxQueryPerSecond number
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    maxReadsPerRequest number
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    maxTotalMetadataSize number
    The amount of maximum size for the total metadata sizes in your index.
    maxVectorCount number
    The number of maximum that your index can contain.
    maxWritesPerRequest number
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    maxWritesPerSecond number
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    name string
    Name of the index.
    readOnlyToken string
    Readonly REST token to send request to the related index. You can't perform update operation with this token.
    region string
    The region where your index is deployed.
    reservedPrice number
    Monthly pricing of your index. Only available for fixed and pro plans.
    similarityFunction string
    Associated distance metric to calculate the similarity.
    token string
    REST token to send request to the related index.
    type string
    Associated plan of the index. Either free, paid, fixed or pro.
    creation_time int
    The creation time of the vector index in UTC as unix timestamp.
    customer_id str
    The unique ID associated to the owner of this index.
    dimension_count int
    Size of the vector array.
    endpoint str
    Associated endpoint of your index.
    max_daily_queries int
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    max_daily_updates int
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    max_monthly_bandwidth int
    The maximum amount of monthly bandwidth for the index. Unit is bytes. -1 if the limit is unlimited.
    max_query_per_second int
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    max_reads_per_request int
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    max_total_metadata_size int
    The amount of maximum size for the total metadata sizes in your index.
    max_vector_count int
    The number of maximum that your index can contain.
    max_writes_per_request int
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    max_writes_per_second int
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    name str
    Name of the index.
    read_only_token str
    Readonly REST token to send request to the related index. You can't perform update operation with this token.
    region str
    The region where your index is deployed.
    reserved_price float
    Monthly pricing of your index. Only available for fixed and pro plans.
    similarity_function str
    Associated distance metric to calculate the similarity.
    token str
    REST token to send request to the related index.
    type str
    Associated plan of the index. Either free, paid, fixed or pro.
    creationTime Number
    The creation time of the vector index in UTC as unix timestamp.
    customerId String
    The unique ID associated to the owner of this index.
    dimensionCount Number
    Size of the vector array.
    endpoint String
    Associated endpoint of your index.
    maxDailyQueries Number
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    maxDailyUpdates Number
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    maxMonthlyBandwidth Number
    The maximum amount of monthly bandwidth for the index. Unit is bytes. -1 if the limit is unlimited.
    maxQueryPerSecond Number
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    maxReadsPerRequest Number
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    maxTotalMetadataSize Number
    The amount of maximum size for the total metadata sizes in your index.
    maxVectorCount Number
    The number of maximum that your index can contain.
    maxWritesPerRequest Number
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    maxWritesPerSecond Number
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    name String
    Name of the index.
    readOnlyToken String
    Readonly REST token to send request to the related index. You can't perform update operation with this token.
    region String
    The region where your index is deployed.
    reservedPrice Number
    Monthly pricing of your index. Only available for fixed and pro plans.
    similarityFunction String
    Associated distance metric to calculate the similarity.
    token String
    REST token to send request to the related index.
    type String
    Associated plan of the index. Either free, paid, fixed or pro.

    Package Details

    Repository
    upstash upstash/pulumi-upstash
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the upstash Terraform Provider.
    upstash logo
    Upstash v0.3.14 published on Friday, Aug 9, 2024 by Upstash
    upstash/pulumi-upstash