Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cyborg.co/llms.txt

Use this file to discover all available pages before exploring further.

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);

​
Parameters

ParameterTypeDescription
idsconst std::vector<std::string>&IDs to retrieve. (For a single item, provide a std::vector with one element.)
includestd::vector<cyborg::ItemFields>List of item fields to return. Can include kVector, kContents, and kMetadata (vector only for IVFFlat indexes).

​
Returns

std::vector<cyborg::Item>: Decrypted items with requested fields.
IDs will always be included in the returned items.

​
Exceptions

  • 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, {cyborg::ItemFields::kContents});

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