Class VoyVectorStore

Class that extends VectorStore. It allows to perform similarity search using Voi similarity search engine. The class requires passing Voy Client as an input parameter.

Hierarchy

VectorStore
- VoyVectorStore

Index

Constructors

constructor

new VoyVectorStore(client, embeddings): VoyVectorStore
Parameters
- client: VoyClient
- embeddings: EmbeddingsInterface
Returns VoyVectorStore
Overrides VectorStore.constructor
- Defined in libs/langchain-community/src/vectorstores/voy.ts:34

Properties

FilterType

FilterType: string | object

client

client: VoyClient

docstore

docstore: InternalDoc[] = []

embeddings

embeddings: EmbeddingsInterface

numDimensions

numDimensions: null | number = null

Methods

addDocuments

addDocuments(documents): Promise<void>
Adds documents to the Voy database. The documents are embedded using embeddings provided while instantiating the class.
Parameters
- documents: Document<Record<string, any>>[]
  
  An array of Document instances associated with the vectors.
Returns Promise<void>
Overrides VectorStore.addDocuments
- Defined in libs/langchain-community/src/vectorstores/voy.ts:44

addVectors

addVectors(vectors, documents): Promise<void>
Adds vectors to the Voy database. The vectors are associated with the provided documents.
Parameters
- vectors: number[][]
  
  An array of vectors to be added to the database.
- documents: Document<Record<string, any>>[]
  
  An array of Document instances associated with the vectors.
Returns Promise<void>
Overrides VectorStore.addVectors
- Defined in libs/langchain-community/src/vectorstores/voy.ts:70

asRetriever

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

delete

delete(params): Promise<void>
Method to delete data from the Voy index. It can delete data based on specific IDs or a filter.
Parameters
- params: {
  deleteAll?: boolean;
  }
  
  Object that includes either an array of IDs or a filter for the data to be deleted.
  - Optional deleteAll?: boolean
Returns Promise<void>
Promise that resolves when the deletion is complete.
Overrides VectorStore.delete
- Defined in libs/langchain-community/src/vectorstores/voy.ts:138

similaritySearch

similaritySearch(query, k?, filter?, _callbacks?): Promise<DocumentInterface<Record<string, any>>[]>
Parameters
- query: string
- Optional k: number
- Optional filter: string | object
- Optional _callbacks: Callbacks
Returns Promise<DocumentInterface<Record<string, any>>[]>
Inherited from VectorStore.similaritySearch
- Defined in langchain-core/dist/vectorstores.d.ts:106

similaritySearchVectorWithScore

similaritySearchVectorWithScore(query, k): Promise<[Document<Record<string, any>>, number][]>
Searches for vectors in the Voy database that are similar to the provided query vector.
Parameters
- query: number[]
  
  The query vector.
- k: number
  
  The number of similar vectors to return.
Returns Promise<[Document<Record<string, any>>, number][]>
A promise that resolves with an array of tuples, each containing a Document instance and a similarity score.
Overrides VectorStore.similaritySearchVectorWithScore
- Defined in libs/langchain-community/src/vectorstores/voy.ts:107

similaritySearchWithScore

similaritySearchWithScore(query, k?, filter?, _callbacks?): Promise<[DocumentInterface<Record<string, any>>, number][]>
Parameters
- query: string
- Optional k: number
- Optional filter: string | object
- Optional _callbacks: Callbacks
Returns Promise<[DocumentInterface<Record<string, any>>, number][]>
Inherited from VectorStore.similaritySearchWithScore
- Defined in langchain-core/dist/vectorstores.d.ts:107

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from VectorStore.toJSON
- Defined in langchain-core/dist/load/serializable.d.ts:64

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from VectorStore.toJSONNotImplemented
- Defined in langchain-core/dist/load/serializable.d.ts:65

`Optional` maxMarginalRelevanceSearch

maxMarginalRelevanceSearch(query, options, _callbacks): Promise<DocumentInterface<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<DocumentInterface<Record<string, any>>[]>
- List of documents selected by maximal marginal relevance.
Inherited from VectorStore.maxMarginalRelevanceSearch
- Defined in langchain-core/dist/vectorstores.d.ts:123

`Static` fromDocuments

fromDocuments(docs, embeddings, client): Promise<VoyVectorStore>
Creates a new VoyVectorStore instance from an array of Document instances. The documents are added to the Voy database.
Parameters
- docs: Document<Record<string, any>>[]
  
  An array of Document instances.
- embeddings: EmbeddingsInterface
  
  An Embeddings instance used to generate embeddings for the documents.
- client: VoyClient
  
  An instance of Voy client to use in the underlying operations.
Returns Promise<VoyVectorStore>
A promise that resolves with a new VoyVectorStore instance.
Overrides VectorStore.fromDocuments
- Defined in libs/langchain-community/src/vectorstores/voy.ts:182

`Static` fromTexts

fromTexts(texts, metadatas, embeddings, client): Promise<VoyVectorStore>
Creates a new VoyVectorStore instance from an array of text strings. The text strings are converted to Document instances and added to the Voy database.
Parameters
- texts: string[]
  
  An array of text strings.
- metadatas: object | object[]
  
  An array of metadata objects or a single metadata object. If an array is provided, it must have the same length as the texts array.
- embeddings: EmbeddingsInterface
  
  An Embeddings instance used to generate embeddings for the documents.
- client: VoyClient
  
  An instance of Voy client to use in the underlying operations.
Returns Promise<VoyVectorStore>
A promise that resolves with a new VoyVectorStore instance.
Overrides VectorStore.fromTexts
- Defined in libs/langchain-community/src/vectorstores/voy.ts:156

Class VoyVectorStore

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: VoyClient

embeddings: EmbeddingsInterface

Returns VoyVectorStore

Properties

FilterType

client

docstore

embeddings

numDimensions

Methods

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<VoyVectorStore>>

Optional filter: string | object

Optional callbacks: Callbacks

Optional tags: string[]

Optional metadata: Record<string, unknown>

Optional verbose: boolean

Returns VectorStoreRetriever<VoyVectorStore>

delete

Parameters

params: { deleteAll?: boolean; }

Optional deleteAll?: boolean

Returns Promise<void>

similaritySearch

Parameters

query: string

Optional k: number

Optional filter: string | object

Optional _callbacks: Callbacks

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

similaritySearchVectorWithScore

Parameters

query: number[]

k: number

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

similaritySearchWithScore

Parameters

query: string

Optional k: number

Optional filter: string | object

Optional _callbacks: Callbacks

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

toJSON

Returns Serialized

toJSONNotImplemented

Returns SerializedNotImplemented

Optional maxMarginalRelevanceSearch

Parameters

query: string

options: MaxMarginalRelevanceSearchOptions<string | object>

_callbacks: undefined | Callbacks

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

Static fromDocuments

Parameters

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

embeddings: EmbeddingsInterface

client: VoyClient

Returns Promise<VoyVectorStore>

Static fromTexts

Parameters

texts: string[]

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

`Optional` filter: string | object

`Optional` callbacks: Callbacks

`Optional` tags: string[]

`Optional` metadata: Record<string, unknown>

`Optional` verbose: boolean

params: {
deleteAll?: boolean;
}

`Optional` deleteAll?: boolean

`Optional` k: number

`Optional` filter: string | object

`Optional` _callbacks: Callbacks

`Optional` k: number

`Optional` filter: string | object

`Optional` _callbacks: Callbacks

`Optional` maxMarginalRelevanceSearch

`Static` fromDocuments

`Static` fromTexts