Query a vector index
query_vs_indexRun similarity, hybrid, or full-text search against a Vector Search index. Returns matching records, scores, and supports pagination.
Instructions
Run a similarity / hybrid / full-text search against a Vector Search index.
Returns the matching records as a list of {column: value} objects, their scores (the 'score' column), the column list, facets (if requested) and query information. Pass the returned next_page_token as page_token to continue.
Safety classification: EXECUTION+READ_ONLY.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| columns | No | Columns to return (required unless page_token is given). | |
| filters | No | Filter object (sent as filters_json), e.g. {'category': 'news', 'id >': 5, 'tag': ['a', 'b']}. | |
| options | No | Extra query_index fields: score_threshold, query_columns, sort_columns, facets, columns_to_rerank, reranker. Unknown fields are rejected. | |
| index_name | Yes | Full index name catalog.schema.index. | |
| page_token | No | next_page_token from a previous query_vs_index response to fetch the next page. | |
| query_text | No | Text query (indexes with a model-computed embedding, or HYBRID/FULL_TEXT). | |
| query_type | No | Search type (default ANN). | |
| num_results | No | Results to return (default 10, server-capped). | |
| query_vector | No | Query embedding (Direct Access or self-managed-embedding indexes). | |
| endpoint_name | No | Endpoint name (optional, used with page_token). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | ||
| page | No | ||
| plan | No | ||
| tool | Yes | ||
| action | No | ||
| safety | No | ||
| status | No | success | |
| summary | Yes | ||
| warnings | No | ||
| next_steps | No | Suggested follow-up calls. | |
| request_id | No |