Getters

*EncryptedIndex exposes index settings and training status as methods. Every getter except GetIndexName takes a context.Context and calls the service’s describe or training-status endpoint. Nothing is cached, so each call returns the current value.

GetIndexName

func (e *EncryptedIndex) GetIndexName() string

The index’s name. Read locally, with no network call.

fmt.Println(index.GetIndexName())
// Output: my-vectors

Dimension

func (e *EncryptedIndex) Dimension(ctx context.Context) (int32, error)

Vector dimensionality. Returns 0 if the index was created without a Dimension and nothing has been upserted yet.

dim, err := index.Dimension(ctx)
if err != nil {
    log.Fatal(err)
}
fmt.Println(dim)
// Output: 384

Metric

func (e *EncryptedIndex) Metric(ctx context.Context) (string, error)

Distance metric: "euclidean", "squared_euclidean", or "cosine".

metric, err := index.Metric(ctx)
if err != nil {
    log.Fatal(err)
}
fmt.Println(metric)
// Output: euclidean

NLists

func (e *EncryptedIndex) NLists(ctx context.Context) (int32, error)

Number of IVF lists. 1 for an untrained index; the trained list count after Train.

nLists, err := index.NLists(ctx)
if err != nil {
    log.Fatal(err)
}
fmt.Println(nLists)
// Output: 1

MetadataSchema

func (e *EncryptedIndex) MetadataSchema(ctx context.Context) (map[string]MetadataFieldPolicy, error)

The per-field indexing policy set with MetadataSchema or TextFields in CreateIndex. Never nil: an empty map when the index uses the default policy. The MetadataFieldPolicy fields are *bool; read them with GetFilterable(), GetPattern(), and GetFullText().

schema, err := index.MetadataSchema(ctx)
if err != nil {
    log.Fatal(err)
}
for field, p := range schema {
    fmt.Println(field, p.GetFilterable(), p.GetPattern(), p.GetFullText())
}
// Output: body false false true

BM25

func (e *EncryptedIndex) BM25(ctx context.Context) (*BM25Config, error)

The index’s BM25 settings, or nil (with a nil error) when it has no full-text fields.

Field / method	Type	Description
`K1`	`float32`	Term-frequency saturation.
`B`	`float32`	Length normalization.
`GetAnalyzerVersion()`	`string`	Text analyzer the index was built with.

bm25, err := index.BM25(ctx)
if err != nil {
    log.Fatal(err)
}
fmt.Println(bm25.K1, bm25.B, bm25.GetAnalyzerVersion())
// Output: 1.2 0.75 en/1;sw=2de831ef7be676b6;snowball-english-utf8-3.0.1

IsTrained

func (e *EncryptedIndex) IsTrained(ctx context.Context) (bool, error)

true if the index has been trained.

trained, err := index.IsTrained(ctx)
if err != nil {
    log.Fatal(err)
}
if !trained {
    if err := index.Train(ctx, cyborgdb.TrainParams{}); err != nil {
        log.Fatal(err)
    }
}

IsTraining

func (e *EncryptedIndex) IsTraining(ctx context.Context) (bool, error)

true while the service is training this index or has it queued for training. Requires the root key: with a per-user key the service returns HTTP 403 and the SDK returns *AuthenticationError.

for {
    training, err := index.IsTraining(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if !training {
        break
    }
    time.Sleep(5 * time.Second)
}

Introduction

Client

Encrypted Index

Types & Helpers

GetIndexName

Dimension

Metric

NLists

MetadataSchema

BM25

IsTrained

IsTraining

​GetIndexName

​Dimension

​Metric

​NLists

​MetadataSchema

​BM25

​IsTrained

​IsTraining

GetIndexName

Dimension

Metric

NLists

MetadataSchema

BM25

IsTrained

IsTraining