Class SingleStoreVectorStore

Class for interacting with SingleStoreDB, a high-performance distributed SQL database. It provides vector storage and vector functions.

Hierarchy

VectorStore
- SingleStoreVectorStore

Constructors

constructor

new SingleStoreVectorStore(embeddings, config): SingleStoreVectorStore
Parameters
- embeddings: Embeddings
- config: SingleStoreVectorStoreConfig
Returns SingleStoreVectorStore
Overrides VectorStore.constructor
- Defined in langchain/src/vectorstores/singlestore.ts:103

Properties

FilterType

FilterType: string | object

connectionPool

connectionPool: Pool

contentColumnName

contentColumnName: string

distanceMetric

distanceMetric: DistanceMetrics

embeddings

embeddings: Embeddings

lc_kwargs

lc_kwargs: SerializedFields

lc_namespace

lc_namespace: string[] = ...

A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.

lc_serializable

lc_serializable: boolean = false

metadataColumnName

metadataColumnName: string

tableName

tableName: string

vectorColumnName

vectorColumnName: string

Accessors

lc_aliases

get lc_aliases(): undefined | {
[key: string]: string;
}
A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

Returns undefined | {
[key: string]: string;
}
Inherited from VectorStore.lc_aliases
- Defined in langchain/src/load/serializable.ts:132

lc_attributes

get lc_attributes(): undefined | SerializedFields
A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

Returns undefined | SerializedFields
Inherited from VectorStore.lc_attributes
- Defined in langchain/src/load/serializable.ts:122

lc_id

get lc_id(): string[]
The final serialized identifier for the module.

Returns string[]
Inherited from VectorStore.lc_id
- Defined in langchain/src/load/serializable.ts:100

lc_secrets

get lc_secrets(): undefined | {
[key: string]: string;
}
A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

Returns undefined | {
[key: string]: string;
}
Inherited from VectorStore.lc_secrets
- Defined in langchain/src/load/serializable.ts:112

Methods

_vectorstoreType

_vectorstoreType(): string
Returns string
Overrides VectorStore._vectorstoreType
- Defined in langchain/src/vectorstores/singlestore.ts:99

addDocuments

addDocuments(documents): Promise<void>
Adds new documents to the SingleStoreDB database.
Parameters
- documents: Document<Record<string, any>>[]
  
  An array of Document objects.
Returns Promise<void>
Overrides VectorStore.addDocuments
- Defined in langchain/src/vectorstores/singlestore.ts:136

addVectors

addVectors(vectors, documents): Promise<void>
Adds new vectors to the SingleStoreDB database.
Parameters
- vectors: number[][]
  
  An array of vectors.
- documents: Document<Record<string, any>>[]
  
  An array of Document objects.
Returns Promise<void>
Overrides VectorStore.addVectors
- Defined in langchain/src/vectorstores/singlestore.ts:147

asRetriever

asRetriever(kOrFields?, filter?, callbacks?, tags?, metadata?, verbose?): VectorStoreRetriever<SingleStoreVectorStore>
Parameters
- Optional kOrFields: number | Partial<VectorStoreRetrieverInput<SingleStoreVectorStore>>
- Optional filter: string | object
- Optional callbacks: Callbacks
- Optional tags: string[]
- Optional metadata: Record<string, unknown>
- Optional verbose: boolean
Returns VectorStoreRetriever<SingleStoreVectorStore>
Inherited from VectorStore.asRetriever
- Defined in langchain/src/vectorstores/base.ts:246

createTableIfNotExists

createTableIfNotExists(): Promise<void>
Creates a new table in the SingleStoreDB database if it does not already exist.

Returns Promise<void>
- Defined in langchain/src/vectorstores/singlestore.ts:117

delete

delete(_params?): Promise<void>
Parameters
- Optional _params: Record<string, any>
Returns Promise<void>
Inherited from VectorStore.delete
- Defined in langchain/src/vectorstores/base.ts:164

end

end(): Promise<void>
Ends the connection to the SingleStoreDB database.

Returns Promise<void>
- Defined in langchain/src/vectorstores/singlestore.ts:128

similaritySearch

similaritySearch(query, k?, filter?, _callbacks?): Promise<Document<Record<string, any>>[]>
Parameters
- query: string
- k: number = 4
- filter: undefined | string | object = undefined
- _callbacks: undefined | Callbacks = undefined
Returns Promise<Document<Record<string, any>>[]>
Inherited from VectorStore.similaritySearch
- Defined in langchain/src/vectorstores/base.ts:174

similaritySearchVectorWithScore

similaritySearchVectorWithScore(query, k, filter?): Promise<[Document<Record<string, any>>, number][]>
Performs a similarity search on the vectors stored in the SingleStoreDB database.
Parameters
- query: number[]
  
  An array of numbers representing the query vector.
- k: number
  
  The number of nearest neighbors to return.
- Optional filter: Metadata
  
  Optional metadata to filter the vectors by.
Returns Promise<[Document<Record<string, any>>, number][]>
Top matching vectors with score
Overrides VectorStore.similaritySearchVectorWithScore
- Defined in langchain/src/vectorstores/singlestore.ts:179

similaritySearchWithScore

similaritySearchWithScore(query, k?, filter?, _callbacks?): Promise<[Document<Record<string, any>>, number][]>
Parameters
- query: string
- k: number = 4
- filter: undefined | string | object = undefined
- _callbacks: undefined | Callbacks = undefined
Returns Promise<[Document<Record<string, any>>, number][]>
Inherited from VectorStore.similaritySearchWithScore
- Defined in langchain/src/vectorstores/base.ts:189

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from VectorStore.toJSON
- Defined in langchain/src/load/serializable.ts:140

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from VectorStore.toJSONNotImplemented
- Defined in langchain/src/load/serializable.ts:214

`Optional` maxMarginalRelevanceSearch

maxMarginalRelevanceSearch(query, options, _callbacks): Promise<Document<Record<string, any>>[]>
Return documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.
Parameters
- query: string
  
  Text to look up documents similar to.
- options: MaxMarginalRelevanceSearchOptions<string | object>
- _callbacks: undefined | Callbacks
Returns Promise<Document<Record<string, any>>[]>
- List of documents selected by maximal marginal relevance.
Inherited from VectorStore.maxMarginalRelevanceSearch
- Defined in langchain/src/vectorstores/base.ts:217

`Static` fromDocuments

fromDocuments(docs, embeddings, dbConfig): Promise<SingleStoreVectorStore>
Creates a new instance of the SingleStoreVectorStore class from a list of Document objects.
Parameters
- docs: Document<Record<string, any>>[]
  
  An array of Document objects.
- embeddings: Embeddings
  
  An Embeddings object.
- dbConfig: SingleStoreVectorStoreConfig
  
  A SingleStoreVectorStoreConfig object.
Returns Promise<SingleStoreVectorStore>
A new SingleStoreVectorStore instance
Overrides VectorStore.fromDocuments
- Defined in langchain/src/vectorstores/singlestore.ts:285

`Static` fromTexts

fromTexts(texts, metadatas, embeddings, dbConfig): Promise<SingleStoreVectorStore>
Creates a new instance of the SingleStoreVectorStore class from a list of texts.
Parameters
- texts: string[]
  
  An array of strings.
- metadatas: object[]
  
  An array of metadata objects.
- embeddings: Embeddings
  
  An Embeddings object.
- dbConfig: SingleStoreVectorStoreConfig
  
  A SingleStoreVectorStoreConfig object.
Returns Promise<SingleStoreVectorStore>
A new SingleStoreVectorStore instance
Overrides VectorStore.fromTexts
- Defined in langchain/src/vectorstores/singlestore.ts:261

`Static` lc_name

lc_name(): string
The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

Implemented as a static method to support loading logic.

Returns string
Inherited from VectorStore.lc_name
- Defined in langchain/src/load/serializable.ts:93

Class SingleStoreVectorStore

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

embeddings: Embeddings

config: SingleStoreVectorStoreConfig

Returns SingleStoreVectorStore

Properties

FilterType

connectionPool

contentColumnName

distanceMetric

embeddings

lc_kwargs

lc_namespace

lc_serializable

metadataColumnName

tableName

vectorColumnName

Accessors

lc_aliases

Returns undefined | { [key: string]: string; }

lc_attributes

Returns undefined | SerializedFields

lc_id

Returns string[]

lc_secrets

Returns undefined | { [key: string]: string; }

Methods

_vectorstoreType

Returns string

addDocuments

Parameters

documents: Document<Record<string, any>>[]

Returns Promise<void>

addVectors

Parameters

vectors: number[][]

documents: Document<Record<string, any>>[]

Returns Promise<void>

asRetriever

Parameters

Optional kOrFields: number | Partial<VectorStoreRetrieverInput<SingleStoreVectorStore>>

Optional filter: string | object

Optional callbacks: Callbacks

Optional tags: string[]

Optional metadata: Record<string, unknown>

Optional verbose: boolean

Returns VectorStoreRetriever<SingleStoreVectorStore>

createTableIfNotExists

Returns Promise<void>

delete

Parameters

Optional _params: Record<string, any>

Returns Promise<void>

end

Returns Promise<void>

similaritySearch

Parameters

query: string

k: number = 4

filter: undefined | string | object = undefined

_callbacks: undefined | Callbacks = undefined

Returns Promise<Document<Record<string, any>>[]>

similaritySearchVectorWithScore

Parameters

query: number[]

k: number

Optional filter: Metadata

Returns Promise<[Document<Record<string, any>>, number][]>

similaritySearchWithScore

Parameters

query: string

k: number = 4

Returns undefined | {
[key: string]: string;
}

Returns undefined | {
[key: string]: string;
}

`Optional` kOrFields: number | Partial<VectorStoreRetrieverInput<SingleStoreVectorStore>>

`Optional` filter: string | object

`Optional` callbacks: Callbacks

`Optional` tags: string[]

`Optional` metadata: Record<string, unknown>

`Optional` verbose: boolean

`Optional` _params: Record<string, any>

`Optional` filter: Metadata

`Optional` maxMarginalRelevanceSearch

`Static` fromDocuments

`Static` fromTexts

`Static` lc_name