Class Typesense

embeddings

lc_kwargs

lc_namespace

lc_serializable

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;
  }

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

lc_id

• get lc_id(): string[]

• The final serialized identifier for the module.

  Returns string[]

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;
  }

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>

delete

• delete(_params?): Promise<void>

• Parameters

  • Optional _params: Record<string, any>

  Returns Promise<void>

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>>[]>

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][]>

toJSON

• toJSON(): Serialized

• Returns Serialized

toJSONNotImplemented

• toJSONNotImplemented(): SerializedNotImplemented

• Returns SerializedNotImplemented

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.

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