This page shows you how to use the fetch endpoint to fetch documents by IDs from a collection.
| Parameter | Description | Type | Required | Default |
|---|
| ids | The document IDs to fetch up to 100. | string[] | ✓ | |
| includeVectors | Indicates whether vector values are included in the response. | boolean | | false |
| consistentRead | Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads. | boolean | | false |
| fields | A list of field names to include and/or exclude in the result. Use dot notation (e.g., user.name) to specify nested fields. | object | | |
| partitionFilter | Partition filter. | object | | |
include is applied first, and than exclude is applied to the included fields when you set both include and exclude in fields parameter.
from lambdadb import LambdaDB
lambda_db = LambdaDB(
server_url="PROJECT_URL",
project_api_key="YOUR_API_KEY"
)
res_fetch = lambda_db.collections.docs.fetch(
collection_name=collection_name,
ids=["33201222"],
include_vectors=True,
fields={
"includes": ["url", "title", "text"],
"excludes": ["metadata.raw"]
}
)
{
"took": 76,
"total": 1,
"docs": [
{
"collection": "example_collection",
"doc": {
"id": "33201222",
"url": "https://en.wikipedia.org/wiki/LambdaDB",
"title": "LambdaDB",
"text": "LambdaDB is a 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.
