mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-05-02 03:00:36 -04:00
## Description This PR is to add the Gemini Data Analytics (GDA) integration for DB NL2SQL conversion to Toolbox. It allows the user to convert a natural language query to SQL statement based on their database instance. See the doc section for details. ## PR Checklist > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #2180 --------- Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com>
155 lines
4.1 KiB
Go
155 lines
4.1 KiB
Go
// Copyright 2025 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
package cloudgda
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/http"
|
|
|
|
"github.com/goccy/go-yaml"
|
|
"github.com/googleapis/genai-toolbox/internal/sources"
|
|
"github.com/googleapis/genai-toolbox/internal/util"
|
|
"go.opentelemetry.io/otel/trace"
|
|
"golang.org/x/oauth2"
|
|
"golang.org/x/oauth2/google"
|
|
)
|
|
|
|
const SourceKind string = "cloud-gemini-data-analytics"
|
|
const Endpoint string = "https://geminidataanalytics.googleapis.com"
|
|
|
|
type userAgentRoundTripper struct {
|
|
userAgent string
|
|
next http.RoundTripper
|
|
}
|
|
|
|
func (rt *userAgentRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
|
|
newReq := *req
|
|
newReq.Header = make(http.Header)
|
|
for k, v := range req.Header {
|
|
newReq.Header[k] = v
|
|
}
|
|
ua := newReq.Header.Get("User-Agent")
|
|
if ua == "" {
|
|
newReq.Header.Set("User-Agent", rt.userAgent)
|
|
} else {
|
|
newReq.Header.Set("User-Agent", ua+" "+rt.userAgent)
|
|
}
|
|
return rt.next.RoundTrip(&newReq)
|
|
}
|
|
|
|
// validate interface
|
|
var _ sources.SourceConfig = Config{}
|
|
|
|
func init() {
|
|
if !sources.Register(SourceKind, newConfig) {
|
|
panic(fmt.Sprintf("source kind %q already registered", SourceKind))
|
|
}
|
|
}
|
|
|
|
func newConfig(ctx context.Context, name string, decoder *yaml.Decoder) (sources.SourceConfig, error) {
|
|
actual := Config{Name: name}
|
|
if err := decoder.DecodeContext(ctx, &actual); err != nil {
|
|
return nil, err
|
|
}
|
|
return actual, nil
|
|
}
|
|
|
|
type Config struct {
|
|
Name string `yaml:"name" validate:"required"`
|
|
Kind string `yaml:"kind" validate:"required"`
|
|
ProjectID string `yaml:"projectId" validate:"required"`
|
|
UseClientOAuth bool `yaml:"useClientOAuth"`
|
|
}
|
|
|
|
func (r Config) SourceConfigKind() string {
|
|
return SourceKind
|
|
}
|
|
|
|
// Initialize initializes a Gemini Data Analytics Source instance.
|
|
func (r Config) Initialize(ctx context.Context, tracer trace.Tracer) (sources.Source, error) {
|
|
ua, err := util.UserAgentFromContext(ctx)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error in User Agent retrieval: %s", err)
|
|
}
|
|
|
|
var client *http.Client
|
|
if r.UseClientOAuth {
|
|
client = &http.Client{
|
|
Transport: &userAgentRoundTripper{
|
|
userAgent: ua,
|
|
next: http.DefaultTransport,
|
|
},
|
|
}
|
|
} else {
|
|
// Use Application Default Credentials
|
|
// Scope: "https://www.googleapis.com/auth/cloud-platform" is generally sufficient for GDA
|
|
creds, err := google.FindDefaultCredentials(ctx, "https://www.googleapis.com/auth/cloud-platform")
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to find default credentials: %w", err)
|
|
}
|
|
baseClient := oauth2.NewClient(ctx, creds.TokenSource)
|
|
baseClient.Transport = &userAgentRoundTripper{
|
|
userAgent: ua,
|
|
next: baseClient.Transport,
|
|
}
|
|
client = baseClient
|
|
}
|
|
|
|
s := &Source{
|
|
Config: r,
|
|
Client: client,
|
|
BaseURL: Endpoint,
|
|
userAgent: ua,
|
|
}
|
|
return s, nil
|
|
}
|
|
|
|
var _ sources.Source = &Source{}
|
|
|
|
type Source struct {
|
|
Config
|
|
Client *http.Client
|
|
BaseURL string
|
|
userAgent string
|
|
}
|
|
|
|
func (s *Source) SourceKind() string {
|
|
return SourceKind
|
|
}
|
|
|
|
func (s *Source) ToConfig() sources.SourceConfig {
|
|
return s.Config
|
|
}
|
|
|
|
func (s *Source) GetClient(ctx context.Context, accessToken string) (*http.Client, error) {
|
|
if s.UseClientOAuth {
|
|
if accessToken == "" {
|
|
return nil, fmt.Errorf("client-side OAuth is enabled but no access token was provided")
|
|
}
|
|
token := &oauth2.Token{AccessToken: accessToken}
|
|
baseClient := oauth2.NewClient(ctx, oauth2.StaticTokenSource(token))
|
|
baseClient.Transport = &userAgentRoundTripper{
|
|
userAgent: s.userAgent,
|
|
next: baseClient.Transport,
|
|
}
|
|
return baseClient, nil
|
|
}
|
|
return s.Client, nil
|
|
}
|
|
|
|
func (s *Source) UseClientAuthorization() bool {
|
|
return s.UseClientOAuth
|
|
}
|