Search with payload

Include metadata in search results.

By default, search returns only vector IDs and similarity scores. To include metadata with your results, set with_payload=True.

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
from actian_vectorai import AsyncVectorAIClient
import random

async def main():
    # Connect to VectorAI DB server
    async with AsyncVectorAIClient("localhost:6574") as client:
        # Generate query vector
        query_vector = [random.gauss(0, 1) for _ in range(128)]
        
        # Include metadata in results (default is True)
        results = await client.points.search(
            "my_collection",  # Collection name
            vector=query_vector,  # Query vector
            limit=10,  # Number of results
            with_payload=True  # Include payload metadata
        )
        
        # Display results with payload
        for result in results:
            print(f"ID: {result.id}, Score: {result.score}")
            print(f"Payload: {result.payload}")
            print("-" * 50)

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.