推荐接口(predict)

调用个性化推荐接口，传入用户id以及相关的上下文信息等，可以获得推荐结果列表。

调用方法

PredictResponse predict(PredictRequest request, Option... opts)

方法参数

request请求体参数：

方法返回

推荐服务相关方法使用自定义的PredictRsp类作为响应类型。

示例

import volcengine.byteair.ByteairClient;
import volcengine.byteair.ByteairClientBuilder;
import volcengine.byteair.protocol.VolcengineByteair;
import volcengine.core.Option;
import volcengine.core.Region;
import volcengine.core.metrics.MetricsCollector;

import java.util.*;


public class Example {


    public static ByteairClient byteairClient;


    // 示例省略public static void init()
    // 某些语法可能在低版本JDK报错,请根据需求替换成等价语法.
    public static void predict() {
        // 请求体
        VolcengineByteair.PredictUser user = VolcengineByteair.PredictUser.newBuilder()
                .setUid("uid1")
                .build();
        Map<String, String> stringFilter = new HashMap<>() {{
            put("key1", "value1");
            put("key2", "value2");
        }};
        List<String> values = new ArrayList<>() {{
            add("value3");
            add("value4");
        }};
        Map<String, VolcengineByteair.StringArray> stringArrayFilter = new HashMap<>() {{
            put("key3", VolcengineByteair.StringArray.newBuilder().addAllValues(values).build());
        }};
        VolcengineByteair.PredictContext context = VolcengineByteair.PredictContext.newBuilder()
                .setSpm("A$##$B$##$C")
                .putExtra("extra_key", "extra_value")
                .setFilter(VolcengineByteair.PredictFilter.newBuilder().putAllStringFilter(stringFilter).putAllStringArrayFilter(stringArrayFilter).build())
                .build();
        List<VolcengineByteair.PredictCandidateItem> items = new ArrayList<>();
        items.add(VolcengineByteair.PredictCandidateItem.newBuilder().setId("item_id1").build());
        items.add(VolcengineByteair.PredictCandidateItem.newBuilder().setId("item_id2").build());
        VolcengineByteair.PredictRequest predictRequest = VolcengineByteair.PredictRequest.newBuilder()
                .setUser(user)
                .setContext(context)
                .addAllCandidateItems(items)
                .build();

    
        Option[] predictOpts = new Option[]{
                // 默认default,无需修改.
                Option.withScene("default"),
                Option.withRequestId(String.valueOf(UUID.randomUUID())),
                // 是否开启SPM路由.开启的话需要保证请求体里的SPM存在且绑定了栏位.
                // server会根据body里的SPM路由到选择的栏位.
                Option.withHeaders(new HashMap<>() {{
                    put("Enable-Spm-Route", "true");
                }})
        };

    
        VolcengineByteair.PredictResponse predictResponse;
        try {
            predictResponse = byteairClient.predict(predictRequest, predictOpts);
        } catch (BizException | NetException e) {
            System.out.printf("[predict] occur error, msg:%s \n", e.getMessage());
            return;
        }
        if (!predictResponse.getSuccess()) {
            System.out.println("[predict] failure");
            return;
        }
        System.out.println("[predict] success");
    }
}