Interface ModelInfo

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

Export

ModelInfo

Hierarchy

  • ModelInfo

Properties

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

Properties

Optional defaultDimension

defaultDimension?: number

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

Memberof

ModelInfo

Optional maxBatchSize

maxBatchSize?: number

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

Memberof

ModelInfo

Optional maxSequenceLength

maxSequenceLength?: number

The maximum tokens per sequence supported by the model.

Memberof

ModelInfo

Optional modality

modality?: string

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

Memberof

ModelInfo

model

model: string

The name of the model.

Memberof

ModelInfo

Optional providerName

providerName?: string

The name of the provider of the model.

Memberof

ModelInfo

shortDescription

shortDescription: string

A summary of the model.

Memberof

ModelInfo

Optional supportedDimensions

supportedDimensions?: number[]

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

Memberof

ModelInfo

Optional supportedMetrics

supportedMetrics?: ModelInfoMetric[]

The distance metrics supported by the model for similarity search.

Memberof

ModelInfo

supportedParameters

supportedParameters: ModelInfoSupportedParameter[]

Memberof

ModelInfo

type

type: string

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

Memberof

ModelInfo

Optional vectorType

vectorType?: string

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

Memberof

ModelInfo

Settings

Member Visibility

Theme

On This Page