Class: IndexHandle

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

A handle bound to one index for data-plane operations.

Constructors

Constructor

new IndexHandle(base, headers, name): IndexHandle

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

Parameters

base

string

headers

Record<string, string>

name

string

Returns

IndexHandle

Properties

name

readonly name: string

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

Methods

deleteMany()

deleteMany(opts): Promise<{ deleted_count: number; }>

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

Parameters

opts

deleteAll?

boolean

filter?

MetadataFilter

ids?

string[]

namespace?

string

Returns

Promise<{ deleted_count: number; }>

---

describeIndexStats()

describeIndexStats(): Promise<IndexStats>

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

Returns

Promise<IndexStats>

---

fetch()

fetch(ids, opts?): Promise<Record<string, VectorRecord>>

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

Parameters

ids

string[]

opts?

namespace?

string

Returns

Promise<Record<string, VectorRecord>>

---

listIds()

listIds(opts?): Promise<string[]>

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

Parameters

opts?

limit?

number

namespace?

string

prefix?

string

Returns

Promise<string[]>

---

query()

query(opts): Promise<{ matches: QueryMatch[]; namespace: string; }>

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

Parameters

opts

QueryOptions

Returns

Promise<{ matches: QueryMatch[]; namespace: string; }>

---

update()

update(id, opts): Promise<{ updated: string; }>

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

Parameters

id

string

opts

namespace?

string

setMetadata?

Record<string, unknown>

values?

number[]

Returns

Promise<{ updated: string; }>

---

upsert()

upsert(vectors, opts?): Promise<{ upserted_count: number; }>

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

Parameters

vectors

VectorRecord[]

opts?

namespace?

string

Returns

Promise<{ upserted_count: number; }>

---

upsertText()

upsertText(records, opts?): Promise<{ upserted_count: number; }>

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

Parameters

records

Record<string, unknown>[]

opts?

namespace?

string

Returns

Promise<{ upserted_count: number; }>