NIMAIModelConfig.java

浏览该文件的文档.

package com.netease.nimlib.sdk.ai.config;

import java.io.Serializable;
import java.util.List;

/**
 * 用于配置 V2 模型的参数类
 */
public class NIMAIModelConfig implements Serializable {

    /**
     * 具体大模型版本模型名
     */
    private String model;

    /**
     * 提示词
     */
    private String       prompt;
    /**
     * 提示词对应的key列表
     */
    private List<String> promptKeys;
    /**
     * 模型最大tokens数量
     */
    private int          maxTokens = 0;

    /**
     * 在服务器端是 double 类型，在端测需要作为 string 取值范围（0，1），生成时，核采样方法的概率阈值。 例如，取值为0.8时，仅保留累计概率之和大于等于0.8的概率分布中的token，作为随机采样的候选集。
     * 取值范围为（0,1.0)，取值越大，生成的随机性越高；取值越低，生成的随机性越低。默认值 0.5。 注意，取值不要大于等于1
     */
    private double topP = 0.5;

    /**
     * 在服务器端是 double 类型的，在端测需要作为 string 取值范围(0,2)，用于控制随机性和多样性的程度。 具体来说，temperature值控制了生成文本时对每个候选词的概率分布进行平滑的程度。
     * 较高的temperature值会降低概率分布的峰值，使得更多的低概率词被选择，生成结果更加多样化； 而较低的temperature值则会增强概率分布的峰值，使得高概率词更容易被选择，生成结果更加确定。
     */
    private double temperature = 1;

    /**
     * 获取具体大模型版本模型名
     *
     * @return 具体大模型版本模型名
     */
    public String getModel() {
        return model;
    }

    /**
     * 设置具体大模型版本模型名
     *
     * @param model 具体大模型版本模型名
     */
    public void setModel(String model) {
        this.model = model;
    }

    /**
     * 获取提示词
     *
     * @return 提示词
     */
    public String getPrompt() {
        return prompt;
    }

    /**
     * 设置提示词
     *
     * @param prompt 提示词
     */
    public void setPrompt(String prompt) {
        this.prompt = prompt;
    }

    /**
     * 获取提示词对应的key列表
     *
     * @return 提示词对应的key列表
     */
    public List<String> getPromptKeys() {
        return promptKeys;
    }

    /**
     * 设置提示词对应的key列表
     *
     * @param promptKeys 提示词对应的key列表
     */
    public void setPromptKeys(List<String> promptKeys) {
        this.promptKeys = promptKeys;
    }

    /**
     * 获取模型最大tokens数量
     *
     * @return 模型最大tokens数量
     */
    public int getMaxTokens() {
        return maxTokens;
    }

    /**
     * 设置模型最大tokens数量
     *
     * @param maxTokens 模型最大tokens数量
     */
    public void setMaxTokens(int maxTokens) {
        this.maxTokens = maxTokens;
    }

    /**
     * 获取topP
     *
     * @return topP
     */
    public double getTopP() {
        return topP;
    }

    /**
     * 设置topP
     *
     * @param topP topP
     */
    public void setTopP(double topP) {
        this.topP = topP;
    }

    /**
     * 获取temperature
     *
     * @return temperature
     */
    public double getTemperature() {
        return temperature;
    }

    /**
     * 设置temperature
     *
     * @param temperature temperature
     */
    public void setTemperature(double temperature) {
        this.temperature = temperature;
    }

    @Override
    public String toString() {
        final StringBuilder sb = new StringBuilder("NIMAIModelConfig{");
        sb.append("model='").append(model).append('\'');
        sb.append(", prompt='").append(prompt).append('\'');
        sb.append(", promptKeys=").append(promptKeys);
        sb.append(", maxTokens=").append(maxTokens);
        sb.append(", topP=").append(topP);
        sb.append(", temperature=").append(temperature);
        sb.append('}');
        return sb.toString();
    }
}