001/*
002 *  Copyright (c) 2023-2026, Agents-Flex (fuhai999@gmail.com).
003 *  <p>
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *  <p>
008 *  http://www.apache.org/licenses/LICENSE-2.0
009 *  <p>
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package com.agentsflex.core.model.embedding;
017
018import com.agentsflex.core.document.Document;
019import com.agentsflex.core.model.exception.ModelException;
020import com.agentsflex.core.store.VectorData;
021
022public interface EmbeddingModel {
023
024    default VectorData embed(String text) {
025        return embed(Document.of(text), EmbeddingOptions.DEFAULT);
026    }
027
028    default VectorData embed(Document document) {
029        return embed(document, EmbeddingOptions.DEFAULT);
030    }
031
032    VectorData embed(Document document, EmbeddingOptions options);
033
034    default int dimensions() {
035        VectorData vectorData = embed(Document.of("agents-flex"));
036        if (vectorData == null) {
037            throw new ModelException("Embedding model does not contain vector data, maybe config is not correct.");
038        }
039        float[] vector = vectorData.getVector();
040        if (vector == null || vector.length == 0) {
041            throw new ModelException("Embedding model does not contain vector data, maybe config is not correct.");
042        }
043        return vector.length;
044    }
045}