Download orama - download do código-fonte orama

Se precisar de mais informações, ajuda ou quiser fornecer feedback geral sobre o Orama, entre no canal Orama Slack

Recursos destacados

Pesquisa de texto completo
Pesquisa vetorial
Pesquisa Híbrida
Sessões de bate-papo GenAI
Filtros de pesquisa
Pesquisa geográfica
Facetas
Impulsionamento de campos
Tolerância a erros de digitação
Correspondência exata
BM25
Lematização e tokenização em 30 idiomas
Sistema de plug-ins

Instalação

Você pode instalar o Orama usando npm , yarn , pnpm , bun :

npm i @orama/orama

Ou importe-o diretamente em um módulo do navegador:

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

Com Deno, você pode simplesmente usar o mesmo URL CDN ou usar especificadores npm:

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

Leia a documentação completa em https://docs.orama.com.

Recursos do Orama

Uso

Orama é bastante simples de usar. A primeira coisa a fazer é criar uma nova instância de banco de dados e definir um esquema de indexação:

 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 atualmente oferece suporte a 10 tipos de dados diferentes:

Tipo	Descrição	Exemplo
`string`	Uma sequência de caracteres.	`'Hello world'`
`number`	Um valor numérico, flutuante ou inteiro.	`42`
`boolean`	Um valor booleano.	`true`
`enum`	Um valor enum.	`'drama'`
`geopoint`	Um valor de ponto geográfico.	`{ lat: 40.7128, lon: 74.0060 }`
`string[]`	Uma matriz de strings.	`['red', 'green', 'blue']`
`number[]`	Uma matriz de números.	`[42, 91, 28.5]`
`boolean[]`	Uma matriz de booleanos.	`[true, false, false]`
`enum[]`	Uma matriz de enumerações.	`['comedy', 'action', 'romance']`
`vector[<size>]`	Um vetor de números para realizar a pesquisa vetorial.	`[0.403, 0.192, 0.830]`

Suporte para pesquisa vetorial e híbrida

Orama suporta pesquisa vetorial e híbrida apenas definindo mode: 'vector' ao realizar a pesquisa.

Para realizar esse tipo de pesquisa, você precisará fornecer incorporações de texto no momento da pesquisa:

 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 ,
} )

Tem problemas para gerar embeddings para pesquisa vetorial e híbrida? Experimente nosso plugin @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'
} )

Quer usar modelos de incorporação OpenAI? Use nosso plugin Secure Proxy para chamar OpenAI do lado do cliente com segurança.

Experiências RAG e Chat com Orama

Desde v3.0.0 , o Orama permite que você crie sua própria experiência semelhante a ChatGPT/Perplexity/SearchGPT. Você precisará chamar as APIs OpenAI, por isso recomendamos fortemente o uso do Secure Proxy Plugin para fazer isso com segurança do lado do cliente. É grátis!

 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?