项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-10-02 · 当前星标 ★ 10608
使用教程
环境要求
- 支持 ESM 的 JavaScript 运行环境(Node.js、浏览器或 Deno)
- 已安装 npm、yarn、pnpm、bun 中任一包管理器
- 无需部署外部服务或数据库,数据可完全本地化
安装与启动步骤
-
1安装 Orama 包
在项目目录中安装 @orama/orama,核心包体积极小,可选 npm、yarn、pnpm 或 bun。
npm i @orama/orama -
2创建实例与 schema
用 create() 初始化数据库并声明索引字段与类型;向量字段必须写成 vector[维度] 并在初始化时确定。
import { create } from '@orama/orama' const db = create({ schema: { name: 'string', description: 'string', price: 'number', embedding: 'vector[1536]', meta: { rating: 'number', }, }, }) -
3插入文档数据
用 insert() 写入文档,字段需与 schema 对应;若含向量字段,需传入与声明维度完全一致的数组。
import { insert, remove } from '@orama/orama' insert(db, { name: 'Noise cancelling headphones', description: 'Best noise cancelling headphones on the market', price: 99.99, meta: { rating: 4.5 }, // 若 schema 声明了 embedding,此处需传入 1536 个数字的数组 }) -
4执行搜索查询
调用 search() 传入 term 做全文检索,返回值包含 hits、count 和查询耗时 elapsed。
import { search } from '@orama/orama' const results = search(db, { term: 'Best headphones', }) console.log(results) -
5浏览器直接引入
不想打包时,可在 HTML 里用 type="module" 的 script 从 jsDelivr CDN 直接 import 使用。
<script type="module"> import { create, insert, search } from 'https://cdn.jsdelivr.net/npm/@orama/orama@latest/+esm' </script> -
6Deno 环境引入
在 Deno 中可复用同一 CDN 地址,也可直接用 npm: 说明符导入包。
import { create, search, insert } from 'npm:@orama/orama'
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
schema | 是 | create() 时声明索引字段名与数据类型,决定可检索内容 | schema: { name: 'string', price: 'number' } |
vector[<size>] | 否 | 向量字段类型,维度必须在 schema 初始化时写死用于向量检索 | embedding: 'vector[1536]' |
term | 是 | search() 的查询关键词,即用户输入的检索词 | term: 'Best headphones' |
如何确认成功
运行脚本后 search 返回的 hits 数组包含刚插入的文档、count 为预期数量,说明索引与检索已正常工作。
常见问题
Q:需要单独部署服务或数据库吗?
A:不需要。Orama 是纯 TypeScript 库,无外部依赖,可直接跑在浏览器、Node.js 或边缘网络,数据完全本地化。
Q:有哪些安装方式?
A:支持 npm、yarn、pnpm、bun;浏览器可通过 jsDelivr CDN 以 ES module 引入,Deno 可用 npm: 说明符导入。
Q:向量检索怎么写?
A:在 schema 中声明 vector[维度] 字段并写入等长向量,再调用 searchVector 查询;维度必须在初始化时确定。
Q:支持哪些字段类型?
A:string、number、boolean、enum、geopoint 及对应的数组类型,加上 vector[size],README 称共 10 种。
注意事项
- README 未给出 Node.js 最低版本要求,请使用支持 ESM 的较新版本。
- 向量字段维度必须在 schema 初始化时声明,写入数据维度不一致会出错。
- CDN 引入使用 @latest,生产环境建议锁定具体版本号。
- 内置拼写容错、前缀匹配,以及 30 种语言的分词与词干处理(README 提及)。
核心亮点
- 核心包小于 2KB,适合浏览器和边缘函数等资源受限环境
- 同时支持全文、向量和混合搜索,一套 API 覆盖多种检索需求
- 内置拼写容错、前缀匹配、多语言分词,开箱即用无需额外依赖
不足之处
- 超大规模数据集的索引与查询性能未在文档中充分说明,需自行压测
- 生态和插件数量相比 Elasticsearch 等成熟方案仍较少
适用场景
- 在纯前端应用中实现离线可用的站内搜索
- 在边缘函数中为 RAG 应用提供低延迟向量检索
- 为文档、笔记类工具添加本地全文与语义混合搜索
替代项目
Meilisearch、Typesense
上一篇:crypto-rag
同类项目推荐
Awesome-Generative-Recommendatio···
开源
一页看懂生成式推荐工业落地论文脉络
Awesome Generative Recommendation papers primarily focused on industry-level applica···
distil-text2sql
开源
用大白话问数据库,自动出 SQL 和结果
Query your data in plain English with a fine-tuned Text2SQL model
second-brain-os
开源
让 AI 自动整理 Obsidian 笔记,知识库自己长大
Guides and resources for AI engineers: an agents course, five handbooks, a hands-on ···
JustSearch
开源
让 AI 自动拆解搜索任务,深度阅读网页,带来源汇总答案
基于 Chrome 扩展桥接的自主 AI 搜索智能体。支持迭代式任务规划、真机深度网页阅读,以及···
OpenDocuments
开源
连接多源文档,自托管 AI 问答,答案带引用。
Self-hosted RAG platform for AI document search across GitHub, Notion, Google Drive,···
nucliadb
开源
把任意数据变成可搜索的 AI 知识库,快速搭建 RAG 应用。
NucliaDB, The AI Search database for RAG
lizheng-open-context
开源
把立正公开内容变成可溯源的 AI 上下文库
Source-grounded public context for 立正: Superlinear posts, selected comments, YouTu···
reor
开源
本地AI自动关联笔记,让知识自动浮现
Private & local AI personal knowledge management app for high entropy people.
Lore
开源
一键唤起,本地 AI 帮你整理并检索所有记忆。
Summon it with a keystroke, throw in anything you want to remember or ask your own m···
