Interface CreateIndexOptions

See

Understanding indexes

Hierarchy

Properties

deletionProtection? dimension? metric? name spec suppressConflicts? tags? vectorType? waitUntilReady?

Properties

Optional deletionProtection

deletionProtection?: DeletionProtection

Memberof

CreateIndexRequest

Optional dimension

dimension?: number

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

Memberof

CreateIndexRequest

Optional metric

metric?: CreateIndexRequestMetricEnum

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

CreateIndexRequest

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

CreateIndexRequest

spec

spec: CreateIndexSpec

This option specifies how the index should be deployed.

Optional suppressConflicts

suppressConflicts?: boolean

This option tells the client not to throw if you attempt to create an index that already exists.

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

CreateIndexRequest

Optional 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

CreateIndexRequest

Optional waitUntilReady

waitUntilReady?: boolean

This option tells the client not to resolve the returned promise until the index is ready to receive data.

Settings

Member Visibility

Theme

On This Page