orama下载 - orama源码下载

如果您需要更多信息、帮助或想要提供有关 Orama 的一般反馈，请加入 Orama Slack 频道

突出特点

全文搜索
矢量搜索
混合搜索
GenAI 聊天会话
搜索过滤器
地理搜索
刻面
场增强
错字容忍度
精确匹配
BM25
30 种语言的词干分析和标记化
插件系统

安装

您可以使用npm 、 yarn 、 pnpm 、 bun安装 Orama ：

npm i @orama/orama

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

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

使用 Deno，您可以使用相同的 CDN URL 或使用 npm 说明符：

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

请阅读 https://docs.orama.com 上的完整文档。

奥拉玛特色

用法

Orama 使用起来非常简单。首先要做的是创建一个新的数据库实例并设置索引架构：

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

const db = create ( {
  schema : {
    name : 'string' ,
    description : 'string' ,
    price : 'number' ,
    embedding : 'vector[1536]' , // Vector size must be expressed during schema initialization
    meta : {
      rating : 'number' ,
    } ,
  } ,
} )

insert ( db , {
  name : 'Noise cancelling headphones' ,
  description : 'Best noise cancelling headphones on the market' ,
  price : 99.99 ,
  embedding : [ 0.2432 , 0.9431 , 0.5322 , 0.4234 , ... ] ,
  meta : {
    rating : 4.5
  }
} )

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

// {
//   elapsed: {
//     raw: 21492,
//     formatted: '21μs',
//   },
//   hits: [
//     {
//       id: '41013877-56',
//       score: 0.925085832971998432,
//       document: {
//         name: 'Noise cancelling headphones',
//         description: 'Best noise cancelling headphones on the market',
//         price: 99.99,
//         embedding: [0.2432, 0.9431, 0.5322, 0.4234, ...],
//         meta: {
//           rating: 4.5
//         }
//       }
//     }
//   ],
//   count: 1
// }

Orama 目前支持 10 种不同的数据类型：

类型	描述	例子
`string`	一串字符。	`'Hello world'`
`number`	数值，可以是浮点数或整数。	`42`
`boolean`	一个布尔值。	`true`
`enum`	一个枚举值。	`'drama'`
`geopoint`	地理点值。	`{ lat: 40.7128, lon: 74.0060 }`
`string[]`	字符串数组。	`['red', 'green', 'blue']`
`number[]`	数字数组。	`[42, 91, 28.5]`
`boolean[]`	布尔值数组。	`[true, false, false]`
`enum[]`	枚举数组。	`['comedy', 'action', 'romance']`
`vector[<size>]`	要执行向量搜索的数字向量。	`[0.403, 0.192, 0.830]`

矢量和混合搜索支持

Orama 支持矢量搜索和混合搜索，只需在执行搜索时设置mode: 'vector'即可。

要执行此类搜索，您需要在搜索时提供文本嵌入：

 import { create , insertMultiple , search } from '@orama/orama'

const db = create ( {
  schema : {
    title : 'string' ,
    embedding : 'vector[5]' ' , // we are using a 5-dimensional vector.
  } ,
} ) ;

insertMultiple ( db , [
  { title : 'The Prestige' , embedding : [ 0.938293 , 0.284951 , 0.348264 , 0.948276 , 0.56472 ] } ,
  { title : 'Barbie' , embedding : [ 0.192839 , 0.028471 , 0.284738 , 0.937463 , 0.092827 ] } ,
  { title : 'Oppenheimer' , embedding : [ 0.827391 , 0.927381 , 0.001982 , 0.983821 , 0.294841 ] } ,
] )

const results = search ( db , {
  // Search mode. Can be 'vector', 'hybrid', or 'fulltext'
  mode : 'vector' ,
  vector : {
    // The vector (text embedding) to use for search
    value : [ 0.938292 , 0.284961 , 0.248264 , 0.748276 , 0.26472 ] ,
    // The schema property where Orama should compare embeddings
    property : 'embedding' ,
  } ,
  // Minimum similarity to determine a match. Defaults to `0.8`
  similarity : 0.85 ,
  // Defaults to `false`. Setting to 'true' will return the embeddings in the response (which can be very large).
  includeVectors : true ,
} )

为向量和混合搜索生成嵌入时遇到问题？尝试我们的@orama/plugin-embeddings插件！

 import { create } from '@orama/orama'
import { pluginEmbeddings } from '@orama/plugin-embeddings'
import '@tensorflow/tfjs-node' // Or any other appropriate TensorflowJS backend, like @tensorflow/tfjs-backend-webgl

const plugin = await pluginEmbeddings ( {
  embeddings : {
    // Schema property used to store generated embeddings
    defaultProperty : 'embeddings' ,
    onInsert : {
      // Generate embeddings at insert-time
      generate : true ,
      // properties to use for generating embeddings at insert time.
      // Will be concatenated to generate a unique embedding.
      properties : [ 'description' ] ,
      verbose : true ,
    }
  }
} )

const db = create ( {
  schema : {
    description : 'string' ,
    // Orama generates 512-dimensions vectors.
    // When using @orama/plugin-embeddings, set the property where you want to store embeddings as `vector[512]`.
    embeddings : 'vector[512]'
  } ,
  plugins : [ plugin ]
} )

// Orama will generate and store embeddings at insert-time!
await insert ( db , { description : 'Classroom Headphones Bulk 5 Pack, Student On Ear Color Varieties' } )
await insert ( db , { description : 'Kids Wired Headphones for School Students K-12' } )
await insert ( db , { description : 'Kids Headphones Bulk 5-Pack for K-12 School' } )
await insert ( db , { description : 'Bose QuietComfort Bluetooth Headphones' } )

// Orama will also generate and use embeddings at search time when search mode is set to "vector" or "hybrid"!
const searchResults = await search ( db , {
  term : 'Headphones for 12th grade students' ,
  mode : 'vector'
} )

想要使用 OpenAI 嵌入模型？使用我们的安全代理插件从客户端安全地调用 OpenAI。

RAG 和 Orama 的聊天体验

从v3.0.0开始，Orama 允许您创建自己的类似 ChatGPT/Perplexity/SearchGPT 的体验。您将需要调用 OpenAI API，因此我们强烈建议使用安全代理插件从客户端安全地执行此操作。它是免费的！

 import { create , insert } from '@orama/orama'
import { pluginSecureProxy } from '@orama/plugin-secure-proxy'

const secureProxy = await pluginSecureProxy ( {
  apiKey : 'my-api-key' ,
  defaultProperty : 'embeddings' ,
  models : {
    // The chat model to use to generate the chat answer
    chat : 'openai/gpt-4o-mini'
  }
} )

const db = create ( {
  schema : {
    name : 'string'
  } ,
  plugins : [ secureProxy ]
} )

insert ( db , { name : 'John Doe' } )
insert ( db , { name : 'Jane Doe' } )

const session = new AnswerSession ( db , {
  // Customize the prompt for the system
  systemPrompt : 'You will get a name as context, please provide a greeting message' ,
  events : {
    // Log all state changes. Useful to reactively update a UI on a new message chunk, sources, etc.
    onStateChange : console . log ,
  }
} )

const response = await session . ask ( {
  term : 'john'
} )

console . log ( response ) // Hello, John Doe! How are you doing?