Interface RocksetLibArgs

Vector store arguments RocksetStore

interface RocksetLibArgs {
    client: MainApi;
    collectionName: string;
    embeddingKey?: string;
    filter?: string;
    similarityMetric?: "COSINE_SIM" | "EUCLIDEAN_DIST" | "DOT_PRODUCT";
    textKey?: string;
    workspaceName?: string;
}

Properties

client collectionName embeddingKey? filter? similarityMetric? textKey? workspaceName?

Properties

client

client: MainApi

The rockset client object constructed with rocksetConfigure

collectionName

collectionName: string

The name of the Rockset collection to store vectors

Optional embeddingKey

embeddingKey?: string

The name of the collection column to contain vectors

Optional filter

filter?: string

The SQL WHERE clause to filter by

Optional similarityMetric

similarityMetric?: "COSINE_SIM" | "EUCLIDEAN_DIST" | "DOT_PRODUCT"

The metric used to measure vector relationship

Optional textKey

textKey?: string

The name of the collection column to contain page contnent of documents

Optional workspaceName

workspaceName?: string

The name of othe Rockset workspace that holds

Member

collectionName

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc