Skip to content

@tyravel/vector

Embedding storage and vector similarity search for Tyravel

Install

bash
npm install @tyravel/vector

Metadata

FieldValue
Version1.0.1
Sourcepackages/vector
CategoryAI & agents
Node.js>=26

Tyravel dependencies

Public exports

From the package entry point (dist/index.d.ts). Deep imports are not supported.

Values

  • ChunkTextOptions
  • EmbedChunksJob
  • EmbedChunksPayload
  • EmbeddingCacheOptions
  • EmbeddingFormatter
  • MemoryVectorSearchDriver
  • MemoryVectorStore
  • MetadataFilter
  • MetadataFilterOperator
  • SqliteVectorSearchDriver
  • VectorSearch
  • VectorSearchDriver
  • blendHybridScore
  • chunkText
  • clearEmbedModels
  • cosineDistance
  • createCachedEmbedFn
  • distanceToScore
  • embeddingCacheKey
  • finalizeVectorResults
  • formatEmbeddingForStorage
  • getVectorSearchDriver
  • innerProductDistance
  • l2Distance
  • matchesMetadataFilters
  • nearestOnBuilder
  • parseMetadataColumn
  • registerEmbedModel
  • registerInMemoryVectorSearchDriver
  • registerLocalVectorSearchDriver
  • registerModelVectorSearch
  • registerSqliteVectorSearchDriver
  • registerVectorSearchDriver
  • resetEmbeddingFormatter
  • resolveEmbedModel
  • scopeNearest
  • searchVectors
  • setEmbedChunksHandler
  • setEmbeddingFormatter
  • similarTo
  • textMatchScore
  • vectorDistance

Types

  • EmbedFn
  • Embedding
  • VectorMetric
  • VectorRecord
  • VectorSearchOptions

Guide

See the Getting started guide for usage examples.

Released under the MIT License.