Interface ModelInfo

Represents the model configuration including model type, supported parameters, and other model details.

Export

ModelInfo

interface ModelInfo {
    defaultDimension?: number;
    maxBatchSize?: number;
    maxSequenceLength?: number;
    modality?: string;
    model: string;
    providerName?: string;
    shortDescription: string;
    supportedDimensions?: number[];
    supportedMetrics?: string[];
    supportedParameters: ModelInfoSupportedParameter[];
    type: string;
    vectorType?: string;
}

Properties

defaultDimension? maxBatchSize? maxSequenceLength? modality? model providerName? shortDescription supportedDimensions? supportedMetrics? supportedParameters type vectorType?

Properties

OptionaldefaultDimension

defaultDimension?: number

The default embedding model dimension (applies to dense embedding models only).

Memberof

ModelInfo

OptionalmaxBatchSize

maxBatchSize?: number

The maximum batch size (number of sequences) supported by the model.

Memberof

ModelInfo

OptionalmaxSequenceLength

maxSequenceLength?: number

The maximum tokens per sequence supported by the model.

Memberof

ModelInfo

Optionalmodality

modality?: string

The modality of the model (e.g. 'text').

Memberof

ModelInfo

model

model: string

The name of the model.

Memberof

ModelInfo

OptionalproviderName

providerName?: string

The name of the provider of the model.

Memberof

ModelInfo

shortDescription

shortDescription: string

A summary of the model.

Memberof

ModelInfo

OptionalsupportedDimensions

supportedDimensions?: number[]

The list of supported dimensions for the model (applies to dense embedding models only).

Memberof

ModelInfo

OptionalsupportedMetrics

supportedMetrics?: string[]

The distance metrics supported by the model for similarity search.

Memberof

ModelInfo

supportedParameters

supportedParameters: ModelInfoSupportedParameter[]

List of parameters supported by the model.

Memberof

ModelInfo

type

type: string

The type of model (e.g. 'embed' or 'rerank').

Memberof

ModelInfo

OptionalvectorType

vectorType?: string

Whether the embedding model produces 'dense' or 'sparse' embeddings.

Memberof

ModelInfo

Settings

Member Visibility

On This Page

Properties