Interface: CreateIndexOptions

Defined in: packages/sdk/src/backend/indexes.ts:18

Properties

deletionProtection?

optional deletionProtection?: boolean

Defined in: packages/sdk/src/backend/indexes.ts:28

---

dimension?

optional dimension?: number

Defined in: packages/sdk/src/backend/indexes.ts:20

---

embed?

optional embed?: object

Defined in: packages/sdk/src/backend/indexes.ts:24

Integrated embedding: upsert text and the server embeds it.

fieldMap?

optional fieldMap?: Record<string, string>

model

model: string

---

metric?

optional metric?: Metric

Defined in: packages/sdk/src/backend/indexes.ts:21

---

name

name: string

Defined in: packages/sdk/src/backend/indexes.ts:19

---

sparse?

optional sparse?: object

Defined in: packages/sdk/src/backend/indexes.ts:27

Hybrid only: where the sparse (full-text) space reads its text — "text" (default, follows the embed field map) or "metadata:<field>".

source?

optional source?: string

---

tags?

optional tags?: Record<string, string>

Defined in: packages/sdk/src/backend/indexes.ts:29

---

vectorType?

optional vectorType?: VectorType

Defined in: packages/sdk/src/backend/indexes.ts:22