com.alibaba.dashscope.embeddings.BatchTextEmbeddingParam Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dashscope-sdk-java Show documentation
There is a newer version: 2.16.9
// Copyright (c) Alibaba, Inc. and its affiliates.

package com.alibaba.dashscope.embeddings;

import com.alibaba.dashscope.base.HalfDuplexServiceParam;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.utils.ApiKeywords;
import com.alibaba.dashscope.utils.JsonUtils;
import com.google.gson.JsonObject;
import java.nio.ByteBuffer;
import java.util.HashMap;
import java.util.Map;
import lombok.Builder.Default;
import lombok.EqualsAndHashCode;
import lombok.experimental.SuperBuilder;
import org.jetbrains.annotations.NotNull;

@EqualsAndHashCode(callSuper = true)
@SuperBuilder
public class BatchTextEmbeddingParam extends HalfDuplexServiceParam {
  public enum TextType {
    QUERY("query"),
    DOCUMENT("document"),
    ;

    private final String value;

    private TextType(String value) {
      this.value = value;
    }

    public String getValue() {
      return value;
    }
  }

  /*The the embedding file url */
  @NotNull private String url;

  // query or document
  /*After the text is converted into a vector, it can be applied to downstream tasks such as retrieval,
  clustering, and classification. For asymmetric tasks such as retrieval, in order to achieve better
  retrieval results, it is recommended to distinguish between query text (query) and bottom database
  text (document) types, clustering Symmetric tasks such as , classification, etc. do not need to be
  specially specified, and the system default value "document" can be used */
  @Default private TextType textType = TextType.DOCUMENT;

  @Override
  public Map getParameters() {
    Map params = new HashMap<>();
    params.put("text_type", textType.getValue());

    if (parameters != null && !parameters.isEmpty()) {
      params.putAll(parameters);
    }
    return params;
  }

  @Override
  public JsonObject getHttpBody() {
    JsonObject requestObject = new JsonObject();
    requestObject.addProperty(ApiKeywords.MODEL, getModel());
    requestObject.add(ApiKeywords.INPUT, getInput());
    if (getParameters() != null && !getParameters().isEmpty()) {
      requestObject.add(ApiKeywords.PARAMETERS, JsonUtils.parametersToJsonObject(getParameters()));
    }
    return requestObject;
  }

  @Override
  public JsonObject getInput() {
    JsonObject input = new JsonObject();
    input.addProperty("url", url);
    return input;
  }

  @Override
  public ByteBuffer getBinaryData() {
    throw new UnsupportedOperationException("Unimplemented method 'getBinaryData'");
  }

  @Override
  public void validate() throws InputRequiredException {
    if (url == null) {
      throw new InputRequiredException("texts must not empty");
    }
  }
}