vector-assist-apply-spec
2 minute read
About
The vector-assist-apply-spec tool automatically executes all the SQL recommendations associated with a specific vector specification (spec_id) or table. It runs the necessary commands in the correct sequence to provision the workload, marking each step as applied once successful.
Use this tool when the user has reviewed the generated recommendations from a defined (or modified) spec and is ready to apply the changes directly to their database instance to finalize the vector search setup. Under the hood, this tool connects to the target database and executes the vector_assist.apply_spec function.
Compatible Sources
This tool can be used with the following database sources:
| Source Name |
|---|
| Cloud SQL for PostgreSQL Source |
Requirements
Tip
Ensure that your target PostgreSQL database has the required vector_assist extension installed, in order for this tool to execute successfully.
Parameters
The tool takes the following input parameters:
| Parameter | Type | Description | Required |
|---|---|---|---|
spec_id | string | Unique ID of the vector specification to apply. | No |
table_name | string | Target table name for applying the vector specification. | No |
column_name | string | Text or vector column name to uniquely identify the specification. | No |
schema_name | string | Schema name for the target table. | No |
Note Parameters are marked as required or optional based on the vector assist function definitions. The function may perform further validation on optional parameters to ensure all necessary data is available before returning a response.
Example
kind: tool
name: apply_spec
type: vector-assist-apply-spec
source: my-database-source
description: "This tool automatically executes all the SQL recommendations associated with a specific vector specification (spec_id) or table. It runs the necessary commands in the correct sequence to provision the workload, marking each step as applied once successful. Use this tool when the user has reviewed the generated recommendations from a defined (or modified) spec and is ready to apply the changes directly to their database instance to finalize the vector search setup."
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be “vector-assist-apply-spec”. |
| source | string | true | Name of the source the SQL should execute on. |
| description | string | false | Description of the tool that is passed to the agent. |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.