Parameter | Description | Type | Required | Default |
---|---|---|---|---|
size | The number of results to return for each query | integer | ✓ | |
query | Query object (details in the subsections) | object | ✓ | |
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 in the result. Use dot notation (e.g., user.name) to specify nested fields. | string[] | ||
sort | Specifies the sorting criteria for the results (details in the subsection) | object[] |
size
results.
This happens when size
is larger than the number of possible matching documents for your query.includeVectors=True
will increase response size significantly, especially for high-dimensional vectors.
Use this option only when vector data is specifically needed for your application.Field | Description | Type |
---|---|---|
took | Milliseconds it took LambdaDB to execute the request | long |
maxScore | Highest returned document score | float |
total | The total number of matching documents | long |
docs | Contains returned documents and metadata | object[] |
score
, and it is calculated based on BM25 algorithm
for full-text search
and a configured similarity metric
for vector search.