chat - 聊天模型的接口及字典

solon-ai 旨在提供一套通用的接口（通过适配）。可访问各种不同的大模型接口。

1、聊天模型（ChatModel）相关的接口

2、四种聊天消息（ChatMessage）

3、主要接口字典

• ChatModel

public interface ChatModel {
    /**
     * 提示语
     */
    ChatRequest prompt(List<ChatMessage> messages);
    
    /**
     * 提示语
     */
    ChatRequest prompt(ChatPrompt prompt);

    /**
     * 提示语
     */
    default ChatRequest prompt(ChatMessage... messages) {
        return prompt(new ArrayList<>(Arrays.asList(messages)));
    }

    /**
     * 提示语
     */
    default ChatRequest prompt(String content) {
        return prompt(ChatMessage.ofUser(content));
    }


    /// /////////////////////////////////

    /**
     * 构建
     */
    static ChatModelBuilder of(ChatConfig config) {
        return new ChatModelBuilder(config);
    }

    /**
     * 开始构建
     */
    static ChatModelBuilder of(String apiUrl) {
        return new ChatModelBuilder(apiUrl);
    }
}

• ChatRequest

public interface ChatRequest {
    /**
     * 选项设置
     */
    ChatRequest options(ChatOptions options);

    /**
     * 选项配置
     */
    ChatRequest options(Consumer<ChatOptions> optionsBuilder);

    /**
     * 调用
     */
    ChatResponse call() throws IOException;

    /**
     * 流响应
     */
    Publisher<ChatResponse> stream();

}

• ChatResponse

public interface ChatResponse {
    /**
     * 获取模型
     */
    String getModel();

    /**
     * 获取错误
     */
    @Nullable
    ChatException getError();

    /**
     * 是否有选择
     */
    boolean hasChoices();

    /**
     * 最后一个选择
     */
    ChatChoice lastChoice();

    /**
     * 获取所有选择
     */
    List<ChatChoice> getChoices();

    /**
     * 获取消息
     */
    @Nullable
    AssistantMessage getMessage();

    /**
     * 获取聚合消息（流响应完成时可用）
     */
    @Nullable
    AssistantMessage getAggregationMessage();

    /**
     * 获取使用情况（完成时，才会有使用情况）
     */
    @Nullable
    AiUsage getUsage();

    /**
     * 是否完成
     */
    boolean isFinished();

    /**
     * 是否为流响应
     */
    boolean isStream();
}

• ChatDialect（可以自己扩展适配，增加不同方言支持）

public interface ChatDialect extends AiModelDialect {
    /**
     * 是否为默认
     */
    default boolean isDefault() {
        return false;
    }

    /**
     * 匹配检测
     *
     * @param config 聊天配置
     */
    boolean matched(ChatConfig config);

    /**
     * 构建请求数据
     *
     * @param config   聊天配置
     * @param options  聊天选项
     * @param messages 消息
     * @param isStream 是否流式获取
     */
    String buildRequestJson(ChatConfig config, ChatOptions options, List<ChatMessage> messages, boolean isStream);

    /**
     * 构建助理消息节点
     *
     * @param toolCallBuilders 工具调用构建器集合
     */
    ONode buildAssistantMessageNode(Map<Integer, ToolCallBuilder> toolCallBuilders);

    /**
     * 构建助理消息根据直接返回的工具消息
     *
     * @param toolMessages 直接返回的工具消息
     */
    AssistantMessage buildAssistantMessageByToolMessages(List<ToolMessage> toolMessages);

    /**
     * 分析响应数据
     *
     * @param config   聊天配置
     * @param resp     响应体
     * @param respJson 响应数据
     */
    boolean parseResponseJson(ChatConfig config, ChatResponseDefault resp, String respJson);

    /**
     * 分析工具调用
     *
     * @param resp     响应体
     * @param oMessage 消息节点
     */
    List<AssistantMessage> parseAssistantMessage(ChatResponseDefault resp, ONode oMessage);
}