diff --git a/docs/query-agent/_includes/code/search_mode.mts b/docs/query-agent/_includes/code/search_mode.mts index fc9f355b..af2bbefb 100644 --- a/docs/query-agent/_includes/code/search_mode.mts +++ b/docs/query-agent/_includes/code/search_mode.mts @@ -102,4 +102,15 @@ for (const obj of filteringResponse.searchResults.objects) { } // END FilteringExample +// START EffortExample +const effortResponse = await qa.search("What are Setwise Rerankers?", { + limit: 10, + effort: "high", +}); + +for (const obj of effortResponse.searchResults.objects) { + console.log(obj.properties); +} +// END EffortExample + await client.close(); diff --git a/docs/query-agent/_includes/code/search_mode.py b/docs/query-agent/_includes/code/search_mode.py index d1bab68d..c8576661 100644 --- a/docs/query-agent/_includes/code/search_mode.py +++ b/docs/query-agent/_includes/code/search_mode.py @@ -107,6 +107,17 @@ print(f"Product: {obj.properties['name']} - ${obj.properties['price']}") # END FilteringExample +# START EffortExample +search_response = qa.search( + "What are Setwise Rerankers?", + limit=10, + effort="high", +) + +for obj in search_response.search_results.objects: + print(obj.properties) +# END EffortExample + # --- Async code examples in string as top-level await doesn't work, full code will be executed in # asyncio.run below diff --git a/docs/query-agent/guides/search_mode.md b/docs/query-agent/guides/search_mode.md index ff4d6a24..6329919c 100644 --- a/docs/query-agent/guides/search_mode.md +++ b/docs/query-agent/guides/search_mode.md @@ -69,6 +69,7 @@ The `.search()` method accepts several arguments: | `limit` | `int` | The maximum number of results returned in this page of results. Defaults to `20`. Use [`.next()`](#pagination) to fetch additional pages. | | `filtering` | `Literal["recall", "precision"]` | Either `"recall"` or `"precision"` to control filter generation. `"recall"` favors more results across filter interpretations; `"precision"` favors strict intent match. See [Customized filtering](#customized-filtering) below. | | `diversity_weight` | `float \| None` | A value between `0.0` and `1.0` that biases the result ranking towards diversity using Maximal Marginal Relevance (MMR). See [Diversity ranking](#diversity-ranking) below. | +| `effort` | `Literal["low", "medium", "high"] \| None` | The amount of effort the agent puts into the search. Higher effort may improve result quality at the expense of increased latency and cost. See [Search effort](#search-effort) below. | @@ -79,6 +80,7 @@ The `.search()` method accepts several arguments: | `limit` | `number` | The maximum number of results returned in this page of results. Defaults to `20`. Use [`.next()`](#pagination) to fetch additional pages. | | `filtering` | `"recall" \| "precision"` | Either `"recall"` or `"precision"` to control filter generation. `"recall"` favors more results across filter interpretations; `"precision"` favors strict intent match. See [Customized filtering](#customized-filtering) below. | | `diversityWeight` | `number` | A value between `0.0` and `1.0` that biases the result ranking towards diversity using Maximal Marginal Relevance (MMR). See [Diversity ranking](#diversity-ranking) below. | +| `effort` | `"low" \| "medium" \| "high"` | The amount of effort the agent puts into the search. Higher effort may improve result quality at the expense of increased latency and cost. See [Search effort](#search-effort) below. | @@ -138,6 +140,31 @@ To use diversity ranking with target vectors, set the single target vector you w +### Search effort + +The optional `effort` parameter controls the amount of effort the agent puts into the search. It accepts one of `"low"`, `"medium"`, or `"high"` — higher effort may improve result quality at the expense of increased latency and cost. When omitted, the search behaves as if the parameter did not exist. + +The effort value is fixed for the lifetime of a search: paginating with [`.next()`](#pagination) reuses the same effort value on every page, just as the underlying searches are reused to keep the result set consistent. + + + + + + + + + + ## Response The Search Mode response has the following properties: