Skip to content

Commit c0755a4

Browse files
authored
docs: updates docs url to new documentation (#972)
1 parent ed0ece5 commit c0755a4

File tree

14 files changed

+92
-92
lines changed

14 files changed

+92
-92
lines changed

README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@ If you need more info, help, or want to provide general feedback on Orama, join
99

1010
# Highlighted features
1111

12-
- [Full-Text search](https://docs.orama.com/open-source/usage/search/introduction)
13-
- [Vector Search](https://docs.orama.com/open-source/usage/search/vector-search)
14-
- [Hybrid Search](https://docs.orama.com/open-source/usage/search/hybrid-search)
15-
- [GenAI Chat Sessions](https://docs.orama.com/open-source/usage/answer-engine/introduction)
16-
- [Search Filters](https://docs.orama.com/open-source/usage/search/filters)
17-
- [Geosearch](https://docs.orama.com/open-source/usage/search/geosearch)
18-
- [Facets](https://docs.orama.com/open-source/usage/search/facets)
19-
- [Fields Boosting](https://docs.orama.com/open-source/usage/search/fields-boosting)
20-
- [Typo Tolerance](https://docs.orama.com/open-source/usage/search/introduction#typo-tolerance)
21-
- [Exact Match](https://docs.orama.com/open-source/usage/search/introduction#exact-match)
22-
- [BM25](https://docs.orama.com/open-source/usage/search/bm25-algorithm)
23-
- [Stemming and tokenization in 30 languages](https://docs.orama.com/open-source/text-analysis/stemming)
24-
- [Plugin System](https://docs.orama.com/open-source/plugins/introduction)
12+
- [Full-Text search](https://docs.orama.com/docs/orama-js/search)
13+
- [Vector Search](https://docs.orama.com/docs/orama-js/search/vector-search)
14+
- [Hybrid Search](https://docs.orama.com/docs/orama-js/search/hybrid-search)
15+
- [GenAI Chat Sessions](https://docs.orama.com/docs/orama-js/answer-engine)
16+
- [Search Filters](https://docs.orama.com/docs/orama-js/search/filters)
17+
- [Geosearch](https://docs.orama.com/docs/orama-js/search/geosearch)
18+
- [Facets](https://docs.orama.com/docs/orama-js/search/facets)
19+
- [Fields Boosting](https://docs.orama.com/docs/orama-js/search/fields-boosting)
20+
- [Typo Tolerance](https://docs.orama.com/docs/orama-js/search#typo-tolerance)
21+
- [Exact Match](https://docs.orama.com/docs/orama-js/search#exact-match)
22+
- [BM25](https://docs.orama.com/docs/orama-js/search/bm25)
23+
- [Stemming and tokenization in 30 languages](https://docs.orama.com/docs/orama-js/text-analysis/stemming)
24+
- [Plugin System](https://docs.orama.com/docs/orama-js/plugins)
2525

2626
# Installation
2727

@@ -215,11 +215,11 @@ const searchResults = await search(db, {
215215
})
216216
```
217217

218-
Want to use OpenAI embedding models? Use our [Secure Proxy](https://docs.orama.com/open-source/plugins/plugin-secure-proxy) plugin to call OpenAI from the client-side securely.
218+
Want to use OpenAI embedding models? Use our [Secure Proxy](https://docs.orama.com/docs/orama-js/plugins/plugin-secure-proxy) plugin to call OpenAI from the client-side securely.
219219

220220
# RAG and Chat Experiences with Orama
221221

222-
Since `v3.0.0`, Orama allows you to create your own ChatGPT/Perplexity/SearchGPT-like experience. You will need to call the OpenAI APIs, so we strongly recommend using the [Secure Proxy Plugin](https://docs.orama.com/open-source/plugins/plugin-secure-proxy) to do that securely from your client side. It's free!
222+
Since `v3.0.0`, Orama allows you to create your own ChatGPT/Perplexity/SearchGPT-like experience. You will need to call the OpenAI APIs, so we strongly recommend using the [Secure Proxy Plugin](https://docs.orama.com/docs/orama-js/plugins/plugin-secure-proxy) to do that securely from your client side. It's free!
223223

224224
```js
225225
import { create, insert } from '@orama/orama'
@@ -260,26 +260,26 @@ const response = await session.ask({
260260
console.log(response) // Hello, John Doe! How are you doing?
261261
```
262262

263-
Read the complete documentation [here](https://docs.orama.com/open-source/usage/answer-engine/introduction).
263+
Read the complete documentation [here](https://docs.orama.com/docs/orama-js/usage/answer-engine/introduction).
264264

265265
# Official Docs
266266

267267
Read the complete documentation at [https://docs.orama.com/open-source](https://docs.orama.com/open-source).
268268

269269
# Official Orama Plugins
270270

271-
- [Plugin Embeddings](https://docs.orama.com/open-source/plugins/plugin-embeddings)
272-
- [Plugin Secure Proxy](https://docs.orama.com/open-source/plugins/plugin-secure-proxy)
273-
- [Plugin Analytics](https://docs.orama.com/open-source/plugins/plugin-analytics)
274-
- [Plugin Data Persistence](https://docs.orama.com/open-source/plugins/plugin-data-persistence)
275-
- [Plugin QPS](https://docs.orama.com/open-source/plugins/plugin-qps)
276-
- [Plugin PT15](https://docs.orama.com/open-source/plugins/plugin-pt15)
277-
- [Plugin Vitepress](https://docs.orama.com/open-source/plugins/plugin-vitepress)
278-
- [Plugin Docusaurus](https://docs.orama.com/open-source/plugins/plugin-docusaurus)
279-
- [Plugin Astro](https://docs.orama.com/open-source/plugins/plugin-astro)
280-
- [Plugin Nextra](https://docs.orama.com/open-source/plugins/plugin-nextra)
281-
282-
Write your own plugin: [https://docs.orama.com/open-source/plugins/writing-your-own-plugins](https://docs.orama.com/open-source/plugins/writing-your-own-plugins)
271+
- [Plugin Embeddings](https://docs.orama.com/docs/orama-js/plugins/plugin-embeddings)
272+
- [Plugin Secure Proxy](https://docs.orama.com/docs/orama-js/plugins/plugin-secure-proxy)
273+
- [Plugin Analytics](https://docs.orama.com/docs/orama-js/plugins/plugin-analytics)
274+
- [Plugin Data Persistence](https://docs.orama.com/docs/orama-js/plugins/plugin-data-persistence)
275+
- [Plugin QPS](https://docs.orama.com/docs/orama-js/plugins/plugin-qps)
276+
- [Plugin PT15](https://docs.orama.com/docs/orama-js/plugins/plugin-pt15)
277+
- [Plugin Vitepress](https://docs.orama.com/docs/orama-js/plugins/plugin-vitepress)
278+
- [Plugin Docusaurus](https://docs.orama.com/docs/orama-js/plugins/plugin-docusaurus)
279+
- [Plugin Astro](https://docs.orama.com/docs/orama-js/plugins/plugin-astro)
280+
- [Plugin Nextra](https://docs.orama.com/docs/orama-js/plugins/plugin-nextra)
281+
282+
Write your own plugin: [https://docs.orama.com/docs/orama-js/plugins/writing-your-own-plugins](https://docs.orama.com/docs/orama-js/plugins/writing-your-own-plugins)
283283

284284
# License
285285

packages/orama/README.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ If you need more info, help, or want to provide general feedback on Orama, join
88

99
# Highlighted features
1010

11-
- [Full-Text search](https://docs.orama.com/open-source/usage/search/introduction)
12-
- [Vector Search](https://docs.orama.com/open-source/usage/search/vector-search)
13-
- [Hybrid Search](https://docs.orama.com/open-source/usage/search/hybrid-search)
14-
- [GenAI Chat Sessions](https://docs.orama.com/open-source/usage/answer-engine/introduction)
15-
- [Search Filters](https://docs.orama.com/open-source/usage/search/filters)
16-
- [Geosearch](https://docs.orama.com/open-source/usage/search/geosearch)
17-
- [Facets](https://docs.orama.com/open-source/usage/search/facets)
18-
- [Fields Boosting](https://docs.orama.com/open-source/usage/search/fields-boosting)
19-
- [Typo Tolerance](https://docs.orama.com/open-source/usage/search/introduction#typo-tolerance)
20-
- [Exact Match](https://docs.orama.com/open-source/usage/search/introduction#exact-match)
21-
- [BM25](https://docs.orama.com/open-source/usage/search/bm25-algorithm)
22-
- [Stemming and tokenization in 30 languages](https://docs.orama.com/open-source/text-analysis/stemming)
23-
- [Plugin System](https://docs.orama.com/open-source/plugins/introduction)
24-
11+
- [Full-Text search](https://docs.orama.com/docs/orama-js/search)
12+
- [Vector Search](https://docs.orama.com/docs/orama-js/search/vector-search)
13+
- [Hybrid Search](https://docs.orama.com/docs/orama-js/search/hybrid-search)
14+
- [GenAI Chat Sessions](https://docs.orama.com/docs/orama-js/answer-engine)
15+
- [Search Filters](https://docs.orama.com/docs/orama-js/search/filters)
16+
- [Geosearch](https://docs.orama.com/docs/orama-js/search/geosearch)
17+
- [Facets](https://docs.orama.com/docs/orama-js/search/facets)
18+
- [Fields Boosting](https://docs.orama.com/docs/orama-js/search/fields-boosting)
19+
- [Typo Tolerance](https://docs.orama.com/docs/orama-js/search#typo-tolerance)
20+
- [Exact Match](https://docs.orama.com/docs/orama-js/search#exact-match)
21+
- [BM25](https://docs.orama.com/docs/orama-js/search/bm25)
22+
- [Stemming and tokenization in 30 languages](https://docs.orama.com/docs/orama-js/text-analysis/stemming)
23+
- [Plugin System](https://docs.orama.com/docs/orama-js/plugins)
24+
-
2525
# Installation
2626

2727
You can install Orama using `npm`, `yarn`, `pnpm`, `bun`:
@@ -212,11 +212,11 @@ const searchResults = await search(db, {
212212
})
213213
```
214214
215-
Want to use OpenAI embedding models? Use our [Secure Proxy](https://docs.orama.com/open-source/plugins/plugin-secure-proxy) plugin to call OpenAI from the client-side securely.
215+
Want to use OpenAI embedding models? Use our [Secure Proxy](https://docs.orama.com/docs/orama-js/plugins/plugin-secure-proxy) plugin to call OpenAI from the client-side securely.
216216
217217
# RAG and Chat Experiences with Orama
218218
219-
Since `v3.0.0`, Orama allows you to create your own ChatGPT/Perplexity/SearchGPT-like experience. You will need to call the OpenAI APIs, so we strongly recommend using the [Secure Proxy Plugin](https://docs.orama.com/open-source/plugins/plugin-secure-proxy) to do that securely from your client side. It's free!
219+
Since `v3.0.0`, Orama allows you to create your own ChatGPT/Perplexity/SearchGPT-like experience. You will need to call the OpenAI APIs, so we strongly recommend using the [Secure Proxy Plugin](https://docs.orama.com/docs/orama-js/plugins/plugin-secure-proxy) to do that securely from your client side. It's free!
220220

221221
```js
222222
import { create, insert } from '@orama/orama'
@@ -257,26 +257,26 @@ const response = await session.ask({
257257
console.log(response) // Hello, John Doe! How are you doing?
258258
```
259259

260-
Read the complete documentation [here](https://docs.orama.com/open-source/usage/answer-engine/introduction).
260+
Read the complete documentation [here](https://docs.orama.com/docs/orama-js/usage/answer-engine/introduction).
261261

262262
# Official Docs
263263

264264
Read the complete documentation at [https://docs.orama.com/open-source](https://docs.orama.com/open-source).
265265

266266
# Official Orama Plugins
267267

268-
- [Plugin Embeddings](https://docs.orama.com/open-source/plugins/plugin-embeddings)
269-
- [Plugin Secure Proxy](https://docs.orama.com/open-source/plugins/plugin-secure-proxy)
270-
- [Plugin Analytics](https://docs.orama.com/open-source/plugins/plugin-analytics)
271-
- [Plugin Data Persistence](https://docs.orama.com/open-source/plugins/plugin-data-persistence)
272-
- [Plugin QPS](https://docs.orama.com/open-source/plugins/plugin-qps)
273-
- [Plugin PT15](https://docs.orama.com/open-source/plugins/plugin-pt15)
274-
- [Plugin Vitepress](https://docs.orama.com/open-source/plugins/plugin-vitepress)
275-
- [Plugin Docusaurus](https://docs.orama.com/open-source/plugins/plugin-docusaurus)
276-
- [Plugin Astro](https://docs.orama.com/open-source/plugins/plugin-astro)
277-
- [Plugin Nextra](https://docs.orama.com/open-source/plugins/plugin-nextra)
278-
279-
Write your own plugin: [https://docs.orama.com/open-source/plugins/writing-your-own-plugins](https://docs.orama.com/open-source/plugins/writing-your-own-plugins)
268+
- [Plugin Embeddings](https://docs.orama.com/docs/orama-js/plugins/plugin-embeddings)
269+
- [Plugin Secure Proxy](https://docs.orama.com/docs/orama-js/plugins/plugin-secure-proxy)
270+
- [Plugin Analytics](https://docs.orama.com/docs/orama-js/plugins/plugin-analytics)
271+
- [Plugin Data Persistence](https://docs.orama.com/docs/orama-js/plugins/plugin-data-persistence)
272+
- [Plugin QPS](https://docs.orama.com/docs/orama-js/plugins/plugin-qps)
273+
- [Plugin PT15](https://docs.orama.com/docs/orama-js/plugins/plugin-pt15)
274+
- [Plugin Vitepress](https://docs.orama.com/docs/orama-js/plugins/plugin-vitepress)
275+
- [Plugin Docusaurus](https://docs.orama.com/docs/orama-js/plugins/plugin-docusaurus)
276+
- [Plugin Astro](https://docs.orama.com/docs/orama-js/plugins/plugin-astro)
277+
- [Plugin Nextra](https://docs.orama.com/docs/orama-js/plugins/plugin-nextra)
278+
279+
Write your own plugin: [https://docs.orama.com/docs/orama-js/plugins/writing-your-own-plugins](https://docs.orama.com/docs/orama-js/plugins/writing-your-own-plugins)
280280

281281
# License
282282

packages/orama/src/errors.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ const errors = {
77
NO_LANGUAGE_WITH_CUSTOM_TOKENIZER: 'Do not pass the language option to create when using a custom tokenizer.',
88
LANGUAGE_NOT_SUPPORTED: `Language "%s" is not supported.\nSupported languages are:\n - ${allLanguages}`,
99
INVALID_STEMMER_FUNCTION_TYPE: `config.stemmer property must be a function.`,
10-
MISSING_STEMMER: `As of version 1.0.0 @orama/orama does not ship non English stemmers by default. To solve this, please explicitly import and specify the "%s" stemmer from the package @orama/stemmers. See https://docs.orama.com/open-source/text-analysis/stemming for more information.`,
10+
MISSING_STEMMER: `As of version 1.0.0 @orama/orama does not ship non English stemmers by default. To solve this, please explicitly import and specify the "%s" stemmer from the package @orama/stemmers. See https://docs.orama.com/docs/orama-js/text-analysis/stemming for more information.`,
1111
CUSTOM_STOP_WORDS_MUST_BE_FUNCTION_OR_ARRAY: 'Custom stop words array must only contain strings.',
1212
UNSUPPORTED_COMPONENT: `Unsupported component "%s".`,
1313
COMPONENT_MUST_BE_FUNCTION: `The component "%s" must be a function.`,
@@ -25,7 +25,7 @@ const errors = {
2525
INVALID_SORT_SCHEMA_TYPE: `Unsupported sort schema type "%s" at "%s". Expected "string" or "number".`,
2626
CANNOT_SORT_BY_ARRAY: `Cannot configure sort for "%s" because it is an array (%s).`,
2727
UNABLE_TO_SORT_ON_UNKNOWN_FIELD: `Unable to sort on unknown field "%s". Allowed fields: %s`,
28-
SORT_DISABLED: `Sort is disabled. Please read the documentation at https://docs.oramasearch for more information.`,
28+
SORT_DISABLED: `Sort is disabled. Please read the documentation at https://docs.orama.com/docs/orama-js for more information.`,
2929
UNKNOWN_GROUP_BY_PROPERTY: `Unknown groupBy property "%s".`,
3030
INVALID_GROUP_BY_PROPERTY: `Invalid groupBy property "%s". Allowed types: "%s", but given "%s".`,
3131
UNKNOWN_FILTER_PROPERTY: `Unknown filter property "%s".`,
@@ -41,10 +41,10 @@ const errors = {
4141
MISSING_TERM: `"term" is a required parameter when performing hybrid search. Please provide a search term.`,
4242
INVALID_VECTOR_INPUT: `Invalid "vector" property. Expected an object with "value" and "property" properties, but got "%s" instead.`,
4343
PLUGIN_CRASHED: `A plugin crashed during initialization. Please check the error message for more information:`,
44-
PLUGIN_SECURE_PROXY_NOT_FOUND: `Could not find '@orama/secure-proxy-plugin' installed in your Orama instance.\nPlease install it before proceeding with creating an answer session.\nRead more at https://docs.orama.com/open-source/plugins/plugin-secure-proxy#plugin-secure-proxy\n`,
45-
PLUGIN_SECURE_PROXY_MISSING_CHAT_MODEL: `Could not find a chat model defined in the secure proxy plugin configuration.\nPlease provide a chat model before proceeding with creating an answer session.\nRead more at https://docs.orama.com/open-source/plugins/plugin-secure-proxy#plugin-secure-proxy\n`,
44+
PLUGIN_SECURE_PROXY_NOT_FOUND: `Could not find '@orama/secure-proxy-plugin' installed in your Orama instance.\nPlease install it before proceeding with creating an answer session.\nRead more at https://docs.orama.com/docs/orama-js/plugins/plugin-secure-proxy#plugin-secure-proxy\n`,
45+
PLUGIN_SECURE_PROXY_MISSING_CHAT_MODEL: `Could not find a chat model defined in the secure proxy plugin configuration.\nPlease provide a chat model before proceeding with creating an answer session.\nRead more at https://docs.orama.com/docs/orama-js/plugins/plugin-secure-proxy#plugin-secure-proxy\n`,
4646
ANSWER_SESSION_LAST_MESSAGE_IS_NOT_ASSISTANT: `The last message in the session is not an assistant message. Cannot regenerate non-assistant messages.`,
47-
PLUGIN_COMPONENT_CONFLICT: `The component "%s" is already defined. The plugin "%s" is trying to redefine it.`,
47+
PLUGIN_COMPONENT_CONFLICT: `The component "%s" is already defined. The plugin "%s" is trying to redefine it.`
4848
}
4949

5050
export type ErrorCode = keyof typeof errors

0 commit comments

Comments
 (0)