Get

Retrieves and decrypts items associated with the specified IDs.

std::vector<cyborg::Item> 
    Get(const std::vector<std::string>& ids,
        const std::vector<cyborg::ItemFields> include = {kVector, kContents, kMetadata});

Parameters

Parameter	Type	Description
`ids`	`const std::vector<std::string>&`	IDs to retrieve. (For a single item, provide a `std::vector` with one element.)
`include`	`std::vector<cyborg::ItemFields>`	(Optional) List of item fields to return. Can include `kVector`, `kContents`, and `kMetadata` (`vector` only for `IVFFlat` indexes). Defaults to include all.

Returns

std::vector<cyborg::Item>: Decrypted items with requested fields.

IDs will always be included in the returned items.

Exceptions

std::runtime_exception

Throws if the items could not be retrieved or decrypted.

Example Usage

std::vector<std::string> item_ids = {"item_1", "item_2"};
auto items = index->Get(item_ids, {kContents});

for (const auto& item : items) {
    // Process each decrypted item (IDs & contents)
    std::string id = item.id
}

Train Index

Delete

⌘I

Introduction

Client

Encrypted Index

Types & Getters

Parameters

Returns

Exceptions

Example Usage

​Parameters

​Returns

​Exceptions

​Example Usage

Parameters

Returns

Exceptions

Example Usage