Skip to content

Interface: JobIndexOptions ​

Defined in: glide-mq/src/types.ts:407

Options for creating a Valkey Search index over job hashes.

Properties ​

createOptions? ​

ts
optional createOptions?: IndexCreateOptions;

Defined in: glide-mq/src/types.ts:424

Pass-through options for FT.CREATE (dataType and prefixes are set automatically).


fields? ​

ts
optional fields?: Field[];

Defined in: glide-mq/src/types.ts:411

Additional schema fields beyond the auto-included base fields (name, state, timestamp, priority).


name? ​

ts
optional name?: string;

Defined in: glide-mq/src/types.ts:409

Index name. Defaults to {queueName}-idx.


vectorField? ​

ts
optional vectorField?: object;

Defined in: glide-mq/src/types.ts:413

Vector field configuration. When omitted, a minimal placeholder vector field is added (required by valkey-search).

algorithm? ​

ts
optional algorithm?: "HNSW" | "FLAT";

Indexing algorithm. Default: 'HNSW'.

dimensions ​

ts
dimensions: number;

Number of dimensions in the vector.

distanceMetric? ​

ts
optional distanceMetric?: "COSINE" | "L2" | "IP";

Distance metric. Default: 'COSINE'.

name ​

ts
name: string;

Field name in the job hash where the vector is stored.

Released under the Apache-2.0 License.