Interface IndexDescription

The IndexDescription describes the configuration of an index.

Export

IndexDescription

interface IndexDescription {
    dimension: number;
    host: string;
    metric: IndexModelMetricEnum;
    name: string;
}

Properties

dimension host metric name

Properties

dimension

dimension: number

The dimensions of the vectors to be inserted in the index

Memberof

IndexDescription

host

host: string

The URL address where the index is hosted.

Memberof

IndexDescription

metric

metric: IndexModelMetricEnum

The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.

Memberof

IndexDescription

name

name: string

The name of the index. The maximum length is 45 characters. It may contain lowercase alphanumeric characters or hyphens, and must not begin or end with a hyphen.

Memberof

IndexDescription

Settings

Member Visibility

Theme

On This Page

dimensionhostmetricname