algoliasearch 5.0.0-alpha.73 → 5.0.0-alpha.75

package/dist/client-abtesting/model/variant.d.ts

@@ -1,58 +1,58 @@
 export type Variant = {
     /**
-     * Average click position for the variant.
+     * Variant\'s [average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position).
      */
     averageClickPosition: number;
     /**
-     * Distinct click count for the variant.
+     * Number of click events for this variant.
      */
     clickCount: number;
     /**
-     * Click through rate for the variant.
+     * Variant\'s [click-through rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      */
     clickThroughRate: number;
     /**
-     * Distinct conversion count for the variant.
+     * Number of click events for this variant.
      */
     conversionCount: number;
     /**
-     * Conversion rate for the variant.
+     * Variant\'s [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
      */
     conversionRate: number;
     /**
-     * The A/B test description.
+     * A/B test description.
      */
     description: string;
     /**
-     * The index performing the A/B test.
+     * A/B test index.
      */
     index: string;
     /**
-     * The number of occurrences.
+     * Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for that variant.
      */
     noResultCount: number;
     /**
-     * Count of the tracked searches attributed to outlier traffic that were removed from the A/B test.
+     * Number of tracked searches attributed to [outlier traffic](https://www.algolia.com/doc/guides/ab-testing/how-to-read-your-a-b-test-results/#is-the-split-off) that were removed from the A/B test. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      */
     outlierTrackedSearchesCount: number;
     /**
-     * Count of users attributed to outlier traffic that were removed from the A/B test.
+     * Number of users attributed to [outlier traffic](https://www.algolia.com/doc/guides/ab-testing/how-to-read-your-a-b-test-results/#is-the-split-off) that were removed from the A/B test.
      */
     outlierUsersCount: number;
     /**
-     * The number of search during the A/B test.
+     * Number of searches carried out during the A/B test.
      */
     searchCount: number;
     /**
-     * The number of tracked search click.
+     * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
      */
     trackedSearchCount: number;
     /**
-     * The traffic percentage for the A/B test.
+     * A/B test traffic percentage.
      */
     trafficPercentage: number;
     /**
-     * The number of user during the A/B test.
+     * Number of users during the A/B test.
      */
     userCount: number;
 };

package/dist/client-abtesting/src/abtestingClient.d.ts

@@ -4,7 +4,7 @@ import type { ABTestResponse } from '../model/aBTestResponse';
 import type { AddABTestsRequest } from '../model/addABTestsRequest';
 import type { DelProps, DeleteABTestProps, GetProps, GetABTestProps, ListABTestsProps, PostProps, PutProps, StopABTestProps } from '../model/clientMethodProps';
 import type { ListABTestsResponse } from '../model/listABTestsResponse';
-export declare const apiClientVersion = "5.0.0-alpha.73";
+export declare const apiClientVersion = "5.0.0-alpha.75";
 export declare const REGIONS: readonly ["de", "us"];
 export type Region = (typeof REGIONS)[number];
 export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -31,9 +31,9 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
      */
     addAlgoliaAgent(segment: string, version?: string): void;
     /**
-     * Creates a new A/B test with provided configuration. You can set an A/B test on two different indices with different settings, or on the same index with different search parameters by providing a customSearchParameters setting on one of the variants.
+     * Creates an A/B test.
      *
-     * @summary Create a test.
+     * @summary Create an A/B test.
      * @param addABTestsRequest - The addABTestsRequest object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -43,17 +43,17 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
      *
      * @summary Send requests to the Algolia REST API.
      * @param del - The del object.
-     * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param del.parameters - Query parameters to be applied to the current query.
+     * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param del.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     del({ path, parameters }: DelProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
-     * Delete a test.
+     * Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
      *
-     * @summary Delete a test.
+     * @summary Delete an A/B test.
      * @param deleteABTest - The deleteABTest object.
-     * @param deleteABTest.id - The A/B test ID.
+     * @param deleteABTest.id - Unique A/B test ID.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteABTest({ id }: DeleteABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
@@ -62,29 +62,29 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
      *
      * @summary Send requests to the Algolia REST API.
      * @param get - The get object.
-     * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param get.parameters - Query parameters to be applied to the current query.
+     * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param get.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     get({ path, parameters }: GetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
-     * Returns metadata and metrics for an A/B test.
+     * Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
      *
-     * @summary Get a test.
+     * @summary Get A/B test details.
      * @param getABTest - The getABTest object.
-     * @param getABTest.id - The A/B test ID.
+     * @param getABTest.id - Unique A/B test ID.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getABTest({ id }: GetABTestProps, requestOptions?: RequestOptions): Promise<ABTest>;
     /**
-     * Fetch all existing A/B tests for App that are available for the current API Key. When no data has been processed, the metrics will be returned as null.
+     * List all A/B tests.
      *
-     * @summary List all tests.
+     * @summary List all A/B tests.
      * @param listABTests - The listABTests object.
      * @param listABTests.offset - Position of the starting record. Used for paging. 0 is the first record.
-     * @param listABTests.limit - Number of records to return. Limit is the size of the page.
-     * @param listABTests.indexPrefix - Filters the returned ab tests by any indices starting with the provided prefix that are assigned to either variant of an ab test.
-     * @param listABTests.indexSuffix - Filters the returned ab tests by any indices ending with the provided suffix that are assigned to either variant of an ab test.
+     * @param listABTests.limit - Number of records to return (page size).
+     * @param listABTests.indexPrefix - Only return A/B tests for indices starting with this prefix.
+     * @param listABTests.indexSuffix - Only return A/B tests for indices ending with this suffix.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listABTests({ offset, limit, indexPrefix, indexSuffix }?: ListABTestsProps, requestOptions?: RequestOptions | undefined): Promise<ListABTestsResponse>;
@@ -93,9 +93,9 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
      *
      * @summary Send requests to the Algolia REST API.
      * @param post - The post object.
-     * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param post.parameters - Query parameters to be applied to the current query.
-     * @param post.body - The parameters to send with the custom request.
+     * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param post.parameters - Query parameters to apply to the current query.
+     * @param post.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
@@ -104,18 +104,18 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
      *
      * @summary Send requests to the Algolia REST API.
      * @param put - The put object.
-     * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param put.parameters - Query parameters to be applied to the current query.
-     * @param put.body - The parameters to send with the custom request.
+     * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param put.parameters - Query parameters to apply to the current query.
+     * @param put.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     put({ path, parameters, body }: PutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
-     * Marks the A/B test as stopped. At this point, the test is over and cannot be restarted. As a result, your application is back to normal: index A will perform as usual, receiving 100% of all search requests. Associated metadata and metrics are still stored.
+     * If stopped, the test is over and can\'t be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
      *
-     * @summary Stop a test.
+     * @summary Stop an A/B test.
      * @param stopABTest - The stopABTest object.
-     * @param stopABTest.id - The A/B test ID.
+     * @param stopABTest.id - Unique A/B test ID.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     stopABTest({ id }: StopABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;

package/dist/client-analytics/model/averageClickEvent.d.ts

@@ -1,14 +1,14 @@
 export type AverageClickEvent = {
     /**
-     * The average of all the click count event.
+     * Average count of all click events.
      */
     average: number;
     /**
-     * The number of click event.
+     * Number of click events.
      */
     clickCount: number;
     /**
-     * Date of the event.
+     * Date of the event in the format YYYY-MM-DD.
      */
     date: string;
 };

package/dist/client-analytics/model/clickPosition.d.ts

@@ -1,10 +1,10 @@
 export type ClickPosition = {
     /**
-     * Range of positions with the following pattern: - Positions from 1 to 10 included are displayed in separated groups. - Positions from 11 to 20 included are grouped together. - Positions from 21 and up are grouped together.
+     * Range of positions with the following pattern: - For positions 1 to 10, the number of click events are shown for each position - For positions 11 to 20, all click events are grouped - For positions 21 and up, all click events are grouped.
      */
     position: number[];
     /**
-     * The number of click event.
+     * Number of click events.
      */
     clickCount: number;
 };

package/dist/client-analytics/model/clickThroughRateEvent.d.ts

@@ -1,18 +1,18 @@
 export type ClickThroughRateEvent = {
     /**
-     * The click-through rate.
+     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      */
     rate: number;
     /**
-     * The number of click event.
+     * Number of click events.
      */
     clickCount: number;
     /**
-     * The number of tracked search click.
+     * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
      */
     trackedSearchCount: number;
     /**
-     * Date of the event.
+     * Date of the event in the format YYYY-MM-DD.
      */
     date: string;
 };