Skip to content

Commit

Permalink
chore: updates version for RC release
Browse files Browse the repository at this point in the history
  • Loading branch information
micheleriva committed Oct 2, 2024
1 parent b391077 commit 08bb7ba
Show file tree
Hide file tree
Showing 20 changed files with 35 additions and 35 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "orama-monorepo",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"description": "Next generation full-text and vector search engine, written in TypeScript",
"workspaces": [
"packages/*",
Expand Down
2 changes: 1 addition & 1 deletion packages/benchmarks/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "benchmarks",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"private": true,
"scripts": {
"bench:group": "node src/group.bench.js",
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@orama/docs",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"description": "Documentation for Orama",
"private": true,
"type": "module",
Expand Down
32 changes: 16 additions & 16 deletions packages/orama/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ instance and set an indexing schema:
```js
import { create, insert, remove, search, searchVector } from '@orama/orama'

const db = await create({
const db = create({
schema: {
name: 'string',
description: 'string',
Expand Down Expand Up @@ -101,7 +101,7 @@ Orama will only index properties specified in the schema but will allow you to s
Once the db instance is created, you can start adding some documents:

```js
await insert(db, {
insert(db, {
name: 'Wireless Headphones',
description: 'Experience immersive sound quality with these noise-cancelling wireless headphones.',
price: 99.99,
Expand All @@ -111,7 +111,7 @@ await insert(db, {
},
})

await insert(db, {
insert(db, {
name: 'Smart LED Bulb',
description: 'Control the lighting in your home with this energy-efficient smart LED bulb, compatible with most smart home systems.',
price: 24.99,
Expand All @@ -121,7 +121,7 @@ await insert(db, {
},
})

await insert(db, {
insert(db, {
name: 'Portable Charger',
description: 'Never run out of power on-the-go with this compact and fast-charging portable charger for your devices.',
price: 29.99,
Expand All @@ -135,7 +135,7 @@ await insert(db, {
After the data has been inserted, you can finally start to query the database.

```js
const searchResult = await search(db, {
const searchResult = search(db, {
term: 'headphones',
})
```
Expand Down Expand Up @@ -170,7 +170,7 @@ word `"headphones"`, looking up in every `string` property specified in the sche
You can also restrict the lookup to a specific property:

```js
const searchResult = await search(db, {
const searchResult = search(db, {
term: 'immersive sound quality',
properties: ['description'],
})
Expand Down Expand Up @@ -205,7 +205,7 @@ Result:
You can use non-string data to [filter](https://docs.askorama.ai/open-source/usage/search/filters), [group](https://docs.askorama.ai/open-source/usage/search/grouping), and create [facets](https://docs.askorama.ai/open-source/usage/search/facets):

```js
const searchResult = await search(db, {
const searchResult = search(db, {
term: 'immersive sound quality',
where: {
price: {
Expand All @@ -227,7 +227,7 @@ To perform vector or hybrid search, you can use the same `search` method used fo
You'll just have to specify which property you want to perform vector search on, and a vector to be used to perform vector similarity:

```js
const searchResult = await searchVector(db, {
const searchResult = search(db, {
mode: 'vector', // or 'hybrid'
vector: {
value: [...], // OpenAI embedding or similar vector to be used as an input
Expand All @@ -242,13 +242,13 @@ If you're using the [Orama Secure AI Proxy](https://askorama.ai/blog/announcing-
import { create } from '@orama/orama'
import { pluginSecureProxy } from '@orama/plugin-secure-proxy'

const secureProxy = secureProxyPlugin({
const secureProxy = await secureProxyPlugin({
apiKey: '<YOUR-PUBLIC-API-KEY>',
defaultProperty: 'embedding', // the default property to perform vector and hybrid search on
model: 'openai/text-embedding-ada-002' // the model to use to generate embeddings
})

const db = await create({
const db = create({
schema: {
name: 'string',
description: 'string',
Expand All @@ -261,7 +261,7 @@ const db = await create({
plugins: [secureProxy]
})

const resultsHybrid = await search(db, {
const resultsHybrid = search(db, {
mode: 'vector', // or 'hybrid'
term: 'Videogame for little kids with a passion about ice cream',
where: {
Expand All @@ -282,18 +282,18 @@ Orama supports Geosearch as a search filter. It will search through all the prop
```js
import { create, insert } from '@orama/orama'

const db = await create({
const db = create({
schema: {
name: 'string',
location: 'geopoint'
}
})

await insert(db, { name: 'Duomo di Milano', location: { lat: 45.46409, lon: 9.19192 } })
await insert(db, { name: 'Piazza Duomo', location: { lat: 45.46416, lon: 9.18945 } })
await insert(db, { name: 'Piazzetta Reale', location: { lat: 45.46339, lon: 9.19092 } })
insert(db, { name: 'Duomo di Milano', location: { lat: 45.46409, lon: 9.19192 } })
insert(db, { name: 'Piazza Duomo', location: { lat: 45.46416, lon: 9.18945 } })
insert(db, { name: 'Piazzetta Reale', location: { lat: 45.46339, lon: 9.19092 } })

const searchResult = await search(db, {
const searchResult = search(db, {
term: 'Duomo',
where: {
location: { // The property we want to filter by
Expand Down
2 changes: 1 addition & 1 deletion packages/orama/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@orama/orama",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"type": "module",
"description": "Next generation full-text and vector search engine, written in TypeScript",
"sideEffects": false,
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-analytics/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@orama/plugin-analytics",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"description": "Orama plugin for providing analytics data on your searches",
"keywords": ["orama", "analytics", "telemetry"],
"license": "Apache-2.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-astro/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@orama/plugin-astro",
"description": "An Astro integration for Orama",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"keywords": ["astro", "astro-component", "cms", "orama", "search"],
"repository": "https://github.com/askorama/orama",
"author": {
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-data-persistence/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@orama/plugin-data-persistence",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"description": "Data persistence plugin for Orama",
"type": "module",
"sideEffects": false,
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-docusaurus-v3/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@orama/plugin-docusaurus-v3",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"description": "Docusaurus plugin for local search powered by orama",
"keywords": ["orama", "docusaurus"],
"license": "Apache-2.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-docusaurus/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@orama/plugin-docusaurus",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"description": "Docusaurus plugin for local search powered by orama",
"keywords": ["orama", "docusaurus"],
"license": "Apache-2.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-embeddings/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@orama/plugin-embeddings",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"description": "Orama plugin for generating embeddings locally",
"keywords": [
"orama",
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-match-highlight/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@orama/plugin-match-highlight",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"description": "Orama plugin for search match highlighting",
"keywords": ["full-text search", "search", "fuzzy search", "typo-tolerant search", "full-text"],
"license": "Apache-2.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-nextra/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@orama/plugin-nextra",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"description": "Nextra plugin for local search powered by orama",
"keywords": ["orama", "nextra"],
"license": "Apache-2.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-parsedoc/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@orama/plugin-parsedoc",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"description": "Orama plugin to populate an index with HTML/Markdown documents",
"keywords": [],
"author": "",
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-secure-proxy/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@orama/plugin-secure-proxy",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"description": "Orama plugin for generating embeddings securely on the front-end",
"keywords": ["orama", "embeddings", "secure proxy", "vector search"],
"license": "Apache-2.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-vitepress/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@orama/plugin-vitepress",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"description": "Vitepress plugin for local search powered by orama",
"keywords": ["orama", "vite", "vitepress", "vue"],
"license": "Apache-2.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/stemmers/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@orama/stemmers",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"type": "module",
"description": "Stemmers for Orama",
"sideEffects": false,
Expand Down
2 changes: 1 addition & 1 deletion packages/stopwords/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@orama/stopwords",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"type": "module",
"description": "Stop-words for Orama",
"sideEffects": false,
Expand Down
2 changes: 1 addition & 1 deletion packages/switch/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@orama/switch",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"description": "Orama Switch allows you to run queries on Orama Cloud and OSS with a single interface",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/tokenizers/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@orama/tokenizers",
"version": "3.0.0-rc-1",
"version": "3.0.0-rc-2",
"type": "module",
"description": "Additional tokenizers for Orama",
"sideEffects": false,
Expand Down

0 comments on commit 08bb7ba

Please sign in to comment.