import { MimeType } from '@celljs/core';
import { Usage } from '../chat/metadata/metadata-protocol';
import { Model, ModelOptions, ModelRequest, ModelResponse, ModelResult, ResponseMetadata, ResultMetadata } from '../model/model-protocol';
export declare const EmbeddingModel: unique symbol;
/**
 * Enum representing the modality type of the source data.
 */
export declare enum ModalityType {
    TEXT = "TEXT",
    IMAGE = "IMAGE",
    AUDIO = "AUDIO",
    VIDEO = "VIDEO"
}
/**
 * Represents the metadata for an embedding result.
 */
export interface EmbeddingResultMetadata extends ResultMetadata {
    /**
     * The modality type of the source data used to generate the embedding.
     */
    modalityType: ModalityType;
    /**
     * The document ID associated with the embedding.
     */
    documentId: string;
    /**
     * The MIME type of the source data used to generate the embedding.
     */
    mimeType: MimeType;
    /**
     * The document data associated with the embedding.
     */
    documentData: any;
}
export declare namespace EmbeddingResultMetadata {
    const EMPTY: EmbeddingResultMetadata;
}
/**
 * Utility class for modality-related operations.
 */
export declare class ModalityUtils {
    private static TEXT_MIME_TYPE;
    private static IMAGE_MIME_TYPE;
    private static VIDEO_MIME_TYPE;
    private static AUDIO_MIME_TYPE;
    /**
     * Infers the {@link ModalityType} of the source data used to generate the
     * embedding using the source data {@link MimeType}.
     * @param mimeType the {@link MimeType} of the source data.
     * @return Returns the {@link ModalityType} of the source data used to generate
     * the embedding.
     */
    static getModalityType(mimeType: MimeType): ModalityType;
}
/**
 * Metadata for the embedding response.
 */
export interface EmbeddingResponseMetadata extends ResponseMetadata {
    /**
     * The model that handled the request.
     */
    model: string;
    /**
     * The AI provider specific metadata on API usage.
     * @see Usage
     */
    usage: Usage;
}
/**
 * Represents a single embedding vector.
 */
export interface Embedding extends ModelResult<number[]> {
    /**
     * The embedding vector values.
     */
    embedding: number[];
    /**
     * The embedding index in a list of embeddings.
     */
    index: number;
    /**
     * The metadata associated with the embedding.
     */
    metadata: EmbeddingResultMetadata;
}
export interface EmbeddingOptions extends ModelOptions {
    /**
     * The name of the embedding model to use.
     */
    model?: string;
    /**
     * The dimensionality of the embedding vectors.
     */
    dimensions?: number;
}
export interface EmbeddingRequest extends ModelRequest<string[]> {
    /**
     * The list of input strings for the embedding request.
     */
    inputs: string[];
    /**
     * The options for the embedding request.
     */
    options: EmbeddingOptions;
}
/**
 * Embedding response object.
 */
export interface EmbeddingResponse extends ModelResponse<Embedding> {
    /**
     * Embedding data.
     */
    embeddings: Embedding[];
    /**
     * Embedding metadata.
     */
    metadata: EmbeddingResponseMetadata;
}
export interface EmbeddingModel extends Model<EmbeddingRequest, EmbeddingResponse> {
}
//# sourceMappingURL=embedding-protocol.d.ts.map