Search with payload

Include metadata in search results.

By default, search returns only vector IDs and similarity scores. Metadata is included with your results, because with_payload=True by default.

Include payload data when you:

• Need metadata to display results
• Want to avoid extra fetch requests
• Require metadata for downstream processing

Excluding payload reduces response size and network transfer time.

Python

import asyncio
import random
from actian_vectorai import AsyncVectorAIClient

async def main():
    async with AsyncVectorAIClient(url="localhost:6574") as client:
        query_vector = [random.gauss(0, 1) for _ in range(128)]

        results = await client.points.search(
            "my_collection",
            vector=query_vector,
            limit=10,
            with_payload=True,
        )

        for result in results or []:
            print(
                f"ID: {result.id}, "
                f"Score: {result.score:.4f}, "
                f"Payload: {result.payload}"
            )

if __name__ == "__main__":
    asyncio.run(main())

Each result includes these fields:

• id: The unique identifier of the matching point.
• score: Similarity score based on distance metric.
• payload: Full metadata dictionary for the point.