Skip to main content

​
Get

Retrieves, decrypts and returns items from their IDs. If an item does not exist at that ID, it will return an empty object. 
def get(self,
        ids: List[str],
        include: List[str] = ["vector", "contents", "metadata"],
        *,
        index_key: bytes = None,
        user_id: bytes = None)

​
Parameters

ParameterTypeDefaultDescription
idsList[str]-Item IDs to retrieve & decrypt
includeList[str]"vector", "contents", "metadata"(Optional) List of item fields to return. Can include vector, contents, and metadata.
index_keybytesNone(Optional, keyword-only) Override the per-operation index key. See Per-operation key override.
user_idbytesNone(Optional, keyword-only) 16-byte RBAC user identifier. See Per-operation key override.

​
Returns

List[Dict]: Decrypted item fields for each item, including id and specified fields (e.g., vector, contents, and metadata).
The contents field is always returned as bytes, regardless of whether it was originally stored as a string or bytes. All contents are encoded to bytes and encrypted before storage.

​
Exceptions

  • Throws if the item could not be retrieved or decrypted.
  • Throws if an unexpected error occurs during retrieval.

​
Example Usage

# Load index
index = client.load_index(
    index_name=index_name, 
    index_key=index_key
)

# Retrieve the items using their IDs
items = index.get(["item_1", "item_2"])

print(items)
# Example output (contents returned as bytes):
# [{"id": "item_1", "vector": [0.1, 0.2], "contents": b"Example contents...", "metadata": {"type": "txt"}},
#  {"id": "item_2", "vector": [0.3, 0.4], "contents": b"Example contents...", "metadata": {"type": "md"}},

# Retrieve only the item contents
items = index.get(["item_1", "item_2"], include=["contents"])
print(items)
# Example output (contents returned as bytes):
# [{"id": "item_1", "contents": b"Example contents..."},
#  {"id": "item_2", "contents": b"Example contents..."}]

​
Per-operation key override

The calls above reuse the key supplied at create_index() / load_index(). You may instead pass index_key= (and user_id= for an RBAC user) to override the per-operation key. This is required in stateless/service deployments that reload the index per request: 
items = index.get(["item_1", "item_2"], index_key=index_key)