Interface IndexModel

The IndexModel describes the configuration and status of a Pinecone index.

Export

IndexModel

Hierarchy

  • IndexModel

Properties

deletionProtection? dimension host metric name spec status tags?

Properties

Optional deletionProtection

deletionProtection?: DeletionProtection

Memberof

IndexModel

dimension

dimension: number

The dimensions of the vectors to be inserted in the index.

Memberof

IndexModel

host

host: string

The URL address where the index is hosted.

Memberof

IndexModel

metric

metric: IndexModelMetricEnum

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

Memberof

IndexModel

name

name: string

The name of the index. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.

Memberof

IndexModel

spec

spec: IndexModelSpec

Memberof

IndexModel

status

status: IndexModelStatus

Memberof

IndexModel

Optional tags

tags?: null | {
    [key: string]: string;
}

Custom user tags added to an index. Keys must be alphanumeric and 80 characters or less. Values must be 120 characters or less.

Type declaration

  • [key: string]: string

Memberof

IndexModel

Settings

Member Visibility

Theme

On This Page