From 08bb7bab8e358737c443224dbec9d285d16f0073 Mon Sep 17 00:00:00 2001 From: Michele Riva Date: Wed, 2 Oct 2024 10:28:09 +0200 Subject: [PATCH] chore: updates version for RC release --- package.json | 2 +- packages/benchmarks/package.json | 2 +- packages/docs/package.json | 2 +- packages/orama/README.md | 32 +++++++++---------- packages/orama/package.json | 2 +- packages/plugin-analytics/package.json | 2 +- packages/plugin-astro/package.json | 2 +- packages/plugin-data-persistence/package.json | 2 +- packages/plugin-docusaurus-v3/package.json | 2 +- packages/plugin-docusaurus/package.json | 2 +- packages/plugin-embeddings/package.json | 2 +- packages/plugin-match-highlight/package.json | 2 +- packages/plugin-nextra/package.json | 2 +- packages/plugin-parsedoc/package.json | 2 +- packages/plugin-secure-proxy/package.json | 2 +- packages/plugin-vitepress/package.json | 2 +- packages/stemmers/package.json | 2 +- packages/stopwords/package.json | 2 +- packages/switch/package.json | 2 +- packages/tokenizers/package.json | 2 +- 20 files changed, 35 insertions(+), 35 deletions(-) diff --git a/package.json b/package.json index 072c486ca..400a26ee8 100644 --- a/package.json +++ b/package.json @@ -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/*", diff --git a/packages/benchmarks/package.json b/packages/benchmarks/package.json index a42edb23f..d70eeab23 100644 --- a/packages/benchmarks/package.json +++ b/packages/benchmarks/package.json @@ -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", diff --git a/packages/docs/package.json b/packages/docs/package.json index 391f62e0c..770026004 100644 --- a/packages/docs/package.json +++ b/packages/docs/package.json @@ -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", diff --git a/packages/orama/README.md b/packages/orama/README.md index 2f4424841..7cffe3152 100644 --- a/packages/orama/README.md +++ b/packages/orama/README.md @@ -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', @@ -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, @@ -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, @@ -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, @@ -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', }) ``` @@ -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'], }) @@ -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: { @@ -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 @@ -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: '', 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', @@ -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: { @@ -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 diff --git a/packages/orama/package.json b/packages/orama/package.json index 26c5ff782..b9039f8bc 100644 --- a/packages/orama/package.json +++ b/packages/orama/package.json @@ -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, diff --git a/packages/plugin-analytics/package.json b/packages/plugin-analytics/package.json index fb57bcc3f..339b04290 100644 --- a/packages/plugin-analytics/package.json +++ b/packages/plugin-analytics/package.json @@ -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", diff --git a/packages/plugin-astro/package.json b/packages/plugin-astro/package.json index bb899f3b7..e13a5dd69 100644 --- a/packages/plugin-astro/package.json +++ b/packages/plugin-astro/package.json @@ -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": { diff --git a/packages/plugin-data-persistence/package.json b/packages/plugin-data-persistence/package.json index 83d853285..262a8f81f 100644 --- a/packages/plugin-data-persistence/package.json +++ b/packages/plugin-data-persistence/package.json @@ -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, diff --git a/packages/plugin-docusaurus-v3/package.json b/packages/plugin-docusaurus-v3/package.json index dbb611588..a0997a5fe 100644 --- a/packages/plugin-docusaurus-v3/package.json +++ b/packages/plugin-docusaurus-v3/package.json @@ -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", diff --git a/packages/plugin-docusaurus/package.json b/packages/plugin-docusaurus/package.json index 4ca7d28e6..2f3f4091e 100644 --- a/packages/plugin-docusaurus/package.json +++ b/packages/plugin-docusaurus/package.json @@ -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", diff --git a/packages/plugin-embeddings/package.json b/packages/plugin-embeddings/package.json index 5265d7d36..bc87a79ac 100644 --- a/packages/plugin-embeddings/package.json +++ b/packages/plugin-embeddings/package.json @@ -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", diff --git a/packages/plugin-match-highlight/package.json b/packages/plugin-match-highlight/package.json index c162ce009..e7c1de6ac 100644 --- a/packages/plugin-match-highlight/package.json +++ b/packages/plugin-match-highlight/package.json @@ -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", diff --git a/packages/plugin-nextra/package.json b/packages/plugin-nextra/package.json index d0aeb425e..743ffafde 100644 --- a/packages/plugin-nextra/package.json +++ b/packages/plugin-nextra/package.json @@ -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", diff --git a/packages/plugin-parsedoc/package.json b/packages/plugin-parsedoc/package.json index 2dabd840c..60cca8338 100644 --- a/packages/plugin-parsedoc/package.json +++ b/packages/plugin-parsedoc/package.json @@ -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": "", diff --git a/packages/plugin-secure-proxy/package.json b/packages/plugin-secure-proxy/package.json index b31936271..d7b1ebf53 100644 --- a/packages/plugin-secure-proxy/package.json +++ b/packages/plugin-secure-proxy/package.json @@ -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", diff --git a/packages/plugin-vitepress/package.json b/packages/plugin-vitepress/package.json index 51087c211..20c033e9e 100644 --- a/packages/plugin-vitepress/package.json +++ b/packages/plugin-vitepress/package.json @@ -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", diff --git a/packages/stemmers/package.json b/packages/stemmers/package.json index 47b9e6be5..f4e58ba38 100644 --- a/packages/stemmers/package.json +++ b/packages/stemmers/package.json @@ -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, diff --git a/packages/stopwords/package.json b/packages/stopwords/package.json index 6f46c5e3d..6e4016b89 100644 --- a/packages/stopwords/package.json +++ b/packages/stopwords/package.json @@ -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, diff --git a/packages/switch/package.json b/packages/switch/package.json index c07d78cde..d50f6b064 100644 --- a/packages/switch/package.json +++ b/packages/switch/package.json @@ -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", diff --git a/packages/tokenizers/package.json b/packages/tokenizers/package.json index dbbca2948..e80042744 100644 --- a/packages/tokenizers/package.json +++ b/packages/tokenizers/package.json @@ -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,