Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lambdadb.ai/llms.txt

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

This page shows you how to use the fetch endpoint to fetch documents by IDs from a collection.
ParameterDescriptionTypeRequiredDefault
idsThe document IDs to fetch up to 100.string[]✓
includeVectorsIndicates whether vector values are included in the response. (Python: include_vectors)booleanfalse
consistentReadDetermines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads. (Python: consistent_read)booleanfalse
fieldsA list of field names to include and/or exclude in the result. Use dot notation (e.g., user.name) to specify nested fields.object
partitionFilterPartition filter.object
includes is applied first, and then excludes is applied to the included fields when you set both in the fields parameter.
To fetch documents, specify the document IDs (up to 100 IDs). 
from lambdadb import LambdaDB

with LambdaDB(
    project_api_key="YOUR_API_KEY",
    base_url="YOUR_BASE_URL",
    project_name="YOUR_PROJECT_NAME",
) as client:
    coll = client.collection("my_collection")
    res = coll.docs.fetch(
        ids=["33201222"],
        include_vectors=True,
        fields={"includes": ["url", "title", "text"], "excludes": ["metadata.raw"]},
    )
    # `res.docs` contains items (each item includes `doc` and metadata).
    # `res.documents` contains document bodies only.
The response will look like this: 
{
  "took": 76,
  "total": 1,
  "docs": [
    {
      "collection": "example_collection",
      "doc": {
        "id": "33201222",
        "url": "https://en.wikipedia.org/wiki/LambdaDB",
        "title": "LambdaDB",
        "text": "LambdaDB is an AI-native database ... ",
        "vector": [0.6, -0.12, 0.65, 0.2, 0.3, ...]
      }
    }
  ],
  "isDocsInline": true
}
The order of the returned documents is not guaranteed to match the order of the IDs in the request.