Orama搜索引擎使用教程

Orama搜索引擎使用教程

orama 🌌 Fast, in-memory, typo-tolerant, full-text and vector search engine in <2kb. 项目地址: https://gitcode.com/gh_mirrors/or/orama

1. 项目介绍

Orama是一个功能强大的搜索引擎，它支持全文搜索、向量搜索和混合搜索，可以在浏览器、服务器或边缘网络中使用。Orama的特点是轻量级，核心功能不到2KB，同时支持多种数据类型和语言。

2. 项目快速启动

以下是Orama的快速启动步骤，包括如何创建数据库实例、设置索引模式以及进行搜索。

安装Orama

可以通过npm、yarn、pnpm或bun安装Orama：

npm i @orama/orama

或者在浏览器中直接导入：

<script type="module">
import { create, insert, search } from 'https://cdn.jsdelivr.net/npm/@orama/orama@latest/+esm';
</script>

创建数据库实例和索引模式

首先，创建一个数据库实例并设置索引模式：

import { create, insert, search } from '@orama/orama';

const db = create({
  schema: {
    name: 'string',
    description: 'string',
    price: 'number',
    embedding: 'vector[1536]',
    meta: {
      rating: 'number'
    }
  }
});

插入数据

接下来，插入一些数据到数据库中：

insert(db, {
  name: 'Noise cancelling headphones',
  description: 'Best noise cancelling headphones on the market',
  price: 99.99,
  embedding: [/* 嵌入向量数据 */],
  meta: {
    rating: 4.5
  }
});

搜索数据

最后，执行一个搜索查询：

const results = search(db, {
  term: 'Best headphones'
});

3. 应用案例和最佳实践

以下是使用Orama的一些应用案例和最佳实践：

• 全文搜索：适用于快速检索文本内容，例如搜索产品描述。
• 向量搜索：适用于复杂的语义搜索，比如根据文本嵌入向量找到相似的内容。
• 混合搜索：结合全文和向量搜索的优势，适用于需要同时考虑文本内容和语义的场景。

4. 典型生态项目

Orama的生态系统中有一些典型的项目，可以帮助开发者更好地集成和使用Orama：

• @orama/plugin-embeddings：用于生成文本嵌入向量。
• @orama/plugin-secure-proxy：允许安全地从客户端调用OpenAI API。

以上就是Orama搜索引擎的基本使用教程。通过这些步骤，您可以快速开始使用Orama来构建强大的搜索功能。

orama 🌌 Fast, in-memory, typo-tolerant, full-text and vector search engine in <2kb. 项目地址: https://gitcode.com/gh_mirrors/or/orama