Skip to content

QueryOutputVector

Source code in docs_src/capo_s3vectors/types/query_output_vector.py 
14
15
16
17
18
19
20
class QueryOutputVector(TypedDict, closed=True):
    distance: NotRequired["float"]
    """<p>The measure of similarity between the vector in the response and the query vector.</p>"""
    key: "capo_s3vectors.types.vector_key.VectorKey"
    """<p>The key of the vector in the approximate nearest neighbor search.</p>"""
    metadata: NotRequired["capo_s3vectors.types.vector_metadata.VectorMetadata"]
    """<p>The metadata associated with the vector, if requested.</p>"""

distance instance-attribute 

distance: NotRequired[float]

The measure of similarity between the vector in the response and the query vector.

key instance-attribute 

key: VectorKey

The key of the vector in the approximate nearest neighbor search.

metadata instance-attribute 

metadata: NotRequired[VectorMetadata]

The metadata associated with the vector, if requested.