vector-storage

vector-storage

轻量的浏览器向量数据库,用于语义相似度文本搜索

Vector Storage 是一个高效轻量的向量数据库,通过浏览器的 IndexedDB 存储文档向量。利用 OpenAI 嵌入技术,该工具将文本文档转换为向量,并基于余弦相似度进行相似文档搜索。主要功能包括文档向量存储管理、基于元数据和内容的搜索过滤、自动管理存储大小及使用 LRU 机制。简单易用,适用于需要高效文本检索的场景。

Vector Storage相似性搜索OpenAI嵌入余弦相似度IndexedDBGithub开源项目

项目介绍:Vector Storage

Vector Storage 是一个轻量级且高效的向量数据库,它将文档向量存储在浏览器的 IndexedDB 中。通过使用向量嵌入,Vector Storage 能够对文本文档执行语义相似性搜索。语义搜索指的是理解文本文档和查询的含义和上下文,从而实现更准确和相关的搜索结果。为了实现这一点,该项目利用 OpenAI 的嵌入技术将文本转化为向量,并提供一个界面来基于余弦相似性进行相似文档的搜索。

功能特性

  • 在 IndexedDB 中存储和管理文档向量
  • 对文本文档进行相似性搜索
  • 可以根据元数据或文本内容筛选搜索结果
  • 自动管理存储空间大小,同时在空间限制达到时移除最近最少使用的文档

余弦相似性算法

余弦相似性是内积空间中两个非零向量之间相似度的度量,定义为两个向量之间夹角的余弦值。其取值范围从 -1 到 1,其中 1 表示完全相似,0 表示无相似性,-1 表示完全不相似。在 Vector Storage 中,余弦相似性用于衡量文档向量与查询向量之间的相似度。余弦相似性分数是通过计算向量的点积并除以其幅度的乘积得到的。

LRU 机制

项目使用了最近最少使用(Least Recently Used,简称 LRU)机制来管理存储空间大小。当存储空间超过指定限制时,自动移除文档。文档根据其访问次数(hit count)和时间戳(timestamp)升序排序,访问次数最低且时间戳最早的文档首先被移除,直到空间大小低于限制。

安装方法

通过 npm 安装此包:

npm i vector-storage

使用方法

以下是如何使用 VectorStorage 类的基本示例:

import { VectorStorage } from "vector-storage"; // 创建 VectorStorage 实例 const vectorStore = new VectorStorage({ openAIApiKey: "your-openai-api-key" }); // 将文本文档添加到存储中 await vectorStore.addText("The quick brown fox jumps over the lazy dog.", { category: "example", }); // 执行相似性搜索 const results = await vectorStore.similaritySearch({ query: "A fast fox leaps over a sleepy hound.", }); // 显示搜索结果 console.log(results);

API 说明

VectorStorage 类

用于在 IndexedDB 中管理文档向量的主类。

constructor(options: IVSOptions)

创建一个新的 VectorStorage 实例。

  • options: 包含以下属性的对象:
interface IVSOptions { openAIApiKey: string; // 用于生成嵌入的 OpenAI API 密钥。 maxSizeInMB?: number; // 存储的最大大小,以MB为单位。默认为 2GB。 debounceTime?: number; // 保存到 IndexedDB 的防抖时间,以毫秒为单位。默认为 0。 openaiModel?: string; // 用于生成嵌入的 OpenAI 模型。默认为 'text-embedding-ada-002'。 }
addText(text: string, metadata: object): Promise<IVSDocument>

将文本文档添加到存储中,并返回创建的文档。

  • text: 文档的文本内容。
  • metadata: 与文档相关联的元数据对象。
similaritySearch(params: ISimilaritySearchParams): Promise<IVSDocument[]>

对存储的文档执行相似性搜索,并返回匹配文档的数组。

  • params: 包含以下属性的对象:
interface ISimilaritySearchParams { query: string | number[]; // 用于搜索的查询文本或向量。 k?: number; // 返回的前 k 个结果的数量(默认:4)。 filterOptions?: object; // 搜索的筛选条件。 }

贡献指南

欢迎大家对这个项目做出贡献!如果您有意贡献,请按照以下步骤操作:

  1. 在 GitHub 上 fork 此仓库。
  2. 克隆您的 fork 到本地机器。
  3. 为自己的修改创建一个新的分支。
  4. 在分支中进行修改,并提交更改。
  5. 将更改推送到 GitHub 上的 fork。
  6. 从您的分支向主仓库发起 pull request。

请确保您的代码遵循项目的编码风格,并在提交 pull request 之前通过所有测试。如果发现任何错误或有改进建议,欢迎在 GitHub 上提出 issue。

许可证

该项目采用 MIT 许可证。请查看 LICENSE 文件以获取完整的许可证文本。

版权所有 (c) Nitai Aharoni。保留所有权利。

编辑推荐精选

TRAE编程

TRAE编程

AI辅助编程,代码自动修复

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多