/*
 * Copyright 2017-2025 noear.org and authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.noear.solon.ai.agent;

import org.noear.solon.ai.chat.message.ChatMessage;
import org.noear.solon.lang.NonSerializable;
import org.noear.solon.lang.Nullable;
import org.noear.solon.lang.Preview;

import java.util.Map;

/**
 * 智能体响应块（用于流式输出的内容片段）
 *
 * @author noear
 * @since 3.9.1
 */
@Preview("3.9.1")
public interface AgentChunk extends NonSerializable {
    /**
     * 获取当前产生块的智能体名字
     */
    String getAgentName();

    /**
     * 获取所属会话
     */
    AgentSession getSession();

    /**
     * 获取当前块的消息
     */
    @Nullable
    ChatMessage getMessage();

    /**
     * 获取当前块的元数据
     */
    Map<String, Object> getMeta();

    /**
     * 是否当前块有元数据
     */
    boolean hasMeta(String name);

    /**
     * 是否有当前块内容
     */
    default boolean hasContent() {
        return getMessage() != null && getMessage().getContent() != null;
    }

    /**
     * 获取当前块的消息内容
     */
    default String getContent() {
        if (hasContent()) {
            return getMessage().getContent();
        } else {
            return "";
        }
    }
}