Class TigrisVectorStore

Class for managing and operating vector search applications with Tigris, an open-source Serverless NoSQL Database and Search Platform.

Hierarchy

VectorStore
- TigrisVectorStore

Index

Constructors

constructor

new TigrisVectorStore(embeddings, args): TigrisVectorStore
Parameters
- embeddings: Embeddings
- args: TigrisLibArgs
Returns TigrisVectorStore
Overrides VectorStore.constructor
- Defined in docs/api_refs/langchain/src/vectorstores/tigris.ts:29

Properties

FilterType

FilterType: string | object

embeddings

embeddings: Embeddings

`Optional` index

index?: any

Methods

addDocuments

addDocuments(documents, options?): Promise<void>
Method to add an array of documents to the Tigris database.
Parameters
- documents: Document<Record<string, any>>[]
  
  An array of Document instances to be added to the Tigris database.
- Optional options: string[] | {
  ids?: string[];
  }
  
  Optional parameter that can either be an array of string IDs or an object with a property 'ids' that is an array of string IDs.
Returns Promise<void>
A Promise that resolves when the documents have been added to the Tigris database.
Overrides VectorStore.addDocuments
- Defined in docs/api_refs/langchain/src/vectorstores/tigris.ts:42

addVectors

addVectors(vectors, documents, options?): Promise<void>
Method to add vectors to the Tigris database.
Parameters
- vectors: number[][]
  
  An array of vectors to be added to the Tigris database.
- documents: Document<Record<string, any>>[]
  
  An array of Document instances corresponding to the vectors.
- Optional options: string[] | {
  ids?: string[];
  }
  
  Optional parameter that can either be an array of string IDs or an object with a property 'ids' that is an array of string IDs.
Returns Promise<void>
A Promise that resolves when the vectors have been added to the Tigris database.
Overrides VectorStore.addVectors
- Defined in docs/api_refs/langchain/src/vectorstores/tigris.ts:61

asRetriever

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

delete

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

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 docs/api_refs/langchain/src/vectorstores/base.ts:180

similaritySearchVectorWithScore

similaritySearchVectorWithScore(query, k, filter?): Promise<[Document<Record<string, any>>, number][]>
Method to perform a similarity search in the Tigris database and return the k most similar vectors along with their similarity scores.
Parameters
- query: number[]
  
  The query vector.
- k: number
  
  The number of most similar vectors to return.
- Optional filter: object
  
  Optional filter object to apply during the search.
Returns Promise<[Document<Record<string, any>>, number][]>
A Promise that resolves to an array of tuples, each containing a Document and its similarity score.
Overrides VectorStore.similaritySearchVectorWithScore
- Defined in docs/api_refs/langchain/src/vectorstores/tigris.ts:94

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 docs/api_refs/langchain/src/vectorstores/base.ts:195

toJSON

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

toJSONNotImplemented

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

`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 docs/api_refs/langchain/src/vectorstores/base.ts:223

`Static` fromDocuments

fromDocuments(docs, embeddings, dbConfig): Promise<TigrisVectorStore>
Static method to create a new instance of TigrisVectorStore from an array of Document instances.
Parameters
- docs: Document<Record<string, any>>[]
  
  An array of Document instances to be added to the Tigris database.
- embeddings: Embeddings
  
  An instance of Embeddings to be used for embedding the documents.
- dbConfig: TigrisLibArgs
  
  An instance of TigrisLibArgs to be used for configuring the Tigris database.
Returns Promise<TigrisVectorStore>
A Promise that resolves to a new instance of TigrisVectorStore.
Overrides VectorStore.fromDocuments
- Defined in docs/api_refs/langchain/src/vectorstores/tigris.ts:154

`Static` fromExistingIndex

fromExistingIndex(embeddings, dbConfig): Promise<TigrisVectorStore>
Static method to create a new instance of TigrisVectorStore from an existing index.
Parameters
- embeddings: Embeddings
  
  An instance of Embeddings to be used for embedding the documents.
- dbConfig: TigrisLibArgs
  
  An instance of TigrisLibArgs to be used for configuring the Tigris database.
Returns Promise<TigrisVectorStore>
A Promise that resolves to a new instance of TigrisVectorStore.
- Defined in docs/api_refs/langchain/src/vectorstores/tigris.ts:171

`Static` fromTexts

fromTexts(texts, metadatas, embeddings, dbConfig): Promise<TigrisVectorStore>
Static method to create a new instance of TigrisVectorStore from an array of texts.
Parameters
- texts: string[]
  
  An array of texts to be converted into Document instances and added to the Tigris database.
- metadatas: object | object[]
  
  Either an array of metadata objects or a single metadata object to be associated with the texts.
- embeddings: Embeddings
  
  An instance of Embeddings to be used for embedding the texts.
- dbConfig: TigrisLibArgs
  
  An instance of TigrisLibArgs to be used for configuring the Tigris database.
Returns Promise<TigrisVectorStore>
A Promise that resolves to a new instance of TigrisVectorStore.
Overrides VectorStore.fromTexts
- Defined in docs/api_refs/langchain/src/vectorstores/tigris.ts:128

Class TigrisVectorStore

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

embeddings: Embeddings

args: TigrisLibArgs

Returns TigrisVectorStore

Properties

FilterType

embeddings

Optional index

Methods

addDocuments

Parameters

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

Optional options: string[] | { ids?: string[]; }

Returns Promise<void>

addVectors

Parameters

vectors: number[][]

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

Optional options: string[] | { ids?: string[]; }

Returns Promise<void>

asRetriever

Parameters

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

Optional filter: string | object

Optional callbacks: Callbacks

Optional tags: string[]

Optional metadata: Record<string, unknown>

Optional verbose: boolean

Returns VectorStoreRetriever<TigrisVectorStore>

delete

Parameters

Optional _params: Record<string, any>

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: object

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

similaritySearchWithScore

Parameters

query: string

k: number = 4

filter: undefined | string | object = undefined

_callbacks: undefined | Callbacks = undefined

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

toJSON

Returns Serialized

toJSONNotImplemented

Returns SerializedNotImplemented

Optional maxMarginalRelevanceSearch

Parameters

query: string

options: MaxMarginalRelevanceSearchOptions<string | object>

_callbacks: undefined | Callbacks

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

Static fromDocuments

Parameters

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

embeddings: Embeddings

dbConfig: TigrisLibArgs

Returns Promise<TigrisVectorStore>

Static fromExistingIndex

Parameters

embeddings: Embeddings

`Optional` index

`Optional` options: string[] | {
ids?: string[];
}

`Optional` options: string[] | {
ids?: string[];
}

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

`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: object

`Optional` maxMarginalRelevanceSearch

`Static` fromDocuments

`Static` fromExistingIndex

`Static` fromTexts