Documentation
¶
Overview ¶
Copyright 2026 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.
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 ¶
- Constants
- func ConvertNumbers(data any) (any, error)
- func DecodeJSON(r io.Reader, v interface{}) error
- func InstrumentationFromContext(ctx context.Context) (*telemetry.Instrumentation, error)
- func LoggerFromContext(ctx context.Context) (log.Logger, error)
- func NewStrictDecoder(v interface{}) (*yaml.Decoder, error)
- func UserAgentFromContext(ctx context.Context) (string, error)
- func WithGenAIMetricAttrs(ctx context.Context, attrs *GenAIMetricAttrs) context.Context
- func WithInstrumentation(ctx context.Context, instrumentation *telemetry.Instrumentation) context.Context
- func WithLogger(ctx context.Context, logger log.Logger) context.Context
- func WithUserAgent(ctx context.Context, versionString string) context.Context
- type AgentError
- type ClientServerError
- type DelayedUnmarshaler
- type ErrorCategory
- type GenAIMetricAttrs
- type ToolboxError
- type UserAgentRoundTripper
Constants ¶
const GDAClientID = "GENAI_TOOLBOX"
GDAClientID is the client ID for Gemini Data Analytics
Variables ¶
This section is empty.
Functions ¶
func ConvertNumbers ¶
ConvertNumbers traverses an interface and converts all json.Number instances to int64 or float64.
func DecodeJSON ¶
DecodeJSON decodes a given reader into an interface using the json decoder.
func InstrumentationFromContext ¶
func InstrumentationFromContext(ctx context.Context) (*telemetry.Instrumentation, error)
InstrumentationFromContext retrieves the instrumentation or return an error
func LoggerFromContext ¶
LoggerFromContext retrieves the logger or return an error
func NewStrictDecoder ¶
func UserAgentFromContext ¶
UserAgentFromContext retrieves the user agent or return an error
func WithGenAIMetricAttrs ¶
func WithGenAIMetricAttrs(ctx context.Context, attrs *GenAIMetricAttrs) context.Context
WithGenAIMetricAttrs adds GenAIMetricAttrs to the context
func WithInstrumentation ¶
func WithInstrumentation(ctx context.Context, instrumentation *telemetry.Instrumentation) context.Context
WithInstrumentation adds an instrumentation into the context as a value
func WithLogger ¶
WithLogger adds a logger into the context as a value
Types ¶
type AgentError ¶
Agent Errors return 200 to the sender
func NewAgentError ¶
func NewAgentError(msg string, cause error) *AgentError
func (*AgentError) Category ¶
func (e *AgentError) Category() ErrorCategory
func (*AgentError) Error ¶
func (e *AgentError) Error() string
func (*AgentError) Unwrap ¶
func (e *AgentError) Unwrap() error
type ClientServerError ¶
ClientServerError returns 4XX/5XX error code
func NewClientServerError ¶
func NewClientServerError(msg string, code int, cause error) *ClientServerError
func (*ClientServerError) Category ¶
func (e *ClientServerError) Category() ErrorCategory
func (*ClientServerError) Error ¶
func (e *ClientServerError) Error() string
func (*ClientServerError) Unwrap ¶
func (e *ClientServerError) Unwrap() error
type DelayedUnmarshaler ¶
type DelayedUnmarshaler struct {
// contains filtered or unexported fields
}
DelayedUnmarshaler is struct that saves the provided unmarshal function passed to UnmarshalYAML so it can be re-used later once the target interface is known.
func (*DelayedUnmarshaler) Unmarshal ¶
func (d *DelayedUnmarshaler) Unmarshal(v interface{}) error
func (*DelayedUnmarshaler) UnmarshalYAML ¶
func (d *DelayedUnmarshaler) UnmarshalYAML(ctx context.Context, unmarshal func(interface{}) error) error
type ErrorCategory ¶
type ErrorCategory string
const ( CategoryAgent ErrorCategory = "AGENT_ERROR" CategoryServer ErrorCategory = "SERVER_ERROR" )
type GenAIMetricAttrs ¶
type GenAIMetricAttrs struct {
OperationName string
ToolName string
PromptName string
NetworkProtocolName string
NetworkProtocolVersion string
}
GenAIMetricAttrs holds gen_ai and network attributes for metrics
func GenAIMetricAttrsFromContext ¶
func GenAIMetricAttrsFromContext(ctx context.Context) *GenAIMetricAttrs
GenAIMetricAttrsFromContext retrieves GenAIMetricAttrs from context
type ToolboxError ¶
type ToolboxError interface {
error
Category() ErrorCategory
Error() string
Unwrap() error
}
ToolboxError is the interface all custom errors must satisfy
func ProcessGcpError ¶
func ProcessGcpError(err error) ToolboxError
ProcessGcpError catches auth related errors in GCP requests results and return 401/403 error codes Returns AgentError for all other errors
func ProcessGeneralError ¶
func ProcessGeneralError(err error) ToolboxError
ProcessGeneralError handles generic errors by inspecting the error string for common status code patterns.
type UserAgentRoundTripper ¶
type UserAgentRoundTripper struct {
// contains filtered or unexported fields
}
func NewUserAgentRoundTripper ¶
func NewUserAgentRoundTripper(ua string, next http.RoundTripper) *UserAgentRoundTripper
Source Files
Directories