mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-13 16:45:01 -05:00
d7390b06b7
Added couchbase support to Genai Toolbox --------- Co-authored-by: duwenxin <duwenxin@google.com>
66 lines
3.1 KiB
Markdown
66 lines
3.1 KiB
Markdown
---
|
|
title: "couchbase-sql"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
A "couchbase-sql" tool executes a pre-defined SQL statement against a Couchbase
|
|
database.
|
|
---
|
|
|
|
## About
|
|
|
|
A `couchbase-sql` tool executes a pre-defined SQL statement against a Couchbase
|
|
database. It's compatible with any of the following sources:
|
|
|
|
- [couchbase](../sources/couchbase.md)
|
|
|
|
The specified SQL statement is executed as a parameterized statement, and specified
|
|
parameters will be used according to their name: e.g. `$id`.
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
tools:
|
|
search_products_by_category:
|
|
kind: couchbase-sql
|
|
source: my-couchbase-instance
|
|
statement: |
|
|
SELECT p.name, p.price, p.description
|
|
FROM products p
|
|
WHERE p.category = $category AND p.price < $max_price
|
|
ORDER BY p.price DESC
|
|
LIMIT 10
|
|
description: |
|
|
Use this tool to get a list of products for a specific category under a maximum price.
|
|
Takes a category name, e.g. "Electronics" and a maximum price e.g 500 and returns a list of product names, prices, and descriptions.
|
|
Do NOT use this tool with invalid category names. Do NOT guess a category name, Do NOT guess a price.
|
|
Example:
|
|
{{
|
|
"category": "Electronics",
|
|
"max_price": 500
|
|
}}
|
|
Example:
|
|
{{
|
|
"category": "Furniture",
|
|
"max_price": 1000
|
|
}}
|
|
parameters:
|
|
- name: category
|
|
type: string
|
|
description: Product category name
|
|
- name: max_price
|
|
type: integer
|
|
description: Maximum price (positive integer)
|
|
```
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|-------------|:------------------------------------------:|:------------:|------------------------------------------------------------------------------------------------|
|
|
| kind | string | true | Must be "couchbase-sql". |
|
|
| source | string | true | Name of the source the SQL query should execute on. |
|
|
| description | string | true | Description of the tool that is passed to the LLM. |
|
|
| statement | string | true | SQL statement to execute |
|
|
| parameters | [parameters](_index#specifying-parameters) | false | List of [parameters](_index#specifying-parameters) that will be used with the SQL statement. |
|
|
| authRequired| array[string] | false | List of auth services that are required to use this tool. |
|