mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-05-02 03:00:36 -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>
55 lines
2.5 KiB
Markdown
55 lines
2.5 KiB
Markdown
---
|
|
title: "HTTP"
|
|
linkTitle: "HTTP"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
The HTTP source enables the Toolbox to retrieve data from a remote server using HTTP requests.
|
|
---
|
|
|
|
## About
|
|
|
|
The HTTP Source allows Toolbox to retrieve data from arbitrary HTTP
|
|
endpoints. This enables Generative AI applications to access data from web APIs
|
|
and other HTTP-accessible resources.
|
|
|
|
## Available Tools
|
|
|
|
- [`http`](../tools/http/http.md)
|
|
Make HTTP requests to REST APIs or other web services.
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
kind: sources
|
|
name: my-http-source
|
|
type: http
|
|
baseUrl: https://api.example.com/data
|
|
timeout: 10s # default to 30s
|
|
headers:
|
|
Authorization: Bearer ${API_KEY}
|
|
Content-Type: application/json
|
|
queryParams:
|
|
param1: value1
|
|
param2: value2
|
|
# disableSslVerification: false
|
|
```
|
|
|
|
{{< notice tip >}}
|
|
Use environment variable replacement with the format ${ENV_NAME}
|
|
instead of hardcoding your secrets into the configuration file.
|
|
{{< /notice >}}
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|------------------------|:-----------------:|:------------:|------------------------------------------------------------------------------------------------------------------------------------|
|
|
| type | string | true | Must be "http". |
|
|
| baseUrl | string | true | The base URL for the HTTP requests (e.g., `https://api.example.com`). |
|
|
| timeout | string | false | The timeout for HTTP requests (e.g., "5s", "1m", refer to [ParseDuration][parse-duration-doc] for more examples). Defaults to 30s. |
|
|
| headers | map[string]string | false | Default headers to include in the HTTP requests. |
|
|
| queryParams | map[string]string | false | Default query parameters to include in the HTTP requests. |
|
|
| disableSslVerification | bool | false | Disable SSL certificate verification. This should only be used for local development. Defaults to `false`. |
|
|
|
|
[parse-duration-doc]: https://pkg.go.dev/time#ParseDuration
|