Skip to content

QueryVectorsOutput

Source code in docs_src/capo_s3vectors/types/query_vectors_output.py 
15
16
17
18
19
20
21
22
23
class QueryVectorsOutput(TypedDict, closed=True):
    vectors: "capo_s3vectors.types.query_vectors_output_list.QueryVectorsOutputList"
    """<p>The vectors in the approximate nearest neighbor search.</p>"""
    distance_metric: NotRequired["capo_s3vectors.types.distance_metric.DistanceMetric"]
    """<p>The distance metric that was used for the similarity search calculation. This is the same distance metric that was configured for the vector index when it was created.</p>"""
    next_token: NotRequired[
        "capo_s3vectors.types.query_vectors_next_token.QueryVectorsNextToken"
    ]
    """<p>Pagination token to be used in the subsequent page request. The field is empty if no further pagination is required.</p>"""

distance_metric instance-attribute 

distance_metric: NotRequired[DistanceMetric]

The distance metric that was used for the similarity search calculation. This is the same distance metric that was configured for the vector index when it was created.

next_token instance-attribute 

next_token: NotRequired[QueryVectorsNextToken]

Pagination token to be used in the subsequent page request. The field is empty if no further pagination is required.

vectors instance-attribute 

vectors: QueryVectorsOutputList

The vectors in the approximate nearest neighbor search.