Add A/B test

Create an A/B test.

This page documents an earlier version of the API client. For the latest version, see Create an A/B test.

Required ACL: editSettings

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.

Examples

C#

var abTest = new ABTest
{
    Name = "myABTest",
    Variants = new List<Variant>
    {
        new Variant
        {
            Index = "indexName1",
            TrafficPercentage = 90,
            Description = "a description"
        },
        new Variant
        {
            Index = "indexName1-alt",
            TrafficPercentage = 10,
            Description = "a description"
        }
    },
    EndAt = DateTime.UtcNow.AddDays(1)
};

// Add a new A/B Test
AnalyticsClient analytics = new AnalyticsClient("YourApplicationID", "YourWriteAPIKey");
analytics.AddABTest(abtest);

// Asynchronous
await analytics.AddABTestAsync(abtest);

Add an A/B test on a single index with custom search parameters

C#

var abTest = new ABTest
{
    Name = "myABTest",
    Variants = new List<Variant>
    {
        new Variant
        {
            Index = "indexName1",
            TrafficPercentage = 90
        },
        new Variant
        {
            Index = "indexName1",
            TrafficPercentage = 10,
            CustomSearchParameters = new Query { IgnorePlurals = true }
        }
    },
    EndAt = DateTime.UtcNow.AddDays(1)
};

var response = analytics.AddABTest(abTest);

Parameters

abTest · object · required

The definition of the A/B test.

Hide child attributes

name · string · required

Name of the A/B test.

variants · object[] · required

A and B variants: the base index and a variant you want to test.

Show child attributes

index · string · required

Index name

trafficPercentage · integer · required

Percentage of the search traffic that should be routed to this variant. The sum of percentages for both variants should be 100.

customSearchParameters · object

Applies search parameters to this variant. This parameter can only be used of both variants use the same index.

Supported parameters

Search:

• advancedSyntax
• alternativesAsExact
• distinct
• enableRules
• exactOnSingleWordQuery
• ignorePlurals
• minProximity
• queryType
• removeStopWords
• removeWordsIfNoResults
• sumOrFiltersScores

Typo tolerance:

• allowTyposOnNumericTokens
• disableTypoToleranceOnAttributes
• minWordSizefor1Typo
• minWordSizefor2Typos
• typoTolerance

Facets:

• facetingAfterDistinct
• sortFacetValuesBy

Synonyms:

• replaceSynonymsInHighlight
• synonyms

Personalization:

• enablePersonalization
• personalizationImpact

Geo search:

• aroundPrecision
• aroundRadius
• minimumAroundRadius

description · string

Description of the variant. This is useful when seeing the results in the dashboard or via the API.

estimatedSampleSize · integer

The estimated number of searches that will need to be run to achieve the desired confidence level and statistical power. A minimumDetectableEffect must be set in the configuration for this to be used.

configuration · object

Configuration settings for this A/B test.

Show child attributes

emptySearch · object

Show child attributes

exclude · boolean · default: false

Whether to exclude empty searches from the A/B test results.

minimumDetectableEffect · object

Options for calculating the minimum detectable effect. This requires setting the estimatedSampleSize parameter on one of the variants.

Show child attributes

effect · enum<string> · required

The effect that you want to detect. One of:

• conversionRate
• clickThroughRate
• purchaseRate
• addToCartRate

size · number · required

The smallest relative difference between the variants that you want to detect. For example, to detect a 10% difference between the variants, set this to 0.1. The size must be between 0 and 1.

outliers · object

Show child attributes

exclude · boolean · default: true

Whether to exclude outliers from the A/B test results. To include outliers in the statistics, set this option to false.

Response

abTestID · integer

Generated Id of the A/B test.

index · string

Base index name for the A/B test.

taskID · integer

The task ID used with the waitTask method.

Response as JSON

This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.

JSON

{
  "abTestID": 78,
  "taskID": 111885720
  "index": "atis-abtest-default",
}