Skip to content

Commit

Permalink
Orama docs - review url to dashboard (#864)
Browse files Browse the repository at this point in the history
  • Loading branch information
albertogiunta authored Jan 23, 2025
1 parent d9d5346 commit fa686ad
Show file tree
Hide file tree
Showing 19 changed files with 43 additions and 41 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ You can get the variables required for the plugin's configuration in your Orama
<Steps>
<ol>
<li>
<p class="pl-10">Go to your [dashboard](https://cloud.orama.com/indexes) and click on "Native Integrations".</p>
<p class="pl-10">Go to a project in your [dashboard](https://cloud.orama.com), and click on "Add index" and then "Native Integrations".</p>
<p class="pl-10">Then, click on the Docusaurus logo to create a new index.</p>
</li>
<li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Now that you have your [Shopify access token](#shopify-access-token), you can cr
<Steps>
<ol>
<li>
<p class="pl-10">Go to your [dashboard](https://cloud.orama.com/indexes) and click on "Import data from e-commerce".</p>
<p class="pl-10">Go to a project in your [dashboard](https://cloud.orama.com), and click on "Add index" and then "Import data from e-commerce".</p>
<p class="pl-10">Then, click on the Shopify logo to create a new Shopify index.</p>
</li>
<li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ You can get the `privateApiKey` from your Orama Cloud dashboard. It is required
<Steps>
<ol>
<li>
<p class="pl-10">Go to your [dashboard](https://cloud.orama.com/indexes) and click on "Native Integrations".</p>
<p class="pl-10">Go to a project in your [dashboard](https://cloud.orama.com), and click on "Add index" and then "Native Integrations".</p>
<p class="pl-10">Then, click on the **Strapi** logo to create a new index.</p>
</li>
<li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ import { ShowcaseImage } from 'starlight-showcases';
import { Aside, Steps } from '@astrojs/starlight/components';
import IntegratingIntoYourApp from '../../../../../components/IntegratingIntoYourApp.astro'

If you are looking for an alternative data source to integrate with Orama Cloud, you can use our <a href="https://cloud.orama.com/indexes/create/from-website" target="_blank">Web Crawler</a> to index the contents of your website. This is particularly useful when you want to index a public website that does not provide an API.
If you are looking for an alternative data source to integrate with Orama Cloud, you can use our Web Crawler to index the contents of your website. This is particularly useful when you want to index a public website that does not provide an API.

In order to use the Web Crawler, you need to be logged in to your [Orama Cloud dashboard](https://cloud.orama.com), and inside a project click on the `Add index` button, and then select the `Web Crawler` data source.

<Aside type="danger">
The Web Crawler is a tool meant to be used to index the contents of a website you own. <br />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ You can follow along with this guide by downloading the following example CSV fi
<Steps>
<ol>
<li>
<p class="pl-10">As always, you can create a new index by visiting your <a href="https://cloud.orama.com/indexes" target="_blank">dashboard</a>.</p>
<p class="pl-10">In this page click on the `Add new index` button and choose: `Import Data from files`.</p>
<p class="pl-10">As always, you can create a new index by visiting a project in your <a href="https://cloud.orama.com" target="_blank">dashboard</a>.</p>
<p class="pl-10">Inside the project page click on the `Add index` button and choose: `Import Data from files`.</p>
</li>
<li>
<p class="pl-10">Of course, you can choose any name and description you want for your index.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ You can follow along with this guide by downloading the following example JSON f
<Steps>
<ol>
<li>
<p class="pl-10">As always, you can create a new index by visiting your <a href="https://cloud.orama.com/indexes" target="_blank">dashboard</a>.</p>
<p class="pl-10">In this page click on the `Add new index` button and choose: `Import Data from files`.</p>
<p class="pl-10">As always, you can create a new index by visiting a project in your <a href="https://cloud.orama.com" target="_blank">dashboard</a>.</p>
<p class="pl-10">Inside the project page click on the `Add index` button and choose: `Import Data from files`.</p>
</li>
<li>
<p class="pl-10">Of course, you can choose any name and description you want for your index.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ After adding your API key, you won't be able to view it again for security reaso

### Creating the Embeddings

You can now create a new index by going to [Orama Cloud dashboard](https://cloud.orama.com/indexes), if you don't have one yet. Depending on your use case, you will need to select the right Data Source to import your data (check out our guide on [Data Sources](/cloud/data-sources/introduction-to-data-sources) to learn more about the available options).
You can now create a new index by going to a project in your [Orama Cloud dashboard](https://cloud.orama.com), if you don't have one yet. Depending on your use case, you will need to select the right Data Source to import your data (check out our guide on [Data Sources](/cloud/data-sources/introduction-to-data-sources) to learn more about the available options).

When creating an index, the embedding generation is automatically enabled. You can select the Large Language Model (LLM) you would like to use for the embeddings generation.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { Aside } from '@astrojs/starlight/components';

Deleting an existing index is a very simple and immediate operation.

From your <a href="https://cloud.orama.com/indexes" target="_blank">dashboard homepage</a>, select the index you want to delete. In our case, we'll select the only one available:
From the project page in your <a href="https://cloud.orama.com" target="_blank">dashboard</a>, select the index you want to delete. In our case, we'll select the only one available:

<img
src="/cloud/guides/working-with-indexes/indexes-list.png"
Expand Down
6 changes: 3 additions & 3 deletions packages/orama/src/errors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const errors = {
NO_LANGUAGE_WITH_CUSTOM_TOKENIZER: 'Do not pass the language option to create when using a custom tokenizer.',
LANGUAGE_NOT_SUPPORTED: `Language "%s" is not supported.\nSupported languages are:\n - ${allLanguages}`,
INVALID_STEMMER_FUNCTION_TYPE: `config.stemmer property must be a function.`,
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.oramasearch.com/open-source/text-analysis/stemming for more information.`,
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.`,
CUSTOM_STOP_WORDS_MUST_BE_FUNCTION_OR_ARRAY: 'Custom stop words array must only contain strings.',
UNSUPPORTED_COMPONENT: `Unsupported component "%s".`,
COMPONENT_MUST_BE_FUNCTION: `The component "%s" must be a function.`,
Expand Down Expand Up @@ -40,8 +40,8 @@ const errors = {
MISSING_TERM: `"term" is a required parameter when performing hybrid search. Please provide a search term.`,
INVALID_VECTOR_INPUT: `Invalid "vector" property. Expected an object with "value" and "property" properties, but got "%s" instead.`,
PLUGIN_CRASHED: `A plugin crashed during initialization. Please check the error message for more information:`,
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\n`,
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\n`,
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`,
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`,
ANSWER_SESSION_LAST_MESSAGE_IS_NOT_ASSISTANT: `The last message in the session is not an assistant message. Cannot regenerate non-assistant messages.`,
PLUGIN_COMPONENT_CONFLICT: `The component "%s" is already defined. The plugin "%s" is trying to redefine it.`,
}
Expand Down
36 changes: 18 additions & 18 deletions packages/orama/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ export interface SearchParamsFullText<T extends AnyOrama, ResultDocument = Typed
*
* d: Frequency normalization lower bound. Default value is 0.5.
*
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/BM25-algorithm
* Full documentation: https://docs.orama.com/open-source/usage/search/changing-search-algorithm#bm25-best-matching-25
*
* @see https://en.wikipedia.org/wiki/Okapi_BM25
*/
Expand All @@ -347,7 +347,7 @@ export interface SearchParamsFullText<T extends AnyOrama, ResultDocument = Typed
* The boost is a number that is multiplied to the score of the property.
* It can be used to give more importance to some properties.
*
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/fields-boosting
* Full documentation: https://docs.orama.com/open-source/usage/search/fields-boosting
*
* @example
* // Give more importance to the 'title' property.
Expand All @@ -365,7 +365,7 @@ export interface SearchParamsFullText<T extends AnyOrama, ResultDocument = Typed

/**
* Facets configuration
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/facets
* Full documentation: https://docs.orama.com/open-source/usage/search/facets
*
* A facet is a feature that allows users to narrow down their search results by specific
* attributes or characteristics, such as category, price, or location.
Expand All @@ -388,7 +388,7 @@ export interface SearchParamsFullText<T extends AnyOrama, ResultDocument = Typed

/**
* Distinct configuration
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/introduction#distinct
* Full documentation: https://docs.orama.com/open-source/usage/search/introduction#distinct
*
* @example
* const results = await search(db, {
Expand All @@ -400,7 +400,7 @@ export interface SearchParamsFullText<T extends AnyOrama, ResultDocument = Typed

/**
* Groups configuration
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/grouping
* Full documentation: https://docs.orama.com/open-source/usage/search/grouping
*
* @example
* const results = await search(db, {
Expand All @@ -415,7 +415,7 @@ export interface SearchParamsFullText<T extends AnyOrama, ResultDocument = Typed

/**
* Filter the search results.
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/filters
* Full documentation: https://docs.orama.com/open-source/usage/search/filters
*
* @example
* // Search for documents that contain 'Headphones' in the 'description' and 'title' fields and
Expand All @@ -438,7 +438,7 @@ export interface SearchParamsFullText<T extends AnyOrama, ResultDocument = Typed
* The threshold is a number between 0 and 1 that represents the minimum score of the documents to return.
* By default, the threshold is 0.
*
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/threshold
* Full documentation: https://docs.orama.com/open-source/usage/search/threshold
*
* @example
*
Expand All @@ -462,7 +462,7 @@ export interface SearchParamsFullText<T extends AnyOrama, ResultDocument = Typed
* Preflight query.
* Will return just the facets (if needed) and the number of matched documents for the given query.
*
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/preflight
* Full documentation: https://docs.orama.com/open-source/usage/search/preflight
*
* @example
*
Expand Down Expand Up @@ -545,7 +545,7 @@ export interface SearchParamsHybrid<T extends AnyOrama, ResultDocument = TypedDo
*
* d: Frequency normalization lower bound. Default value is 0.5.
*
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/BM25-algorithm
* Full documentation: https://docs.orama.com/open-source/usage/search/changing-search-algorithm#bm25-best-matching-25
*
* @see https://en.wikipedia.org/wiki/Okapi_BM25
*/
Expand Down Expand Up @@ -578,13 +578,13 @@ export interface SearchParamsHybrid<T extends AnyOrama, ResultDocument = TypedDo

/**
* Groups configuration
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/grouping
* Full documentation: https://docs.orama.com/open-source/usage/search/grouping
*/
groupBy?: GroupByParams<T, ResultDocument>

/**
* Filter the search results.
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/filters
* Full documentation: https://docs.orama.com/open-source/usage/search/filters
*/
where?: Partial<WhereCondition<T['schema']>>

Expand All @@ -593,7 +593,7 @@ export interface SearchParamsHybrid<T extends AnyOrama, ResultDocument = TypedDo
* The threshold is a number between 0 and 1 that represents the minimum score of the documents to return.
* By default, the threshold is 1. Only applies to the full-text search.
*
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/threshold
* Full documentation: https://docs.orama.com/open-source/usage/search/threshold
*/
threshold?: number

Expand All @@ -603,13 +603,13 @@ export interface SearchParamsHybrid<T extends AnyOrama, ResultDocument = TypedDo
* The boost is a number that is multiplied to the score of the property.
* It can be used to give more importance to some properties. Only applies to the full-text search.
*
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/fields-boosting
* Full documentation: https://docs.orama.com/open-source/usage/search/fields-boosting
*/
boost?: Partial<Record<OnlyStrings<FlattenSchemaProperty<T>[]>, number>>

/**
* Facets configuration
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/facets
* Full documentation: https://docs.orama.com/open-source/usage/search/facets
*
* A facet is a feature that allows users to narrow down their search results by specific
* attributes or characteristics, such as category, price, or location.
Expand All @@ -621,7 +621,7 @@ export interface SearchParamsHybrid<T extends AnyOrama, ResultDocument = TypedDo
* Hybrid search weights.
* By default, Orama will use 0.5 for the full-text search and 0.5 for the vector search, which means that both will have the same importance.
* You can change the weights to give more importance to the full-text search or the vector search.
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/hybrid-search
* Full documentation: https://docs.orama.com/open-source/usage/search/hybrid-search
*/
hybridWeights?: HybridWeights
}
Expand Down Expand Up @@ -689,19 +689,19 @@ export interface SearchParamsVector<T extends AnyOrama, ResultDocument = TypedDo

/**
* Filter the search results.
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/filters
* Full documentation: https://docs.orama.com/open-source/usage/search/filters
*/
where?: Partial<WhereCondition<T['schema']>>

/**
* Facets configuration
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/facets
* Full documentation: https://docs.orama.com/open-source/usage/search/facets
*/
facets?: FacetsParams<T>

/**
* Groups configuration
* Full documentation: https://docs.oramasearch.com/open-source/usage/search/grouping
* Full documentation: https://docs.orama.com/open-source/usage/search/grouping
*/
groupBy?: GroupByParams<T, ResultDocument>

Expand Down
4 changes: 2 additions & 2 deletions packages/plugin-analytics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Official plugin to provide analytics data on your searches.

# Usage

For the complete usage guide, please refer to the [official plugin documentation](https://docs.oramasearch.com/open-source/plugins/plugin-analytics).
For the complete usage guide, please refer to the [official plugin documentation](https://docs.orama.com/open-source/plugins/plugin-analytics).

To use the Orama Analytics Plugin, you will need to sign up for a free account at [https://cloud.orama.com](https://cloud.orama.com)

Expand All @@ -28,7 +28,7 @@ const db = await create({
})
```

For the full configuration guide of this plugin, please follow the [official plugin documentation](https://docs.oramasearch.com/open-source/plugins/plugin-analytics).
For the full configuration guide of this plugin, please follow the [official plugin documentation](https://docs.orama.com/open-source/plugins/plugin-analytics).

# License

Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-data-persistence/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This plugin aims to provide data persistence capabilities to Orama.

# Usage

For the complete usage guide, please refer to the [official plugin documentation](https://docs.oramasearch.com/open-source/plugins/plugin-data-persistence).
For the complete usage guide, please refer to the [official plugin documentation](https://docs.orama.com/open-source/plugins/plugin-data-persistence).

# License

Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-data-persistence/src/errors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ export function FILESYSTEM_NOT_SUPPORTED_ON_RUNTIME(runtime: string): string {
}

export function METHOD_MOVED(method: string): string {
return `Function ${method} has been moved to the "/server" module. \n\nImport it via "import { ${method} } from 'orama/plugin-data-persistence/server'". \n\nRead more at https://docs.oramasearch.com/open-source/plugins/plugin-data-persistence.`
return `Function ${method} has been moved to the "/server" module. \n\nImport it via "import { ${method} } from 'orama/plugin-data-persistence/server'". \n\nRead more at https://docs.orama.com/open-source/plugins/plugin-data-persistence.`
}
2 changes: 1 addition & 1 deletion packages/plugin-nextra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Official plugin to provide search capabilities through Orama on any Nextra websi

# Usage

For the complete usage guide, please refer to the [official plugin documentation](https://docs.oramasearch.com/open-source/plugins/plugin-nextra).
For the complete usage guide, please refer to the [official plugin documentation](https://docs.orama.com/open-source/plugins/plugin-nextra).

# License

Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-parsedoc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This plugin aims to generate an index for Orama from HTML files

# Usage

For the complete usage guide, please refer to the [official plugin documentation](https://docs.oramasearch.com/open-source/plugins/plugin-parsedoc).
For the complete usage guide, please refer to the [official plugin documentation](https://docs.orama.com/open-source/plugins/plugin-parsedoc).

# License

Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-secure-proxy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Available **chat** models:

Mode models coming soon!

For the full configuration guide of this plugin, please follow the [official plugin documentation](https://docs.oramasearch.com/open-source/plugins/plugin-secure-proxy).
For the full configuration guide of this plugin, please follow the [official plugin documentation](https://docs.orama.com/open-source/plugins/plugin-secure-proxy).

# License

Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-vitepress/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Official plugin to provide search capabilities through Orama on any Vitepress we

# Usage

For the complete usage guide, please refer to the [official plugin documentation](https://docs.oramasearch.com/open-source/plugins/plugin-vitepress).
For the complete usage guide, please refer to the [official plugin documentation](https://docs.orama.com/open-source/plugins/plugin-vitepress).

# TL;DR

Expand Down
2 changes: 1 addition & 1 deletion packages/stemmers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ const db = create({
})
```
Read more in the official docs: [https://docs.oramasearch.com/open-source/text-analysis/stemming](https://docs.oramasearch.com/open-source/text-analysis/stemming).
Read more in the official docs: [https://docs.orama.com/open-source/text-analysis/stemming](https://docs.orama.com/open-source/text-analysis/stemming).
# License
Expand Down
Loading

0 comments on commit fa686ad

Please sign in to comment.