Interface IndexModel

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

Export

IndexModel

Hierarchy

  • IndexModel

Properties

deletionProtection? dimension? embed? host metric name spec status tags? vectorType

Properties

Optional deletionProtection

deletionProtection?: DeletionProtection

Memberof

IndexModel

Optional dimension

dimension?: number

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

Memberof

IndexModel

Optional embed

embed?: ModelIndexEmbed

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'. If the 'vector_type' is 'sparse', the metric must be 'dotproduct'. If the vector_type is dense, the metric defaults to 'cosine'.

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?: {
    [key: string]: string;
}

Custom user tags added to an index. Keys must be 80 characters or less. Values must be 120 characters or less. Keys must be alphanumeric, '', or '-'. Values must be alphanumeric, ';', '@', '', '-', '.', '+', or ' '. To unset a key, set the value to be an empty string.

Type declaration

  • [key: string]: string

Memberof

IndexModel

vectorType

vectorType: string

The index vector type. You can use 'dense' or 'sparse'. If 'dense', the vector dimension must be specified. If 'sparse', the vector dimension should not be specified.

Memberof

IndexModel

Settings

Member Visibility

Theme

On This Page