Move content out of learn/experimental section (#2979)

meilisearch · Nov 6, 2024 · 8221d99 · 8221d99
1 parent 9e8fbc6
commit 8221d99
Show file tree

Hide file tree

Showing 28 changed files with 525 additions and 636 deletions.
diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml
@@ -1215,43 +1215,6 @@ index_settings_tutorial_api_put_setting_1: |-
 index_settings_tutorial_api_task_1: |-
   curl \
     -X GET 'http://localhost:7700/tasks/TASK_UID'
-get_embedders_1: |-
-  curl \
-    -X GET 'http://localhost:7700/indexes/INDEX_NAME/settings/embedders'
-update_embedders_1: |-
-  curl \
-    -X PATCH 'http://localhost:7700/indexes/INDEX_NAME/settings' \
-    -H 'Content-Type: application/json' \
-    --data-binary '{
-      "embedders": {
-        "default": {
-          "source":  "openAi",
-          "apiKey": "anOpenAiApiKey",
-          "model": "text-embedding-3-small",
-          "documentTemplate": "A document titled '{{doc.title}}' whose description starts with {{doc.overview|truncatewords: 20}}"
-        }
-      }
-    }'
-reset_embedders_1: |-
-  curl \
-    -X DELETE 'http://localhost:7700/indexes/INDEX_NAME/settings/embedders'
-search_parameter_guide_hybrid_1: |-
-  curl -X POST 'localhost:7700/indexes/INDEX_NAME/search' \
-    -H 'content-type: application/json' \
-    --data-binary '{
-      "q": "kitchen utensils",
-      "hybrid": {
-        "semanticRatio": 0.9,
-        "embedder": "EMBEDDER_NAME"
-      }
-    }'
-search_parameter_guide_vector_1: |-
-  curl -X POST 'localhost:7700/indexes/INDEX_NAME/search' \
-    -H 'content-type: application/json' \
-    --data-binary '{ 
-      "vector": [0, 1, 2],
-      "embedder": "EMBEDDER_NAME"
-    }'
 get_search_cutoff_1: |-
   curl \
     -X GET 'http://localhost:7700/indexes/movies/settings/search-cutoff-ms'
@@ -1317,16 +1280,6 @@ analytics_event_bind_event_1: |-
       "objectId": "0",
       "position": 0
     }'
-search_parameter_reference_retrieve_vectors_1: |-
-  curl -X POST 'localhost:7700/indexes/INDEX_NAME/search' \
-    -H 'content-type: application/json' \
-    --data-binary '{
-      "q": "kitchen utensils",
-      "retrieveVectors": true,
-      "hybrid": {
-        "embedder": "EMBEDDER_NAME"
-      }
-    }'
 search_parameter_reference_distinct_1: |-
   curl \
     -X POST 'http://localhost:7700/indexes/INDEX_NAME/search' \
@@ -1395,3 +1348,73 @@ update_localized_attribute_settings_1: |-
 reset_localized_attribute_settings_1: |-
   curl \
     -X DELETE 'http://localhost:7700/indexes/INDEX_NAME/settings/localized-attributes'
+
+### Code samples for experimental features
+get_embedders_1: |-
+  curl \
+    -X GET 'http://localhost:7700/indexes/INDEX_NAME/settings/embedders'
+update_embedders_1: |-
+  curl \
+    -X PATCH 'http://localhost:7700/indexes/INDEX_NAME/settings' \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+      "embedders": {
+        "default": {
+          "source":  "openAi",
+          "apiKey": "anOpenAiApiKey",
+          "model": "text-embedding-3-small",
+          "documentTemplate": "A document titled '{{doc.title}}' whose description starts with {{doc.overview|truncatewords: 20}}"
+        }
+      }
+    }'
+reset_embedders_1: |-
+  curl \
+    -X DELETE 'http://localhost:7700/indexes/INDEX_NAME/settings/embedders'
+search_parameter_guide_hybrid_1: |-
+  curl -X POST 'localhost:7700/indexes/INDEX_NAME/search' \
+    -H 'content-type: application/json' \
+    --data-binary '{
+      "q": "kitchen utensils",
+      "hybrid": {
+        "semanticRatio": 0.9,
+        "embedder": "EMBEDDER_NAME"
+      }
+    }'
+search_parameter_guide_vector_1: |-
+  curl -X POST 'localhost:7700/indexes/INDEX_NAME/search' \
+    -H 'content-type: application/json' \
+    --data-binary '{ 
+      "vector": [0, 1, 2],
+      "embedder": "EMBEDDER_NAME"
+    }'
+search_parameter_reference_retrieve_vectors_1: |-
+  curl -X POST 'localhost:7700/indexes/INDEX_NAME/search' \
+    -H 'content-type: application/json' \
+    --data-binary '{
+      "q": "kitchen utensils",
+      "retrieveVectors": true,
+      "hybrid": {
+        "embedder": "EMBEDDER_NAME"
+      }
+    }'
+experimental_get_metrics_1: |-
+  curl \
+    -X GET 'http://localhost:7700/metrics'
+experimental_post_logs_stderr_1: |-
+  curl \
+    -X POST http://localhost:7700/logs/stderr \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+        "target": "milli=trace,index_scheduler=info,actix_web=off"
+    }'
+experimental_post_logs_stream_1: |-
+  curl \
+    -X POST http://localhost:7700/logs/stream \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+      "mode": "human",
+      "target": "index_scheduler=trace"
+    }'
+experimental_delete_logs_stream_1: |-
+  curl \
+    -X DELETE http://localhost:7700/logs/stream
diff --git a/config/redirects.json b/config/redirects.json
@@ -499,6 +499,46 @@
     "destination": "/docs/learn/resources/contributing_docs",
     "permanent": true
   },
+  {
+    "source": "/docs/learn/experimental/overview",
+    "destination": "/docs/learn/resources/experimental_features_overview",
+    "permanent": true
+  },
+  {
+    "source": "/docs/learn/experimental/max_number_of_batched_tasks",
+    "destination": "/docs/learn/self_hosted/configure_meilisearch_at_launch",
+    "permanent": true
+  },
+  {
+    "source": "/docs/learn/experimental/metrics",
+    "destination": "/docs/reference/api/metrics",
+    "permanent": true
+  },
+  {
+    "source": "/docs/learn/experimental/reduce-indexing-memory-usage",
+    "destination": "/docs/learn/self_hosted/configure_meilisearch_at_launch",
+    "permanent": true
+  },
+  {
+    "source": "/docs/learn/experimental/log_customization",
+    "destination": "/docs/reference/api/logs",
+    "permanent": true
+  },
+  {
+    "source": "/docs/learn/experimental/vector_search",
+    "destination": "/docs/learn/ai_powered_search/getting_started_with_ai_search",
+    "permanent": true
+  },
+  {
+    "source": "/docs/learn/experimental/search_queue_size",
+    "destination": "/docs/learn/self_hosted/configure_meilisearch_at_launch",
+    "permanent": true
+  },
+  {
+    "source": "/docs/learn/experimental/replication_parameter",
+    "destination": "/docs/learn/self_hosted/configure_meilisearch_at_launch",
+    "permanent": true
+  },
   {
     "source": "/docs/guides/database/meilisync_mysql",
     "destination": "https://github.com/long2ice/meilisync",
@@ -508,5 +548,25 @@
     "source": "/docs/guides/database/meilisync_postgresql",
     "destination": "https://github.com/long2ice/meilisync",
     "permanent": true
+  },
+  {
+    "source": "/docs/learn/ai-powered-search/search_with_user_provided_embeddings",
+    "destination": "/docs/learn/ai_powered_search/search_with_user_provided_embeddings",
+    "permanent": true
+  },
+  {
+    "source": "/docs/learn/ai-powered-search/getting_started_with_ai_search",
+    "destination": "/docs/learn/ai_powered_search/getting_started_with_ai_search",
+    "permanent": true
+  },
+  {
+    "source": "/docs/learn/ai-powered-search/deactivate_ai_powered_search",
+    "destination": "/docs/learn/ai_powered_search/deactivate_ai_powered_search",
+    "permanent": true
+  },
+  {
+    "source": "/docs/learn/ai-powered-search/difference_full_text_ai_search",
+    "destination": "/docs/learn/ai_powered_search/difference_full_text_ai_search",
+    "permanent": true
   }
 ]
diff --git a/config/sidebar-learn.json b/config/sidebar-learn.json
@@ -37,13 +37,23 @@
   },
   {
     "title": "AI-powered search",
-    "slug": "ai-powered-search",
+    "slug": "ai_powered_search",
     "routes": [
       {
         "source": "learn/ai_powered_search/getting_started_with_ai_search.mdx",
         "label": "Getting started with AI-powered search",
         "slug": "getting_started_with_ai_search"
       },
+      {
+        "source": "learn/ai_powered_search/search_with_user_provided_embeddings.mdx",
+        "label": "Use AI-powered search with user-provided embeddings",
+        "slug": "search_with_user_provided_embeddings"
+      },
+      {
+        "source": "learn/ai_powered_search/deactivate_ai_powered_search.mdx",
+        "label": "Deactivate AI-powered search",
+        "slug": "deactivate_ai_powered_search"
+      },
       {
         "source": "learn/ai_powered_search/difference_full_text_ai_search.mdx",
         "label": "Differences between full-text and AI-powered search",
@@ -428,6 +438,11 @@
         "label": "Known limitations",
         "slug": "known_limitations"
       },
+      {
+        "source": "learn/resources/experimental_features_overview.mdx",
+        "label": "Experimental features overview",
+        "slug": "experimental_features_overview"
+      },
       {
         "source": "learn/resources/faq.mdx",
         "label": "FAQ",
@@ -469,46 +484,6 @@
     "title": "Experimental",
     "slug": "experimental",
     "routes": [
-      {
-        "source": "learn/experimental/overview.mdx",
-        "label": "Overview",
-        "slug": "overview"
-      },
-      {
-        "source": "learn/experimental/max_number_of_batched_tasks.mdx",
-        "label": "Limit number of batched tasks",
-        "slug": "max_number_of_batched_tasks"
-      },
-      {
-        "source": "learn/experimental/metrics.mdx",
-        "label": "Metrics",
-        "slug": "metrics"
-      },
-      {
-        "source": "learn/experimental/reduce-indexing-memory-usage.mdx",
-        "label": "Reduce indexing memory usage",
-        "slug": "reduce-indexing-memory-usage"
-      },
-      {
-        "source": "learn/experimental/log_customization.mdx",
-        "label": "Log customization",
-        "slug": "log_customization"
-      },
-      {
-        "source": "learn/experimental/vector_search.mdx",
-        "label": "Vector search",
-        "slug": "vector_search"
-      },
-      {
-        "source": "learn/experimental/replication_parameters.mdx",
-        "label": "Replication parameters",
-        "slug": "replication_parameters"
-      },
-      {
-        "source": "learn/experimental/search_queue_size.mdx",
-        "label": "Search queue size",
-        "slug": "search_queue_size"
-      }
     ]
   }
 ]
diff --git a/config/sidebar-reference.json b/config/sidebar-reference.json
@@ -82,6 +82,16 @@
         "source": "reference/api/experimental_features.mdx",
         "label": "Experimental features",
         "slug": "experimental_features"
+      },
+      {
+        "source": "reference/api/metrics.mdx",
+        "label": "Metrics",
+        "slug": "metrics"
+      },
+      {
+        "source": "reference/api/logs.mdx",
+        "label": "Logs",
+        "slug": "logs"
       }
     ]
   },

diff --git a/guides/embedders/cloudflare.mdx b/guides/embedders/cloudflare.mdx
@@ -55,7 +55,7 @@ In this configuration:
 - `source`: Specifies the source of the embedder, which is set to "rest" for using a REST API.
 - `apiKey`: Replace `<API Key>` with your actual Cloudflare API key.
 - `dimensions`: Specifies the dimensions of the embeddings. Set to 384 for `baai/bge-small-en-v1.5`, 768 for `baai/bge-base-en-v1.5`, or 1024 for `baai/bge-large-en-v1.5`.
-- `documentTemplate`: Optionally, you can provide a [custom template](/learn/ai-powered-search/getting_started_with_ai_search?utm_campaign=vector-search&utm_source=docs&utm_medium=cloudflare-embeddings-guide#documenttemplate) for generating embeddings from your documents.
+- `documentTemplate`: Optionally, you can provide a [custom template](/learn/ai_powered_search/getting_started_with_ai_search?utm_campaign=vector-search&utm_source=docs&utm_medium=cloudflare-embeddings-guide#documenttemplate) for generating embeddings from your documents.
 - `url`: Specifies the URL of the Cloudflare Worker AI API endpoint.
 - `request`: Defines the request structure for the Cloudflare Worker AI API, including the input parameters.
 - `response`: Defines the expected response structure from the Cloudflare Worker AI API, including the embedding data.

diff --git a/guides/embedders/cohere.mdx b/guides/embedders/cohere.mdx
@@ -58,7 +58,7 @@ In this configuration:
 - `source`: Specifies the source of the embedder, which is set to "rest" for using a REST API.
 - `apiKey`: Replace `<Cohere API Key>` with your actual Cohere API key.
 - `dimensions`: Specifies the dimensions of the embeddings, set to 1024 for the `embed-english-v3.0` model.
-- `documentTemplate`: Optionally, you can provide a [custom template](/learn/ai-powered-search/getting_started_with_ai_search?utm_campaign=vector-search&utm_source=docs&utm_medium=cohere-embeddings-guide#documenttemplate) for generating embeddings from your documents.
+- `documentTemplate`: Optionally, you can provide a [custom template](/learn/ai_powered_search/getting_started_with_ai_search?utm_campaign=vector-search&utm_source=docs&utm_medium=cohere-embeddings-guide#documenttemplate) for generating embeddings from your documents.
 - `url`: Specifies the URL of the Cohere API endpoint.
 - `request`: Defines the request structure for the Cohere API, including the model name and input parameters.
 - `response`: Defines the expected response structure from the Cohere API, including the embedding data.

diff --git a/guides/embedders/mistral.mdx b/guides/embedders/mistral.mdx
@@ -54,7 +54,7 @@ In this configuration:
 - `source`: Specifies the source of the embedder, which is set to "rest" for using a REST API.
 - `apiKey`: Replace `<Mistral API Key>` with your actual Mistral API key.
 - `dimensions`: Specifies the dimensions of the embeddings, set to 1024 for the `mistral-embed` model.
-- `documentTemplate`: Optionally, you can provide a [custom template](/learn/ai-powered-search/getting_started_with_ai_search?utm_campaign=vector-search&utm_source=docs&utm_medium=mistral-embeddings-guide#documenttemplate) for generating embeddings from your documents.
+- `documentTemplate`: Optionally, you can provide a [custom template](/learn/ai_powered_search/getting_started_with_ai_search?utm_campaign=vector-search&utm_source=docs&utm_medium=mistral-embeddings-guide#documenttemplate) for generating embeddings from your documents.
 - `url`: Specifies the URL of the Mistral API endpoint.
 - `request`: Defines the request structure for the Mistral API, including the model name and input parameters.
 - `response`: Defines the expected response structure from the Mistral API, including the embedding data.

diff --git a/guides/embedders/openai.mdx b/guides/embedders/openai.mdx
@@ -46,7 +46,7 @@ In this configuration:
 - `source`: Specifies the source of the embedder, which is set to "openAi" for using OpenAI's API.
 - `apiKey`: Replace `<OpenAI API Key>` with your actual OpenAI API key.
 - `dimensions`: Specifies the dimensions of the embeddings. Set to 1536 for `text-embedding-3-small` and `text-embedding-ada-002`, or 3072 for `text-embedding-3-large`.
-- `documentTemplate`: Optionally, you can provide a [custom template](/learn/ai-powered-search/getting_started_with_ai_search?utm_campaign=vector-search&utm_source=docs&utm_medium=openai-embeddings-guide#documenttemplate) for generating embeddings from your documents.
+- `documentTemplate`: Optionally, you can provide a [custom template](/learn/ai_powered_search/getting_started_with_ai_search?utm_campaign=vector-search&utm_source=docs&utm_medium=openai-embeddings-guide#documenttemplate) for generating embeddings from your documents.
 - `model`: Specifies the OpenAI model to use for generating embeddings. Choose from `text-embedding-3-large`, `text-embedding-3-small`, or `text-embedding-ada-002`.
 
 Once you've configured the embedder settings, Meilisearch will automatically generate embeddings for your documents and store them in the vector store.

diff --git a/guides/embedders/voyage.mdx b/guides/embedders/voyage.mdx
@@ -59,7 +59,7 @@ In this configuration:
 - `source`: Specifies the source of the embedder, which is set to "rest" for using a REST API.
 - `apiKey`: Replace `<Voyage AI API Key>` with your actual Voyage AI API key.
 - `dimensions`: Specifies the dimensions of the embeddings. Set to 1024 for `voyage-2`, `voyage-large-2-instruct`, and `voyage-multilingual-2`, or 1536 for `voyage-large-2`.
-- `documentTemplate`: Optionally, you can provide a [custom template](/learn/ai-powered-search/getting_started_with_ai_search?utm_campaign=vector-search&utm_source=docs&utm_medium=voyage-embeddings-guide#documenttemplate) for generating embeddings from your documents.
+- `documentTemplate`: Optionally, you can provide a [custom template](/learn/ai_powered_search/getting_started_with_ai_search?utm_campaign=vector-search&utm_source=docs&utm_medium=voyage-embeddings-guide#documenttemplate) for generating embeddings from your documents.
 - `url`: Specifies the URL of the Voyage AI API endpoint.
 - `request`: Defines the request structure for the Voyage AI API, including the model name and input parameters.
 - `response`: Defines the expected response structure from the Voyage AI API, including the embedding data.

diff --git a/guides/langchain.mdx b/guides/langchain.mdx
@@ -20,7 +20,7 @@ On Meilisearch Cloud, enable the vector store feature via your project’s Setti
 
 ![A section of the project overview interface titled "Experimental features". There are two options: "Score details" and "Vector store". "Vector store" is turned on.](https://raw.githubusercontent.com/meilisearch/documentation/main/assets/images/vector-search/01-cloud-vector-store.png)
 
-If you are working with a self-hosted Meilisearch instance, activate the vector store with the [API route](/learn/experimental/vector_search#activate-vector-search).
+If you are working with a self-hosted Meilisearch instance, activate the vector store with the [API route](/reference/api/experimental_features).
 
 ## Creating the application
 
@@ -167,4 +167,4 @@ For additional information, consult:
 
 [Meilisearch Python SDK docs](https://python-sdk.meilisearch.com/)
 
-Finally, should you want to use Meilisearch's vector search capabilities without LangChain or its hybrid search feature, refer to the [dedicated guide](/learn/experimental/vector_search).
+Finally, should you want to use Meilisearch's vector search capabilities without LangChain or its hybrid search feature, refer to the [dedicated tutorial](/learn/ai_powered_search/getting_started_with_ai_search).