mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-04-09 03:02:26 -04:00
293c1d6889
This PR introduces a significant update to the Toolbox configuration file format, which is one of the primary **breaking changes** required for the implementation of the Advanced Control Plane. # Summary of Changes The configuration schema has been updated to enforce resource isolation and facilitate atomic, incremental updates. * Resource Isolation: Resource definitions are now separated into individual blocks, using a distinct structure for each resource type (Source, Tool, Toolset, etc.). This improves readability, management, and auditing of configuration files. * Field Name Modification: Internal field names have been modified to align with declarative methodologies. Specifically, the configuration now separates kind (general resource type, e.g., Source) from type (specific implementation, e.g., Postgres). # User Impact Existing tools.yaml configuration files are now in an outdated format. Users must eventually update their files to the new YAML format. # Mitigation & Compatibility Backward compatibility is maintained during this transition to ensure no immediate user action is required for existing files. * Immediate Backward Compatibility: The source code includes a pre-processing layer that automatically detects outdated configuration files (v1 format) and converts them to the new v2 format under the hood. * [COMING SOON] Migration Support: The new toolbox migrate subcommand will be introduced to allow users to automatically convert their old configuration files to the latest format. # Example Example for config file v2: ``` kind: sources name: my-pg-instance type: cloud-sql-postgres project: my-project region: my-region instance: my-instance database: my_db user: my_user password: my_pass --- kind: authServices name: my-google-auth type: google clientId: testing-id --- kind: tools name: example_tool type: postgres-sql source: my-pg-instance description: some description statement: SELECT * FROM SQL_STATEMENT; parameters: - name: country type: string description: some description --- kind: tools name: example_tool_2 type: postgres-sql source: my-pg-instance description: returning the number one statement: SELECT 1; --- kind: toolsets name: example_toolset tools: - example_tool ``` --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com>
272 lines
9.2 KiB
Markdown
272 lines
9.2 KiB
Markdown
---
|
|
title: "http"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
A "http" tool sends out an HTTP request to an HTTP endpoint.
|
|
aliases:
|
|
- /resources/tools/http
|
|
---
|
|
|
|
|
|
## About
|
|
|
|
The `http` tool allows you to make HTTP requests to APIs to retrieve data.
|
|
An HTTP request is the method by which a client communicates with a server to
|
|
retrieve or manipulate resources.
|
|
Toolbox allows you to configure the request URL, method, headers, query
|
|
parameters, and the request body for an HTTP Tool.
|
|
|
|
### URL
|
|
|
|
An HTTP request URL identifies the target the client wants to access.
|
|
Toolbox composes the request URL from 3 places:
|
|
|
|
1. The HTTP Source's `baseUrl`.
|
|
2. The HTTP Tool's `path` field.
|
|
3. The HTTP Tool's `pathParams` for dynamic path composed during Tool
|
|
invocation.
|
|
|
|
For example, the following config allows you to reach different paths of the
|
|
same server using multiple Tools:
|
|
|
|
```yaml
|
|
kind: sources
|
|
name: my-http-source
|
|
type: http
|
|
baseUrl: https://api.example.com
|
|
---
|
|
kind: tools
|
|
name: my-post-tool
|
|
type: http
|
|
source: my-http-source
|
|
method: POST
|
|
path: /update
|
|
description: Tool to update information to the example API
|
|
---
|
|
kind: tools
|
|
name: my-get-tool
|
|
type: http
|
|
source: my-http-source
|
|
method: GET
|
|
path: /search
|
|
description: Tool to search information from the example API
|
|
---
|
|
kind: tools
|
|
name: my-dynamic-path-tool
|
|
type: http
|
|
source: my-http-source
|
|
method: GET
|
|
path: /{{.myPathParam}}/search
|
|
description: Tool to reach endpoint based on the input to `myPathParam`
|
|
pathParams:
|
|
- name: myPathParam
|
|
type: string
|
|
description: The dynamic path parameter
|
|
|
|
```
|
|
|
|
### Headers
|
|
|
|
An HTTP request header is a key-value pair sent by a client to a server,
|
|
providing additional information about the request, such as the client's
|
|
preferences, the request body content type, and other metadata.
|
|
Headers specified by the HTTP Tool are combined with its HTTP Source headers for
|
|
the resulting HTTP request, and override the Source headers in case of conflict.
|
|
The HTTP Tool allows you to specify headers in two different ways:
|
|
|
|
- Static headers can be specified using the `headers` field, and will be the
|
|
same for every invocation:
|
|
|
|
```yaml
|
|
kind: tools
|
|
name: my-http-tool
|
|
type: http
|
|
source: my-http-source
|
|
method: GET
|
|
path: /search
|
|
description: Tool to search data from API
|
|
headers:
|
|
Authorization: API_KEY
|
|
Content-Type: application/json
|
|
```
|
|
|
|
- Dynamic headers can be specified as parameters in the `headerParams` field.
|
|
The `name` of the `headerParams` will be used as the header key, and the value
|
|
is determined by the LLM input upon Tool invocation:
|
|
|
|
```yaml
|
|
kind: tools
|
|
name: my-http-tool
|
|
type: http
|
|
source: my-http-source
|
|
method: GET
|
|
path: /search
|
|
description: some description
|
|
headerParams:
|
|
- name: Content-Type # Example LLM input: "application/json"
|
|
description: request content type
|
|
type: string
|
|
```
|
|
|
|
### Query parameters
|
|
|
|
Query parameters are key-value pairs appended to a URL after a question mark (?)
|
|
to provide additional information to the server for processing the request, like
|
|
filtering or sorting data.
|
|
|
|
- Static request query parameters should be specified in the `path` as part of
|
|
the URL itself:
|
|
|
|
```yaml
|
|
kind: tools
|
|
name: my-http-tool
|
|
type: http
|
|
source: my-http-source
|
|
method: GET
|
|
path: /search?language=en&id=1
|
|
description: Tool to search for item with ID 1 in English
|
|
```
|
|
|
|
- Dynamic request query parameters should be specified as parameters in the
|
|
`queryParams` section:
|
|
|
|
```yaml
|
|
kind: tools
|
|
name: my-http-tool
|
|
type: http
|
|
source: my-http-source
|
|
method: GET
|
|
path: /search
|
|
description: Tool to search for item with ID
|
|
queryParams:
|
|
- name: id
|
|
description: item ID
|
|
type: integer
|
|
```
|
|
|
|
### Request body
|
|
|
|
The request body payload is a string that supports parameter replacement
|
|
following [Go template][go-template-doc]'s annotations.
|
|
The parameter names in the `requestBody` should be preceded by "." and enclosed
|
|
by double curly brackets "{{}}". The values will be populated into the request
|
|
body payload upon Tool invocation.
|
|
|
|
Example:
|
|
|
|
```yaml
|
|
kind: tools
|
|
name: my-http-tool
|
|
type: http
|
|
source: my-http-source
|
|
method: GET
|
|
path: /search
|
|
description: Tool to search for person with name and age
|
|
requestBody: |
|
|
{
|
|
"age": {{.age}},
|
|
"name": "{{.name}}"
|
|
}
|
|
bodyParams:
|
|
- name: age
|
|
description: age number
|
|
type: integer
|
|
- name: name
|
|
description: name string
|
|
type: string
|
|
```
|
|
|
|
#### Formatting Parameters
|
|
|
|
Some complex parameters (such as arrays) may require additional formatting to
|
|
match the expected output. For convenience, you can specify one of the following
|
|
pre-defined functions before the parameter name to format it:
|
|
|
|
##### JSON
|
|
|
|
The `json` keyword converts a parameter into a JSON format.
|
|
|
|
{{< notice note >}}
|
|
Using JSON may add quotes to the variable name for certain types (such as
|
|
strings).
|
|
{{< /notice >}}
|
|
|
|
Example:
|
|
|
|
```yaml
|
|
requestBody: |
|
|
{
|
|
"age": {{json .age}},
|
|
"name": {{json .name}},
|
|
"nickname": "{{json .nickname}}",
|
|
"nameArray": {{json .nameArray}}
|
|
}
|
|
```
|
|
|
|
will send the following output:
|
|
|
|
```yaml
|
|
{
|
|
"age": 18,
|
|
"name": "Katherine",
|
|
"nickname": ""Kat"", # Duplicate quotes
|
|
"nameArray": ["A", "B", "C"]
|
|
}
|
|
```
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
kind: tools
|
|
name: my-http-tool
|
|
type: http
|
|
source: my-http-source
|
|
method: GET
|
|
path: /search
|
|
description: some description
|
|
authRequired:
|
|
- my-google-auth-service
|
|
- other-auth-service
|
|
queryParams:
|
|
- name: country
|
|
description: some description
|
|
type: string
|
|
requestBody: |
|
|
{
|
|
"age": {{.age}},
|
|
"city": "{{.city}}"
|
|
}
|
|
bodyParams:
|
|
- name: age
|
|
description: age number
|
|
type: integer
|
|
- name: city
|
|
description: city string
|
|
type: string
|
|
headers:
|
|
Authorization: API_KEY
|
|
Content-Type: application/json
|
|
headerParams:
|
|
- name: Language
|
|
description: language string
|
|
type: string
|
|
```
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|--------------|:---------------------------------------:|:------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| type | string | true | Must be "http". |
|
|
| source | string | true | Name of the source the HTTP request should be sent to. |
|
|
| description | string | true | Description of the tool that is passed to the LLM. |
|
|
| path | string | true | The path of the HTTP request. You can include static query parameters in the path string. |
|
|
| method | string | true | The HTTP method to use (e.g., GET, POST, PUT, DELETE). |
|
|
| headers | map[string]string | false | A map of headers to include in the HTTP request (overrides source headers). |
|
|
| requestBody | string | false | The request body payload. Use [go template][go-template-doc] with the parameter name as the placeholder (e.g., `{{.id}}` will be replaced with the value of the parameter that has name `id` in the `bodyParams` section). |
|
|
| queryParams | [parameters](../#specifying-parameters) | false | List of [parameters](../#specifying-parameters) that will be inserted into the query string. |
|
|
| bodyParams | [parameters](../#specifying-parameters) | false | List of [parameters](../#specifying-parameters) that will be inserted into the request body payload. |
|
|
| headerParams | [parameters](../#specifying-parameters) | false | List of [parameters](../#specifying-parameters) that will be inserted as the request headers. |
|
|
|
|
[go-template-doc]: <https://pkg.go.dev/text/template#pkg-overview>
|