diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Clients/AbtestingClient.cs b/clients/algoliasearch-client-csharp/algoliasearch/Clients/AbtestingClient.cs
index 71a62f4d4b..c8deada1b8 100644
--- a/clients/algoliasearch-client-csharp/algoliasearch/Clients/AbtestingClient.cs
+++ b/clients/algoliasearch-client-csharp/algoliasearch/Clients/AbtestingClient.cs
@@ -204,8 +204,8 @@ public interface IAbtestingClient
///
/// List all A/B tests.
///
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
- /// Number of records to return (page size). (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. (optional, default to 10)
/// Only return A/B tests for indices starting with this prefix. (optional)
/// Only return A/B tests for indices ending with this suffix. (optional)
/// Add extra http header or query parameters to Algolia.
@@ -219,8 +219,8 @@ public interface IAbtestingClient
///
/// List all A/B tests. (Synchronous version)
///
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
- /// Number of records to return (page size). (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. (optional, default to 10)
/// Only return A/B tests for indices starting with this prefix. (optional)
/// Only return A/B tests for indices ending with this suffix. (optional)
/// Add extra http header or query parameters to Algolia.
@@ -621,8 +621,8 @@ public ABTest GetABTest(int id, RequestOptions options = null, CancellationToken
///
/// Required API Key ACLs:
/// - analytics
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
- /// Number of records to return (page size). (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. (optional, default to 10)
/// Only return A/B tests for indices starting with this prefix. (optional)
/// Only return A/B tests for indices ending with this suffix. (optional)
/// Add extra http header or query parameters to Algolia.
@@ -650,8 +650,8 @@ public async Task ListABTestsAsync(int? offset = default, i
///
/// Required API Key ACLs:
/// - analytics
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
- /// Number of records to return (page size). (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
+ /// Number of items to return. (optional, default to 10)
/// Only return A/B tests for indices starting with this prefix. (optional)
/// Only return A/B tests for indices ending with this suffix. (optional)
/// Add extra http header or query parameters to Algolia.
diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Clients/AnalyticsClient.cs b/clients/algoliasearch-client-csharp/algoliasearch/Clients/AnalyticsClient.cs
index 5201f33237..9072aa4a1e 100644
--- a/clients/algoliasearch-client-csharp/algoliasearch/Clients/AnalyticsClient.cs
+++ b/clients/algoliasearch-client-csharp/algoliasearch/Clients/AnalyticsClient.cs
@@ -132,9 +132,9 @@ public interface IAnalyticsClient
///
/// Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -147,9 +147,9 @@ public interface IAnalyticsClient
///
/// Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`. (Synchronous version)
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -162,9 +162,9 @@ public interface IAnalyticsClient
///
/// Show the number of clicks events and their associated position in the search results. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -177,9 +177,9 @@ public interface IAnalyticsClient
///
/// Show the number of clicks events and their associated position in the search results. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`. (Synchronous version)
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -192,9 +192,9 @@ public interface IAnalyticsClient
///
/// Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -207,9 +207,9 @@ public interface IAnalyticsClient
///
/// Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate). (Synchronous version)
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -222,9 +222,9 @@ public interface IAnalyticsClient
///
/// Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -237,9 +237,9 @@ public interface IAnalyticsClient
///
/// Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate). (Synchronous version)
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -252,9 +252,9 @@ public interface IAnalyticsClient
///
/// Returns the rate at which searches don't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -267,9 +267,9 @@ public interface IAnalyticsClient
///
/// Returns the rate at which searches don't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks. (Synchronous version)
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -282,9 +282,9 @@ public interface IAnalyticsClient
///
/// Returns the rate at which searches didn't return any results.
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -297,9 +297,9 @@ public interface IAnalyticsClient
///
/// Returns the rate at which searches didn't return any results. (Synchronous version)
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -312,9 +312,9 @@ public interface IAnalyticsClient
///
/// Returns the number of searches within a time range.
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -327,9 +327,9 @@ public interface IAnalyticsClient
///
/// Returns the number of searches within a time range. (Synchronous version)
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -342,11 +342,11 @@ public interface IAnalyticsClient
///
/// Return the most popular of the last 1,000 searches that didn't lead to any clicks.
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -359,11 +359,11 @@ public interface IAnalyticsClient
///
/// Return the most popular of the last 1,000 searches that didn't lead to any clicks. (Synchronous version)
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -376,11 +376,11 @@ public interface IAnalyticsClient
///
/// Returns the most popular of the latest 1,000 searches that didn't return any results.
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -393,11 +393,11 @@ public interface IAnalyticsClient
///
/// Returns the most popular of the latest 1,000 searches that didn't return any results. (Synchronous version)
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -410,7 +410,7 @@ public interface IAnalyticsClient
///
/// Return the latest update time of the Analytics API for an index. If the index has been recently created or no search has been performed yet, `updatedAt` will be `null`. > **Note**: The Analytics API is updated every 5 minutes.
///
- /// Index name to target.
+ /// Index name.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -422,7 +422,7 @@ public interface IAnalyticsClient
///
/// Return the latest update time of the Analytics API for an index. If the index has been recently created or no search has been performed yet, `updatedAt` will be `null`. > **Note**: The Analytics API is updated every 5 minutes. (Synchronous version)
///
- /// Index name to target.
+ /// Index name.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -434,11 +434,11 @@ public interface IAnalyticsClient
///
/// Returns top countries. Limited to the 1,000 most frequent ones.
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -451,11 +451,11 @@ public interface IAnalyticsClient
///
/// Returns top countries. Limited to the 1,000 most frequent ones. (Synchronous version)
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -468,12 +468,12 @@ public interface IAnalyticsClient
///
/// Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters.
///
- /// Index name to target.
+ /// Index name.
/// User query. (optional)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -486,12 +486,12 @@ public interface IAnalyticsClient
///
/// Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters. (Synchronous version)
///
- /// Index name to target.
+ /// Index name.
/// User query. (optional)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -505,12 +505,12 @@ public interface IAnalyticsClient
/// Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
///
/// Attribute name.
- /// Index name to target.
+ /// Index name.
/// User query. (optional)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -524,12 +524,12 @@ public interface IAnalyticsClient
/// Returns the most popular filter values for an attribute in the 1,000 most recently used filters. (Synchronous version)
///
/// Attribute name.
- /// Index name to target.
+ /// Index name.
/// User query. (optional)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -542,12 +542,12 @@ public interface IAnalyticsClient
///
/// Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters.
///
- /// Index name to target.
+ /// Index name.
/// User query. (optional)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -560,12 +560,12 @@ public interface IAnalyticsClient
///
/// Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters. (Synchronous version)
///
- /// Index name to target.
+ /// Index name.
/// User query. (optional)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -578,13 +578,13 @@ public interface IAnalyticsClient
///
/// Return the most popular clicked results in the last 1,000 searches.
///
- /// Index name to target.
+ /// Index name.
/// User query. (optional)
/// Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (optional, default to false)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -597,13 +597,13 @@ public interface IAnalyticsClient
///
/// Return the most popular clicked results in the last 1,000 searches. (Synchronous version)
///
- /// Index name to target.
+ /// Index name.
/// User query. (optional)
/// Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (optional, default to false)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -616,14 +616,14 @@ public interface IAnalyticsClient
///
/// Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
///
- /// Index name to target.
+ /// Index name.
/// Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (optional, default to false)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Reorder the results. (optional)
/// Sorting direction of the results: ascending or descending. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -636,14 +636,14 @@ public interface IAnalyticsClient
///
/// Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits. (Synchronous version)
///
- /// Index name to target.
+ /// Index name.
/// Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (optional, default to false)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Reorder the results. (optional)
/// Sorting direction of the results: ascending or descending. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -656,9 +656,9 @@ public interface IAnalyticsClient
///
/// Return the count of unique users.
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -671,9 +671,9 @@ public interface IAnalyticsClient
///
/// Return the count of unique users. (Synchronous version)
///
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -923,9 +923,9 @@ public object CustomPut(string path, Dictionary parameters = def
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -956,9 +956,9 @@ public async Task GetAverageClickPositionAsync(
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -976,9 +976,9 @@ public GetAverageClickPositionResponse GetAverageClickPosition(string index, str
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1009,9 +1009,9 @@ public async Task GetClickPositionsAsync(string index
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1029,9 +1029,9 @@ public GetClickPositionsResponse GetClickPositions(string index, string startDat
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1062,9 +1062,9 @@ public async Task GetClickThroughRateAsync(string i
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1082,9 +1082,9 @@ public GetClickThroughRateResponse GetClickThroughRate(string index, string star
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1115,9 +1115,9 @@ public async Task GetConversationRateAsync(string i
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1135,9 +1135,9 @@ public GetConversationRateResponse GetConversationRate(string index, string star
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1168,9 +1168,9 @@ public async Task GetNoClickRateAsync(string index, stri
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1188,9 +1188,9 @@ public GetNoClickRateResponse GetNoClickRate(string index, string startDate = de
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1221,9 +1221,9 @@ public async Task GetNoResultsRateAsync(string index,
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1241,9 +1241,9 @@ public GetNoResultsRateResponse GetNoResultsRate(string index, string startDate
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1274,9 +1274,9 @@ public async Task GetSearchesCountAsync(string index,
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1294,11 +1294,11 @@ public GetSearchesCountResponse GetSearchesCount(string index, string startDate
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1331,11 +1331,11 @@ public async Task GetSearchesNoClicksAsync(string i
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1353,11 +1353,11 @@ public GetSearchesNoClicksResponse GetSearchesNoClicks(string index, string star
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1390,11 +1390,11 @@ public async Task GetSearchesNoResultsAsync(string
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1412,7 +1412,7 @@ public GetSearchesNoResultsResponse GetSearchesNoResults(string index, string st
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
+ /// Index name.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -1439,7 +1439,7 @@ public async Task GetStatusAsync(string index, RequestOptions
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
+ /// Index name.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -1456,11 +1456,11 @@ public GetStatusResponse GetStatus(string index, RequestOptions options = null,
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1493,11 +1493,11 @@ public async Task GetTopCountriesAsync(string index, st
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1515,12 +1515,12 @@ public GetTopCountriesResponse GetTopCountries(string index, string startDate =
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
+ /// Index name.
/// User query. (optional)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1554,12 +1554,12 @@ public async Task GetTopFilterAttributesAsync(st
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
+ /// Index name.
/// User query. (optional)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1578,12 +1578,12 @@ public GetTopFilterAttributesResponse GetTopFilterAttributes(string index, strin
/// Required API Key ACLs:
/// - analytics
/// Attribute name.
- /// Index name to target.
+ /// Index name.
/// User query. (optional)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1623,12 +1623,12 @@ public async Task GetTopFilterForAttributeAsyn
/// Required API Key ACLs:
/// - analytics
/// Attribute name.
- /// Index name to target.
+ /// Index name.
/// User query. (optional)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1646,12 +1646,12 @@ public GetTopFilterForAttributeResponse GetTopFilterForAttribute(string attribut
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
+ /// Index name.
/// User query. (optional)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1685,12 +1685,12 @@ public async Task GetTopFiltersNoResultsAsync(st
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
+ /// Index name.
/// User query. (optional)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1708,13 +1708,13 @@ public GetTopFiltersNoResultsResponse GetTopFiltersNoResults(string index, strin
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
+ /// Index name.
/// User query. (optional)
/// Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (optional, default to false)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1749,13 +1749,13 @@ public async Task GetTopHitsAsync(string index, string searc
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
+ /// Index name.
/// User query. (optional)
/// Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (optional, default to false)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1773,14 +1773,14 @@ public GetTopHitsResponse GetTopHits(string index, string search = default, bool
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
+ /// Index name.
/// Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (optional, default to false)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Reorder the results. (optional)
/// Sorting direction of the results: ascending or descending. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1816,14 +1816,14 @@ public async Task GetTopSearchesAsync(string index, bool
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
+ /// Index name.
/// Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (optional, default to false)
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Reorder the results. (optional)
/// Sorting direction of the results: ascending or descending. (optional)
- /// Number of records to return (page size). (optional, default to 10)
- /// Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
+ /// Number of items to return. (optional, default to 10)
+ /// Position of the first item to return. (optional, default to 0)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1841,9 +1841,9 @@ public GetTopSearchesResponse GetTopSearches(string index, bool? clickAnalytics
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -1874,9 +1874,9 @@ public async Task GetUsersCountAsync(string index, string
///
/// Required API Key ACLs:
/// - analytics
- /// Index name to target.
- /// Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
- /// End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
+ /// Index name.
+ /// Start date (`YYYY-MM-DD`) of the period to analyze. (optional)
+ /// End date (`YYYY-MM-DD`) of the period to analyze. (optional)
/// Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Clients/RecommendClient.cs b/clients/algoliasearch-client-csharp/algoliasearch/Clients/RecommendClient.cs
index 3c92cad53a..9b334e13f5 100644
--- a/clients/algoliasearch-client-csharp/algoliasearch/Clients/RecommendClient.cs
+++ b/clients/algoliasearch-client-csharp/algoliasearch/Clients/RecommendClient.cs
@@ -132,9 +132,9 @@ public interface IRecommendClient
///
/// Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
- /// Unique record (object) identifier.
+ /// Unique record identifier.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -146,9 +146,9 @@ public interface IRecommendClient
///
/// Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/). (Synchronous version)
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
- /// Unique record (object) identifier.
+ /// Unique record identifier.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -160,9 +160,9 @@ public interface IRecommendClient
///
/// Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
- /// Unique record (object) identifier.
+ /// Unique record identifier.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -174,9 +174,9 @@ public interface IRecommendClient
///
/// Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/). (Synchronous version)
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
- /// Unique record (object) identifier.
+ /// Unique record identifier.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -188,7 +188,7 @@ public interface IRecommendClient
///
/// Some operations, such as deleting a Recommend rule, will respond with a `taskID` value. Use this value here to check the status of that task.
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
/// Unique identifier of a task. Numeric value (up to 64bits).
/// Add extra http header or query parameters to Algolia.
@@ -202,7 +202,7 @@ public interface IRecommendClient
///
/// Some operations, such as deleting a Recommend rule, will respond with a `taskID` value. Use this value here to check the status of that task. (Synchronous version)
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
/// Unique identifier of a task. Numeric value (up to 64bits).
/// Add extra http header or query parameters to Algolia.
@@ -240,7 +240,7 @@ public interface IRecommendClient
///
/// List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
/// (optional)
/// Add extra http header or query parameters to Algolia.
@@ -254,7 +254,7 @@ public interface IRecommendClient
///
/// List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/). (Synchronous version)
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
/// (optional)
/// Add extra http header or query parameters to Algolia.
@@ -505,9 +505,9 @@ public object CustomPut(string path, Dictionary parameters = def
///
/// Required API Key ACLs:
/// - editSettings
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
- /// Unique record (object) identifier.
+ /// Unique record identifier.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -541,9 +541,9 @@ public async Task DeleteRecommendRuleAsync(string indexName,
///
/// Required API Key ACLs:
/// - editSettings
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
- /// Unique record (object) identifier.
+ /// Unique record identifier.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -560,9 +560,9 @@ public DeletedAtResponse DeleteRecommendRule(string indexName, RecommendModels m
///
/// Required API Key ACLs:
/// - settings
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
- /// Unique record (object) identifier.
+ /// Unique record identifier.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -596,9 +596,9 @@ public async Task GetRecommendRuleAsync(string indexName, Recommen
///
/// Required API Key ACLs:
/// - settings
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
- /// Unique record (object) identifier.
+ /// Unique record identifier.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -615,7 +615,7 @@ public RuleResponse GetRecommendRule(string indexName, RecommendModels model, st
///
/// Required API Key ACLs:
/// - editSettings
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
/// Unique identifier of a task. Numeric value (up to 64bits).
/// Add extra http header or query parameters to Algolia.
@@ -648,7 +648,7 @@ public async Task GetRecommendStatusAsync(string index
///
/// Required API Key ACLs:
/// - editSettings
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
/// Unique identifier of a task. Numeric value (up to 64bits).
/// Add extra http header or query parameters to Algolia.
@@ -712,7 +712,7 @@ public GetRecommendationsResponse GetRecommendations(GetRecommendationsParams ge
///
/// Required API Key ACLs:
/// - settings
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
/// (optional)
/// Add extra http header or query parameters to Algolia.
@@ -745,7 +745,7 @@ public async Task SearchRecommendRulesAsync(string
///
/// Required API Key ACLs:
/// - settings
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
/// (optional)
/// Add extra http header or query parameters to Algolia.
diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Clients/SearchClient.cs b/clients/algoliasearch-client-csharp/algoliasearch/Clients/SearchClient.cs
index 958f8217e0..395ce9c97f 100644
--- a/clients/algoliasearch-client-csharp/algoliasearch/Clients/SearchClient.cs
+++ b/clients/algoliasearch-client-csharp/algoliasearch/Clients/SearchClient.cs
@@ -22,7 +22,7 @@ namespace Algolia.Search.Clients;
public interface ISearchClient
{
///
- /// Add a new API key with specific permissions and restrictions. The request must be authenticated with the admin API key. The response returns an API key string.
+ /// Creates a new API key with specific permissions and restrictions.
///
///
/// Add extra http header or query parameters to Algolia.
@@ -34,7 +34,7 @@ public interface ISearchClient
Task AddApiKeyAsync(ApiKey apiKey, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Add a new API key with specific permissions and restrictions. The request must be authenticated with the admin API key. The response returns an API key string. (Synchronous version)
+ /// Creates a new API key with specific permissions and restrictions. (Synchronous version)
///
///
/// Add extra http header or query parameters to Algolia.
@@ -46,11 +46,11 @@ public interface ISearchClient
AddApiKeyResponse AddApiKey(ApiKey apiKey, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// If you use an existing `objectID`, the existing record will be replaced with the new one. To update only some attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch).
+ /// If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
///
- /// Index on which to perform the request.
- /// Unique record (object) identifier.
- /// Algolia record.
+ /// Name of the index on which to perform the operation.
+ /// Unique record identifier.
+ /// The record, a schemaless object with attributes that are useful in the context of search and discovery.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -60,11 +60,11 @@ public interface ISearchClient
Task AddOrUpdateObjectAsync(string indexName, string objectID, object body, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// If you use an existing `objectID`, the existing record will be replaced with the new one. To update only some attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch). (Synchronous version)
+ /// If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). (Synchronous version)
///
- /// Index on which to perform the request.
- /// Unique record (object) identifier.
- /// Algolia record.
+ /// Name of the index on which to perform the operation.
+ /// Unique record identifier.
+ /// The record, a schemaless object with attributes that are useful in the context of search and discovery.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -74,7 +74,7 @@ public interface ISearchClient
UpdatedAtWithObjectIdResponse AddOrUpdateObject(string indexName, string objectID, object body, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Add a source to the list of allowed sources.
+ /// Adds a source to the list of allowed sources.
///
/// Source to add.
/// Add extra http header or query parameters to Algolia.
@@ -86,7 +86,7 @@ public interface ISearchClient
Task AppendSourceAsync(Source varSource, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Add a source to the list of allowed sources. (Synchronous version)
+ /// Adds a source to the list of allowed sources. (Synchronous version)
///
/// Source to add.
/// Add extra http header or query parameters to Algolia.
@@ -98,9 +98,9 @@ public interface ISearchClient
CreatedAtResponse AppendSource(Source varSource, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Assign or move a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID.
+ /// Assigns or moves a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID.
///
- /// userID to assign.
+ /// User ID to assign.
///
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -111,9 +111,9 @@ public interface ISearchClient
Task AssignUserIdAsync(string xAlgoliaUserID, AssignUserIdParams assignUserIdParams, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Assign or move a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID. (Synchronous version)
+ /// Assigns or moves a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID. (Synchronous version)
///
- /// userID to assign.
+ /// User ID to assign.
///
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -124,9 +124,9 @@ public interface ISearchClient
CreatedAtResponse AssignUserId(string xAlgoliaUserID, AssignUserIdParams assignUserIdParams, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// To reduce the time spent on network round trips, you can perform several write actions in a single API call. Actions are applied in the order they are specified. The supported `action`s are equivalent to the individual operations of the same name.
+ /// Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name.
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
///
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -137,9 +137,9 @@ public interface ISearchClient
Task BatchAsync(string indexName, BatchWriteParams batchWriteParams, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// To reduce the time spent on network round trips, you can perform several write actions in a single API call. Actions are applied in the order they are specified. The supported `action`s are equivalent to the individual operations of the same name. (Synchronous version)
+ /// Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name. (Synchronous version)
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
///
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -150,9 +150,9 @@ public interface ISearchClient
BatchResponse Batch(string indexName, BatchWriteParams batchWriteParams, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Assign multiple user IDs to a cluster. **You can't _move_ users with this operation.**.
+ /// Assigns multiple user IDs to a cluster. **You can't move users with this operation**.
///
- /// userID to assign.
+ /// User ID to assign.
///
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -163,9 +163,9 @@ public interface ISearchClient
Task BatchAssignUserIdsAsync(string xAlgoliaUserID, BatchAssignUserIdsParams batchAssignUserIdsParams, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Assign multiple user IDs to a cluster. **You can't _move_ users with this operation.**. (Synchronous version)
+ /// Assigns multiple user IDs to a cluster. **You can't move users with this operation**. (Synchronous version)
///
- /// userID to assign.
+ /// User ID to assign.
///
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -176,9 +176,9 @@ public interface ISearchClient
CreatedAtResponse BatchAssignUserIds(string xAlgoliaUserID, BatchAssignUserIdsParams batchAssignUserIdsParams, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Add or remove a batch of dictionary entries.
+ /// Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
///
- /// Dictionary to search in.
+ /// Dictionary type in which to search.
///
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -189,9 +189,9 @@ public interface ISearchClient
Task BatchDictionaryEntriesAsync(DictionaryType dictionaryName, BatchDictionaryEntriesParams batchDictionaryEntriesParams, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Add or remove a batch of dictionary entries. (Synchronous version)
+ /// Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries. (Synchronous version)
///
- /// Dictionary to search in.
+ /// Dictionary type in which to search.
///
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -202,9 +202,9 @@ public interface ISearchClient
UpdatedAtResponse BatchDictionaryEntries(DictionaryType dictionaryName, BatchDictionaryEntriesParams batchDictionaryEntriesParams, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Retrieve up to 1,000 records per call. Supports full-text search and filters. For better performance, it doesn't support: - The `distinct` query parameter - Sorting by typos, proximity, words, or geographical distance.
+ /// Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - Deduplication (`distinct`) is turned off. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance.
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -215,9 +215,9 @@ public interface ISearchClient
Task> BrowseAsync(string indexName, BrowseParams browseParams = default, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Retrieve up to 1,000 records per call. Supports full-text search and filters. For better performance, it doesn't support: - The `distinct` query parameter - Sorting by typos, proximity, words, or geographical distance. (Synchronous version)
+ /// Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - Deduplication (`distinct`) is turned off. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance. (Synchronous version)
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -228,9 +228,9 @@ public interface ISearchClient
BrowseResponse Browse(string indexName, BrowseParams browseParams = default, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Delete the records but leave settings and index-specific API keys untouched.
+ /// Deletes only the records from an index while keeping settings, synonyms, and rules.
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -240,9 +240,9 @@ public interface ISearchClient
Task ClearObjectsAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Delete the records but leave settings and index-specific API keys untouched. (Synchronous version)
+ /// Deletes only the records from an index while keeping settings, synonyms, and rules. (Synchronous version)
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -252,10 +252,10 @@ public interface ISearchClient
UpdatedAtResponse ClearObjects(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Delete all rules in the index.
+ /// Deletes all rules from the index.
///
- /// Index on which to perform the request.
- /// Indicates whether changed index settings are forwarded to the replica indices. (optional)
+ /// Name of the index on which to perform the operation.
+ /// Whether changes are applied to replica indices. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -265,10 +265,10 @@ public interface ISearchClient
Task ClearRulesAsync(string indexName, bool? forwardToReplicas = default, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Delete all rules in the index. (Synchronous version)
+ /// Deletes all rules from the index. (Synchronous version)
///
- /// Index on which to perform the request.
- /// Indicates whether changed index settings are forwarded to the replica indices. (optional)
+ /// Name of the index on which to perform the operation.
+ /// Whether changes are applied to replica indices. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -278,10 +278,10 @@ public interface ISearchClient
UpdatedAtResponse ClearRules(string indexName, bool? forwardToReplicas = default, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Delete all synonyms in the index.
+ /// Deletes all synonyms from the index.
///
- /// Index on which to perform the request.
- /// Indicates whether changed index settings are forwarded to the replica indices. (optional)
+ /// Name of the index on which to perform the operation.
+ /// Whether changes are applied to replica indices. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -291,10 +291,10 @@ public interface ISearchClient
Task ClearSynonymsAsync(string indexName, bool? forwardToReplicas = default, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Delete all synonyms in the index. (Synchronous version)
+ /// Deletes all synonyms from the index. (Synchronous version)
///
- /// Index on which to perform the request.
- /// Indicates whether changed index settings are forwarded to the replica indices. (optional)
+ /// Name of the index on which to perform the operation.
+ /// Whether changes are applied to replica indices. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -412,7 +412,7 @@ public interface ISearchClient
object CustomPut(string path, Dictionary parameters = default, object body = default, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Delete an existing API key. The request must be authenticated with the admin API key.
+ /// Deletes the API key.
///
/// API key.
/// Add extra http header or query parameters to Algolia.
@@ -424,7 +424,7 @@ public interface ISearchClient
Task DeleteApiKeyAsync(string key, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Delete an existing API key. The request must be authenticated with the admin API key. (Synchronous version)
+ /// Deletes the API key. (Synchronous version)
///
/// API key.
/// Add extra http header or query parameters to Algolia.
@@ -436,9 +436,9 @@ public interface ISearchClient
DeleteApiKeyResponse DeleteApiKey(string key, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// This operation doesn't support all the query options, only its filters (numeric, facet, or tag) and geo queries. It doesn't accept empty filters or queries.
+ /// This operation doesn't accept empty queries or filters. It's more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](tag/Records/operation/batch).
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
///
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -449,9 +449,9 @@ public interface ISearchClient
Task DeleteByAsync(string indexName, DeleteByParams deleteByParams, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// This operation doesn't support all the query options, only its filters (numeric, facet, or tag) and geo queries. It doesn't accept empty filters or queries. (Synchronous version)
+ /// This operation doesn't accept empty queries or filters. It's more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](tag/Records/operation/batch). (Synchronous version)
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
///
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -462,9 +462,9 @@ public interface ISearchClient
DeletedAtResponse DeleteBy(string indexName, DeleteByParams deleteByParams, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Delete an existing index.
+ /// Deletes an index and all its settings. - Deleting an index doesn't delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/).
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -474,9 +474,9 @@ public interface ISearchClient
Task DeleteIndexAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Delete an existing index. (Synchronous version)
+ /// Deletes an index and all its settings. - Deleting an index doesn't delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/). (Synchronous version)
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -486,10 +486,10 @@ public interface ISearchClient
DeletedAtResponse DeleteIndex(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// To delete a set of records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy) instead.
+ /// Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).
///
- /// Index on which to perform the request.
- /// Unique record (object) identifier.
+ /// Name of the index on which to perform the operation.
+ /// Unique record identifier.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -499,10 +499,10 @@ public interface ISearchClient
Task DeleteObjectAsync(string indexName, string objectID, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// To delete a set of records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy) instead. (Synchronous version)
+ /// Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy). (Synchronous version)
///
- /// Index on which to perform the request.
- /// Unique record (object) identifier.
+ /// Name of the index on which to perform the operation.
+ /// Unique record identifier.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -512,11 +512,11 @@ public interface ISearchClient
DeletedAtResponse DeleteObject(string indexName, string objectID, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Delete a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules).
+ /// Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](#tag/Rules/operation/searchRules).
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// Unique identifier of a rule object.
- /// Indicates whether changed index settings are forwarded to the replica indices. (optional)
+ /// Whether changes are applied to replica indices. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -526,11 +526,11 @@ public interface ISearchClient
Task DeleteRuleAsync(string indexName, string objectID, bool? forwardToReplicas = default, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Delete a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules). (Synchronous version)
+ /// Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](#tag/Rules/operation/searchRules). (Synchronous version)
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// Unique identifier of a rule object.
- /// Indicates whether changed index settings are forwarded to the replica indices. (optional)
+ /// Whether changes are applied to replica indices. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -540,7 +540,7 @@ public interface ISearchClient
UpdatedAtResponse DeleteRule(string indexName, string objectID, bool? forwardToReplicas = default, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Remove a source from the list of allowed sources.
+ /// Deletes a source from the list of allowed sources.
///
/// IP address range of the source.
/// Add extra http header or query parameters to Algolia.
@@ -552,7 +552,7 @@ public interface ISearchClient
Task DeleteSourceAsync(string varSource, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Remove a source from the list of allowed sources. (Synchronous version)
+ /// Deletes a source from the list of allowed sources. (Synchronous version)
///
/// IP address range of the source.
/// Add extra http header or query parameters to Algolia.
@@ -564,11 +564,11 @@ public interface ISearchClient
DeleteSourceResponse DeleteSource(string varSource, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Delete a synonym by its `objectID`. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
+ /// Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// Unique identifier of a synonym object.
- /// Indicates whether changed index settings are forwarded to the replica indices. (optional)
+ /// Whether changes are applied to replica indices. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -578,11 +578,11 @@ public interface ISearchClient
Task DeleteSynonymAsync(string indexName, string objectID, bool? forwardToReplicas = default, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Delete a synonym by its `objectID`. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). (Synchronous version)
+ /// Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). (Synchronous version)
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// Unique identifier of a synonym object.
- /// Indicates whether changed index settings are forwarded to the replica indices. (optional)
+ /// Whether changes are applied to replica indices. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -592,7 +592,7 @@ public interface ISearchClient
DeletedAtResponse DeleteSynonym(string indexName, string objectID, bool? forwardToReplicas = default, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Get the permissions and restrictions of a specific API key. When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key.
+ /// Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key.
///
/// API key.
/// Add extra http header or query parameters to Algolia.
@@ -604,7 +604,7 @@ public interface ISearchClient
Task GetApiKeyAsync(string key, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Get the permissions and restrictions of a specific API key. When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key. (Synchronous version)
+ /// Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key. (Synchronous version)
///
/// API key.
/// Add extra http header or query parameters to Algolia.
@@ -616,7 +616,7 @@ public interface ISearchClient
GetApiKeyResponse GetApiKey(string key, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Lists Algolia's [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and any customizations applied to each language's [stop word](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plural](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), and [segmentation (compound)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) features.
+ /// Lists supported languages with their supported dictionary types and number of custom entries.
///
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -627,7 +627,7 @@ public interface ISearchClient
Task> GetDictionaryLanguagesAsync(RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Lists Algolia's [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and any customizations applied to each language's [stop word](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plural](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), and [segmentation (compound)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) features. (Synchronous version)
+ /// Lists supported languages with their supported dictionary types and number of custom entries. (Synchronous version)
///
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -638,7 +638,7 @@ public interface ISearchClient
Dictionary GetDictionaryLanguages(RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Get the languages for which [stop words are turned off](#tag/Dictionaries/operation/setDictionarySettings).
+ /// Retrieves the languages for which standard dictionary entries are turned off.
///
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -649,7 +649,7 @@ public interface ISearchClient
Task GetDictionarySettingsAsync(RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Get the languages for which [stop words are turned off](#tag/Dictionaries/operation/setDictionarySettings). (Synchronous version)
+ /// Retrieves the languages for which standard dictionary entries are turned off. (Synchronous version)
///
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -660,12 +660,12 @@ public interface ISearchClient
GetDictionarySettingsResponse GetDictionarySettings(RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are held for the last seven days. There's also a logging limit of 1,000 API calls per server. This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search Network (DSN) cluster, target the [DSN's endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers).
+ /// The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself.
///
- /// First log entry to retrieve. Sorted by decreasing date with 0 being the most recent. (optional, default to 0)
+ /// First log entry to retrieve. The most recent entries are listed first. (optional, default to 0)
/// Maximum number of entries to retrieve. (optional, default to 10)
- /// Index for which log entries should be retrieved. When omitted, log entries are retrieved for all indices. (optional)
- /// Type of log entries to retrieve. When omitted, all log entries are retrieved. (optional)
+ /// Index for which to retrieve log entries. By default, log entries are retrieved for all indices. (optional)
+ /// Type of log entries to retrieve. By default, all log entries are retrieved. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -675,12 +675,12 @@ public interface ISearchClient
Task GetLogsAsync(int? offset = default, int? length = default, string indexName = default, LogType? type = default, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are held for the last seven days. There's also a logging limit of 1,000 API calls per server. This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search Network (DSN) cluster, target the [DSN's endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers). (Synchronous version)
+ /// The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. (Synchronous version)
///
- /// First log entry to retrieve. Sorted by decreasing date with 0 being the most recent. (optional, default to 0)
+ /// First log entry to retrieve. The most recent entries are listed first. (optional, default to 0)
/// Maximum number of entries to retrieve. (optional, default to 10)
- /// Index for which log entries should be retrieved. When omitted, log entries are retrieved for all indices. (optional)
- /// Type of log entries to retrieve. When omitted, all log entries are retrieved. (optional)
+ /// Index for which to retrieve log entries. By default, log entries are retrieved for all indices. (optional)
+ /// Type of log entries to retrieve. By default, all log entries are retrieved. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -690,11 +690,11 @@ public interface ISearchClient
GetLogsResponse GetLogs(int? offset = default, int? length = default, string indexName = default, LogType? type = default, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
+ /// Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
///
- /// Index on which to perform the request.
- /// Unique record (object) identifier.
- /// Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved, even when not specified. [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) won't be retrieved unless the request is authenticated with the admin API key. (optional)
+ /// Name of the index on which to perform the operation.
+ /// Unique record identifier.
+ /// Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -704,11 +704,11 @@ public interface ISearchClient
Task> GetObjectAsync(string indexName, string objectID, List attributesToRetrieve = default, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects). (Synchronous version)
+ /// Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects). (Synchronous version)
///
- /// Index on which to perform the request.
- /// Unique record (object) identifier.
- /// Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved, even when not specified. [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) won't be retrieved unless the request is authenticated with the admin API key. (optional)
+ /// Name of the index on which to perform the operation.
+ /// Unique record identifier.
+ /// Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key. (optional)
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -718,7 +718,7 @@ public interface ISearchClient
Dictionary GetObject(string indexName, string objectID, List attributesToRetrieve = default, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Retrieve one or more records, potentially from different indices, in a single API operation. Results will be received in the same order as the requests.
+ /// Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.
///
/// Request object.
/// Add extra http header or query parameters to Algolia.
@@ -730,7 +730,7 @@ public interface ISearchClient
Task> GetObjectsAsync(GetObjectsParams getObjectsParams, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Retrieve one or more records, potentially from different indices, in a single API operation. Results will be received in the same order as the requests. (Synchronous version)
+ /// Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests. (Synchronous version)
///
/// Request object.
/// Add extra http header or query parameters to Algolia.
@@ -742,9 +742,9 @@ public interface ISearchClient
GetObjectsResponse GetObjects(GetObjectsParams getObjectsParams, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Get a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules).
+ /// Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// Unique identifier of a rule object.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -755,9 +755,9 @@ public interface ISearchClient
Task GetRuleAsync(string indexName, string objectID, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Get a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules). (Synchronous version)
+ /// Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules). (Synchronous version)
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// Unique identifier of a rule object.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -768,9 +768,9 @@ public interface ISearchClient
Rule GetRule(string indexName, string objectID, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Return an object containing an index's [configuration settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).
+ /// Retrieves an object with non-null index settings.
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -780,9 +780,9 @@ public interface ISearchClient
Task GetSettingsAsync(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Return an object containing an index's [configuration settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). (Synchronous version)
+ /// Retrieves an object with non-null index settings. (Synchronous version)
///
- /// Index on which to perform the request.
+ /// Name of the index on which to perform the operation.
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
/// Thrown when arguments are not correct
@@ -792,7 +792,7 @@ public interface ISearchClient
IndexSettings GetSettings(string indexName, RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Get all allowed sources (IP addresses).
+ /// Retrieves all allowed IP addresses with access to your application.
///
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -803,7 +803,7 @@ public interface ISearchClient
Task> GetSourcesAsync(RequestOptions options = null, CancellationToken cancellationToken = default);
///
- /// Get all allowed sources (IP addresses). (Synchronous version)
+ /// Retrieves all allowed IP addresses with access to your application. (Synchronous version)
///
/// Add extra http header or query parameters to Algolia.
/// Cancellation Token to cancel the request.
@@ -814,9 +814,9 @@ public interface ISearchClient
List