ABTest SDK for Java

Prerequisites

Before you begin, ensure that you have:

• Environment variables configured in the runtime environment. For more information, see Configure environment variables in Linux, macOS, and Windows

• An experiment created. For more information, see Create an experiment

Add dependencies

Add the following dependencies to the <dependencies> section of your pom.xml file.

<dependency>
  <groupId>com.aliyun.openservices.aiservice</groupId>
  <artifactId>pai-abtest-sdk</artifactId>
  <version>1.0.0</version>
</dependency>

<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>4.12.0</version>
</dependency>

Initialize the client

Create a Configuration object with your region and credentials, then initialize the experiment client by calling init(), which loads experiment data from the server before traffic allocation is available.

package com.aliyun.openservices.paiabtest;

import com.aliyun.openservices.paiabtest.api.ApiClient;
import com.aliyun.openservices.paiabtest.api.Configuration;
import com.aliyun.openservices.paiabtest.model.ExperimentContext;
import com.aliyun.openservices.paiabtest.model.ExperimentResult;

import java.util.HashMap;
import java.util.Map;

public class ExperimentTest {
    static ExperimentClient experimentClient;

    public static void main(String[] args) throws Exception {
        // Initialize the experiment client
        String regionId = "cn-beijing";
        String accessId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
        String accessKey = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
        Configuration configuration = new Configuration(regionId, accessId, accessKey);
        ApiClient apiClient = new ApiClient(configuration);
        experimentClient = new ExperimentClient(apiClient);

        // Load experiment data before calling matchExperiment
        experimentClient.init();
    }
}

Call init() before making any calls to matchExperiment(). The method loads experiment data from the server and must complete before traffic allocation is available.

Match an experiment

Build an ExperimentContext with the user's ID and any filter parameters, then call matchExperiment() to assign the user to an experiment group and retrieve the corresponding parameters.

// Set up the experiment context
ExperimentContext experimentContext = new ExperimentContext();
experimentContext.setRequestId("<req_id>");
// Set the user ID used for traffic allocation
experimentContext.setUid("<uid>");
// Add filter parameters for condition-based matching
Map<String, Object> filterParams = new HashMap<>();
filterParams.put("sex", "male");
experimentContext.setFilterParams(filterParams);

// Match the user to an experiment
ExperimentResult experimentResult = experimentClient.matchExperiment("<DefaultProject>", experimentContext);

// Read experiment information and parameters
System.out.println(experimentResult.info());
System.out.println(experimentResult.getExpId());
System.out.println(experimentResult.getExperimentParams().get("recall_v", "not exist"));
System.out.println(experimentResult.getExperimentParams().get("rank_v", "not exist"));
System.out.println(experimentResult.getExperimentParams().get("male_v", "not exist"));

What's next

• Create an experiment

• Create an experiment project