From c6587f929b8a2fae8e238ab1bcf447a81e44f91f Mon Sep 17 00:00:00 2001 From: Arka Poddar Date: Fri, 28 Jun 2024 14:42:55 +0530 Subject: [PATCH 1/3] Update search.mdx Added two rows separately for GET and POST for "showRankingScoreDetails" --- reference/api/search.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/reference/api/search.mdx b/reference/api/search.mdx index d178e3320..ba6efeaf4 100644 --- a/reference/api/search.mdx +++ b/reference/api/search.mdx @@ -53,6 +53,7 @@ By default, [this endpoint returns a maximum of 1000 results](/learn/advanced/kn | **[`sort`](#sort)** | Array of strings | `null` | Sort search results by an attribute's value | | **[`matchingStrategy`](#matching-strategy)** | String | `last` | Strategy used to match query terms within documents | | **[`showRankingScore`](#ranking-score)** | Boolean | `false` | Display the global ranking score of a document | +| **[`showRankingScoreDetails`](#ranking-score-details)** | Boolean | `false` | Adds a detailed global ranking score field | | **[`attributesToSearchOn`](#customize-attributes-to-search-on-at-search-time)** | Array of strings | `["*"]` | Restrict search to the specified attributes | | **[`hybrid`](#hybrid-search-experimental)** | Object | `null` | Return results based on query keywords and meaning | | **[`vector`](#vector-experimental)** | Array of numbers | `null` | Search using a custom query vector | @@ -163,6 +164,7 @@ By default, [this endpoint returns a maximum of 1000 results](/learn/advanced/kn | **[`sort`](#sort)** | Array of strings | `null` | Sort search results by an attribute's value | | **[`matchingStrategy`](#matching-strategy)** | String | `last` | Strategy used to match query terms within documents | | **[`showRankingScore`](#ranking-score)** | Boolean | `false` | Display the global ranking score of a document | +| **[`showRankingScoreDetails`](#ranking-score-details)** | Boolean | `false` | Adds a detailed global ranking score field | | **[`attributesToSearchOn`](#customize-attributes-to-search-on-at-search-time)** | Array of strings | `["*"]` | Restrict search to the specified attributes | | **[`hybrid`](#hybrid-search-experimental)** | Object | `null` | Return results based on query keywords and meaning | | **[`vector`](#vector-experimental)** | Array of numbers | `null` | Search using a custom query vector | From 1b5f798c3d5126e99faaba9e6796e916e7863863 Mon Sep 17 00:00:00 2001 From: Arka Poddar Date: Mon, 5 Aug 2024 23:13:24 +0530 Subject: [PATCH 2/3] Update generate_tenant_token_scratch.mdx Fixed #2893 --- learn/security/generate_tenant_token_scratch.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/learn/security/generate_tenant_token_scratch.mdx b/learn/security/generate_tenant_token_scratch.mdx index 50678da16..a7f8e0c1c 100644 --- a/learn/security/generate_tenant_token_scratch.mdx +++ b/learn/security/generate_tenant_token_scratch.mdx @@ -64,7 +64,7 @@ Consult the [token payload reference](/learn/security/tenant_token_reference) fo ## Encode header and payload -You must then encode both the header and the payload into `base64`, concatenate them, and generate the token by signing it using your chosen encryption algorithm. +You must then encode both the header and the payload into `base64`, concatenate them, and generate the token by signing it using your chosen encryption algorithm. For more details [click here](https://jwt.io/). ## Make a search request using a tenant token From 3c7ec8a392ea168acb83c08d9f8fa65052dfcf25 Mon Sep 17 00:00:00 2001 From: Arka Poddar Date: Mon, 5 Aug 2024 23:33:38 +0530 Subject: [PATCH 3/3] Update search.mdx Fixed #2774 --- reference/api/search.mdx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/reference/api/search.mdx b/reference/api/search.mdx index 9c2de1614..3fc03deac 100644 --- a/reference/api/search.mdx +++ b/reference/api/search.mdx @@ -383,6 +383,9 @@ A search query cannot return more results than configured in [`maxTotalHits`](/r #### Example If you want your query to return only **two** documents, set `limit` to `2`: +
+Also,
+If you want your query to return only **zero** documents, set `limit` to 0: (Maybe useful for anykind of restricted search)