Class Typesense

Typesense vector store.

Hierarchy

VectorStore
- Typesense

Index

Constructors

constructor

new Typesense(embeddings, config): Typesense
Parameters
- embeddings: Embeddings
- config: TypesenseConfig
Returns Typesense
Overrides VectorStore.constructor
- Defined in docs/api_refs/langchain/src/vectorstores/typesense.ts:99

Properties

FilterType

FilterType: Partial<MultiSearchRequestSchema>

embeddings

embeddings: Embeddings

Methods

addDocuments

addDocuments(documents): Promise<void>
Add documents to the vector store. Will be updated if in the metadata there is a document with the same id if is using the default import function. Metadata will be added in the columns of the schema based on metadataColumnNames.
Parameters
- documents: Document<Record<string, any>>[]
  
  Documents to add.
Returns Promise<void>
Overrides VectorStore.addDocuments
- Defined in docs/api_refs/langchain/src/vectorstores/typesense.ts:206

addVectors

addVectors(vectors, documents): Promise<void>
Adds vectors to the vector store.
Parameters
- vectors: number[][]
  
  Vectors to add.
- documents: Document<Record<string, any>>[]
  
  Documents associated with the vectors.
Returns Promise<void>
Overrides VectorStore.addVectors
- Defined in docs/api_refs/langchain/src/vectorstores/typesense.ts:221

asRetriever

asRetriever(kOrFields?, filter?, callbacks?, tags?, metadata?, verbose?): VectorStoreRetriever<Typesense>
Parameters
- Optional kOrFields: number | Partial<VectorStoreRetrieverInput<Typesense>>
- Optional filter: Partial<MultiSearchRequestSchema>
- Optional callbacks: Callbacks
- Optional tags: string[]
- Optional metadata: Record<string, unknown>
- Optional verbose: boolean
Returns VectorStoreRetriever<Typesense>
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

deleteDocuments

deleteDocuments(documentIds): Promise<void>
Delete documents from the vector store.
Parameters
- documentIds: string[]
  
  ids of the documents to delete
Returns Promise<void>
- Defined in docs/api_refs/langchain/src/vectorstores/typesense.ts:272

similaritySearch

similaritySearch(query, k?, filter?, _callbacks?): Promise<Document<Record<string, any>>[]>
Parameters
- query: string
- k: number = 4
- filter: undefined | Partial<MultiSearchRequestSchema> = 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(vectorPrompt, k?, filter?): Promise<[Document<Record<string, any>>, number][]>
Search for similar documents with their similarity score.
Parameters
- vectorPrompt: number[]
  
  vector to search for
- Optional k: number
  
  amount of results to return
- filter: Partial<MultiSearchRequestSchema> = {}
Returns Promise<[Document<Record<string, any>>, number][]>
similar documents with their similarity score
Overrides VectorStore.similaritySearchVectorWithScore
- Defined in docs/api_refs/langchain/src/vectorstores/typesense.ts:235

similaritySearchWithScore

similaritySearchWithScore(query, k?, filter?, _callbacks?): Promise<[Document<Record<string, any>>, number][]>
Parameters
- query: string
- k: number = 4
- filter: undefined | Partial<MultiSearchRequestSchema> = 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<Partial<MultiSearchRequestSchema>>
- _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, config): Promise<Typesense>
Create a vector store from documents.
Parameters
- docs: Document<Record<string, any>>[]
  
  documents
- embeddings: Embeddings
  
  embeddings
- config: TypesenseConfig
  
  Typesense configuration
Returns Promise<Typesense>
Typesense vector store

Warning
You can omit this method, and only use the constructor and addDocuments.
Overrides VectorStore.fromDocuments
- Defined in docs/api_refs/langchain/src/vectorstores/typesense.ts:289

`Static` fromTexts

fromTexts(texts, metadatas, embeddings, config): Promise<Typesense>
Create a vector store from texts.
Parameters
- texts: string[]
- metadatas: object[]
- embeddings: Embeddings
- config: TypesenseConfig
Returns Promise<Typesense>
Typesense vector store
Overrides VectorStore.fromTexts
- Defined in docs/api_refs/langchain/src/vectorstores/typesense.ts:308

Class Typesense

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

embeddings: Embeddings

config: TypesenseConfig

Returns Typesense

Properties

FilterType

embeddings

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

Optional filter: Partial<MultiSearchRequestSchema>

Optional callbacks: Callbacks

Optional tags: string[]

Optional metadata: Record<string, unknown>

Optional verbose: boolean

Returns VectorStoreRetriever<Typesense>

delete

Parameters

Optional _params: Record<string, any>

Returns Promise<void>

deleteDocuments

Parameters

documentIds: string[]

Returns Promise<void>

similaritySearch

Parameters

query: string

k: number = 4

filter: undefined | Partial<MultiSearchRequestSchema> = undefined

_callbacks: undefined | Callbacks = undefined

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

similaritySearchVectorWithScore

Parameters

vectorPrompt: number[]

Optional k: number

filter: Partial<MultiSearchRequestSchema> = {}

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

similaritySearchWithScore

Parameters

query: string

k: number = 4

filter: undefined | Partial<MultiSearchRequestSchema> = 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<Partial<MultiSearchRequestSchema>>

_callbacks: undefined | Callbacks

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

Static fromDocuments

Parameters

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

embeddings: Embeddings

config: TypesenseConfig

Returns Promise<Typesense>

Warning

Static fromTexts

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

`Optional` filter: Partial<MultiSearchRequestSchema>

`Optional` callbacks: Callbacks

`Optional` tags: string[]

`Optional` metadata: Record<string, unknown>

`Optional` verbose: boolean

`Optional` _params: Record<string, any>

`Optional` k: number

`Optional` maxMarginalRelevanceSearch

`Static` fromDocuments

`Static` fromTexts