/*
 * Copyright 2023-2024 the original author or 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.springframework.ai.embedding;

import java.util.Map;

import org.springframework.ai.chat.metadata.EmptyUsage;
import org.springframework.ai.chat.metadata.Usage;
import org.springframework.ai.model.AbstractResponseMetadata;
import org.springframework.ai.model.ResponseMetadata;

/**
 * Common AI provider metadata returned in an embedding response.
 *
 * @author Christian Tzolov
 * @author Thomas Vitale
 */
public class EmbeddingResponseMetadata extends AbstractResponseMetadata implements ResponseMetadata {

	private String model;

	private Usage usage;

	public EmbeddingResponseMetadata() {
	}

	public EmbeddingResponseMetadata(String model, Usage usage) {
		this(model, usage, Map.of());
	}

	public EmbeddingResponseMetadata(String model, Usage usage, Map<String, Object> metadata) {
		this.model = model;
		this.usage = usage;
		for (Map.Entry<String, Object> entry : metadata.entrySet()) {
			this.map.put(entry.getKey(), entry.getValue());
		}
	}

	/**
	 * The model that handled the request.
	 */
	public String getModel() {
		return this.model != null ? this.model : "";
	}

	public void setModel(String model) {
		this.model = model;
	}

	/**
	 * The AI provider specific metadata on API usage.
	 * @see Usage
	 */
	public Usage getUsage() {
		return this.usage != null ? this.usage : new EmptyUsage();
	}

	public void setUsage(Usage usage) {
		this.usage = usage;
	}

}
