Documentation
¶
Overview ¶
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.
Index ¶
- type Config
- type Tool
- func (t Tool) Authorized(verifiedAuthServices []string) bool
- func (t Tool) EmbedParams(ctx context.Context, paramValues parameters.ParamValues, ...) (parameters.ParamValues, error)
- func (t Tool) GetAnnotations() *tools.ToolAnnotations
- func (t Tool) GetAuthRequired() []string
- func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string, error)
- func (t Tool) GetDescription() string
- func (t Tool) GetName() string
- func (t Tool) GetParameters() parameters.Parameters
- func (t Tool) GetScopesRequired() []string
- func (t Tool) Invoke(ctx context.Context, resourceMgr tools.SourceProvider, ...) (any, util.ToolboxError)
- func (t Tool) Manifest() tools.Manifest
- func (t Tool) RequiresClientAuthorization(resourceMgr tools.SourceProvider) (bool, error)
- func (t Tool) ToConfig() tools.ToolConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Name string `yaml:"name" validate:"required"`
Type string `yaml:"type" validate:"required"`
Source string `yaml:"source" validate:"required"`
Description string `yaml:"description" validate:"required"`
Commands [][]string `yaml:"commands" validate:"required"`
AuthRequired []string `yaml:"authRequired"`
Parameters parameters.Parameters `yaml:"parameters"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`
ScopesRequired []string `yaml:"scopesRequired"`
}
func (Config) Initialize ¶
func (Config) ToolConfigType ¶
type Tool ¶
type Tool struct {
Config
// contains filtered or unexported fields
}
func (Tool) Authorized ¶
func (Tool) EmbedParams ¶
func (t Tool) EmbedParams(ctx context.Context, paramValues parameters.ParamValues, embeddingModelsMap map[string]embeddingmodels.EmbeddingModel) (parameters.ParamValues, error)
func (Tool) GetAnnotations ¶ added in v1.3.0
func (t Tool) GetAnnotations() *tools.ToolAnnotations
func (Tool) GetAuthRequired ¶ added in v1.3.0
func (Tool) GetAuthTokenHeaderName ¶
func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string, error)
func (Tool) GetDescription ¶ added in v1.3.0
func (Tool) GetParameters ¶
func (t Tool) GetParameters() parameters.Parameters
func (Tool) GetScopesRequired ¶ added in v1.3.0
func (Tool) Invoke ¶
func (t Tool) Invoke(ctx context.Context, resourceMgr tools.SourceProvider, params parameters.ParamValues, accessToken tools.AccessToken) (any, util.ToolboxError)
func (Tool) RequiresClientAuthorization ¶
func (t Tool) RequiresClientAuthorization(resourceMgr tools.SourceProvider) (bool, error)
func (Tool) ToConfig ¶
func (t Tool) ToConfig() tools.ToolConfig
Source Files
Click to show internal directories.
Click to hide internal directories.