orama
v3.0.2
Orama에 대한 추가 정보나 도움이 필요하거나 일반적인 피드백을 제공하고 싶다면 Orama Slack 채널에 가입하세요.
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를 안전하게 호출하세요.
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?여기에서 전체 문서를 읽어보세요.
https://docs.orama.com/open-source에서 전체 설명서를 읽어보세요.
나만의 플러그인 작성: https://docs.orama.com/open-source/plugins/writing-your-own-plugins
Orama는 Apache 2.0 라이선스에 따라 라이선스가 부여됩니다.
