ces

package
v0.280.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 19, 2026 License: BSD-3-Clause Imports: 18 Imported by: 0

Documentation

Overview

Package ces provides access to the Gemini Enterprise for Customer Experience API.

For product documentation, see: https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/ces/v1beta"
...
ctx := context.Background()
cesService, err := ces.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes:

cesService, err := ces.NewService(ctx, option.WithScopes(ces.CloudPlatformScope))

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

cesService, err := ces.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
cesService, err := ces.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// Create, update, delete, and manage your Next Gen Agents
	CesScope = "https://www.googleapis.com/auth/ces"

	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Action

type Action struct {
	// ConnectionActionId: ID of a Connection action for the tool to use.
	ConnectionActionId string `json:"connectionActionId,omitempty"`
	// EntityOperation: Entity operation configuration for the tool to use.
	EntityOperation *ActionEntityOperation `json:"entityOperation,omitempty"`
	// InputFields: Optional. Entity fields to use as inputs for the operation. If
	// no fields are specified, all fields of the Entity will be used.
	InputFields []string `json:"inputFields,omitempty"`
	// OutputFields: Optional. Entity fields to return from the operation. If no
	// fields are specified, all fields of the Entity will be returned.
	OutputFields []string `json:"outputFields,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConnectionActionId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConnectionActionId") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Action: Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details.

func (Action) MarshalJSON

func (s Action) MarshalJSON() ([]byte, error)

type ActionEntityOperation

type ActionEntityOperation struct {
	// EntityId: Required. ID of the entity.
	EntityId string `json:"entityId,omitempty"`
	// Operation: Required. Operation to perform on the entity.
	//
	// Possible values:
	//   "OPERATION_TYPE_UNSPECIFIED" - Operation type unspecified. Invalid,
	// ConnectorTool create/update will fail.
	//   "LIST" - List operation.
	//   "GET" - Get operation.
	//   "CREATE" - Create operation.
	//   "UPDATE" - Update operation.
	//   "DELETE" - Delete operation.
	Operation string `json:"operation,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EntityId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EntityId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ActionEntityOperation: Entity CRUD operation specification.

func (ActionEntityOperation) MarshalJSON

func (s ActionEntityOperation) MarshalJSON() ([]byte, error)

type Agent

type Agent struct {
	// AfterAgentCallbacks: Optional. The callbacks to execute after the agent is
	// called. The provided callbacks are executed sequentially in the exact order
	// they are given in the list. If a callback returns an overridden response,
	// execution stops and any remaining callbacks are skipped.
	AfterAgentCallbacks []*Callback `json:"afterAgentCallbacks,omitempty"`
	// AfterModelCallbacks: Optional. The callbacks to execute after the model is
	// called. If there are multiple calls to the model, the callback will be
	// executed multiple times. The provided callbacks are executed sequentially in
	// the exact order they are given in the list. If a callback returns an
	// overridden response, execution stops and any remaining callbacks are
	// skipped.
	AfterModelCallbacks []*Callback `json:"afterModelCallbacks,omitempty"`
	// AfterToolCallbacks: Optional. The callbacks to execute after the tool is
	// invoked. If there are multiple tool invocations, the callback will be
	// executed multiple times. The provided callbacks are executed sequentially in
	// the exact order they are given in the list. If a callback returns an
	// overridden response, execution stops and any remaining callbacks are
	// skipped.
	AfterToolCallbacks []*Callback `json:"afterToolCallbacks,omitempty"`
	// BeforeAgentCallbacks: Optional. The callbacks to execute before the agent is
	// called. The provided callbacks are executed sequentially in the exact order
	// they are given in the list. If a callback returns an overridden response,
	// execution stops and any remaining callbacks are skipped.
	BeforeAgentCallbacks []*Callback `json:"beforeAgentCallbacks,omitempty"`
	// BeforeModelCallbacks: Optional. The callbacks to execute before the model is
	// called. If there are multiple calls to the model, the callback will be
	// executed multiple times. The provided callbacks are executed sequentially in
	// the exact order they are given in the list. If a callback returns an
	// overridden response, execution stops and any remaining callbacks are
	// skipped.
	BeforeModelCallbacks []*Callback `json:"beforeModelCallbacks,omitempty"`
	// BeforeToolCallbacks: Optional. The callbacks to execute before the tool is
	// invoked. If there are multiple tool invocations, the callback will be
	// executed multiple times. The provided callbacks are executed sequentially in
	// the exact order they are given in the list. If a callback returns an
	// overridden response, execution stops and any remaining callbacks are
	// skipped.
	BeforeToolCallbacks []*Callback `json:"beforeToolCallbacks,omitempty"`
	// ChildAgents: Optional. List of child agents in the agent tree. Format:
	// `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
	ChildAgents []string `json:"childAgents,omitempty"`
	// CreateTime: Output only. Timestamp when the agent was created.
	CreateTime string `json:"createTime,omitempty"`
	// Description: Optional. Human-readable description of the agent.
	Description string `json:"description,omitempty"`
	// DisplayName: Required. Display name of the agent.
	DisplayName string `json:"displayName,omitempty"`
	// Etag: Etag used to ensure the object hasn't changed during a
	// read-modify-write operation. If the etag is empty, the update will overwrite
	// any concurrent changes.
	Etag string `json:"etag,omitempty"`
	// GeneratedSummary: Output only. If the agent is generated by the LLM
	// assistant, this field contains a descriptive summary of the generation.
	GeneratedSummary string `json:"generatedSummary,omitempty"`
	// Guardrails: Optional. List of guardrails for the agent. Format:
	// `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
	Guardrails []string `json:"guardrails,omitempty"`
	// Instruction: Optional. Instructions for the LLM model to guide the agent's
	// behavior.
	Instruction string `json:"instruction,omitempty"`
	// LlmAgent: Optional. The default agent type.
	LlmAgent *AgentLlmAgent `json:"llmAgent,omitempty"`
	// ModelSettings: Optional. Configurations for the LLM model.
	ModelSettings *ModelSettings `json:"modelSettings,omitempty"`
	// Name: Identifier. The unique identifier of the agent. Format:
	// `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
	Name string `json:"name,omitempty"`
	// RemoteDialogflowAgent: Optional. The remote Dialogflow
	// (https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents)
	// agent to be used for the agent execution. If this field is set, all other
	// agent level properties will be ignored. Note: If the Dialogflow agent is in
	// a different project from the app, you should grant `roles/dialogflow.client`
	// to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
	RemoteDialogflowAgent *AgentRemoteDialogflowAgent `json:"remoteDialogflowAgent,omitempty"`
	// Tools: Optional. List of available tools for the agent. Format:
	// `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
	Tools []string `json:"tools,omitempty"`
	// Toolsets: Optional. List of toolsets for the agent.
	Toolsets []*AgentAgentToolset `json:"toolsets,omitempty"`
	// TransferRules: Optional. Agent transfer rules. If multiple rules match, the
	// first one in the list will be used.
	TransferRules []*TransferRule `json:"transferRules,omitempty"`
	// UpdateTime: Output only. Timestamp when the agent was last updated.
	UpdateTime string `json:"updateTime,omitempty"`
	// ValidationErrors: Output only. Misconfigurations or errors in the agent that
	// may affect agent quality.
	ValidationErrors []string `json:"validationErrors,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AfterAgentCallbacks") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AfterAgentCallbacks") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Agent: An agent acts as the fundamental building block that provides instructions to the Large Language Model (LLM) for executing specific tasks.

func (Agent) MarshalJSON

func (s Agent) MarshalJSON() ([]byte, error)

type AgentAgentToolset

type AgentAgentToolset struct {
	// ToolIds: Optional. The tools IDs to filter the toolset.
	ToolIds []string `json:"toolIds,omitempty"`
	// Toolset: Required. The resource name of the toolset. Format:
	// `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
	Toolset string `json:"toolset,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ToolIds") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ToolIds") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AgentAgentToolset: A toolset with a selection of its tools.

func (AgentAgentToolset) MarshalJSON

func (s AgentAgentToolset) MarshalJSON() ([]byte, error)

type AgentCard added in v0.279.0

type AgentCard struct {
	// Description: Required. A description of the agent's domain of
	// action/solution space.
	Description string `json:"description,omitempty"`
	// Name: Required. A human-readable name for the agent.
	Name string `json:"name,omitempty"`
	// Skills: Required. Skills represent a unit of ability an agent can perform.
	// This may somewhat abstract but represents a more focused set of actions that
	// the agent is highly likely to succeed at.
	Skills []*AgentSkill `json:"skills,omitempty"`
	// SupportedInterfaces: Required. Ordered list of supported interfaces. The
	// first entry is preferred.
	SupportedInterfaces []*AgentInterface `json:"supportedInterfaces,omitempty"`
	// Version: Required. The version of the agent.
	Version string `json:"version,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AgentCard: AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard

func (AgentCard) MarshalJSON added in v0.279.0

func (s AgentCard) MarshalJSON() ([]byte, error)

type AgentInterface added in v0.279.0

type AgentInterface struct {
	// ProtocolBinding: Required. The protocol binding supported at this URL. This
	// is an open form string, to be easily extended for other protocol bindings.
	// The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
	ProtocolBinding string `json:"protocolBinding,omitempty"`
	// ProtocolVersion: Required. The version of the A2A protocol this interface
	// exposes. Use the latest supported minor version per major version. Examples:
	// "0.3", "1.0"
	ProtocolVersion string `json:"protocolVersion,omitempty"`
	// Tenant: Tenant ID to be used in the request when calling the agent.
	Tenant string `json:"tenant,omitempty"`
	// Url: Required. The URL where this interface is available. Must be a valid
	// absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1",
	// "https://grpc.example.com/a2a"
	Url string `json:"url,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ProtocolBinding") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ProtocolBinding") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AgentInterface: Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.

func (AgentInterface) MarshalJSON added in v0.279.0

func (s AgentInterface) MarshalJSON() ([]byte, error)

type AgentLlmAgent

type AgentLlmAgent struct {
}

AgentLlmAgent: Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model.

type AgentRemoteDialogflowAgent

type AgentRemoteDialogflowAgent struct {
	// Agent: Required. The Dialogflow
	// (https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent
	// resource name. Format:
	// `projects/{project}/locations/{location}/agents/{agent}`
	Agent string `json:"agent,omitempty"`
	// EnvironmentId: Optional. The environment ID of the Dialogflow agent to be
	// used for the agent execution. If not specified, the draft environment will
	// be used.
	EnvironmentId string `json:"environmentId,omitempty"`
	// FlowId: Optional. The flow ID of the flow in the Dialogflow agent.
	FlowId string `json:"flowId,omitempty"`
	// InputVariableMapping: Optional. The mapping of the app variables names to
	// the Dialogflow session parameters names to be sent to the Dialogflow agent
	// as input.
	InputVariableMapping map[string]string `json:"inputVariableMapping,omitempty"`
	// OutputVariableMapping: Optional. The mapping of the Dialogflow session
	// parameters names to the app variables names to be sent back to the CES agent
	// after the Dialogflow agent execution ends.
	OutputVariableMapping map[string]string `json:"outputVariableMapping,omitempty"`
	// RespectResponseInterruptionSettings: Optional. Indicates whether to respect
	// the message-level interruption settings configured in the Dialogflow agent.
	// * If false: all response messages from the Dialogflow agent follow the
	// app-level barge-in settings. * If true: only response messages with
	// `allow_playback_interruption`
	// (https://docs.cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#text)
	// set to true will be interruptable, all other messages follow the app-level
	// barge-in settings.
	RespectResponseInterruptionSettings bool `json:"respectResponseInterruptionSettings,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Agent") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Agent") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AgentRemoteDialogflowAgent: The agent which will transfer execution to a remote Dialogflow CX (https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent.

func (AgentRemoteDialogflowAgent) MarshalJSON

func (s AgentRemoteDialogflowAgent) MarshalJSON() ([]byte, error)

type AgentSkill added in v0.279.0

type AgentSkill struct {
	// Description: Required. A detailed description of the skill.
	Description string `json:"description,omitempty"`
	// Examples: Example prompts or scenarios that this skill can handle.
	Examples []string `json:"examples,omitempty"`
	// Id: Required. A unique identifier for the agent's skill.
	Id string `json:"id,omitempty"`
	// InputModes: The set of supported input media types for this skill,
	// overriding the agent's defaults.
	InputModes []string `json:"inputModes,omitempty"`
	// Name: Required. A human-readable name for the skill.
	Name string `json:"name,omitempty"`
	// OutputModes: The set of supported output media types for this skill,
	// overriding the agent's defaults.
	OutputModes []string `json:"outputModes,omitempty"`
	// Tags: Required. A set of keywords describing the skill's capabilities.
	Tags []string `json:"tags,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AgentSkill: Represents a distinct capability or function that an agent can perform.

func (AgentSkill) MarshalJSON added in v0.279.0

func (s AgentSkill) MarshalJSON() ([]byte, error)

type AgentTool added in v0.272.0

type AgentTool struct {
	// Agent: Optional. The resource name of the agent that is the entry point of
	// the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
	Agent string `json:"agent,omitempty"`
	// Description: Optional. Description of the tool's purpose.
	Description string `json:"description,omitempty"`
	// Name: Required. The name of the agent tool.
	Name string `json:"name,omitempty"`
	// RootAgent: Optional. Deprecated: Use `agent` instead. The resource name of
	// the root agent that is the entry point of the tool. Format:
	// `projects/{project}/locations/{location}/agents/{agent}`
	RootAgent string `json:"rootAgent,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Agent") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Agent") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AgentTool: Represents a tool that allows the agent to call another agent.

func (AgentTool) MarshalJSON added in v0.272.0

func (s AgentTool) MarshalJSON() ([]byte, error)

type AgentTransfer

type AgentTransfer struct {
	// DisplayName: Output only. Display name of the agent.
	DisplayName string `json:"displayName,omitempty"`
	// TargetAgent: Required. The agent to which the conversation is being
	// transferred. The agent will handle the conversation from this point forward.
	// Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
	TargetAgent string `json:"targetAgent,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AgentTransfer: Represents an event indicating the transfer of a conversation to a different agent.

func (AgentTransfer) MarshalJSON

func (s AgentTransfer) MarshalJSON() ([]byte, error)

type AggregatedMetrics

type AggregatedMetrics struct {
	// MetricsByAppVersion: Output only. Aggregated metrics, grouped by app version
	// ID.
	MetricsByAppVersion []*AggregatedMetricsMetricsByAppVersion `json:"metricsByAppVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MetricsByAppVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MetricsByAppVersion") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AggregatedMetrics: Aggregated metrics for an evaluation or evaluation dataset.

func (AggregatedMetrics) MarshalJSON

func (s AggregatedMetrics) MarshalJSON() ([]byte, error)

type AggregatedMetricsHallucinationMetrics

type AggregatedMetricsHallucinationMetrics struct {
	// Score: Output only. The average hallucination score (0 to 1).
	Score float64 `json:"score,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Score") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Score") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AggregatedMetricsHallucinationMetrics: Metrics for hallucination results.

func (AggregatedMetricsHallucinationMetrics) MarshalJSON

func (s AggregatedMetricsHallucinationMetrics) MarshalJSON() ([]byte, error)

func (*AggregatedMetricsHallucinationMetrics) UnmarshalJSON

func (s *AggregatedMetricsHallucinationMetrics) UnmarshalJSON(data []byte) error

type AggregatedMetricsMetricsByAppVersion

type AggregatedMetricsMetricsByAppVersion struct {
	// AppVersionId: Output only. The app version ID.
	AppVersionId string `json:"appVersionId,omitempty"`
	// FailCount: Output only. The number of times the evaluation failed.
	FailCount int64 `json:"failCount,omitempty"`
	// HallucinationMetrics: Output only. Metrics for hallucination within this app
	// version.
	HallucinationMetrics []*AggregatedMetricsHallucinationMetrics `json:"hallucinationMetrics,omitempty"`
	// MetricsByTurn: Output only. Metrics aggregated per turn within this app
	// version.
	MetricsByTurn []*AggregatedMetricsMetricsByTurn `json:"metricsByTurn,omitempty"`
	// PassCount: Output only. The number of times the evaluation passed.
	PassCount int64 `json:"passCount,omitempty"`
	// SemanticSimilarityMetrics: Output only. Metrics for semantic similarity
	// within this app version.
	SemanticSimilarityMetrics []*AggregatedMetricsSemanticSimilarityMetrics `json:"semanticSimilarityMetrics,omitempty"`
	// ToolCallLatencyMetrics: Output only. Metrics for tool call latency within
	// this app version.
	ToolCallLatencyMetrics []*AggregatedMetricsToolCallLatencyMetrics `json:"toolCallLatencyMetrics,omitempty"`
	// ToolMetrics: Output only. Metrics for each tool within this app version.
	ToolMetrics []*AggregatedMetricsToolMetrics `json:"toolMetrics,omitempty"`
	// TurnLatencyMetrics: Output only. Metrics for turn latency within this app
	// version.
	TurnLatencyMetrics []*AggregatedMetricsTurnLatencyMetrics `json:"turnLatencyMetrics,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AppVersionId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppVersionId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AggregatedMetricsMetricsByAppVersion: Metrics aggregated per app version.

func (AggregatedMetricsMetricsByAppVersion) MarshalJSON

func (s AggregatedMetricsMetricsByAppVersion) MarshalJSON() ([]byte, error)

type AggregatedMetricsMetricsByTurn

type AggregatedMetricsMetricsByTurn struct {
	// HallucinationMetrics: Output only. Metrics for hallucination within this
	// turn.
	HallucinationMetrics []*AggregatedMetricsHallucinationMetrics `json:"hallucinationMetrics,omitempty"`
	// SemanticSimilarityMetrics: Output only. Metrics for semantic similarity
	// within this turn.
	SemanticSimilarityMetrics []*AggregatedMetricsSemanticSimilarityMetrics `json:"semanticSimilarityMetrics,omitempty"`
	// ToolCallLatencyMetrics: Output only. Metrics for tool call latency within
	// this turn.
	ToolCallLatencyMetrics []*AggregatedMetricsToolCallLatencyMetrics `json:"toolCallLatencyMetrics,omitempty"`
	// ToolMetrics: Output only. Metrics for each tool within this turn.
	ToolMetrics []*AggregatedMetricsToolMetrics `json:"toolMetrics,omitempty"`
	// TurnIndex: Output only. The turn index (0-based).
	TurnIndex int64 `json:"turnIndex,omitempty"`
	// TurnLatencyMetrics: Output only. Metrics for turn latency within this turn.
	TurnLatencyMetrics []*AggregatedMetricsTurnLatencyMetrics `json:"turnLatencyMetrics,omitempty"`
	// ForceSendFields is a list of field names (e.g. "HallucinationMetrics") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "HallucinationMetrics") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AggregatedMetricsMetricsByTurn: Metrics aggregated per turn.

func (AggregatedMetricsMetricsByTurn) MarshalJSON

func (s AggregatedMetricsMetricsByTurn) MarshalJSON() ([]byte, error)

type AggregatedMetricsSemanticSimilarityMetrics

type AggregatedMetricsSemanticSimilarityMetrics struct {
	// Score: Output only. The average semantic similarity score (0-4).
	Score float64 `json:"score,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Score") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Score") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AggregatedMetricsSemanticSimilarityMetrics: Metrics for semantic similarity results.

func (AggregatedMetricsSemanticSimilarityMetrics) MarshalJSON

func (*AggregatedMetricsSemanticSimilarityMetrics) UnmarshalJSON

func (s *AggregatedMetricsSemanticSimilarityMetrics) UnmarshalJSON(data []byte) error

type AggregatedMetricsToolCallLatencyMetrics

type AggregatedMetricsToolCallLatencyMetrics struct {
	// AverageLatency: Output only. The average latency of the tool calls.
	AverageLatency string `json:"averageLatency,omitempty"`
	// Tool: Output only. The name of the tool.
	Tool string `json:"tool,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AverageLatency") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AverageLatency") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AggregatedMetricsToolCallLatencyMetrics: Metrics for tool call latency.

func (AggregatedMetricsToolCallLatencyMetrics) MarshalJSON

func (s AggregatedMetricsToolCallLatencyMetrics) MarshalJSON() ([]byte, error)

type AggregatedMetricsToolMetrics

type AggregatedMetricsToolMetrics struct {
	// FailCount: Output only. The number of times the tool failed.
	FailCount int64 `json:"failCount,omitempty"`
	// PassCount: Output only. The number of times the tool passed.
	PassCount int64 `json:"passCount,omitempty"`
	// Tool: Output only. The name of the tool.
	Tool string `json:"tool,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FailCount") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FailCount") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AggregatedMetricsToolMetrics: Metrics for a single tool.

func (AggregatedMetricsToolMetrics) MarshalJSON

func (s AggregatedMetricsToolMetrics) MarshalJSON() ([]byte, error)

type AggregatedMetricsTurnLatencyMetrics

type AggregatedMetricsTurnLatencyMetrics struct {
	// AverageLatency: Output only. The average latency of the turns.
	AverageLatency string `json:"averageLatency,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AverageLatency") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AverageLatency") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AggregatedMetricsTurnLatencyMetrics: Metrics for turn latency.

func (AggregatedMetricsTurnLatencyMetrics) MarshalJSON

func (s AggregatedMetricsTurnLatencyMetrics) MarshalJSON() ([]byte, error)

type AmbientSoundConfig

type AmbientSoundConfig struct {
	// GcsUri: Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in
	// Cloud Storage (https://cloud.google.com/storage). Note: Please make sure the
	// CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com` has
	// `storage.objects.get` permission to the Cloud Storage object.
	GcsUri string `json:"gcsUri,omitempty"`
	// PrebuiltAmbientNoise: Optional. Deprecated: `prebuilt_ambient_noise` is
	// deprecated in favor of `prebuilt_ambient_sound`.
	//
	// Possible values:
	//   "PREBUILT_AMBIENT_NOISE_UNSPECIFIED" - Not specified.
	//   "RETAIL_STORE" - Ambient noise of a retail store.
	//   "CONVENTION_HALL" - Ambient noise of a convention hall.
	//   "OUTDOOR" - Ambient noise of a street.
	PrebuiltAmbientNoise string `json:"prebuiltAmbientNoise,omitempty"`
	// PrebuiltAmbientSound: Optional. Name of the prebuilt ambient sound. Valid
	// values are: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" -
	// "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" -
	// "room_5" - "air_conditioner"
	PrebuiltAmbientSound string `json:"prebuiltAmbientSound,omitempty"`
	// VolumeGainDb: Optional. Volume gain (in dB) of the normal native volume
	// supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to
	// a value of 0.0 (dB), will play at normal native signal amplitude. A value of
	// -6.0 (dB) will play at approximately half the amplitude of the normal native
	// signal amplitude. A value of +6.0 (dB) will play at approximately twice the
	// amplitude of the normal native signal amplitude. We strongly recommend not
	// to exceed +10 (dB) as there's usually no effective increase in loudness for
	// any value greater than that.
	VolumeGainDb float64 `json:"volumeGainDb,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GcsUri") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GcsUri") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AmbientSoundConfig: Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation.

func (AmbientSoundConfig) MarshalJSON

func (s AmbientSoundConfig) MarshalJSON() ([]byte, error)

func (*AmbientSoundConfig) UnmarshalJSON

func (s *AmbientSoundConfig) UnmarshalJSON(data []byte) error

type ApiAuthentication

type ApiAuthentication struct {
	// ApiKeyConfig: Optional. Config for API key auth.
	ApiKeyConfig *ApiKeyConfig `json:"apiKeyConfig,omitempty"`
	// BearerTokenConfig: Optional. Config for bearer token auth.
	BearerTokenConfig *BearerTokenConfig `json:"bearerTokenConfig,omitempty"`
	// OauthConfig: Optional. Config for OAuth.
	OauthConfig *OAuthConfig `json:"oauthConfig,omitempty"`
	// ServiceAccountAuthConfig: Optional. Config for service account
	// authentication.
	ServiceAccountAuthConfig *ServiceAccountAuthConfig `json:"serviceAccountAuthConfig,omitempty"`
	// ServiceAgentIdTokenAuthConfig: Optional. Config for ID token auth generated
	// from CES service agent.
	ServiceAgentIdTokenAuthConfig *ServiceAgentIdTokenAuthConfig `json:"serviceAgentIdTokenAuthConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiKeyConfig") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApiKeyConfig") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ApiAuthentication: Authentication information required for API calls.

func (ApiAuthentication) MarshalJSON

func (s ApiAuthentication) MarshalJSON() ([]byte, error)

type ApiKeyConfig

type ApiKeyConfig struct {
	// ApiKeySecretVersion: Required. The name of the SecretManager secret version
	// resource storing the API key. Format:
	// `projects/{project}/secrets/{secret}/versions/{version}` Note: You should
	// grant `roles/secretmanager.secretAccessor` role to the CES service agent
	// `service-@gcp-sa-ces.iam.gserviceaccount.com`.
	ApiKeySecretVersion string `json:"apiKeySecretVersion,omitempty"`
	// KeyName: Required. The parameter name or the header name of the API key.
	// E.g., If the API request is "https://example.com/act?X-Api-Key=",
	// "X-Api-Key" would be the parameter name.
	KeyName string `json:"keyName,omitempty"`
	// RequestLocation: Required. Key location in the request.
	//
	// Possible values:
	//   "REQUEST_LOCATION_UNSPECIFIED" - Unspecified. This value should not be
	// used.
	//   "HEADER" - Represents the key in http header.
	//   "QUERY_STRING" - Represents the key in query string.
	RequestLocation string `json:"requestLocation,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiKeySecretVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApiKeySecretVersion") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ApiKeyConfig: Configurations for authentication with API key.

func (ApiKeyConfig) MarshalJSON

func (s ApiKeyConfig) MarshalJSON() ([]byte, error)

type App

type App struct {
	// AudioProcessingConfig: Optional. Audio processing configuration of the app.
	AudioProcessingConfig *AudioProcessingConfig `json:"audioProcessingConfig,omitempty"`
	// ClientCertificateSettings: Optional. The default client certificate settings
	// for the app.
	ClientCertificateSettings *ClientCertificateSettings `json:"clientCertificateSettings,omitempty"`
	// CreateTime: Output only. Timestamp when the app was created.
	CreateTime string `json:"createTime,omitempty"`
	// DataStoreSettings: Optional. The data store settings for the app.
	DataStoreSettings *DataStoreSettings `json:"dataStoreSettings,omitempty"`
	// DefaultChannelProfile: Optional. The default channel profile used by the
	// app.
	DefaultChannelProfile *ChannelProfile `json:"defaultChannelProfile,omitempty"`
	// DeploymentCount: Output only. Number of deployments in the app.
	DeploymentCount int64 `json:"deploymentCount,omitempty"`
	// Description: Optional. Human-readable description of the app.
	Description string `json:"description,omitempty"`
	// DisplayName: Required. Display name of the app.
	DisplayName string `json:"displayName,omitempty"`
	// ErrorHandlingSettings: Optional. Error handling settings of the app.
	ErrorHandlingSettings *ErrorHandlingSettings `json:"errorHandlingSettings,omitempty"`
	// Etag: Output only. Etag used to ensure the object hasn't changed during a
	// read-modify-write operation. If the etag is empty, the update will overwrite
	// any concurrent changes.
	Etag string `json:"etag,omitempty"`
	// EvaluationMetricsThresholds: Optional. The evaluation thresholds for the
	// app.
	EvaluationMetricsThresholds *EvaluationMetricsThresholds `json:"evaluationMetricsThresholds,omitempty"`
	// EvaluationPersonas: Optional. The evaluation personas for the app. This
	// field is used to define the personas that can be used for evaluation.
	// Maximum of 30 personas can be defined.
	EvaluationPersonas []*EvaluationPersona `json:"evaluationPersonas,omitempty"`
	// EvaluationSettings: Optional. The evaluation settings for the app.
	EvaluationSettings *EvaluationSettings `json:"evaluationSettings,omitempty"`
	// GlobalInstruction: Optional. Instructions for all the agents in the app. You
	// can use this instruction to set up a stable identity or personality across
	// all the agents.
	GlobalInstruction string `json:"globalInstruction,omitempty"`
	// Guardrails: Optional. List of guardrails for the app. Format:
	// `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
	Guardrails []string `json:"guardrails,omitempty"`
	// LanguageSettings: Optional. Language settings of the app.
	LanguageSettings *LanguageSettings `json:"languageSettings,omitempty"`
	// Locked: Optional. Indicates whether the app is locked for changes. If the
	// app is locked, modifications to the app resources will be rejected.
	Locked bool `json:"locked,omitempty"`
	// LoggingSettings: Optional. Logging settings of the app.
	LoggingSettings *LoggingSettings `json:"loggingSettings,omitempty"`
	// Metadata: Optional. Metadata about the app. This field can be used to store
	// additional information relevant to the app's details or intended usages.
	Metadata map[string]string `json:"metadata,omitempty"`
	// ModelSettings: Optional. The default LLM model settings for the app.
	// Individual resources (e.g. agents, guardrails) can override these
	// configurations as needed.
	ModelSettings *ModelSettings `json:"modelSettings,omitempty"`
	// Name: Identifier. The unique identifier of the app. Format:
	// `projects/{project}/locations/{location}/apps/{app}`
	Name string `json:"name,omitempty"`
	// Pinned: Optional. Whether the app is pinned in the app list.
	Pinned bool `json:"pinned,omitempty"`
	// PredefinedVariableDeclarations: Output only. The declarations of predefined
	// variables for the app.
	PredefinedVariableDeclarations []*AppVariableDeclaration `json:"predefinedVariableDeclarations,omitempty"`
	// RootAgent: Optional. The root agent is the entry point of the app. Format:
	// `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
	RootAgent string `json:"rootAgent,omitempty"`
	// TimeZoneSettings: Optional. TimeZone settings of the app.
	TimeZoneSettings *TimeZoneSettings `json:"timeZoneSettings,omitempty"`
	// ToolExecutionMode: Optional. The tool execution mode for the app. If not
	// provided, will default to PARALLEL.
	//
	// Possible values:
	//   "TOOL_EXECUTION_MODE_UNSPECIFIED" - Unspecified tool execution mode.
	// Default to PARALLEL.
	//   "PARALLEL" - If there are multiple tools being selected, they will be
	// executed in parallel, with the same
	// [ToolContext](https://google.github.io/adk-docs/context/#the-different-types-
	// of-context).
	//   "SEQUENTIAL" - If there are multiple tools being selected, they will be
	// executed sequentially. The next tool will only be executed after the
	// previous tool completes and it can see updated
	// [ToolContext](https://google.github.io/adk-docs/context/#the-different-types-
	// of-context) from the previous tool.
	ToolExecutionMode string `json:"toolExecutionMode,omitempty"`
	// UpdateTime: Output only. Timestamp when the app was last updated.
	UpdateTime string `json:"updateTime,omitempty"`
	// ValidationErrors: Output only. Misconfigurations or warnings in the app.
	ValidationErrors []string `json:"validationErrors,omitempty"`
	// VariableDeclarations: Optional. The declarations of the variables.
	VariableDeclarations []*AppVariableDeclaration `json:"variableDeclarations,omitempty"`
	// VpcScSettings: Optional. VPC-SC settings for the app.
	VpcScSettings *VpcScSettings `json:"vpcScSettings,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AudioProcessingConfig") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AudioProcessingConfig") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

App: An app serves as a top-level container for a group of agents, including the root agent and its sub-agents, along with their associated configurations. These agents work together to achieve specific goals within the app's context.

func (App) MarshalJSON

func (s App) MarshalJSON() ([]byte, error)

type AppSnapshot

type AppSnapshot struct {
	// Agents: Optional. List of agents in the app.
	Agents []*Agent `json:"agents,omitempty"`
	// App: Optional. The basic settings for the app.
	App *App `json:"app,omitempty"`
	// Examples: Optional. List of examples in the app.
	Examples []*Example `json:"examples,omitempty"`
	// Guardrails: Optional. List of guardrails in the app.
	Guardrails []*Guardrail `json:"guardrails,omitempty"`
	// Tools: Optional. List of tools in the app.
	Tools []*Tool `json:"tools,omitempty"`
	// Toolsets: Optional. List of toolsets in the app.
	Toolsets []*Toolset `json:"toolsets,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Agents") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Agents") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AppSnapshot: A snapshot of the app.

func (AppSnapshot) MarshalJSON

func (s AppSnapshot) MarshalJSON() ([]byte, error)

type AppVariableDeclaration

type AppVariableDeclaration struct {
	// Description: Required. The description of the variable.
	Description string `json:"description,omitempty"`
	// Name: Required. The name of the variable. The name must start with a letter
	// or underscore and contain only letters, numbers, or underscores.
	Name string `json:"name,omitempty"`
	// Schema: Required. The schema of the variable.
	Schema *Schema `json:"schema,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AppVariableDeclaration: Defines the structure and metadata for a variable.

func (AppVariableDeclaration) MarshalJSON

func (s AppVariableDeclaration) MarshalJSON() ([]byte, error)

type AppVersion

type AppVersion struct {
	// CreateTime: Output only. Timestamp when the app version was created.
	CreateTime string `json:"createTime,omitempty"`
	// Creator: Output only. Email of the user who created the app version.
	Creator string `json:"creator,omitempty"`
	// Description: Optional. The description of the app version.
	Description string `json:"description,omitempty"`
	// DisplayName: Optional. The display name of the app version.
	DisplayName string `json:"displayName,omitempty"`
	// Etag: Output only. Etag used to ensure the object hasn't changed during a
	// read-modify-write operation. If the etag is empty, the update will overwrite
	// any concurrent changes.
	Etag string `json:"etag,omitempty"`
	// Name: Identifier. The unique identifier of the app version. Format:
	// `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
	Name string `json:"name,omitempty"`
	// Snapshot: Output only. The snapshot of the app when the version is created.
	Snapshot *AppSnapshot `json:"snapshot,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AppVersion: In Customer Engagement Suite (CES), an app version is a snapshot of the app at a specific point in time. It is immutable and cannot be modified once created.

func (AppVersion) MarshalJSON

func (s AppVersion) MarshalJSON() ([]byte, error)

type AudioProcessingConfig

type AudioProcessingConfig struct {
	// AmbientSoundConfig: Optional. Configuration for the ambient sound to be
	// played with the synthesized agent response, to enhance the naturalness of
	// the conversation.
	AmbientSoundConfig *AmbientSoundConfig `json:"ambientSoundConfig,omitempty"`
	// BargeInConfig: Optional. Configures the agent behavior for the user barge-in
	// activities.
	BargeInConfig *BargeInConfig `json:"bargeInConfig,omitempty"`
	// InactivityTimeout: Optional. The duration of user inactivity (no speech or
	// interaction) before the agent prompts the user for reengagement. If not set,
	// the agent will not prompt the user for reengagement.
	InactivityTimeout string `json:"inactivityTimeout,omitempty"`
	// SynthesizeSpeechConfigs: Optional. Configuration of how the agent response
	// should be synthesized, mapping from the language code to
	// SynthesizeSpeechConfig. If the configuration for the specified language code
	// is not found, the configuration for the root language code will be used. For
	// example, if the map contains "en-us" and "en", and the specified language
	// code is "en-gb", then "en" configuration will be used. Note: Language code
	// is case-insensitive.
	SynthesizeSpeechConfigs map[string]SynthesizeSpeechConfig `json:"synthesizeSpeechConfigs,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AmbientSoundConfig") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AmbientSoundConfig") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AudioProcessingConfig: Configuration for how the input and output audio should be processed and delivered.

func (AudioProcessingConfig) MarshalJSON

func (s AudioProcessingConfig) MarshalJSON() ([]byte, error)

type AudioRecordingConfig

type AudioRecordingConfig struct {
	// GcsBucket: Optional. The Cloud Storage (https://cloud.google.com/storage)
	// bucket to store the session audio recordings. The URI must start with
	// "gs://". Please choose a bucket location that meets your data residency
	// requirements. Note: If the Cloud Storage bucket is in a different project
	// from the app, you should grant `storage.objects.create` permission to the
	// CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
	GcsBucket string `json:"gcsBucket,omitempty"`
	// GcsPathPrefix: Optional. The Cloud Storage path prefix for audio recordings.
	// This prefix can include the following placeholders, which will be
	// dynamically substituted at serving time: - $project: project ID - $location:
	// app location - $app: app ID - $date: session date in YYYY-MM-DD format -
	// $session: session ID If the path prefix is not specified, the default prefix
	// `$project/$location/$app/$date/$session/` will be used.
	GcsPathPrefix string `json:"gcsPathPrefix,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GcsBucket") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GcsBucket") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AudioRecordingConfig: Configuration for how the audio interactions should be recorded.

func (AudioRecordingConfig) MarshalJSON

func (s AudioRecordingConfig) MarshalJSON() ([]byte, error)

type BargeInConfig

type BargeInConfig struct {
	// BargeInAwareness: Optional. If enabled, the agent will adapt its next
	// response based on the assumption that the user hasn't heard the full
	// preceding agent message. This should not be used in scenarios where agent
	// responses are displayed visually.
	BargeInAwareness bool `json:"bargeInAwareness,omitempty"`
	// DisableBargeIn: Optional. Disables user barge-in while the agent is
	// speaking. If true, user input during agent response playback will be
	// ignored. Deprecated: `disable_barge_in` is deprecated in favor of
	// `disable_barge_in_control` in ChannelProfile.
	DisableBargeIn bool `json:"disableBargeIn,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BargeInAwareness") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BargeInAwareness") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BargeInConfig: Configuration for how the user barge-in activities should be handled.

func (BargeInConfig) MarshalJSON

func (s BargeInConfig) MarshalJSON() ([]byte, error)

type BatchDeleteConversationsRequest

type BatchDeleteConversationsRequest struct {
	// Conversations: Required. The resource names of the conversations to delete.
	Conversations []string `json:"conversations,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Conversations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Conversations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BatchDeleteConversationsRequest: Request message for AgentService.BatchDeleteConversations.

func (BatchDeleteConversationsRequest) MarshalJSON

func (s BatchDeleteConversationsRequest) MarshalJSON() ([]byte, error)

type BatchDeleteConversationsResponse

type BatchDeleteConversationsResponse struct {
	// DeletedConversations: The list of conversations that were successfully
	// deleted.
	DeletedConversations []string `json:"deletedConversations,omitempty"`
	// ErrorMessages: Optional. A list of error messages associated with
	// conversations that failed to be deleted.
	ErrorMessages []string `json:"errorMessages,omitempty"`
	// FailedConversations: The list of conversations that failed to be deleted.
	FailedConversations []string `json:"failedConversations,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DeletedConversations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DeletedConversations") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BatchDeleteConversationsResponse: Response message for AgentService.BatchDeleteConversations.

func (BatchDeleteConversationsResponse) MarshalJSON

func (s BatchDeleteConversationsResponse) MarshalJSON() ([]byte, error)

type BearerTokenConfig

type BearerTokenConfig struct {
	// Token: Required. The bearer token. Must be in the format
	// `$context.variables.`.
	Token string `json:"token,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Token") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Token") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BearerTokenConfig: Configurations for authentication with a bearer token.

func (BearerTokenConfig) MarshalJSON

func (s BearerTokenConfig) MarshalJSON() ([]byte, error)

type BigQueryExportSettings

type BigQueryExportSettings struct {
	// Dataset: Optional. The BigQuery **dataset ID** to export the data to.
	Dataset string `json:"dataset,omitempty"`
	// Enabled: Optional. Indicates whether the BigQuery export is enabled.
	Enabled bool `json:"enabled,omitempty"`
	// Project: Optional. The **project ID** of the BigQuery dataset to export the
	// data to. Note: If the BigQuery dataset is in a different project from the
	// app, you should grant `roles/bigquery.admin` role to the CES service agent
	// `service-@gcp-sa-ces.iam.gserviceaccount.com`.
	Project string `json:"project,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Dataset") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Dataset") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BigQueryExportSettings: Settings to describe the BigQuery export behaviors for the app.

func (BigQueryExportSettings) MarshalJSON

func (s BigQueryExportSettings) MarshalJSON() ([]byte, error)

type Blob

type Blob struct {
	// Data: Required. Raw bytes of the blob.
	Data string `json:"data,omitempty"`
	// MimeType: Required. The IANA standard MIME type of the source data.
	MimeType string `json:"mimeType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Data") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Data") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Blob: Represents a blob input or output in the conversation.

func (Blob) MarshalJSON

func (s Blob) MarshalJSON() ([]byte, error)

type Callback

type Callback struct {
	// Description: Optional. Human-readable description of the callback.
	Description string `json:"description,omitempty"`
	// Disabled: Optional. Whether the callback is disabled. Disabled callbacks are
	// ignored by the agent.
	Disabled bool `json:"disabled,omitempty"`
	// ProactiveExecutionEnabled: Optional. If enabled, the callback will also be
	// executed on intermediate model outputs. This setting only affects after
	// model callback. **ENABLE WITH CAUTION**. Typically after model callback only
	// needs to be executed after receiving all model responses. Enabling proactive
	// execution may have negative implication on the execution cost and latency,
	// and should only be enabled in rare situations.
	ProactiveExecutionEnabled bool `json:"proactiveExecutionEnabled,omitempty"`
	// PythonCode: Required. The python code to execute for the callback.
	PythonCode string `json:"pythonCode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Callback: A callback defines the custom logic to be executed at various stages of agent interaction.

func (Callback) MarshalJSON

func (s Callback) MarshalJSON() ([]byte, error)

type CancelOperationRequest

type CancelOperationRequest struct {
}

CancelOperationRequest: The request message for Operations.CancelOperation.

type Changelog

type Changelog struct {
	// Action: Output only. The action that was performed on the resource.
	Action string `json:"action,omitempty"`
	// Author: Output only. Email address of the change author.
	Author string `json:"author,omitempty"`
	// CreateTime: Output only. The time when the change was made.
	CreateTime string `json:"createTime,omitempty"`
	// DependentResources: Output only. The dependent resources that were changed.
	DependentResources []googleapi.RawMessage `json:"dependentResources,omitempty"`
	// Description: Output only. Description of the change. which typically
	// captures the changed fields in the resource.
	Description string `json:"description,omitempty"`
	// DisplayName: Output only. Display name of the change. It typically should be
	// the display name of the resource that was changed.
	DisplayName string `json:"displayName,omitempty"`
	// Name: Identifier. The unique identifier of the changelog. Format:
	// `projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}`
	Name string `json:"name,omitempty"`
	// NewResource: Output only. The new resource after the change.
	NewResource googleapi.RawMessage `json:"newResource,omitempty"`
	// OriginalResource: Output only. The original resource before the change.
	OriginalResource googleapi.RawMessage `json:"originalResource,omitempty"`
	// Resource: Output only. The resource that was changed.
	Resource string `json:"resource,omitempty"`
	// ResourceType: Output only. The type of the resource that was changed.
	ResourceType string `json:"resourceType,omitempty"`
	// SequenceNumber: Output only. The monotonically increasing sequence number of
	// the changelog.
	SequenceNumber int64 `json:"sequenceNumber,omitempty,string"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Action") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Action") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Changelog: Changelogs represent a change made to the app or to an resource within the app.

func (Changelog) MarshalJSON

func (s Changelog) MarshalJSON() ([]byte, error)

type ChannelProfile

type ChannelProfile struct {
	// ChannelType: Optional. The type of the channel profile.
	//
	// Possible values:
	//   "UNKNOWN" - Unknown channel type.
	//   "WEB_UI" - Web UI channel.
	//   "API" - API channel.
	//   "TWILIO" - Twilio channel.
	//   "GOOGLE_TELEPHONY_PLATFORM" - Google Telephony Platform channel.
	//   "CONTACT_CENTER_AS_A_SERVICE" - Contact Center as a Service (CCaaS)
	// channel.
	//   "FIVE9" - Five9 channel.
	//   "CONTACT_CENTER_INTEGRATION" - Third party contact center integration
	// channel.
	ChannelType string `json:"channelType,omitempty"`
	// DisableBargeInControl: Optional. Whether to disable user barge-in control in
	// the conversation. - **true**: User interruptions are disabled while the
	// agent is speaking. - **false**: The agent retains automatic control over
	// when the user can interrupt.
	DisableBargeInControl bool `json:"disableBargeInControl,omitempty"`
	// DisableDtmf: Optional. Whether to disable DTMF (dual-tone multi-frequency).
	DisableDtmf bool `json:"disableDtmf,omitempty"`
	// NoiseSuppressionLevel: Optional. The noise suppression level of the channel
	// profile. Available values are "low", "moderate", "high", "very_high".
	NoiseSuppressionLevel string `json:"noiseSuppressionLevel,omitempty"`
	// PersonaProperty: Optional. The persona property of the channel profile.
	PersonaProperty *ChannelProfilePersonaProperty `json:"personaProperty,omitempty"`
	// ProfileId: Optional. The unique identifier of the channel profile.
	ProfileId string `json:"profileId,omitempty"`
	// WebWidgetConfig: Optional. The configuration for the web widget.
	WebWidgetConfig *ChannelProfileWebWidgetConfig `json:"webWidgetConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ChannelType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ChannelType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ChannelProfile: A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony.

func (ChannelProfile) MarshalJSON

func (s ChannelProfile) MarshalJSON() ([]byte, error)

type ChannelProfilePersonaProperty

type ChannelProfilePersonaProperty struct {
	// Persona: Optional. The persona of the channel.
	//
	// Possible values:
	//   "UNKNOWN" - UNKNOWN persona.
	//   "CONCISE" - The agent keeps the responses concise and to the point
	//   "CHATTY" - The agent provides additional context, explanations, and
	// details
	Persona string `json:"persona,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Persona") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Persona") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ChannelProfilePersonaProperty: Represents the persona property of a channel.

func (ChannelProfilePersonaProperty) MarshalJSON

func (s ChannelProfilePersonaProperty) MarshalJSON() ([]byte, error)

type ChannelProfileWebWidgetConfig

type ChannelProfileWebWidgetConfig struct {
	// Modality: Optional. The modality of the web widget.
	//
	// Possible values:
	//   "MODALITY_UNSPECIFIED" - Unknown modality.
	//   "CHAT_AND_VOICE" - Widget supports both chat and voice input.
	//   "VOICE_ONLY" - Widget supports only voice input.
	//   "CHAT_ONLY" - Widget supports only chat input.
	//   "CHAT_VOICE_AND_VIDEO" - Widget supports chat, voice, and video input.
	Modality string `json:"modality,omitempty"`
	// SecuritySettings: Optional. The security settings of the web widget.
	SecuritySettings *ChannelProfileWebWidgetConfigSecuritySettings `json:"securitySettings,omitempty"`
	// Theme: Optional. The theme of the web widget.
	//
	// Possible values:
	//   "THEME_UNSPECIFIED" - Unknown theme.
	//   "LIGHT" - Light theme.
	//   "DARK" - Dark theme.
	Theme string `json:"theme,omitempty"`
	// WebWidgetTitle: Optional. The title of the web widget.
	WebWidgetTitle string `json:"webWidgetTitle,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Modality") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Modality") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ChannelProfileWebWidgetConfig: Message for configuration for the web widget.

func (ChannelProfileWebWidgetConfig) MarshalJSON

func (s ChannelProfileWebWidgetConfig) MarshalJSON() ([]byte, error)

type ChannelProfileWebWidgetConfigSecuritySettings

type ChannelProfileWebWidgetConfigSecuritySettings struct {
	// AllowedOrigins: Optional. The origins that are allowed to host the web
	// widget. An origin is defined by RFC 6454. If empty, all origins are allowed.
	// A maximum of 100 origins is allowed. Example: "https://example.com"
	AllowedOrigins []string `json:"allowedOrigins,omitempty"`
	// EnableOriginCheck: Optional. Indicates whether origin check for the web
	// widget is enabled. If `true`, the web widget will check the origin of the
	// website that loads the web widget and only allow it to be loaded in the same
	// origin or any of the allowed origins.
	EnableOriginCheck bool `json:"enableOriginCheck,omitempty"`
	// EnablePublicAccess: Optional. Indicates whether public access to the web
	// widget is enabled. If `true`, the web widget will be publicly accessible. If
	// `false`, the web widget must be integrated with your own authentication and
	// authorization system to return valid credentials for accessing the CES
	// agent.
	EnablePublicAccess bool `json:"enablePublicAccess,omitempty"`
	// EnableRecaptcha: Optional. Indicates whether reCAPTCHA verification for the
	// web widget is enabled.
	EnableRecaptcha bool `json:"enableRecaptcha,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowedOrigins") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllowedOrigins") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ChannelProfileWebWidgetConfigSecuritySettings: Security settings for the web widget.

func (ChannelProfileWebWidgetConfigSecuritySettings) MarshalJSON

type Chunk

type Chunk struct {
	// AgentTransfer: Optional. Agent transfer event.
	AgentTransfer *AgentTransfer `json:"agentTransfer,omitempty"`
	// Blob: Optional. Blob data.
	Blob *Blob `json:"blob,omitempty"`
	// DefaultVariables: A struct represents default variables at the start of the
	// conversation, keyed by variable names.
	DefaultVariables googleapi.RawMessage `json:"defaultVariables,omitempty"`
	// Image: Optional. Image data.
	Image *Image `json:"image,omitempty"`
	// Payload: Optional. Custom payload data.
	Payload googleapi.RawMessage `json:"payload,omitempty"`
	// Text: Optional. Text data.
	Text string `json:"text,omitempty"`
	// ToolCall: Optional. Tool execution request.
	ToolCall *ToolCall `json:"toolCall,omitempty"`
	// ToolResponse: Optional. Tool execution response.
	ToolResponse *ToolResponse `json:"toolResponse,omitempty"`
	// Transcript: Optional. Transcript associated with the audio.
	Transcript string `json:"transcript,omitempty"`
	// UpdatedVariables: A struct represents variables that were updated in the
	// conversation, keyed by variable names.
	UpdatedVariables googleapi.RawMessage `json:"updatedVariables,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AgentTransfer") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AgentTransfer") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Chunk: A chunk of content within a message.

func (Chunk) MarshalJSON

func (s Chunk) MarshalJSON() ([]byte, error)

type Citations

type Citations struct {
	// CitedChunks: List of cited pieces of information.
	CitedChunks []*CitationsCitedChunk `json:"citedChunks,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CitedChunks") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CitedChunks") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Citations: Citations associated with the agent response.

func (Citations) MarshalJSON

func (s Citations) MarshalJSON() ([]byte, error)

type CitationsCitedChunk

type CitationsCitedChunk struct {
	// Text: Text used for citation.
	Text string `json:"text,omitempty"`
	// Title: Title of the cited document.
	Title string `json:"title,omitempty"`
	// Uri: URI used for citation.
	Uri string `json:"uri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Text") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Text") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CitationsCitedChunk: Piece of cited information.

func (CitationsCitedChunk) MarshalJSON

func (s CitationsCitedChunk) MarshalJSON() ([]byte, error)

type ClientCertificateSettings

type ClientCertificateSettings struct {
	// Passphrase: Optional. The name of the SecretManager secret version resource
	// storing the passphrase to decrypt the private key. Should be left unset if
	// the private key is not encrypted. Format:
	// `projects/{project}/secrets/{secret}/versions/{version}`
	Passphrase string `json:"passphrase,omitempty"`
	// PrivateKey: Required. The name of the SecretManager secret version resource
	// storing the private key encoded in PEM format. Format:
	// `projects/{project}/secrets/{secret}/versions/{version}`
	PrivateKey string `json:"privateKey,omitempty"`
	// TlsCertificate: Required. The TLS certificate encoded in PEM format. This
	// string must include the begin header and end footer lines.
	TlsCertificate string `json:"tlsCertificate,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Passphrase") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Passphrase") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ClientCertificateSettings: Settings for custom client certificates.

func (ClientCertificateSettings) MarshalJSON

func (s ClientCertificateSettings) MarshalJSON() ([]byte, error)

type ClientFunction

type ClientFunction struct {
	// Description: Optional. The function description.
	Description string `json:"description,omitempty"`
	// Name: Required. The function name.
	Name string `json:"name,omitempty"`
	// Parameters: Optional. The schema of the function parameters.
	Parameters *Schema `json:"parameters,omitempty"`
	// Response: Optional. The schema of the function response.
	Response *Schema `json:"response,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ClientFunction: Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent.

func (ClientFunction) MarshalJSON

func (s ClientFunction) MarshalJSON() ([]byte, error)

type CloudLoggingSettings

type CloudLoggingSettings struct {
	// EnableCloudLogging: Optional. Whether to enable Cloud Logging for the
	// sessions.
	EnableCloudLogging bool `json:"enableCloudLogging,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EnableCloudLogging") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EnableCloudLogging") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CloudLoggingSettings: Settings to describe the Cloud Logging behaviors for the app.

func (CloudLoggingSettings) MarshalJSON

func (s CloudLoggingSettings) MarshalJSON() ([]byte, error)

type CodeBlock

type CodeBlock struct {
	// PythonCode: Required. Python code which will be invoked in tool fake mode.
	// Expected Python function signature - To catch all tool calls: def
	// fake_tool_call(tool: Tool, input: dict[str, Any], callback_context:
	// CallbackContext) -> Optional[dict[str, Any]]: To catch a specific tool call:
	// def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context:
	// CallbackContext) -> Optional[dict[str, Any]]: If the function returns None,
	// the real tool will be invoked instead.
	PythonCode string `json:"pythonCode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PythonCode") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "PythonCode") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CodeBlock: A code block to be executed instead of a real tool call.

func (CodeBlock) MarshalJSON

func (s CodeBlock) MarshalJSON() ([]byte, error)

type ConnectorTool

type ConnectorTool struct {
	// Action: Required. Action for the tool to use.
	Action *Action `json:"action,omitempty"`
	// AuthConfig: Optional. Configures how authentication is handled in
	// Integration Connectors. By default, an admin authentication is passed in the
	// Integration Connectors API requests. You can override it with a different
	// end-user authentication config. **Note**: The Connection must have
	// authentication override enabled in order to specify an EUC configuration
	// here - otherwise, the ConnectorTool creation will fail. See
	// https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
	// for details.
	AuthConfig *EndUserAuthConfig `json:"authConfig,omitempty"`
	// Connection: Required. The full resource name of the referenced Integration
	// Connectors Connection. Format:
	// `projects/{project}/locations/{location}/connections/{connection}`
	Connection string `json:"connection,omitempty"`
	// Description: Optional. The description of the tool that can be used by the
	// Agent to decide whether to call this ConnectorTool.
	Description string `json:"description,omitempty"`
	// Name: Optional. The name of the tool that can be used by the Agent to decide
	// whether to call this ConnectorTool.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Action") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Action") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ConnectorTool: A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview.

func (ConnectorTool) MarshalJSON

func (s ConnectorTool) MarshalJSON() ([]byte, error)

type ConnectorToolset

type ConnectorToolset struct {
	// AuthConfig: Optional. Configures how authentication is handled in
	// Integration Connectors. By default, an admin authentication is passed in the
	// Integration Connectors API requests. You can override it with a different
	// end-user authentication config. **Note**: The Connection must have
	// authentication override enabled in order to specify an EUC configuration
	// here - otherwise, the Toolset creation will fail. See:
	// https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
	AuthConfig *EndUserAuthConfig `json:"authConfig,omitempty"`
	// Connection: Required. The full resource name of the referenced Integration
	// Connectors Connection. Format:
	// `projects/{project}/locations/{location}/connections/{connection}`
	Connection string `json:"connection,omitempty"`
	// ConnectorActions: Required. The list of connector actions/entity operations
	// to generate tools for.
	ConnectorActions []*Action `json:"connectorActions,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AuthConfig") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AuthConfig") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ConnectorToolset: A toolset that generates tools from an Integration Connectors Connection.

func (ConnectorToolset) MarshalJSON

func (s ConnectorToolset) MarshalJSON() ([]byte, error)

type Conversation

type Conversation struct {
	// AppVersion: Output only. The version of the app used for processing the
	// conversation. Format:
	// `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
	AppVersion string `json:"appVersion,omitempty"`
	// ChannelType: DEPRECATED. Please use input_types instead.
	//
	// Possible values:
	//   "CHANNEL_TYPE_UNSPECIFIED" - Unspecified channel type.
	//   "TEXT" - The conversation only contains text messages between the end user
	// and the agent.
	//   "AUDIO" - The conversation contains audio messages between the end user
	// and the agent.
	//   "MULTIMODAL" - The conversation multi-modal messages (e.g. image) between
	// the end user and the agent.
	ChannelType string `json:"channelType,omitempty"`
	// Deployment: Output only. The deployment of the app used for processing the
	// conversation. Format:
	// `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
	Deployment string `json:"deployment,omitempty"`
	// EndTime: Output only. Timestamp when the conversation was completed.
	EndTime string `json:"endTime,omitempty"`
	// EntryAgent: Output only. The agent that initially handles the conversation.
	// If not specified, the conversation is handled by the root agent. Format:
	// `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
	EntryAgent string `json:"entryAgent,omitempty"`
	// InputTypes: Output only. The input types of the conversation.
	//
	// Possible values:
	//   "INPUT_TYPE_UNSPECIFIED" - Unspecified input type.
	//   "INPUT_TYPE_TEXT" - Text input.
	//   "INPUT_TYPE_EVENT" - Event input.
	//   "INPUT_TYPE_AUDIO" - Audio input.
	//   "INPUT_TYPE_IMAGE" - Image input.
	//   "INPUT_TYPE_BLOB" - Blob input.
	//   "INPUT_TYPE_TOOL_RESPONSE" - Client function tool response input.
	//   "INPUT_TYPE_VARIABLES" - Variables input.
	InputTypes []string `json:"inputTypes,omitempty"`
	// LanguageCode: Output only. The language code of the conversation.
	LanguageCode string `json:"languageCode,omitempty"`
	// Messages: Deprecated. Use turns instead.
	Messages []*Message `json:"messages,omitempty"`
	// Name: Identifier. The unique identifier of the conversation. Format:
	// `projects/{project}/locations/{location}/apps/{app}/conversations/{conversati
	// on}`
	Name string `json:"name,omitempty"`
	// Source: Output only. Indicate the source of the conversation.
	//
	// Possible values:
	//   "SOURCE_UNSPECIFIED" - Unspecified source.
	//   "LIVE" - The conversation is from the live end user.
	//   "SIMULATOR" - The conversation is from the simulator.
	//   "EVAL" - The conversation is from the evaluation.
	//   "AGENT_TOOL" - The conversation is from an agent tool. Agent tool runs the
	// agent in a separate session, which is persisted for testing and debugging
	// purposes.
	Source string `json:"source,omitempty"`
	// StartTime: Output only. Timestamp when the conversation was created.
	StartTime string `json:"startTime,omitempty"`
	// TurnCount: Output only. The number of turns in the conversation.
	TurnCount int64 `json:"turnCount,omitempty"`
	// Turns: Required. The turns in the conversation.
	Turns []*ConversationTurn `json:"turns,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AppVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Conversation: A conversation represents an interaction between an end user and the CES app.

func (Conversation) MarshalJSON

func (s Conversation) MarshalJSON() ([]byte, error)

type ConversationLoggingSettings

type ConversationLoggingSettings struct {
	// DisableConversationLogging: Optional. Whether to disable conversation
	// logging for the sessions.
	DisableConversationLogging bool `json:"disableConversationLogging,omitempty"`
	// RetentionWindow: Optional. Controls the retention window for the
	// conversation. If not set, the conversation will be retained for 365 days.
	RetentionWindow string `json:"retentionWindow,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DisableConversationLogging")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisableConversationLogging") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ConversationLoggingSettings: Settings to describe the conversation logging behaviors for the app.

func (ConversationLoggingSettings) MarshalJSON

func (s ConversationLoggingSettings) MarshalJSON() ([]byte, error)

type ConversationTurn

type ConversationTurn struct {
	// Messages: Optional. List of messages in the conversation turn, including
	// user input, agent responses and intermediate events during the processing.
	Messages []*Message `json:"messages,omitempty"`
	// RootSpan: Optional. The root span of the action processing.
	RootSpan *Span `json:"rootSpan,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Messages") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Messages") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ConversationTurn: All information about a single turn in the conversation.

func (ConversationTurn) MarshalJSON

func (s ConversationTurn) MarshalJSON() ([]byte, error)

type DataStore

type DataStore struct {
	// ConnectorConfig: Output only. The connector config for the data store
	// connection.
	ConnectorConfig *DataStoreConnectorConfig `json:"connectorConfig,omitempty"`
	// CreateTime: Output only. Timestamp when the data store was created.
	CreateTime string `json:"createTime,omitempty"`
	// DisplayName: Output only. The display name of the data store.
	DisplayName string `json:"displayName,omitempty"`
	// DocumentProcessingMode: Output only. The document processing mode for the
	// data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
	//
	// Possible values:
	//   "DOCUMENT_PROCESSING_MODE_UNSPECIFIED" - Not specified.
	//   "DOCUMENTS" - Documents are processed as documents.
	//   "CHUNKS" - Documents are converted to chunks.
	DocumentProcessingMode string `json:"documentProcessingMode,omitempty"`
	// Name: Required. Full resource name of the DataStore. Format:
	// `projects/{project}/locations/{location}/collections/{collection}/dataStores/
	// {dataStore}`
	Name string `json:"name,omitempty"`
	// Type: Output only. The type of the data store. This field is readonly and
	// populated by the server.
	//
	// Possible values:
	//   "DATA_STORE_TYPE_UNSPECIFIED" - Not specified. This value indicates that
	// the data store type is not specified, so it will not be used during search.
	//   "PUBLIC_WEB" - A data store that contains public web content.
	//   "UNSTRUCTURED" - A data store that contains unstructured private data.
	//   "FAQ" - A data store that contains structured data used as FAQ.
	//   "CONNECTOR" - A data store that is a connector to a first-party or a
	// third-party service.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConnectorConfig") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConnectorConfig") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataStore: A DataStore resource in Vertex AI Search.

func (DataStore) MarshalJSON

func (s DataStore) MarshalJSON() ([]byte, error)

type DataStoreConnectorConfig

type DataStoreConnectorConfig struct {
	// Collection: Resource name of the collection the data store belongs to.
	Collection string `json:"collection,omitempty"`
	// CollectionDisplayName: Display name of the collection the data store belongs
	// to.
	CollectionDisplayName string `json:"collectionDisplayName,omitempty"`
	// DataSource: The name of the data source. Example: `salesforce`, `jira`,
	// `confluence`, `bigquery`.
	DataSource string `json:"dataSource,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Collection") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Collection") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataStoreConnectorConfig: The connector config for the data store connection.

func (DataStoreConnectorConfig) MarshalJSON

func (s DataStoreConnectorConfig) MarshalJSON() ([]byte, error)

type DataStoreSettings

type DataStoreSettings struct {
	// Engines: Output only. The engines for the app.
	Engines []*DataStoreSettingsEngine `json:"engines,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Engines") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Engines") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataStoreSettings: Data store related settings for the app.

func (DataStoreSettings) MarshalJSON

func (s DataStoreSettings) MarshalJSON() ([]byte, error)

type DataStoreSettingsEngine

type DataStoreSettingsEngine struct {
	// Name: Output only. The resource name of the engine. Format:
	// `projects/{project}/locations/{location}/collections/{collection}/engines/{en
	// gine}`
	Name string `json:"name,omitempty"`
	// Type: Output only. The type of the engine.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Unspecified engine type.
	//   "ENGINE_TYPE_SEARCH" - The SOLUTION_TYPE_SEARCH engine for the app. All
	// connector data stores added to the app will be added to this engine.
	//   "ENGINE_TYPE_CHAT" - Chat engine type. The SOLUTION_TYPE_CHAT engine for
	// the app. All connector data stores added to the app will be added to this
	// engine.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataStoreSettingsEngine: An engine to which the data stores are connected. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

func (DataStoreSettingsEngine) MarshalJSON

func (s DataStoreSettingsEngine) MarshalJSON() ([]byte, error)

type DataStoreTool

type DataStoreTool struct {
	// BoostSpecs: Optional. Boost specification to boost certain documents.
	BoostSpecs []*DataStoreToolBoostSpecs `json:"boostSpecs,omitempty"`
	// DataStoreSource: Optional. Search within a single specific DataStore.
	DataStoreSource *DataStoreToolDataStoreSource `json:"dataStoreSource,omitempty"`
	// Description: Optional. The tool description.
	Description string `json:"description,omitempty"`
	// EngineSource: Optional. Search within an Engine (potentially across multiple
	// DataStores).
	EngineSource *DataStoreToolEngineSource `json:"engineSource,omitempty"`
	// FilterParameterBehavior: Optional. The filter parameter behavior.
	//
	// Possible values:
	//   "FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED" - Default filter behavior. Include
	// filter parameter for connector datastores. For the rest of the datastore
	// types, the filter input parameter is omitted.
	//   "ALWAYS_INCLUDE" - Always include filter parameter for all datastore
	// types.
	//   "NEVER_INCLUDE" - The filter parameter is never included in the list of
	// tool parameters, regardless of the datastore type.
	FilterParameterBehavior string `json:"filterParameterBehavior,omitempty"`
	// ModalityConfigs: Optional. The modality configs for the data store.
	ModalityConfigs []*DataStoreToolModalityConfig `json:"modalityConfigs,omitempty"`
	// Name: Required. The data store tool name.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BoostSpecs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BoostSpecs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataStoreTool: Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

func (DataStoreTool) MarshalJSON

func (s DataStoreTool) MarshalJSON() ([]byte, error)

type DataStoreToolBoostSpec

type DataStoreToolBoostSpec struct {
	// ConditionBoostSpecs: Required. A list of boosting specifications.
	ConditionBoostSpecs []*DataStoreToolBoostSpecConditionBoostSpec `json:"conditionBoostSpecs,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConditionBoostSpecs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConditionBoostSpecs") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataStoreToolBoostSpec: Boost specification to boost certain documents.

func (DataStoreToolBoostSpec) MarshalJSON

func (s DataStoreToolBoostSpec) MarshalJSON() ([]byte, error)

type DataStoreToolBoostSpecConditionBoostSpec

type DataStoreToolBoostSpecConditionBoostSpec struct {
	// Boost: Optional. Strength of the boost, which should be in [-1, 1]. Negative
	// boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a
	// big promotion. However, it does not necessarily mean that the top result
	// will be a boosted suggestion. Setting to -1.0 gives the suggestions a big
	// demotion. However, other suggestions that are relevant might still be shown.
	// Setting to 0.0 means no boost applied. The boosting condition is ignored.
	Boost float64 `json:"boost,omitempty"`
	// BoostControlSpec: Optional. Complex specification for custom ranking based
	// on customer defined attribute value.
	BoostControlSpec *DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec `json:"boostControlSpec,omitempty"`
	// Condition: Required. An expression which specifies a boost condition. The
	// syntax is the same as filter expression syntax. Currently, the only
	// supported condition is a list of BCP-47 lang codes. Example: To boost
	// suggestions in languages en or fr: (lang_code: ANY("en", "fr"))
	Condition string `json:"condition,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Boost") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Boost") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataStoreToolBoostSpecConditionBoostSpec: Boost specification for a condition.

func (DataStoreToolBoostSpecConditionBoostSpec) MarshalJSON

func (*DataStoreToolBoostSpecConditionBoostSpec) UnmarshalJSON

func (s *DataStoreToolBoostSpecConditionBoostSpec) UnmarshalJSON(data []byte) error

type DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec

type DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec struct {
	// AttributeType: Optional. The attribute type to be used to determine the
	// boost amount. The attribute value can be derived from the field value of the
	// specified field_name. In the case of numerical it is straightforward i.e.
	// attribute_value = numerical_field_value. In the case of freshness however,
	// attribute_value = (time.now() - datetime_field_value).
	//
	// Possible values:
	//   "ATTRIBUTE_TYPE_UNSPECIFIED" - Unspecified AttributeType.
	//   "NUMERICAL" - The value of the numerical field will be used to dynamically
	// update the boost amount. In this case, the attribute_value (the x value) of
	// the control point will be the actual value of the numerical field for which
	// the boost_amount is specified.
	//   "FRESHNESS" - For the freshness use case the attribute value will be the
	// duration between the current time and the date in the datetime field
	// specified. The value must be formatted as an XSD `dayTimeDuration` value (a
	// restricted subset of an ISO 8601 duration value). The pattern for this is:
	// `nDnM]`. E.g. `5D`, `3DT12H30M`, `T24H`.
	AttributeType string `json:"attributeType,omitempty"`
	// ControlPoints: Optional. The control points used to define the curve. The
	// monotonic function (defined through the interpolation_type above) passes
	// through the control points listed here.
	ControlPoints []*DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint `json:"controlPoints,omitempty"`
	// FieldName: Optional. The name of the field whose value will be used to
	// determine the boost amount.
	FieldName string `json:"fieldName,omitempty"`
	// InterpolationType: Optional. The interpolation type to be applied to connect
	// the control points listed below.
	//
	// Possible values:
	//   "INTERPOLATION_TYPE_UNSPECIFIED" - Interpolation type is unspecified. In
	// this case, it defaults to Linear.
	//   "LINEAR" - Piecewise linear interpolation will be applied.
	InterpolationType string `json:"interpolationType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AttributeType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AttributeType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec: Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.

func (DataStoreToolBoostSpecConditionBoostSpecBoostControlSpec) MarshalJSON

type DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint

type DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint struct {
	// AttributeValue: Optional. Can be one of: 1. The numerical field value. 2.
	// The duration spec for freshness: The value must be formatted as an XSD
	// `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value).
	// The pattern for this is: `nDnM]`.
	AttributeValue string `json:"attributeValue,omitempty"`
	// BoostAmount: Optional. The value between -1 to 1 by which to boost the score
	// if the attribute_value evaluates to the value specified above.
	BoostAmount float64 `json:"boostAmount,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AttributeValue") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AttributeValue") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint: The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).

func (DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint) MarshalJSON

func (*DataStoreToolBoostSpecConditionBoostSpecBoostControlSpecControlPoint) UnmarshalJSON

type DataStoreToolBoostSpecs

type DataStoreToolBoostSpecs struct {
	// DataStores: Required. The Data Store where the boosting configuration is
	// applied. Full resource name of DataStore, such as
	// projects/{project}/locations/{location}/collections/{collection}/dataStores/{
	// dataStore}.
	DataStores []string `json:"dataStores,omitempty"`
	// Spec: Required. A list of boosting specifications.
	Spec []*DataStoreToolBoostSpec `json:"spec,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DataStores") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DataStores") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataStoreToolBoostSpecs: Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.

func (DataStoreToolBoostSpecs) MarshalJSON

func (s DataStoreToolBoostSpecs) MarshalJSON() ([]byte, error)

type DataStoreToolDataStoreSource

type DataStoreToolDataStoreSource struct {
	// DataStore: Optional. The data store.
	DataStore *DataStore `json:"dataStore,omitempty"`
	// Filter: Optional. Filter specification for the DataStore. See:
	// https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
	Filter string `json:"filter,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DataStore") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DataStore") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataStoreToolDataStoreSource: Configuration for searching within a specific DataStore.

func (DataStoreToolDataStoreSource) MarshalJSON

func (s DataStoreToolDataStoreSource) MarshalJSON() ([]byte, error)

type DataStoreToolEngineSource

type DataStoreToolEngineSource struct {
	// DataStoreSources: Optional. Use to target specific DataStores within the
	// Engine. If empty, the search applies to all DataStores associated with the
	// Engine.
	DataStoreSources []*DataStoreToolDataStoreSource `json:"dataStoreSources,omitempty"`
	// Engine: Required. Full resource name of the Engine. Format:
	// `projects/{project}/locations/{location}/collections/{collection}/engines/{en
	// gine}`
	Engine string `json:"engine,omitempty"`
	// Filter: Optional. A filter applied to the search across the Engine. Not
	// relevant and not used if 'data_store_sources' is provided. See:
	// https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
	Filter string `json:"filter,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DataStoreSources") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DataStoreSources") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataStoreToolEngineSource: Configuration for searching within an Engine, potentially targeting specific DataStores.

func (DataStoreToolEngineSource) MarshalJSON

func (s DataStoreToolEngineSource) MarshalJSON() ([]byte, error)

type DataStoreToolGroundingConfig

type DataStoreToolGroundingConfig struct {
	// Disabled: Optional. Whether grounding is disabled.
	Disabled bool `json:"disabled,omitempty"`
	// GroundingLevel: Optional. The groundedness threshold of the answer based on
	// the retrieved sources. The value has a configurable range of [1, 5]. The
	// level is used to threshold the groundedness of the answer, meaning that all
	// responses with a groundedness score below the threshold will fall back to
	// returning relevant snippets only. For example, a level of 3 means that the
	// groundedness score must be 3 or higher for the response to be returned.
	GroundingLevel float64 `json:"groundingLevel,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Disabled") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Disabled") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataStoreToolGroundingConfig: Grounding configuration.

func (DataStoreToolGroundingConfig) MarshalJSON

func (s DataStoreToolGroundingConfig) MarshalJSON() ([]byte, error)

func (*DataStoreToolGroundingConfig) UnmarshalJSON

func (s *DataStoreToolGroundingConfig) UnmarshalJSON(data []byte) error

type DataStoreToolModalityConfig

type DataStoreToolModalityConfig struct {
	// GroundingConfig: Optional. The grounding configuration.
	GroundingConfig *DataStoreToolGroundingConfig `json:"groundingConfig,omitempty"`
	// ModalityType: Required. The modality type.
	//
	// Possible values:
	//   "MODALITY_TYPE_UNSPECIFIED" - Unspecified modality type.
	//   "TEXT" - Text modality.
	//   "AUDIO" - Audio modality.
	ModalityType string `json:"modalityType,omitempty"`
	// RewriterConfig: Optional. The rewriter config.
	RewriterConfig *DataStoreToolRewriterConfig `json:"rewriterConfig,omitempty"`
	// SummarizationConfig: Optional. The summarization config.
	SummarizationConfig *DataStoreToolSummarizationConfig `json:"summarizationConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GroundingConfig") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GroundingConfig") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataStoreToolModalityConfig: If specified, will apply the given configuration for the specified modality.

func (DataStoreToolModalityConfig) MarshalJSON

func (s DataStoreToolModalityConfig) MarshalJSON() ([]byte, error)

type DataStoreToolRewriterConfig

type DataStoreToolRewriterConfig struct {
	// Disabled: Optional. Whether the rewriter is disabled.
	Disabled bool `json:"disabled,omitempty"`
	// ModelSettings: Required. Configurations for the LLM model.
	ModelSettings *ModelSettings `json:"modelSettings,omitempty"`
	// Prompt: Optional. The prompt definition. If not set, default prompt will be
	// used.
	Prompt string `json:"prompt,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Disabled") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Disabled") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataStoreToolRewriterConfig: Rewriter configuration.

func (DataStoreToolRewriterConfig) MarshalJSON

func (s DataStoreToolRewriterConfig) MarshalJSON() ([]byte, error)

type DataStoreToolSummarizationConfig

type DataStoreToolSummarizationConfig struct {
	// Disabled: Optional. Whether summarization is disabled.
	Disabled bool `json:"disabled,omitempty"`
	// ModelSettings: Optional. Configurations for the LLM model.
	ModelSettings *ModelSettings `json:"modelSettings,omitempty"`
	// Prompt: Optional. The prompt definition. If not set, default prompt will be
	// used.
	Prompt string `json:"prompt,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Disabled") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Disabled") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataStoreToolSummarizationConfig: Summarization configuration.

func (DataStoreToolSummarizationConfig) MarshalJSON

func (s DataStoreToolSummarizationConfig) MarshalJSON() ([]byte, error)

type DeleteEvaluationRunOperationMetadata

type DeleteEvaluationRunOperationMetadata struct {
}

DeleteEvaluationRunOperationMetadata: Operation metadata for EvaluationService.DeleteEvaluationRun.

type Deployment

type Deployment struct {
	// AppVersion: Optional. The resource name of the app version to deploy.
	// Format:
	// `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use
	// `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the
	// draft app.
	AppVersion string `json:"appVersion,omitempty"`
	// ChannelProfile: Required. The channel profile used in the deployment.
	ChannelProfile *ChannelProfile `json:"channelProfile,omitempty"`
	// CreateTime: Output only. Timestamp when this deployment was created.
	CreateTime string `json:"createTime,omitempty"`
	// DisplayName: Required. Display name of the deployment.
	DisplayName string `json:"displayName,omitempty"`
	// Etag: Output only. Etag used to ensure the object hasn't changed during a
	// read-modify-write operation. If the etag is empty, the update will overwrite
	// any concurrent changes.
	Etag string `json:"etag,omitempty"`
	// ExperimentConfig: Optional. Experiment configuration for the deployment.
	ExperimentConfig *ExperimentConfig `json:"experimentConfig,omitempty"`
	// Name: Identifier. The resource name of the deployment. Format:
	// `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
	Name string `json:"name,omitempty"`
	// UpdateTime: Output only. Timestamp when this deployment was last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AppVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Deployment: A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.

func (Deployment) MarshalJSON

func (s Deployment) MarshalJSON() ([]byte, error)

type Empty

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type EndSession

type EndSession struct {
	// Metadata: Optional. Provides additional information about the end session
	// signal, such as the reason for ending the session.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Metadata") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Metadata") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EndSession: Indicates the session has terminated, due to either successful completion (e.g. user says "Good bye!" ) or an agent escalation. The agent will not process any further inputs after session is terminated and the client should half-close and disconnect after receiving all remaining responses from the agent.

func (EndSession) MarshalJSON

func (s EndSession) MarshalJSON() ([]byte, error)

type EndUserAuthConfig

type EndUserAuthConfig struct {
	// Oauth2AuthCodeConfig: Oauth 2.0 Authorization Code authentication.
	Oauth2AuthCodeConfig *EndUserAuthConfigOauth2AuthCodeConfig `json:"oauth2AuthCodeConfig,omitempty"`
	// Oauth2JwtBearerConfig: JWT Profile Oauth 2.0 Authorization Grant
	// authentication.
	Oauth2JwtBearerConfig *EndUserAuthConfigOauth2JwtBearerConfig `json:"oauth2JwtBearerConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Oauth2AuthCodeConfig") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Oauth2AuthCodeConfig") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EndUserAuthConfig: End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`.

func (EndUserAuthConfig) MarshalJSON

func (s EndUserAuthConfig) MarshalJSON() ([]byte, error)

type EndUserAuthConfigOauth2AuthCodeConfig

type EndUserAuthConfigOauth2AuthCodeConfig struct {
	// OauthToken: Required. Oauth token parameter name to pass through. Must be in
	// the format `$context.variables.`.
	OauthToken string `json:"oauthToken,omitempty"`
	// ForceSendFields is a list of field names (e.g. "OauthToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "OauthToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EndUserAuthConfigOauth2AuthCodeConfig: Oauth 2.0 Authorization Code authentication configuration.

func (EndUserAuthConfigOauth2AuthCodeConfig) MarshalJSON

func (s EndUserAuthConfigOauth2AuthCodeConfig) MarshalJSON() ([]byte, error)

type EndUserAuthConfigOauth2JwtBearerConfig

type EndUserAuthConfigOauth2JwtBearerConfig struct {
	// ClientKey: Required. Client parameter name to pass through. Must be in the
	// format `$context.variables.`.
	ClientKey string `json:"clientKey,omitempty"`
	// Issuer: Required. Issuer parameter name to pass through. Must be in the
	// format `$context.variables.`.
	Issuer string `json:"issuer,omitempty"`
	// Subject: Required. Subject parameter name to pass through. Must be in the
	// format `$context.variables.`.
	Subject string `json:"subject,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ClientKey") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ClientKey") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EndUserAuthConfigOauth2JwtBearerConfig: JWT Profile Oauth 2.0 Authorization Grant authentication configuration.

func (EndUserAuthConfigOauth2JwtBearerConfig) MarshalJSON

func (s EndUserAuthConfigOauth2JwtBearerConfig) MarshalJSON() ([]byte, error)

type EndpointControlPolicy added in v0.270.0

type EndpointControlPolicy struct {
	// AllowedOrigins: Optional. The allowed HTTP(s) origins that tools in the App
	// are able to directly call. The enforcement depends on the value of
	// enforcement_scope and the VPC-SC status of the project. If a port number is
	// not provided, all ports will be allowed. Otherwise, the port number must
	// match exactly. For example, "https://example.com" will match
	// "https://example.com:443" and any other port. "https://example.com:443" will
	// only match "https://example.com:443".
	AllowedOrigins []string `json:"allowedOrigins,omitempty"`
	// EnforcementScope: Optional. The scope in which this policy's allowed_origins
	// list is enforced.
	//
	// Possible values:
	//   "ENFORCEMENT_SCOPE_UNSPECIFIED" - Unspecified. This policy will be treated
	// as VPCSC_ONLY.
	//   "VPCSC_ONLY" - This policy applies only when VPC-SC is active.
	//   "ALWAYS" - This policy ALWAYS applies, regardless of VPC-SC status.
	EnforcementScope string `json:"enforcementScope,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowedOrigins") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllowedOrigins") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EndpointControlPolicy: Defines project/location level endpoint control policy.

func (EndpointControlPolicy) MarshalJSON added in v0.270.0

func (s EndpointControlPolicy) MarshalJSON() ([]byte, error)

type ErrorHandlingSettings added in v0.270.0

type ErrorHandlingSettings struct {
	// EndSessionConfig: Optional. Configuration for ending the session in case of
	// system errors (e.g. LLM errors).
	EndSessionConfig *ErrorHandlingSettingsEndSessionConfig `json:"endSessionConfig,omitempty"`
	// ErrorHandlingStrategy: Optional. The strategy to use for error handling.
	//
	// Possible values:
	//   "ERROR_HANDLING_STRATEGY_UNSPECIFIED" - Unspecified error handling
	// strategy.
	//   "NONE" - No specific handling is enabled.
	//   "FALLBACK_RESPONSE" - A fallback message will be returned to the user in
	// case of system errors (e.g. LLM errors).
	//   "END_SESSION" - An EndSession signal will be emitted in case of system
	// errors (e.g. LLM errors).
	ErrorHandlingStrategy string `json:"errorHandlingStrategy,omitempty"`
	// FallbackResponseConfig: Optional. Configuration for handling fallback
	// responses.
	FallbackResponseConfig *ErrorHandlingSettingsFallbackResponseConfig `json:"fallbackResponseConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndSessionConfig") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EndSessionConfig") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ErrorHandlingSettings: Settings to describe how errors should be handled in the app.

func (ErrorHandlingSettings) MarshalJSON added in v0.270.0

func (s ErrorHandlingSettings) MarshalJSON() ([]byte, error)

type ErrorHandlingSettingsEndSessionConfig added in v0.276.0

type ErrorHandlingSettingsEndSessionConfig struct {
	// EscalateSession: Optional. Whether to escalate the session in EndSession. If
	// session is escalated, metadata in EndSession will contain `session_escalated
	// = true`. See
	// https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent
	// for details.
	EscalateSession bool `json:"escalateSession,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EscalateSession") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EscalateSession") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ErrorHandlingSettingsEndSessionConfig: Configuration for ending the session in case of system errors (e.g. LLM errors).

func (ErrorHandlingSettingsEndSessionConfig) MarshalJSON added in v0.276.0

func (s ErrorHandlingSettingsEndSessionConfig) MarshalJSON() ([]byte, error)

type ErrorHandlingSettingsFallbackResponseConfig added in v0.276.0

type ErrorHandlingSettingsFallbackResponseConfig struct {
	// CustomFallbackMessages: Optional. The fallback messages in case of system
	// errors (e.g. LLM errors), mapped by supported language code
	// (https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language).
	CustomFallbackMessages map[string]string `json:"customFallbackMessages,omitempty"`
	// MaxFallbackAttempts: Optional. The maximum number of fallback attempts to
	// make before the agent emitting EndSession Signal.
	MaxFallbackAttempts int64 `json:"maxFallbackAttempts,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CustomFallbackMessages") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CustomFallbackMessages") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ErrorHandlingSettingsFallbackResponseConfig: Configuration for handling fallback responses.

func (ErrorHandlingSettingsFallbackResponseConfig) MarshalJSON added in v0.276.0

type Evaluation

type Evaluation struct {
	// AggregatedMetrics: Output only. The aggregated metrics for this evaluation
	// across all runs.
	AggregatedMetrics *AggregatedMetrics `json:"aggregatedMetrics,omitempty"`
	// CreateTime: Output only. Timestamp when the evaluation was created.
	CreateTime string `json:"createTime,omitempty"`
	// CreatedBy: Output only. The user who created the evaluation.
	CreatedBy string `json:"createdBy,omitempty"`
	// Description: Optional. User-defined description of the evaluation.
	Description string `json:"description,omitempty"`
	// DisplayName: Required. User-defined display name of the evaluation. Unique
	// within an App.
	DisplayName string `json:"displayName,omitempty"`
	// Etag: Output only. Etag used to ensure the object hasn't changed during a
	// read-modify-write operation. If the etag is empty, the update will overwrite
	// any concurrent changes.
	Etag string `json:"etag,omitempty"`
	// EvaluationDatasets: Output only. List of evaluation datasets the evaluation
	// belongs to. Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evalu
	// ationDataset}`
	EvaluationDatasets []string `json:"evaluationDatasets,omitempty"`
	// EvaluationMetricsConfigOverride: Optional. Overrides metrics config for this
	// specific evaluation.
	EvaluationMetricsConfigOverride *EvaluationMetricsConfig `json:"evaluationMetricsConfigOverride,omitempty"`
	// EvaluationMetricsThresholdOverride: Optional. Overrides metrics thresholds
	// for this specific evaluation.
	EvaluationMetricsThresholdOverride *EvaluationMetricsThresholds `json:"evaluationMetricsThresholdOverride,omitempty"`
	// EvaluationRuns: Output only. The EvaluationRuns that this Evaluation is
	// associated with.
	EvaluationRuns []string `json:"evaluationRuns,omitempty"`
	// Golden: Optional. The golden steps to be evaluated.
	Golden *EvaluationGolden `json:"golden,omitempty"`
	// Invalid: Output only. Whether the evaluation is invalid. This can happen if
	// an evaluation is referencing a tool, toolset, or agent that has since been
	// deleted.
	Invalid bool `json:"invalid,omitempty"`
	// LastCompletedResult: Output only. The latest evaluation result for this
	// evaluation.
	LastCompletedResult *EvaluationResult `json:"lastCompletedResult,omitempty"`
	// LastTenResults: Output only. The last 10 evaluation results for this
	// evaluation. This is only populated if include_last_ten_results is set to
	// true in the ListEvaluationsRequest or GetEvaluationRequest.
	LastTenResults []*EvaluationResult `json:"lastTenResults,omitempty"`
	// LastUpdatedBy: Output only. The user who last updated the evaluation.
	LastUpdatedBy string `json:"lastUpdatedBy,omitempty"`
	// Name: Identifier. The unique identifier of this evaluation. Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`
	Name string `json:"name,omitempty"`
	// Scenario: Optional. The config for a scenario.
	Scenario *EvaluationScenario `json:"scenario,omitempty"`
	// Tags: Optional. User defined tags to categorize the evaluation.
	Tags []string `json:"tags,omitempty"`
	// UpdateTime: Output only. Timestamp when the evaluation was last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AggregatedMetrics") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AggregatedMetrics") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Evaluation: An evaluation represents all of the information needed to simulate and evaluate an agent.

func (Evaluation) MarshalJSON

func (s Evaluation) MarshalJSON() ([]byte, error)

type EvaluationConfig

type EvaluationConfig struct {
	// EvaluationChannel: Optional. The channel to evaluate.
	//
	// Possible values:
	//   "EVALUATION_CHANNEL_UNSPECIFIED" - Unspecified evaluation channel.
	//   "TEXT" - Text-only evaluation channel.
	//   "AUDIO" - Audio evaluation channel.
	EvaluationChannel string `json:"evaluationChannel,omitempty"`
	// InputAudioConfig: Optional. Configuration for processing the input audio.
	InputAudioConfig *InputAudioConfig `json:"inputAudioConfig,omitempty"`
	// OutputAudioConfig: Optional. Configuration for generating the output audio.
	OutputAudioConfig *OutputAudioConfig `json:"outputAudioConfig,omitempty"`
	// ToolCallBehaviour: Optional. Specifies whether the evaluation should use
	// real tool calls or fake tools.
	//
	// Possible values:
	//   "EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED" - Unspecified tool call
	// behavior. Will default to real tool calls.
	//   "REAL" - Use real tool calls.
	//   "FAKE" - Use fake tool calls.
	ToolCallBehaviour string `json:"toolCallBehaviour,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EvaluationChannel") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EvaluationChannel") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationConfig: EvaluationConfig configures settings for running the evaluation.

func (EvaluationConfig) MarshalJSON

func (s EvaluationConfig) MarshalJSON() ([]byte, error)

type EvaluationDataset

type EvaluationDataset struct {
	// AggregatedMetrics: Output only. The aggregated metrics for this evaluation
	// dataset across all runs.
	AggregatedMetrics *AggregatedMetrics `json:"aggregatedMetrics,omitempty"`
	// CreateTime: Output only. Timestamp when the evaluation dataset was created.
	CreateTime string `json:"createTime,omitempty"`
	// CreatedBy: Output only. The user who created the evaluation dataset.
	CreatedBy string `json:"createdBy,omitempty"`
	// DisplayName: Required. User-defined display name of the evaluation dataset.
	// Unique within an App.
	DisplayName string `json:"displayName,omitempty"`
	// Etag: Output only. Etag used to ensure the object hasn't changed during a
	// read-modify-write operation. If the etag is empty, the update will overwrite
	// any concurrent changes.
	Etag string `json:"etag,omitempty"`
	// Evaluations: Optional. Evaluations that are included in this dataset.
	Evaluations []string `json:"evaluations,omitempty"`
	// LastUpdatedBy: Output only. The user who last updated the evaluation
	// dataset.
	LastUpdatedBy string `json:"lastUpdatedBy,omitempty"`
	// Name: Identifier. The unique identifier of this evaluation dataset. Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evalu
	// ationDataset}`
	Name string `json:"name,omitempty"`
	// UpdateTime: Output only. Timestamp when the evaluation dataset was last
	// updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AggregatedMetrics") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AggregatedMetrics") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationDataset: An evaluation dataset represents a set of evaluations that are grouped together basaed on shared tags.

func (EvaluationDataset) MarshalJSON

func (s EvaluationDataset) MarshalJSON() ([]byte, error)

type EvaluationErrorInfo

type EvaluationErrorInfo struct {
	// ErrorMessage: Output only. The error message.
	ErrorMessage string `json:"errorMessage,omitempty"`
	// ErrorType: Output only. The type of error.
	//
	// Possible values:
	//   "ERROR_TYPE_UNSPECIFIED" - Unspecified error type.
	//   "RUNTIME_FAILURE" - Failure during runtime execution.
	//   "CONVERSATION_RETRIEVAL_FAILURE" - Failure to retrieve conversation from
	// CES Runtime.
	//   "METRIC_CALCULATION_FAILURE" - Failure to calculate a metric / outcome.
	//   "EVALUATION_UPDATE_FAILURE" - Failure to update the evaluation.
	//   "QUOTA_EXHAUSTED" - Ran out of quota.
	//   "USER_SIMULATION_FAILURE" - Failure during user simulation.
	ErrorType string `json:"errorType,omitempty"`
	// SessionId: Output only. The session ID for the conversation that caused the
	// error.
	SessionId string `json:"sessionId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ErrorMessage") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ErrorMessage") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationErrorInfo: Information about an error encountered during an evaluation execution.

func (EvaluationErrorInfo) MarshalJSON

func (s EvaluationErrorInfo) MarshalJSON() ([]byte, error)

type EvaluationExpectation

type EvaluationExpectation struct {
	// CreateTime: Output only. Timestamp when the evaluation expectation was
	// created.
	CreateTime string `json:"createTime,omitempty"`
	// DisplayName: Required. User-defined display name. Must be unique within the
	// app.
	DisplayName string `json:"displayName,omitempty"`
	// Etag: Output only. Etag used to ensure the object hasn't changed during a
	// read-modify-write operation. If the etag is empty, the update will overwrite
	// any concurrent changes.
	Etag string `json:"etag,omitempty"`
	// LlmCriteria: Optional. Evaluation criteria based on an LLM prompt.
	LlmCriteria *EvaluationExpectationLlmCriteria `json:"llmCriteria,omitempty"`
	// Name: Identifier. The unique identifier of this evaluation expectation.
	// Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{e
	// valuation_expectation}`
	Name string `json:"name,omitempty"`
	// Tags: Optional. User-defined tags for expectations. Can be used to filter
	// expectations.
	Tags []string `json:"tags,omitempty"`
	// UpdateTime: Output only. Timestamp when the evaluation expectation was last
	// updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationExpectation: An evaluation expectation represents a specific criteria to evaluate against.

func (EvaluationExpectation) MarshalJSON

func (s EvaluationExpectation) MarshalJSON() ([]byte, error)

type EvaluationExpectationLlmCriteria

type EvaluationExpectationLlmCriteria struct {
	// Prompt: Required. The prompt/instructions provided to the LLM judge.
	Prompt string `json:"prompt,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Prompt") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Prompt") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationExpectationLlmCriteria: Configuration for LLM-based evaluation criteria.

func (EvaluationExpectationLlmCriteria) MarshalJSON

func (s EvaluationExpectationLlmCriteria) MarshalJSON() ([]byte, error)

type EvaluationGolden

type EvaluationGolden struct {
	// EvaluationExpectations: Optional. The evaluation expectations to evaluate
	// the replayed conversation against. Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{e
	// valuationExpectation}`
	EvaluationExpectations []string `json:"evaluationExpectations,omitempty"`
	// Turns: Required. The golden turns required to replay a golden conversation.
	Turns []*EvaluationGoldenTurn `json:"turns,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EvaluationExpectations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EvaluationExpectations") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationGolden: The steps required to replay a golden conversation.

func (EvaluationGolden) MarshalJSON

func (s EvaluationGolden) MarshalJSON() ([]byte, error)

type EvaluationGoldenExpectation

type EvaluationGoldenExpectation struct {
	// AgentResponse: Optional. Check that the agent responded with the correct
	// response. The role "agent" is implied.
	AgentResponse *Message `json:"agentResponse,omitempty"`
	// AgentResponseHallucinationMetricsConfigOverride: Optional. Overrides for
	// agent_response hallucination metrics.
	AgentResponseHallucinationMetricsConfigOverride *EvaluationMetricsConfigHallucinationMetricsConfig `json:"agentResponseHallucinationMetricsConfigOverride,omitempty"`
	// AgentResponseSemanticSimilarityMetricsConfigOverride: Optional. Overrides
	// for agent_response semantic similarity metrics.
	AgentResponseSemanticSimilarityMetricsConfigOverride *EvaluationMetricsConfigSemanticSimilarityMetricsConfig `json:"agentResponseSemanticSimilarityMetricsConfigOverride,omitempty"`
	// AgentTransfer: Optional. Check that the agent transferred the conversation
	// to a different agent.
	AgentTransfer *AgentTransfer `json:"agentTransfer,omitempty"`
	// ExpectationLevelMetricsThresholdsOverride: Optional. Overrides metrics at
	// the step level.
	ExpectationLevelMetricsThresholdsOverride *EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds `json:"expectationLevelMetricsThresholdsOverride,omitempty"`
	// MockToolResponse: Optional. The tool response to mock, with the parameters
	// of interest specified. Any parameters not specified will be hallucinated by
	// the LLM.
	MockToolResponse *ToolResponse `json:"mockToolResponse,omitempty"`
	// Note: Optional. A note for this requirement, useful in reporting when
	// specific checks fail. E.g., "Check_Payment_Tool_Called".
	Note string `json:"note,omitempty"`
	// SkipEvaluation: Optional. If set to true, this specific expectation will not
	// be evaluated.
	SkipEvaluation bool `json:"skipEvaluation,omitempty"`
	// ToolCall: Optional. Check that a specific tool was called with the
	// parameters.
	ToolCall *ToolCall `json:"toolCall,omitempty"`
	// ToolResponse: Optional. Check that a specific tool had the expected
	// response.
	ToolResponse *ToolResponse `json:"toolResponse,omitempty"`
	// UpdatedVariables: Optional. Check that the agent updated the session
	// variables to the expected values. Used to also capture agent variable
	// updates for golden evals.
	UpdatedVariables googleapi.RawMessage `json:"updatedVariables,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AgentResponse") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AgentResponse") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationGoldenExpectation: Represents a single, checkable requirement.

func (EvaluationGoldenExpectation) MarshalJSON

func (s EvaluationGoldenExpectation) MarshalJSON() ([]byte, error)

type EvaluationGoldenTurn

type EvaluationGoldenTurn struct {
	// HallucinationMetricBehaviorOverride: Optional. Override for turn-level
	// hallucination metric behavior.
	//
	// Possible values:
	//   "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED" - Unspecified hallucination
	// metric behavior.
	//   "DISABLED" - Disable hallucination metric.
	//   "ENABLED" - Enable hallucination metric.
	HallucinationMetricBehaviorOverride string `json:"hallucinationMetricBehaviorOverride,omitempty"`
	// RootSpan: Optional. The root span of the golden turn for processing and
	// maintaining audio information. The uri for the audio must contain audio
	// saved in 16Khz sample rate.
	RootSpan *Span `json:"rootSpan,omitempty"`
	// Steps: Required. The steps required to replay a golden conversation.
	Steps []*EvaluationStep `json:"steps,omitempty"`
	// TurnLevelMetricsThresholdsOverride: Optional. Overrides for turn-level
	// metric thresholds.
	TurnLevelMetricsThresholdsOverride *EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds `json:"turnLevelMetricsThresholdsOverride,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "HallucinationMetricBehaviorOverride") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted from
	// API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g.
	// "HallucinationMetricBehaviorOverride") to include in API requests with the
	// JSON null value. By default, fields with empty values are omitted from API
	// requests. See https://pkg.go.dev/google.golang.org/api#hdr-NullFields for
	// more details.
	NullFields []string `json:"-"`
}

EvaluationGoldenTurn: A golden turn defines a single turn in a golden conversation.

func (EvaluationGoldenTurn) MarshalJSON

func (s EvaluationGoldenTurn) MarshalJSON() ([]byte, error)

type EvaluationMetricsConfig added in v0.280.0

type EvaluationMetricsConfig struct {
	// GoldenMetricsConfig: Optional. Configuration for the golden metrics for the
	// evaluation.
	GoldenMetricsConfig *EvaluationMetricsConfigGoldenMetricsConfig `json:"goldenMetricsConfig,omitempty"`
	// ScenarioMetricsConfig: Optional. Configuration for the scenario metrics for
	// the evaluation.
	ScenarioMetricsConfig *EvaluationMetricsConfigScenarioMetricsConfig `json:"scenarioMetricsConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GoldenMetricsConfig") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GoldenMetricsConfig") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationMetricsConfig: Configures the metrics for an evaluation.

func (EvaluationMetricsConfig) MarshalJSON added in v0.280.0

func (s EvaluationMetricsConfig) MarshalJSON() ([]byte, error)

type EvaluationMetricsConfigExpectationsMetMetricsConfig added in v0.280.0

type EvaluationMetricsConfigExpectationsMetMetricsConfig struct {
	// EnableExpectationsMetMetrics: Optional. Whether to calculate the expectation
	// level metrics for the evaluation.
	EnableExpectationsMetMetrics bool `json:"enableExpectationsMetMetrics,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "EnableExpectationsMetMetrics") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. See https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields
	// for more details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EnableExpectationsMetMetrics") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationMetricsConfigExpectationsMetMetricsConfig: Configuration for the expectation level metrics for the evaluation. To disable the metric, set the message but do not set the `enable_expectations_met_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.

func (EvaluationMetricsConfigExpectationsMetMetricsConfig) MarshalJSON added in v0.280.0

type EvaluationMetricsConfigGoldenMetricsConfig added in v0.280.0

type EvaluationMetricsConfigGoldenMetricsConfig struct {
	// SemanticSimilarityMetricsConfig: Optional. Global configuration for semantic
	// similarity metrics.
	SemanticSimilarityMetricsConfig *EvaluationMetricsConfigSemanticSimilarityMetricsConfig `json:"semanticSimilarityMetricsConfig,omitempty"`
	// StepToolCorrectnessMetricsConfig: Optional. Configuration for step level
	// tool correctness metrics.
	StepToolCorrectnessMetricsConfig *EvaluationMetricsConfigToolCorrectnessMetricsConfig `json:"stepToolCorrectnessMetricsConfig,omitempty"`
	// ToolCorrectnessMetricsConfig: Optional. Configuration for turn level tool
	// correctness metrics.
	ToolCorrectnessMetricsConfig *EvaluationMetricsConfigToolCorrectnessMetricsConfig `json:"toolCorrectnessMetricsConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "SemanticSimilarityMetricsConfig") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted from
	// API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "SemanticSimilarityMetricsConfig")
	// to include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationMetricsConfigGoldenMetricsConfig: Configuration for the golden metrics for the evaluation.

func (EvaluationMetricsConfigGoldenMetricsConfig) MarshalJSON added in v0.280.0

type EvaluationMetricsConfigHallucinationMetricsConfig added in v0.280.0

type EvaluationMetricsConfigHallucinationMetricsConfig struct {
	// EnableHallucinationMetrics: Optional. Whether to calculate hallucination
	// metrics for the evaluation.
	EnableHallucinationMetrics bool `json:"enableHallucinationMetrics,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EnableHallucinationMetrics")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EnableHallucinationMetrics") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationMetricsConfigHallucinationMetricsConfig: Configuration for the hallucination metrics for the evaluation. To disable the metric, set the message but do not set the `enable_hallucination_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.

func (EvaluationMetricsConfigHallucinationMetricsConfig) MarshalJSON added in v0.280.0

type EvaluationMetricsConfigScenarioMetricsConfig added in v0.280.0

type EvaluationMetricsConfigScenarioMetricsConfig struct {
	// ExpectationsMetMetricsConfig: Optional. Configuration for expectation level
	// metrics.
	ExpectationsMetMetricsConfig *EvaluationMetricsConfigExpectationsMetMetricsConfig `json:"expectationsMetMetricsConfig,omitempty"`
	// UserGoalMetMetricsConfig: Optional. Configuration for user goal met metrics.
	UserGoalMetMetricsConfig *EvaluationMetricsConfigUserGoalMetMetricsConfig `json:"userGoalMetMetricsConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "ExpectationsMetMetricsConfig") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. See https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields
	// for more details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExpectationsMetMetricsConfig") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationMetricsConfigScenarioMetricsConfig: Configuration for the scenario metrics for the evaluation.

func (EvaluationMetricsConfigScenarioMetricsConfig) MarshalJSON added in v0.280.0

type EvaluationMetricsConfigSemanticSimilarityMetricsConfig added in v0.280.0

type EvaluationMetricsConfigSemanticSimilarityMetricsConfig struct {
	// EnableSemanticSimilarityMetrics: Optional. Whether to calculate semantic
	// similarity metrics for the evaluation.
	EnableSemanticSimilarityMetrics bool `json:"enableSemanticSimilarityMetrics,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "EnableSemanticSimilarityMetrics") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted from
	// API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EnableSemanticSimilarityMetrics")
	// to include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationMetricsConfigSemanticSimilarityMetricsConfig: Configuration for similarity metrics for the evaluation. To disable the metric, set the message but do not set the `enable_semantic_similarity_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.

func (EvaluationMetricsConfigSemanticSimilarityMetricsConfig) MarshalJSON added in v0.280.0

type EvaluationMetricsConfigToolCorrectnessMetricsConfig added in v0.280.0

type EvaluationMetricsConfigToolCorrectnessMetricsConfig struct {
	// EnableToolCorrectnessMetrics: Optional. Whether to calculate tool
	// correctness metrics for the evaluation.
	EnableToolCorrectnessMetrics bool `json:"enableToolCorrectnessMetrics,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "EnableToolCorrectnessMetrics") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. See https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields
	// for more details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EnableToolCorrectnessMetrics") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationMetricsConfigToolCorrectnessMetricsConfig: Configuration for correctness metrics for the evaluation. To disable the metric, set the message but do not set the `enable_tool_correctness_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.

func (EvaluationMetricsConfigToolCorrectnessMetricsConfig) MarshalJSON added in v0.280.0

type EvaluationMetricsConfigUserGoalMetMetricsConfig added in v0.280.0

type EvaluationMetricsConfigUserGoalMetMetricsConfig struct {
	// EnableUserGoalMetMetrics: Optional. Whether to calculate the user goal met
	// metrics for the evaluation.
	EnableUserGoalMetMetrics bool `json:"enableUserGoalMetMetrics,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EnableUserGoalMetMetrics")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EnableUserGoalMetMetrics") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationMetricsConfigUserGoalMetMetricsConfig: Configuration for the user goal met metrics for the evaluation. To disable the metric, set the message but do not set the `enable_user_goal_met_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely.

func (EvaluationMetricsConfigUserGoalMetMetricsConfig) MarshalJSON added in v0.280.0

type EvaluationMetricsThresholds

type EvaluationMetricsThresholds struct {
	// GoldenEvaluationMetricsThresholds: Optional. The golden evaluation metrics
	// thresholds.
	GoldenEvaluationMetricsThresholds *EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds `json:"goldenEvaluationMetricsThresholds,omitempty"`
	// GoldenHallucinationMetricBehavior: Optional. The hallucination metric
	// behavior for golden evaluations.
	//
	// Possible values:
	//   "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED" - Unspecified hallucination
	// metric behavior.
	//   "DISABLED" - Disable hallucination metric.
	//   "ENABLED" - Enable hallucination metric.
	GoldenHallucinationMetricBehavior string `json:"goldenHallucinationMetricBehavior,omitempty"`
	// HallucinationMetricBehavior: Optional. Deprecated: Use
	// `golden_hallucination_metric_behavior` instead. The hallucination metric
	// behavior is currently used for golden evaluations.
	//
	// Possible values:
	//   "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED" - Unspecified hallucination
	// metric behavior.
	//   "DISABLED" - Disable hallucination metric.
	//   "ENABLED" - Enable hallucination metric.
	HallucinationMetricBehavior string `json:"hallucinationMetricBehavior,omitempty"`
	// ScenarioHallucinationMetricBehavior: Optional. The hallucination metric
	// behavior for scenario evaluations.
	//
	// Possible values:
	//   "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED" - Unspecified hallucination
	// metric behavior.
	//   "DISABLED" - Disable hallucination metric.
	//   "ENABLED" - Enable hallucination metric.
	ScenarioHallucinationMetricBehavior string `json:"scenarioHallucinationMetricBehavior,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "GoldenEvaluationMetricsThresholds") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted from
	// API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g.
	// "GoldenEvaluationMetricsThresholds") to include in API requests with the
	// JSON null value. By default, fields with empty values are omitted from API
	// requests. See https://pkg.go.dev/google.golang.org/api#hdr-NullFields for
	// more details.
	NullFields []string `json:"-"`
}

EvaluationMetricsThresholds: Threshold settings for metrics in an Evaluation.

func (EvaluationMetricsThresholds) MarshalJSON

func (s EvaluationMetricsThresholds) MarshalJSON() ([]byte, error)

type EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds

type EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds struct {
	// ExpectationLevelMetricsThresholds: Optional. The expectation level metrics
	// thresholds.
	ExpectationLevelMetricsThresholds *EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds `json:"expectationLevelMetricsThresholds,omitempty"`
	// ToolMatchingSettings: Optional. The tool matching settings. An extra tool
	// call is a tool call that is present in the execution but does not match any
	// tool call in the golden expectation.
	ToolMatchingSettings *EvaluationMetricsThresholdsToolMatchingSettings `json:"toolMatchingSettings,omitempty"`
	// TurnLevelMetricsThresholds: Optional. The turn level metrics thresholds.
	TurnLevelMetricsThresholds *EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds `json:"turnLevelMetricsThresholds,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "ExpectationLevelMetricsThresholds") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted from
	// API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g.
	// "ExpectationLevelMetricsThresholds") to include in API requests with the
	// JSON null value. By default, fields with empty values are omitted from API
	// requests. See https://pkg.go.dev/google.golang.org/api#hdr-NullFields for
	// more details.
	NullFields []string `json:"-"`
}

EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds: Settings for golden evaluations.

func (EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholds) MarshalJSON

type EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds

type EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds struct {
	// ToolInvocationParameterCorrectnessThreshold: Optional. The success threshold
	// for individual tool invocation parameter correctness. Must be a float
	// between 0 and 1. Default is 1.0.
	ToolInvocationParameterCorrectnessThreshold float64 `json:"toolInvocationParameterCorrectnessThreshold,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "ToolInvocationParameterCorrectnessThreshold") to unconditionally include in
	// API requests. By default, fields with empty or default values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g.
	// "ToolInvocationParameterCorrectnessThreshold") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelM etricsThresholds: Expectation level metrics thresholds.

func (EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds) MarshalJSON

func (*EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds) UnmarshalJSON

type EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds

type EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds struct {
	// OverallToolInvocationCorrectnessThreshold: Optional. The success threshold
	// for overall tool invocation correctness. Must be a float between 0 and 1.
	// Default is 1.0.
	OverallToolInvocationCorrectnessThreshold float64 `json:"overallToolInvocationCorrectnessThreshold,omitempty"`
	// SemanticSimilarityChannel: Optional. The semantic similarity channel to use
	// for evaluation.
	//
	// Possible values:
	//   "SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED" - Metric unspecified. Defaults
	// to TEXT.
	//   "TEXT" - Use text semantic similarity.
	//   "AUDIO" - Use audio semantic similarity.
	SemanticSimilarityChannel string `json:"semanticSimilarityChannel,omitempty"`
	// SemanticSimilaritySuccessThreshold: Optional. The success threshold for
	// semantic similarity. Must be an integer between 0 and 4. Default is >= 3.
	SemanticSimilaritySuccessThreshold int64 `json:"semanticSimilaritySuccessThreshold,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "OverallToolInvocationCorrectnessThreshold") to unconditionally include in
	// API requests. By default, fields with empty or default values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g.
	// "OverallToolInvocationCorrectnessThreshold") to include in API requests with
	// the JSON null value. By default, fields with empty values are omitted from
	// API requests. See https://pkg.go.dev/google.golang.org/api#hdr-NullFields
	// for more details.
	NullFields []string `json:"-"`
}

EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsT hresholds: Turn level metrics thresholds.

func (EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds) MarshalJSON

func (*EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsTurnLevelMetricsThresholds) UnmarshalJSON

type EvaluationMetricsThresholdsToolMatchingSettings added in v0.270.0

type EvaluationMetricsThresholdsToolMatchingSettings struct {
	// ExtraToolCallBehavior: Optional. Behavior for extra tool calls. Defaults to
	// FAIL.
	//
	// Possible values:
	//   "EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED" - Unspecified behavior. Defaults to
	// FAIL.
	//   "FAIL" - Fail the evaluation if an extra tool call is encountered.
	//   "ALLOW" - Allow the extra tool call.
	ExtraToolCallBehavior string `json:"extraToolCallBehavior,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExtraToolCallBehavior") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExtraToolCallBehavior") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationMetricsThresholdsToolMatchingSettings: Settings for matching tool calls.

func (EvaluationMetricsThresholdsToolMatchingSettings) MarshalJSON added in v0.270.0

type EvaluationPersona

type EvaluationPersona struct {
	// Description: Optional. The description of the persona.
	Description string `json:"description,omitempty"`
	// DisplayName: Required. The display name of the persona. Unique within an
	// app.
	DisplayName string `json:"displayName,omitempty"`
	// Name: Required. The unique identifier of the persona. Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evalu
	// ationPersona}`
	Name string `json:"name,omitempty"`
	// Personality: Required. An instruction for the agent on how to behave in the
	// evaluation.
	Personality string `json:"personality,omitempty"`
	// SpeechConfig: Optional. Configuration for how the persona sounds (TTS
	// settings).
	SpeechConfig *EvaluationPersonaSpeechConfig `json:"speechConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationPersona: A persona represents an end user in an evaluation.

func (EvaluationPersona) MarshalJSON

func (s EvaluationPersona) MarshalJSON() ([]byte, error)

type EvaluationPersonaSpeechConfig

type EvaluationPersonaSpeechConfig struct {
	// Environment: Optional. The simulated audio environment.
	//
	// Possible values:
	//   "BACKGROUND_ENVIRONMENT_UNSPECIFIED" - Background environment unspecified.
	//   "CALL_CENTER" - Call center environment.
	//   "TRAFFIC" - Traffic noise environment.
	//   "KIDS_NOISE" - Kids noise environment.
	//   "CAFE" - Cafe environment.
	Environment string `json:"environment,omitempty"`
	// SpeakingRate: Optional. The speaking rate. 1.0 is normal. Lower is slower
	// (e.g., 0.8), higher is faster (e.g., 1.5). Useful for testing how the agent
	// handles fast talkers.
	SpeakingRate float64 `json:"speakingRate,omitempty"`
	// VoiceId: Optional. The specific voice identifier/accent to use. Example:
	// "en-US-Wavenet-D" or "en-GB-Standard-A"
	VoiceId string `json:"voiceId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Environment") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Environment") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationPersonaSpeechConfig: Configuration for Text-to-Speech generation.

func (EvaluationPersonaSpeechConfig) MarshalJSON

func (s EvaluationPersonaSpeechConfig) MarshalJSON() ([]byte, error)

func (*EvaluationPersonaSpeechConfig) UnmarshalJSON

func (s *EvaluationPersonaSpeechConfig) UnmarshalJSON(data []byte) error

type EvaluationResult

type EvaluationResult struct {
	// AppVersion: Output only. The app version used to generate the conversation
	// that resulted in this result. Format:
	// `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
	AppVersion string `json:"appVersion,omitempty"`
	// AppVersionDisplayName: Output only. The display name of the `app_version`
	// that the evaluation ran against.
	AppVersionDisplayName string `json:"appVersionDisplayName,omitempty"`
	// Changelog: Output only. The changelog of the app version that the evaluation
	// ran against. This is populated if user runs evaluation on latest/draft.
	Changelog string `json:"changelog,omitempty"`
	// ChangelogCreateTime: Output only. The create time of the changelog of the
	// app version that the evaluation ran against. This is populated if user runs
	// evaluation on latest/draft.
	ChangelogCreateTime string `json:"changelogCreateTime,omitempty"`
	// Config: Output only. The configuration used in the evaluation run that
	// resulted in this result.
	Config *EvaluationConfig `json:"config,omitempty"`
	// CreateTime: Output only. Timestamp when the evaluation result was created.
	CreateTime string `json:"createTime,omitempty"`
	// DisplayName: Required. Display name of the Evaluation Result. Unique within
	// an Evaluation. By default, it has the following format: " result - ".
	DisplayName string `json:"displayName,omitempty"`
	// Error: Output only. Deprecated: Use `error_info` instead. Errors encountered
	// during execution.
	Error *Status `json:"error,omitempty"`
	// ErrorInfo: Output only. Error information for the evaluation result.
	ErrorInfo *EvaluationErrorInfo `json:"errorInfo,omitempty"`
	// EvaluationMetricsThresholds: Output only. The evaluation thresholds for the
	// result.
	EvaluationMetricsThresholds *EvaluationMetricsThresholds `json:"evaluationMetricsThresholds,omitempty"`
	// EvaluationRun: Output only. The evaluation run that produced this result.
	// Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluatio
	// nRun}`
	EvaluationRun string `json:"evaluationRun,omitempty"`
	// EvaluationStatus: Output only. The outcome of the evaluation. Only populated
	// if execution_state is COMPLETE.
	//
	// Possible values:
	//   "OUTCOME_UNSPECIFIED" - Evaluation outcome is not specified.
	//   "PASS" - Evaluation/Expectation passed. In the case of an evaluation, this
	// means that all expectations were met.
	//   "FAIL" - Evaluation/Expectation failed. In the case of an evaluation, this
	// means that at least one expectation was not met.
	//   "SKIPPED" - Evaluation/Expectation was skipped.
	EvaluationStatus string `json:"evaluationStatus,omitempty"`
	// ExecutionState: Output only. The state of the evaluation result execution.
	//
	// Possible values:
	//   "EXECUTION_STATE_UNSPECIFIED" - Evaluation result execution state is not
	// specified.
	//   "RUNNING" - Evaluation result execution is running.
	//   "COMPLETED" - Evaluation result execution has completed.
	//   "ERROR" - Evaluation result execution failed due to an internal error.
	ExecutionState string `json:"executionState,omitempty"`
	// GoldenResult: Output only. The outcome of a golden evaluation.
	GoldenResult *EvaluationResultGoldenResult `json:"goldenResult,omitempty"`
	// GoldenRunMethod: Output only. The method used to run the golden evaluation.
	//
	// Possible values:
	//   "GOLDEN_RUN_METHOD_UNSPECIFIED" - Run method is not specified.
	//   "STABLE" - Run the evaluation as stable replay, where each turn is a
	// unique session with the previous expected turns injected as context.
	//   "NAIVE" - Run the evaluation as naive replay, where the run is a single
	// session with no context injected.
	GoldenRunMethod string `json:"goldenRunMethod,omitempty"`
	// InitiatedBy: Output only. The user who initiated the evaluation run that
	// resulted in this result.
	InitiatedBy string `json:"initiatedBy,omitempty"`
	// Name: Identifier. The unique identifier of the evaluation result. Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/
	// results/{result}`
	Name string `json:"name,omitempty"`
	// Persona: Output only. The persona used to generate the conversation for the
	// evaluation result.
	Persona *EvaluationPersona `json:"persona,omitempty"`
	// ScenarioResult: Output only. The outcome of a scenario evaluation.
	ScenarioResult *EvaluationResultScenarioResult `json:"scenarioResult,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AppVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResult: An evaluation result represents the output of running an Evaluation.

func (EvaluationResult) MarshalJSON

func (s EvaluationResult) MarshalJSON() ([]byte, error)

type EvaluationResultEvaluationExpectationResult

type EvaluationResultEvaluationExpectationResult struct {
	// EvaluationExpectation: Output only. The evaluation expectation. Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{e
	// valuation_expectation}`
	EvaluationExpectation string `json:"evaluationExpectation,omitempty"`
	// Explanation: Output only. The explanation for the result.
	Explanation string `json:"explanation,omitempty"`
	// Outcome: Output only. The outcome of the evaluation expectation.
	//
	// Possible values:
	//   "OUTCOME_UNSPECIFIED" - Evaluation outcome is not specified.
	//   "PASS" - Evaluation/Expectation passed. In the case of an evaluation, this
	// means that all expectations were met.
	//   "FAIL" - Evaluation/Expectation failed. In the case of an evaluation, this
	// means that at least one expectation was not met.
	//   "SKIPPED" - Evaluation/Expectation was skipped.
	Outcome string `json:"outcome,omitempty"`
	// Prompt: Output only. The prompt that was used for the evaluation.
	Prompt string `json:"prompt,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EvaluationExpectation") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EvaluationExpectation") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResultEvaluationExpectationResult: The result of a single evaluation expectation.

func (EvaluationResultEvaluationExpectationResult) MarshalJSON

type EvaluationResultGoldenExpectationOutcome

type EvaluationResultGoldenExpectationOutcome struct {
	// Expectation: Output only. The expectation that was evaluated.
	Expectation *EvaluationGoldenExpectation `json:"expectation,omitempty"`
	// ObservedAgentResponse: Output only. The result of the agent response
	// expectation.
	ObservedAgentResponse *Message `json:"observedAgentResponse,omitempty"`
	// ObservedAgentTransfer: Output only. The result of the agent transfer
	// expectation.
	ObservedAgentTransfer *AgentTransfer `json:"observedAgentTransfer,omitempty"`
	// ObservedPayload: Output only. An observed custom payload. There are no
	// expectations for custom payloads. This is only used for metrics calculation.
	// The outcome is always SKIPPED.
	ObservedPayload googleapi.RawMessage `json:"observedPayload,omitempty"`
	// ObservedToolCall: Output only. The result of the tool call expectation.
	ObservedToolCall *ToolCall `json:"observedToolCall,omitempty"`
	// ObservedToolResponse: Output only. The result of the tool response
	// expectation.
	ObservedToolResponse *ToolResponse `json:"observedToolResponse,omitempty"`
	// Outcome: Output only. The outcome of the expectation.
	//
	// Possible values:
	//   "OUTCOME_UNSPECIFIED" - Evaluation outcome is not specified.
	//   "PASS" - Evaluation/Expectation passed. In the case of an evaluation, this
	// means that all expectations were met.
	//   "FAIL" - Evaluation/Expectation failed. In the case of an evaluation, this
	// means that at least one expectation was not met.
	//   "SKIPPED" - Evaluation/Expectation was skipped.
	Outcome string `json:"outcome,omitempty"`
	// SemanticSimilarityResult: Output only. The result of the semantic similarity
	// check.
	SemanticSimilarityResult *EvaluationResultSemanticSimilarityResult `json:"semanticSimilarityResult,omitempty"`
	// ToolInvocationResult: Output only. The result of the tool invocation check.
	ToolInvocationResult *EvaluationResultGoldenExpectationOutcomeToolInvocationResult `json:"toolInvocationResult,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Expectation") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Expectation") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResultGoldenExpectationOutcome: Specifies the expectation and the result of that expectation.

func (EvaluationResultGoldenExpectationOutcome) MarshalJSON

type EvaluationResultGoldenExpectationOutcomeToolInvocationResult

type EvaluationResultGoldenExpectationOutcomeToolInvocationResult struct {
	// Explanation: Output only. A free text explanation for the tool invocation
	// result.
	Explanation string `json:"explanation,omitempty"`
	// Outcome: Output only. The outcome of the tool invocation check. This is
	// determined by comparing the parameter_correctness_score to the threshold. If
	// the score is equal to or above the threshold, the outcome will be PASS.
	// Otherwise, the outcome will be FAIL.
	//
	// Possible values:
	//   "OUTCOME_UNSPECIFIED" - Evaluation outcome is not specified.
	//   "PASS" - Evaluation/Expectation passed. In the case of an evaluation, this
	// means that all expectations were met.
	//   "FAIL" - Evaluation/Expectation failed. In the case of an evaluation, this
	// means that at least one expectation was not met.
	//   "SKIPPED" - Evaluation/Expectation was skipped.
	Outcome string `json:"outcome,omitempty"`
	// ParameterCorrectnessScore: Output only. The tool invocation parameter
	// correctness score. This indicates the percent of parameters from the
	// expected tool call that were also present in the actual tool call.
	ParameterCorrectnessScore float64 `json:"parameterCorrectnessScore,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Explanation") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Explanation") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResultGoldenExpectationOutcomeToolInvocationResult: The result of the tool invocation check.

func (EvaluationResultGoldenExpectationOutcomeToolInvocationResult) MarshalJSON

func (*EvaluationResultGoldenExpectationOutcomeToolInvocationResult) UnmarshalJSON

type EvaluationResultGoldenResult

type EvaluationResultGoldenResult struct {
	// EvaluationExpectationResults: Output only. The results of the evaluation
	// expectations.
	EvaluationExpectationResults []*EvaluationResultEvaluationExpectationResult `json:"evaluationExpectationResults,omitempty"`
	// TurnReplayResults: Output only. The result of running each turn of the
	// golden conversation.
	TurnReplayResults []*EvaluationResultGoldenResultTurnReplayResult `json:"turnReplayResults,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "EvaluationExpectationResults") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. See https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields
	// for more details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EvaluationExpectationResults") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResultGoldenResult: The result of a golden evaluation.

func (EvaluationResultGoldenResult) MarshalJSON

func (s EvaluationResultGoldenResult) MarshalJSON() ([]byte, error)

type EvaluationResultGoldenResultTurnReplayResult

type EvaluationResultGoldenResultTurnReplayResult struct {
	// Conversation: Output only. The conversation that was generated for this
	// turn.
	Conversation string `json:"conversation,omitempty"`
	// ErrorInfo: Output only. Information about the error that occurred during
	// this turn.
	ErrorInfo *EvaluationErrorInfo `json:"errorInfo,omitempty"`
	// ExpectationOutcome: Output only. The outcome of each expectation.
	ExpectationOutcome []*EvaluationResultGoldenExpectationOutcome `json:"expectationOutcome,omitempty"`
	// HallucinationResult: Output only. The result of the hallucination check.
	HallucinationResult *EvaluationResultHallucinationResult `json:"hallucinationResult,omitempty"`
	// OverallToolInvocationResult: Output only. The result of the overall tool
	// invocation check.
	OverallToolInvocationResult *EvaluationResultOverallToolInvocationResult `json:"overallToolInvocationResult,omitempty"`
	// SemanticSimilarityResult: Output only. The result of the semantic similarity
	// check.
	SemanticSimilarityResult *EvaluationResultSemanticSimilarityResult `json:"semanticSimilarityResult,omitempty"`
	// SpanLatencies: Output only. The latency of spans in the turn.
	SpanLatencies []*EvaluationResultSpanLatency `json:"spanLatencies,omitempty"`
	// ToolCallLatencies: Output only. The latency of each tool call in the turn.
	ToolCallLatencies []*EvaluationResultToolCallLatency `json:"toolCallLatencies,omitempty"`
	// ToolInvocationScore: Output only. Deprecated. Use
	// OverallToolInvocationResult instead.
	ToolInvocationScore float64 `json:"toolInvocationScore,omitempty"`
	// ToolOrderedInvocationScore: Output only. The overall tool ordered invocation
	// score for this turn. This indicates the overall percent of tools from the
	// expected turn that were actually invoked in the expected order.
	ToolOrderedInvocationScore float64 `json:"toolOrderedInvocationScore,omitempty"`
	// TurnLatency: Output only. Duration of the turn.
	TurnLatency string `json:"turnLatency,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Conversation") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Conversation") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResultGoldenResultTurnReplayResult: The result of running a single turn of the golden conversation.

func (EvaluationResultGoldenResultTurnReplayResult) MarshalJSON

func (*EvaluationResultGoldenResultTurnReplayResult) UnmarshalJSON

func (s *EvaluationResultGoldenResultTurnReplayResult) UnmarshalJSON(data []byte) error

type EvaluationResultHallucinationResult

type EvaluationResultHallucinationResult struct {
	// Explanation: Output only. The explanation for the hallucination score.
	Explanation string `json:"explanation,omitempty"`
	// Label: Output only. The label associated with each score. Score 1: Justified
	// Score 0: Not Justified Score -1: No Claim To Assess
	Label string `json:"label,omitempty"`
	// Score: Output only. The hallucination score. Can be -1, 0, 1.
	Score int64 `json:"score,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Explanation") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Explanation") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResultHallucinationResult: The result of the hallucination check for a single turn.

func (EvaluationResultHallucinationResult) MarshalJSON

func (s EvaluationResultHallucinationResult) MarshalJSON() ([]byte, error)

type EvaluationResultOverallToolInvocationResult

type EvaluationResultOverallToolInvocationResult struct {
	// Outcome: Output only. The outcome of the tool invocation check. This is
	// determined by comparing the tool_invocation_score to the
	// overall_tool_invocation_correctness_threshold. If the score is equal to or
	// above the threshold, the outcome will be PASS. Otherwise, the outcome will
	// be FAIL.
	//
	// Possible values:
	//   "OUTCOME_UNSPECIFIED" - Evaluation outcome is not specified.
	//   "PASS" - Evaluation/Expectation passed. In the case of an evaluation, this
	// means that all expectations were met.
	//   "FAIL" - Evaluation/Expectation failed. In the case of an evaluation, this
	// means that at least one expectation was not met.
	//   "SKIPPED" - Evaluation/Expectation was skipped.
	Outcome string `json:"outcome,omitempty"`
	// ToolInvocationScore: The overall tool invocation score for this turn. This
	// indicates the overall percent of tools from the expected turn that were
	// actually invoked.
	ToolInvocationScore float64 `json:"toolInvocationScore,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Outcome") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Outcome") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResultOverallToolInvocationResult: The result of the overall tool invocation check.

func (EvaluationResultOverallToolInvocationResult) MarshalJSON

func (*EvaluationResultOverallToolInvocationResult) UnmarshalJSON

func (s *EvaluationResultOverallToolInvocationResult) UnmarshalJSON(data []byte) error

type EvaluationResultScenarioExpectationOutcome

type EvaluationResultScenarioExpectationOutcome struct {
	// Expectation: Output only. The expectation that was evaluated.
	Expectation *EvaluationScenarioExpectation `json:"expectation,omitempty"`
	// ObservedAgentResponse: Output only. The observed agent response.
	ObservedAgentResponse *Message `json:"observedAgentResponse,omitempty"`
	// ObservedToolCall: Output only. The observed tool call.
	ObservedToolCall *EvaluationResultScenarioExpectationOutcomeObservedToolCall `json:"observedToolCall,omitempty"`
	// Outcome: Output only. The outcome of the ScenarioExpectation.
	//
	// Possible values:
	//   "OUTCOME_UNSPECIFIED" - Evaluation outcome is not specified.
	//   "PASS" - Evaluation/Expectation passed. In the case of an evaluation, this
	// means that all expectations were met.
	//   "FAIL" - Evaluation/Expectation failed. In the case of an evaluation, this
	// means that at least one expectation was not met.
	//   "SKIPPED" - Evaluation/Expectation was skipped.
	Outcome string `json:"outcome,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Expectation") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Expectation") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResultScenarioExpectationOutcome: The outcome of a scenario expectation.

func (EvaluationResultScenarioExpectationOutcome) MarshalJSON

type EvaluationResultScenarioExpectationOutcomeObservedToolCall

type EvaluationResultScenarioExpectationOutcomeObservedToolCall struct {
	// ToolCall: Output only. The observed tool call.
	ToolCall *ToolCall `json:"toolCall,omitempty"`
	// ToolResponse: Output only. The observed tool response.
	ToolResponse *ToolResponse `json:"toolResponse,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ToolCall") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ToolCall") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResultScenarioExpectationOutcomeObservedToolCall: The observed tool call and response.

func (EvaluationResultScenarioExpectationOutcomeObservedToolCall) MarshalJSON

type EvaluationResultScenarioResult

type EvaluationResultScenarioResult struct {
	// AllExpectationsSatisfied: Output only. Whether all expectations were
	// satisfied for this turn.
	AllExpectationsSatisfied bool `json:"allExpectationsSatisfied,omitempty"`
	// Conversation: Output only. The conversation that was generated in the
	// scenario.
	Conversation string `json:"conversation,omitempty"`
	// EvaluationExpectationResults: Output only. The results of the evaluation
	// expectations.
	EvaluationExpectationResults []*EvaluationResultEvaluationExpectationResult `json:"evaluationExpectationResults,omitempty"`
	// ExpectationOutcomes: Output only. The outcome of each expectation.
	ExpectationOutcomes []*EvaluationResultScenarioExpectationOutcome `json:"expectationOutcomes,omitempty"`
	// HallucinationResult: Output only. The result of the hallucination check.
	// There will be one hallucination result for each turn in the conversation.
	HallucinationResult []*EvaluationResultHallucinationResult `json:"hallucinationResult,omitempty"`
	// RubricOutcomes: Output only. The outcome of the rubric.
	RubricOutcomes []*EvaluationResultScenarioRubricOutcome `json:"rubricOutcomes,omitempty"`
	// SpanLatencies: Output only. The latency of spans in the conversation.
	SpanLatencies []*EvaluationResultSpanLatency `json:"spanLatencies,omitempty"`
	// Task: Output only. The task that was used when running the scenario for this
	// result.
	Task string `json:"task,omitempty"`
	// TaskCompleted: Output only. Whether the task was completed for this turn.
	// This is a composite of all expectations satisfied, no hallucinations, and
	// user goal satisfaction.
	TaskCompleted bool `json:"taskCompleted,omitempty"`
	// TaskCompletionResult: Output only. The result of the task completion check.
	TaskCompletionResult *EvaluationResultTaskCompletionResult `json:"taskCompletionResult,omitempty"`
	// ToolCallLatencies: Output only. The latency of each tool call execution in
	// the conversation.
	ToolCallLatencies []*EvaluationResultToolCallLatency `json:"toolCallLatencies,omitempty"`
	// UserFacts: Output only. The user facts that were used by the scenario for
	// this result.
	UserFacts []*EvaluationScenarioUserFact `json:"userFacts,omitempty"`
	// UserGoalSatisfactionResult: Output only. The result of the user goal
	// satisfaction check.
	UserGoalSatisfactionResult *EvaluationResultUserGoalSatisfactionResult `json:"userGoalSatisfactionResult,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllExpectationsSatisfied")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllExpectationsSatisfied") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResultScenarioResult: The outcome of a scenario evaluation.

func (EvaluationResultScenarioResult) MarshalJSON

func (s EvaluationResultScenarioResult) MarshalJSON() ([]byte, error)

type EvaluationResultScenarioRubricOutcome

type EvaluationResultScenarioRubricOutcome struct {
	// Rubric: Output only. The rubric that was used to evaluate the conversation.
	Rubric string `json:"rubric,omitempty"`
	// Score: Output only. The score of the conversation against the rubric.
	Score float64 `json:"score,omitempty"`
	// ScoreExplanation: Output only. The rater's response to the rubric.
	ScoreExplanation string `json:"scoreExplanation,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Rubric") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Rubric") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResultScenarioRubricOutcome: The outcome of the evaluation against the rubric.

func (EvaluationResultScenarioRubricOutcome) MarshalJSON

func (s EvaluationResultScenarioRubricOutcome) MarshalJSON() ([]byte, error)

func (*EvaluationResultScenarioRubricOutcome) UnmarshalJSON

func (s *EvaluationResultScenarioRubricOutcome) UnmarshalJSON(data []byte) error

type EvaluationResultSemanticSimilarityResult

type EvaluationResultSemanticSimilarityResult struct {
	// Explanation: Output only. The explanation for the semantic similarity score.
	Explanation string `json:"explanation,omitempty"`
	// Label: Output only. The label associated with each score. Score 4: Fully
	// Consistent Score 3: Mostly Consistent Score 2: Partially Consistent (Minor
	// Omissions) Score 1: Largely Inconsistent (Major Omissions) Score 0:
	// Completely Inconsistent / Contradictory
	Label string `json:"label,omitempty"`
	// Outcome: Output only. The outcome of the semantic similarity check. This is
	// determined by comparing the score to the
	// semantic_similarity_success_threshold. If the score is equal to or above the
	// threshold, the outcome will be PASS. Otherwise, the outcome will be FAIL.
	//
	// Possible values:
	//   "OUTCOME_UNSPECIFIED" - Evaluation outcome is not specified.
	//   "PASS" - Evaluation/Expectation passed. In the case of an evaluation, this
	// means that all expectations were met.
	//   "FAIL" - Evaluation/Expectation failed. In the case of an evaluation, this
	// means that at least one expectation was not met.
	//   "SKIPPED" - Evaluation/Expectation was skipped.
	Outcome string `json:"outcome,omitempty"`
	// Score: Output only. The semantic similarity score. Can be 0, 1, 2, 3, or 4.
	Score int64 `json:"score,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Explanation") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Explanation") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResultSemanticSimilarityResult: The result of the semantic similarity check.

func (EvaluationResultSemanticSimilarityResult) MarshalJSON

type EvaluationResultSpanLatency

type EvaluationResultSpanLatency struct {
	// Callback: Output only. The name of the user callback span.
	Callback string `json:"callback,omitempty"`
	// DisplayName: Output only. The display name of the span. Applicable to tool
	// and guardrail spans.
	DisplayName string `json:"displayName,omitempty"`
	// EndTime: Output only. The end time of span.
	EndTime string `json:"endTime,omitempty"`
	// ExecutionLatency: Output only. The latency of span.
	ExecutionLatency string `json:"executionLatency,omitempty"`
	// Model: Output only. The name of the LLM span.
	Model string `json:"model,omitempty"`
	// Resource: Output only. The resource name of the guardrail or tool spans.
	Resource string `json:"resource,omitempty"`
	// StartTime: Output only. The start time of span.
	StartTime string `json:"startTime,omitempty"`
	// Toolset: Output only. The toolset tool identifier.
	Toolset *ToolsetTool `json:"toolset,omitempty"`
	// Type: Output only. The type of span.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Default value. This value is unused.
	//   "TOOL" - Tool call span.
	//   "USER_CALLBACK" - User callback span.
	//   "GUARDRAIL" - Guardrail span.
	//   "LLM" - LLM span.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Callback") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Callback") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResultSpanLatency: The latency of a span execution.

func (EvaluationResultSpanLatency) MarshalJSON

func (s EvaluationResultSpanLatency) MarshalJSON() ([]byte, error)

type EvaluationResultTaskCompletionResult

type EvaluationResultTaskCompletionResult struct {
	// Explanation: Output only. The explanation for the task completion score.
	Explanation string `json:"explanation,omitempty"`
	// Label: Output only. The label associated with each score. Score 1: Task
	// Completed Score 0: Task Not Completed Score -1: User Goal Undefined
	Label string `json:"label,omitempty"`
	// Score: Output only. The task completion score. Can be -1, 0, 1
	Score int64 `json:"score,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Explanation") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Explanation") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResultTaskCompletionResult: The result of the task completion check for the conversation.

func (EvaluationResultTaskCompletionResult) MarshalJSON

func (s EvaluationResultTaskCompletionResult) MarshalJSON() ([]byte, error)

type EvaluationResultToolCallLatency

type EvaluationResultToolCallLatency struct {
	// DisplayName: Output only. The display name of the tool.
	DisplayName string `json:"displayName,omitempty"`
	// EndTime: Output only. The end time of the tool call execution.
	EndTime string `json:"endTime,omitempty"`
	// ExecutionLatency: Output only. The latency of the tool call execution.
	ExecutionLatency string `json:"executionLatency,omitempty"`
	// StartTime: Output only. The start time of the tool call execution.
	StartTime string `json:"startTime,omitempty"`
	// Tool: Output only. The name of the tool that got executed. Format:
	// `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`.
	Tool string `json:"tool,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResultToolCallLatency: The latency of a tool call execution.

func (EvaluationResultToolCallLatency) MarshalJSON

func (s EvaluationResultToolCallLatency) MarshalJSON() ([]byte, error)

type EvaluationResultUserGoalSatisfactionResult

type EvaluationResultUserGoalSatisfactionResult struct {
	// Explanation: Output only. The explanation for the user task satisfaction
	// score.
	Explanation string `json:"explanation,omitempty"`
	// Label: Output only. The label associated with each score. Score 1: User Task
	// Satisfied Score 0: User Task Not Satisfied Score -1: User Task Unspecified
	Label string `json:"label,omitempty"`
	// Score: Output only. The user task satisfaction score. Can be -1, 0, 1.
	Score int64 `json:"score,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Explanation") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Explanation") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationResultUserGoalSatisfactionResult: The result of a user goal satisfaction check for a conversation.

func (EvaluationResultUserGoalSatisfactionResult) MarshalJSON

type EvaluationRun

type EvaluationRun struct {
	// AppVersion: Output only. The app version to evaluate. Format:
	// `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
	AppVersion string `json:"appVersion,omitempty"`
	// AppVersionDisplayName: Output only. The display name of the `app_version`
	// that the evaluation ran against.
	AppVersionDisplayName string `json:"appVersionDisplayName,omitempty"`
	// Changelog: Output only. The changelog of the app version that the evaluation
	// ran against. This is populated if user runs evaluation on latest/draft.
	Changelog string `json:"changelog,omitempty"`
	// ChangelogCreateTime: Output only. The create time of the changelog of the
	// app version that the evaluation ran against. This is populated if user runs
	// evaluation on latest/draft.
	ChangelogCreateTime string `json:"changelogCreateTime,omitempty"`
	// Config: Output only. The configuration used in the run.
	Config *EvaluationConfig `json:"config,omitempty"`
	// CreateTime: Output only. Timestamp when the evaluation run was created.
	CreateTime string `json:"createTime,omitempty"`
	// DisplayName: Optional. User-defined display name of the evaluation run.
	// default: " run - ".
	DisplayName string `json:"displayName,omitempty"`
	// Error: Output only. Deprecated: Use error_info instead. Errors encountered
	// during execution.
	Error *Status `json:"error,omitempty"`
	// ErrorInfo: Output only. Error information for the evaluation run.
	ErrorInfo *EvaluationErrorInfo `json:"errorInfo,omitempty"`
	// EvaluationDataset: Output only. The evaluation dataset that this run is
	// associated with. This field is mutually exclusive with `evaluations`.
	// Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evalu
	// ationDataset}`
	EvaluationDataset string `json:"evaluationDataset,omitempty"`
	// EvaluationResults: Output only. The evaluation results that are part of this
	// run. Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/
	// results/{result}`
	EvaluationResults []string `json:"evaluationResults,omitempty"`
	// EvaluationRunSummaries: Output only. Map of evaluation name to
	// EvaluationRunSummary.
	EvaluationRunSummaries map[string]EvaluationRunEvaluationRunSummary `json:"evaluationRunSummaries,omitempty"`
	// EvaluationType: Output only. The type of the evaluations in this run.
	//
	// Possible values:
	//   "EVALUATION_TYPE_UNSPECIFIED" - Evaluation type is not specified.
	//   "GOLDEN" - Golden evaluation.
	//   "SCENARIO" - Scenario evaluation.
	//   "MIXED" - Indicates the run includes a mix of golden and scenario
	// evaluations.
	EvaluationType string `json:"evaluationType,omitempty"`
	// Evaluations: Output only. The evaluations that are part of this run. The
	// list may contain evaluations of either type. This field is mutually
	// exclusive with `evaluation_dataset`. Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`
	Evaluations []string `json:"evaluations,omitempty"`
	// GoldenRunMethod: Output only. The method used to run the evaluation.
	//
	// Possible values:
	//   "GOLDEN_RUN_METHOD_UNSPECIFIED" - Run method is not specified.
	//   "STABLE" - Run the evaluation as stable replay, where each turn is a
	// unique session with the previous expected turns injected as context.
	//   "NAIVE" - Run the evaluation as naive replay, where the run is a single
	// session with no context injected.
	GoldenRunMethod string `json:"goldenRunMethod,omitempty"`
	// InitiatedBy: Output only. The user who initiated the evaluation run.
	InitiatedBy string `json:"initiatedBy,omitempty"`
	// LatencyReport: Output only. Latency report for the evaluation run.
	LatencyReport *LatencyReport `json:"latencyReport,omitempty"`
	// Name: Identifier. The unique identifier of the evaluation run. Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluatio
	// nRun}`
	Name string `json:"name,omitempty"`
	// OptimizationConfig: Optional. Configuration for running the optimization
	// step after the evaluation run. If not set, the optimization step will not be
	// run.
	OptimizationConfig *OptimizationConfig `json:"optimizationConfig,omitempty"`
	// PersonaRunConfigs: Output only. The configuration to use for the run per
	// persona.
	PersonaRunConfigs []*PersonaRunConfig `json:"personaRunConfigs,omitempty"`
	// Progress: Output only. The progress of the evaluation run.
	Progress *EvaluationRunProgress `json:"progress,omitempty"`
	// RunCount: Output only. The number of times the evaluations inside the run
	// were run.
	RunCount int64 `json:"runCount,omitempty"`
	// ScheduledEvaluationRun: Output only. The scheduled evaluation run resource
	// name that created this evaluation run. This field is only set if the
	// evaluation run was created by a scheduled evaluation run. Format:
	// `projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{
	// scheduled_evaluation_run}`
	ScheduledEvaluationRun string `json:"scheduledEvaluationRun,omitempty"`
	// State: Output only. The state of the evaluation run.
	//
	// Possible values:
	//   "EVALUATION_RUN_STATE_UNSPECIFIED" - Evaluation run state is not
	// specified.
	//   "RUNNING" - Evaluation run is running.
	//   "COMPLETED" - Evaluation run has completed.
	//   "ERROR" - The evaluation run has an error.
	State string `json:"state,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AppVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationRun: An evaluation run represents an all the evaluation results from an evaluation execution.

func (EvaluationRun) MarshalJSON

func (s EvaluationRun) MarshalJSON() ([]byte, error)

type EvaluationRunEvaluationRunSummary

type EvaluationRunEvaluationRunSummary struct {
	// ErrorCount: Output only. Number of error results for the associated
	// Evaluation in this run.
	ErrorCount int64 `json:"errorCount,omitempty"`
	// FailedCount: Output only. Number of failed results for the associated
	// Evaluation in this run.
	FailedCount int64 `json:"failedCount,omitempty"`
	// PassedCount: Output only. Number of passed results for the associated
	// Evaluation in this run.
	PassedCount int64 `json:"passedCount,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ErrorCount") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ErrorCount") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationRunEvaluationRunSummary: Contains the summary of passed and failed result counts for a specific evaluation in an evaluation run.

func (EvaluationRunEvaluationRunSummary) MarshalJSON

func (s EvaluationRunEvaluationRunSummary) MarshalJSON() ([]byte, error)

type EvaluationRunProgress

type EvaluationRunProgress struct {
	// CompletedCount: Output only. Number of evaluation results that finished
	// successfully. (EvaluationResult.execution_state is COMPLETED).
	CompletedCount int64 `json:"completedCount,omitempty"`
	// ErrorCount: Output only. Number of evaluation results that failed to
	// execute. (EvaluationResult.execution_state is ERROR).
	ErrorCount int64 `json:"errorCount,omitempty"`
	// FailedCount: Output only. Number of completed evaluation results with an
	// outcome of FAIL. (EvaluationResult.execution_state is COMPLETED and
	// EvaluationResult.evaluation_status is FAIL).
	FailedCount int64 `json:"failedCount,omitempty"`
	// PassedCount: Output only. Number of completed evaluation results with an
	// outcome of PASS. (EvaluationResult.execution_state is COMPLETED and
	// EvaluationResult.evaluation_status is PASS).
	PassedCount int64 `json:"passedCount,omitempty"`
	// TotalCount: Output only. Total number of evaluation results in this run.
	TotalCount int64 `json:"totalCount,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CompletedCount") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CompletedCount") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationRunProgress: The progress of the evaluation run.

func (EvaluationRunProgress) MarshalJSON

func (s EvaluationRunProgress) MarshalJSON() ([]byte, error)

type EvaluationScenario

type EvaluationScenario struct {
	// EvaluationExpectations: Optional. The evaluation expectations to evaluate
	// the conversation produced by the simulation against. Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{e
	// valuationExpectation}`
	EvaluationExpectations []string `json:"evaluationExpectations,omitempty"`
	// MaxTurns: Optional. The maximum number of turns to simulate. If not
	// specified, the simulation will continue until the task is complete.
	MaxTurns int64 `json:"maxTurns,omitempty"`
	// Rubrics: Required. The rubrics to score the scenario against.
	Rubrics []string `json:"rubrics,omitempty"`
	// ScenarioExpectations: Required. The ScenarioExpectations to evaluate the
	// conversation produced by the user simulation.
	ScenarioExpectations []*EvaluationScenarioExpectation `json:"scenarioExpectations,omitempty"`
	// Task: Required. The task to be targeted by the scenario.
	Task string `json:"task,omitempty"`
	// TaskCompletionBehavior: Optional. Deprecated. Use user_goal_behavior
	// instead.
	//
	// Possible values:
	//   "TASK_COMPLETION_BEHAVIOR_UNSPECIFIED" - Behavior unspecified. Will
	// default to TASK_SATISFIED.
	//   "TASK_SATISFIED" - The user task should be completed successfully.
	//   "TASK_REJECTED" - The user task should be rejected.
	TaskCompletionBehavior string `json:"taskCompletionBehavior,omitempty"`
	// UserFacts: Optional. The user facts to be used by the scenario.
	UserFacts []*EvaluationScenarioUserFact `json:"userFacts,omitempty"`
	// UserGoalBehavior: Optional. The expected behavior of the user goal.
	//
	// Possible values:
	//   "USER_GOAL_BEHAVIOR_UNSPECIFIED" - Behavior unspecified. Will default to
	// USER_GOAL_SATISFIED.
	//   "USER_GOAL_SATISFIED" - The user goal should be completed successfully.
	//   "USER_GOAL_REJECTED" - The user goal should be rejected.
	//   "USER_GOAL_IGNORED" - Ignore the user goal status.
	UserGoalBehavior string `json:"userGoalBehavior,omitempty"`
	// VariableOverrides: Optional. Variables / Session Parameters as context for
	// the session, keyed by variable names. Members of this struct will override
	// any default values set by the system. Note, these are different from user
	// facts, which are facts known to the user. Variables are parameters known to
	// the agent: i.e. MDN (phone number) passed by the telephony system.
	VariableOverrides googleapi.RawMessage `json:"variableOverrides,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EvaluationExpectations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EvaluationExpectations") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationScenario: The config for a scenario

func (EvaluationScenario) MarshalJSON

func (s EvaluationScenario) MarshalJSON() ([]byte, error)

type EvaluationScenarioExpectation

type EvaluationScenarioExpectation struct {
	// AgentResponse: Optional. The agent response to be evaluated.
	AgentResponse *Message `json:"agentResponse,omitempty"`
	// ToolExpectation: Optional. The tool call and response pair to be evaluated.
	ToolExpectation *EvaluationScenarioExpectationToolExpectation `json:"toolExpectation,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AgentResponse") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AgentResponse") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationScenarioExpectation: The expectation to evaluate the conversation produced by the simulation.

func (EvaluationScenarioExpectation) MarshalJSON

func (s EvaluationScenarioExpectation) MarshalJSON() ([]byte, error)

type EvaluationScenarioExpectationToolExpectation

type EvaluationScenarioExpectationToolExpectation struct {
	// ExpectedToolCall: Required. The expected tool call, with the parameters of
	// interest specified. Any parameters not specified will be hallucinated by the
	// LLM.
	ExpectedToolCall *ToolCall `json:"expectedToolCall,omitempty"`
	// MockToolResponse: Required. The tool response to mock, with the parameters
	// of interest specified. Any parameters not specified will be hallucinated by
	// the LLM.
	MockToolResponse *ToolResponse `json:"mockToolResponse,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExpectedToolCall") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExpectedToolCall") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationScenarioExpectationToolExpectation: The tool call and response pair to be evaluated.

func (EvaluationScenarioExpectationToolExpectation) MarshalJSON

type EvaluationScenarioUserFact

type EvaluationScenarioUserFact struct {
	// Name: Required. The name of the user fact.
	Name string `json:"name,omitempty"`
	// Value: Required. The value of the user fact.
	Value string `json:"value,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationScenarioUserFact: Facts about the user as a key value pair.

func (EvaluationScenarioUserFact) MarshalJSON

func (s EvaluationScenarioUserFact) MarshalJSON() ([]byte, error)

type EvaluationSettings

type EvaluationSettings struct {
	// GoldenEvaluationToolCallBehaviour: Optional. Configures the default tool
	// call behaviour for golden evaluations.
	//
	// Possible values:
	//   "EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED" - Unspecified tool call
	// behavior. Will default to real tool calls.
	//   "REAL" - Use real tool calls.
	//   "FAKE" - Use fake tool calls.
	GoldenEvaluationToolCallBehaviour string `json:"goldenEvaluationToolCallBehaviour,omitempty"`
	// GoldenRunMethod: Optional. The default method used to run golden
	// evaluations. This will be used if no golden_run_method is specified in the
	// RunEvaluationRequest.
	//
	// Possible values:
	//   "GOLDEN_RUN_METHOD_UNSPECIFIED" - Run method is not specified.
	//   "STABLE" - Run the evaluation as stable replay, where each turn is a
	// unique session with the previous expected turns injected as context.
	//   "NAIVE" - Run the evaluation as naive replay, where the run is a single
	// session with no context injected.
	GoldenRunMethod string `json:"goldenRunMethod,omitempty"`
	// MetricsConfig: Optional. Configures the default metrics for evaluations.
	MetricsConfig *EvaluationMetricsConfig `json:"metricsConfig,omitempty"`
	// ScenarioConversationInitiator: Optional. Who starts the conversation in a
	// scenario evaluation.
	//
	// Possible values:
	//   "SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED" - Unspecified. Defaults to
	// USER.
	//   "USER" - The user starts the conversation.
	//   "AGENT" - The agent starts the conversation.
	ScenarioConversationInitiator string `json:"scenarioConversationInitiator,omitempty"`
	// ScenarioEvaluationToolCallBehaviour: Optional. Configures the default tool
	// call behaviour for scenario evaluations.
	//
	// Possible values:
	//   "EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED" - Unspecified tool call
	// behavior. Will default to real tool calls.
	//   "REAL" - Use real tool calls.
	//   "FAKE" - Use fake tool calls.
	ScenarioEvaluationToolCallBehaviour string `json:"scenarioEvaluationToolCallBehaviour,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "GoldenEvaluationToolCallBehaviour") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted from
	// API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g.
	// "GoldenEvaluationToolCallBehaviour") to include in API requests with the
	// JSON null value. By default, fields with empty values are omitted from API
	// requests. See https://pkg.go.dev/google.golang.org/api#hdr-NullFields for
	// more details.
	NullFields []string `json:"-"`
}

EvaluationSettings: Settings for evaluation.

func (EvaluationSettings) MarshalJSON

func (s EvaluationSettings) MarshalJSON() ([]byte, error)

type EvaluationStep

type EvaluationStep struct {
	// AgentTransfer: Optional. Transfer the conversation to a different agent.
	AgentTransfer *AgentTransfer `json:"agentTransfer,omitempty"`
	// Expectation: Optional. Executes an expectation on the current turn.
	Expectation *EvaluationGoldenExpectation `json:"expectation,omitempty"`
	// UserInput: Optional. User input for the conversation.
	UserInput *SessionInput `json:"userInput,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AgentTransfer") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AgentTransfer") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EvaluationStep: A step defines a singular action to happen during the evaluation.

func (EvaluationStep) MarshalJSON

func (s EvaluationStep) MarshalJSON() ([]byte, error)

type Event

type Event struct {
	// Event: Required. The name of the event.
	Event string `json:"event,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Event") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Event") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Event: Event input.

func (Event) MarshalJSON

func (s Event) MarshalJSON() ([]byte, error)

type Example

type Example struct {
	// CreateTime: Output only. Timestamp when the example was created.
	CreateTime string `json:"createTime,omitempty"`
	// Description: Optional. Human-readable description of the example.
	Description string `json:"description,omitempty"`
	// DisplayName: Required. Display name of the example.
	DisplayName string `json:"displayName,omitempty"`
	// EntryAgent: Optional. The agent that initially handles the conversation. If
	// not specified, the example represents a conversation that is handled by the
	// root agent. Format:
	// `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
	EntryAgent string `json:"entryAgent,omitempty"`
	// Etag: Etag used to ensure the object hasn't changed during a
	// read-modify-write operation. If the etag is empty, the update will overwrite
	// any concurrent changes.
	Etag string `json:"etag,omitempty"`
	// Invalid: Output only. The example may become invalid if referencing
	// resources are deleted. Invalid examples will not be used as few-shot
	// examples.
	Invalid bool `json:"invalid,omitempty"`
	// Messages: Optional. The collection of messages that make up the
	// conversation.
	Messages []*Message `json:"messages,omitempty"`
	// Name: Identifier. The unique identifier of the example. Format:
	// `projects/{project}/locations/{location}/apps/{app}/examples/{example}`
	Name string `json:"name,omitempty"`
	// UpdateTime: Output only. Timestamp when the example was last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Example: An example represents a sample conversation between the user and the agent(s).

func (Example) MarshalJSON

func (s Example) MarshalJSON() ([]byte, error)

type ExecuteToolRequest

type ExecuteToolRequest struct {
	// Args: Optional. The input parameters and values for the tool in JSON object
	// format.
	Args googleapi.RawMessage `json:"args,omitempty"`
	// Context: Optional. The ToolCallContext
	// (https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment
	// for details) to be passed to the Python tool.
	Context googleapi.RawMessage `json:"context,omitempty"`
	// MockConfig: Optional. Mock configuration for the tool execution. If this
	// field is set, tools that call other tools will be mocked based on the
	// provided patterns and responses.
	MockConfig *MockConfig `json:"mockConfig,omitempty"`
	// Tool: Optional. The name of the tool to execute. Format:
	// projects/{project}/locations/{location}/apps/{app}/tools/{tool}
	Tool string `json:"tool,omitempty"`
	// ToolsetTool: Optional. The toolset tool to execute. Only one tool should
	// match the predicate from the toolset. Otherwise, an error will be returned.
	ToolsetTool *ToolsetTool `json:"toolsetTool,omitempty"`
	// Variables: Optional. The variables that are available for the tool
	// execution.
	Variables googleapi.RawMessage `json:"variables,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Args") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Args") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExecuteToolRequest: Request message for ToolService.ExecuteTool.

func (ExecuteToolRequest) MarshalJSON

func (s ExecuteToolRequest) MarshalJSON() ([]byte, error)

type ExecuteToolResponse

type ExecuteToolResponse struct {
	// Response: The tool execution result in JSON object format. Use "output" key
	// to specify tool response and "error" key to specify error details (if any).
	// If "output" and "error" keys are not specified, then whole "response" is
	// treated as tool execution result.
	Response googleapi.RawMessage `json:"response,omitempty"`
	// Tool: The name of the tool that got executed. Format:
	// `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
	Tool string `json:"tool,omitempty"`
	// ToolsetTool: The toolset tool that got executed.
	ToolsetTool *ToolsetTool `json:"toolsetTool,omitempty"`
	// Variables: The variable values at the end of the tool execution.
	Variables googleapi.RawMessage `json:"variables,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Response") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Response") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExecuteToolResponse: Response message for ToolService.ExecuteTool.

func (ExecuteToolResponse) MarshalJSON

func (s ExecuteToolResponse) MarshalJSON() ([]byte, error)

type ExperimentConfig added in v0.277.0

type ExperimentConfig struct {
	// VersionRelease: Optional. Version release for the experiment.
	VersionRelease *ExperimentConfigVersionRelease `json:"versionRelease,omitempty"`
	// ForceSendFields is a list of field names (e.g. "VersionRelease") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "VersionRelease") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExperimentConfig: Experiment for the deployment.

func (ExperimentConfig) MarshalJSON added in v0.277.0

func (s ExperimentConfig) MarshalJSON() ([]byte, error)

type ExperimentConfigVersionRelease added in v0.277.0

type ExperimentConfigVersionRelease struct {
	// State: Optional. State of the version release.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Unspecified state.
	//   "PENDING" - Pending state. Experiment is pending and not valid.
	//   "RUNNING" - Running state. Experiment is running and valid.
	//   "DONE" - Done state. Experiment is done and no longer valid.
	//   "EXPIRED" - Expired state. Experiment is expired and no longer valid.
	State string `json:"state,omitempty"`
	// TrafficAllocations: Optional. Traffic allocations for the version release.
	TrafficAllocations []*ExperimentConfigVersionReleaseTrafficAllocation `json:"trafficAllocations,omitempty"`
	// ForceSendFields is a list of field names (e.g. "State") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "State") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExperimentConfigVersionRelease: Version release for the experiment.

func (ExperimentConfigVersionRelease) MarshalJSON added in v0.277.0

func (s ExperimentConfigVersionRelease) MarshalJSON() ([]byte, error)

type ExperimentConfigVersionReleaseTrafficAllocation added in v0.277.0

type ExperimentConfigVersionReleaseTrafficAllocation struct {
	// AppVersion: Optional. App version of the traffic allocation. Format:
	// `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
	AppVersion string `json:"appVersion,omitempty"`
	// Id: Optional. Id of the traffic allocation. Free format string, up to 128
	// characters.
	Id string `json:"id,omitempty"`
	// TrafficPercentage: Optional. Traffic percentage of the traffic allocation.
	// Must be between 0 and 100.
	TrafficPercentage int64 `json:"trafficPercentage,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AppVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExperimentConfigVersionReleaseTrafficAllocation: Traffic allocation for the version release.

func (ExperimentConfigVersionReleaseTrafficAllocation) MarshalJSON added in v0.277.0

type ExportAppRequest

type ExportAppRequest struct {
	// AppVersion: Optional. The resource name of the app version to export.
	// Format:
	// `projects/{project}/locations/{location}/apps/{app}/versions/{version}`.
	AppVersion string `json:"appVersion,omitempty"`
	// ExportFormat: Required. The format to export the app in.
	//
	// Possible values:
	//   "EXPORT_FORMAT_UNSPECIFIED" - The export format is unspecified.
	//   "JSON" - The export format is JSON.
	//   "YAML" - The export format is YAML.
	ExportFormat string `json:"exportFormat,omitempty"`
	// GcsUri: Optional. The Google Cloud Storage
	// (https://cloud.google.com/storage/docs/) URI to which to export the app. The
	// format of this URI must be `gs:///`. The exported app archive will be
	// written directly to the specified GCS object.
	GcsUri string `json:"gcsUri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AppVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportAppRequest: Request message for AgentService.ExportApp.

func (ExportAppRequest) MarshalJSON

func (s ExportAppRequest) MarshalJSON() ([]byte, error)

type ExportAppResponse

type ExportAppResponse struct {
	// AppContent: App folder compressed as a zip file.
	AppContent string `json:"appContent,omitempty"`
	// AppUri: The Google Cloud Storage (https://cloud.google.com/storage/docs/)
	// URI to which the app was exported.
	AppUri string `json:"appUri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AppContent") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppContent") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportAppResponse: Response message for AgentService.ExportApp.

func (ExportAppResponse) MarshalJSON

func (s ExportAppResponse) MarshalJSON() ([]byte, error)

type ExportEvaluationResultsRequest added in v0.279.0

type ExportEvaluationResultsRequest struct {
	// ExportOptions: Optional. The export options for the evaluation results.
	ExportOptions *ExportOptions `json:"exportOptions,omitempty"`
	// Names: Required. The resource names of the evaluation results to export.
	Names []string `json:"names,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExportOptions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExportOptions") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportEvaluationResultsRequest: Request message for EvaluationService.ExportEvaluationResults.

func (ExportEvaluationResultsRequest) MarshalJSON added in v0.279.0

func (s ExportEvaluationResultsRequest) MarshalJSON() ([]byte, error)

type ExportEvaluationResultsResponse added in v0.277.0

type ExportEvaluationResultsResponse struct {
	// EvaluationResultsContent: The content of the exported Evaluation Results.
	// This will be populated if gcs_uri was not specified in the request.
	EvaluationResultsContent string `json:"evaluationResultsContent,omitempty"`
	// EvaluationResultsUri: The Google Cloud Storage URI folder where the exported
	// Evaluation Results were written. This will be populated if gcs_uri was
	// specified in the request.
	EvaluationResultsUri string `json:"evaluationResultsUri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EvaluationResultsContent")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EvaluationResultsContent") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportEvaluationResultsResponse: Response message for EvaluationService.ExportEvaluationResults.

func (ExportEvaluationResultsResponse) MarshalJSON added in v0.277.0

func (s ExportEvaluationResultsResponse) MarshalJSON() ([]byte, error)

type ExportEvaluationRunsRequest added in v0.279.0

type ExportEvaluationRunsRequest struct {
	// ExportOptions: Optional. The export options for the evaluation runs.
	ExportOptions *ExportOptions `json:"exportOptions,omitempty"`
	// Names: Required. The resource names of the evaluation runs to export.
	Names []string `json:"names,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExportOptions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExportOptions") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportEvaluationRunsRequest: Request message for EvaluationService.ExportEvaluationRuns.

func (ExportEvaluationRunsRequest) MarshalJSON added in v0.279.0

func (s ExportEvaluationRunsRequest) MarshalJSON() ([]byte, error)

type ExportEvaluationRunsResponse added in v0.277.0

type ExportEvaluationRunsResponse struct {
	// EvaluationRunsContent: The content of the exported Evaluation Runs. This
	// will be populated if gcs_uri was not specified in the request.
	EvaluationRunsContent string `json:"evaluationRunsContent,omitempty"`
	// EvaluationRunsUri: The Google Cloud Storage URI folder where the exported
	// Evaluation Runs were written. This will be populated if gcs_uri was
	// specified in the request.
	EvaluationRunsUri string `json:"evaluationRunsUri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EvaluationRunsContent") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EvaluationRunsContent") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportEvaluationRunsResponse: Response message for EvaluationService.ExportEvaluationRuns.

func (ExportEvaluationRunsResponse) MarshalJSON added in v0.277.0

func (s ExportEvaluationRunsResponse) MarshalJSON() ([]byte, error)

type ExportEvaluationsRequest added in v0.276.0

type ExportEvaluationsRequest struct {
	// ExportOptions: Optional. The export options for the evaluations.
	ExportOptions *ExportOptions `json:"exportOptions,omitempty"`
	// IncludeEvaluationResults: Optional. Includes evaluation results in the
	// export. At least one of include_evaluation_results or include_evaluations
	// must be set.
	IncludeEvaluationResults bool `json:"includeEvaluationResults,omitempty"`
	// IncludeEvaluations: Optional. Includes evaluations in the export. At least
	// one of include_evaluation_results or include_evaluations must be set.
	IncludeEvaluations bool `json:"includeEvaluations,omitempty"`
	// Names: Required. The resource names of the evaluations to export.
	Names []string `json:"names,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExportOptions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExportOptions") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportEvaluationsRequest: Request message for EvaluationService.ExportEvaluations.

func (ExportEvaluationsRequest) MarshalJSON added in v0.276.0

func (s ExportEvaluationsRequest) MarshalJSON() ([]byte, error)

type ExportEvaluationsResponse added in v0.276.0

type ExportEvaluationsResponse struct {
	// EvaluationsContent: The content of the exported Evaluations. This will be
	// populated if gcs_uri was not specified in the request.
	EvaluationsContent string `json:"evaluationsContent,omitempty"`
	// EvaluationsUri: The Google Cloud Storage URI folder where the exported
	// evaluations were written. This will be populated if gcs_uri was specified in
	// the request.
	EvaluationsUri string `json:"evaluationsUri,omitempty"`
	// FailedEvaluations: Output only. A map of evaluation resource names that
	// could not be exported, to the reason why they failed.
	FailedEvaluations map[string]string `json:"failedEvaluations,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EvaluationsContent") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EvaluationsContent") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportEvaluationsResponse: Response message for EvaluationService.ExportEvaluations.

func (ExportEvaluationsResponse) MarshalJSON added in v0.276.0

func (s ExportEvaluationsResponse) MarshalJSON() ([]byte, error)

type ExportOptions added in v0.276.0

type ExportOptions struct {
	// ExportFormat: Optional. The format to export the evaluation results in.
	// Defaults to JSON if not specified.
	//
	// Possible values:
	//   "EXPORT_FORMAT_UNSPECIFIED" - Unspecified format.
	//   "JSON" - JSON format.
	//   "YAML" - YAML format.
	ExportFormat string `json:"exportFormat,omitempty"`
	// GcsUri: Optional. The Google Cloud Storage URI to write the exported
	// Evaluation Results to.
	GcsUri string `json:"gcsUri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExportFormat") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExportFormat") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportOptions: Options for exporting CES evaluation resources.

func (ExportOptions) MarshalJSON added in v0.276.0

func (s ExportOptions) MarshalJSON() ([]byte, error)

type ExpressionCondition

type ExpressionCondition struct {
	// Expression: Required. The string representation of cloud.api.Expression
	// condition.
	Expression string `json:"expression,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Expression") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Expression") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExpressionCondition: Expression condition based on session state.

func (ExpressionCondition) MarshalJSON

func (s ExpressionCondition) MarshalJSON() ([]byte, error)

type FileContext added in v0.274.0

type FileContext struct {
	// FileBytes: Optional. File provided as raw bytes.
	FileBytes *FileContextFileBytes `json:"fileBytes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FileBytes") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FileBytes") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

FileContext: Files to be used as context. Files can be provided as raw bytes.

func (FileContext) MarshalJSON added in v0.274.0

func (s FileContext) MarshalJSON() ([]byte, error)

type FileContextFileBytes added in v0.274.0

type FileContextFileBytes struct {
	// Data: Required. Raw bytes of the file.
	Data string `json:"data,omitempty"`
	// FileName: Required. The name of the file provided as raw bytes.
	FileName string `json:"fileName,omitempty"`
	// MimeType: Required. The IANA standard MIME type of the source data.
	MimeType string `json:"mimeType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Data") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Data") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

FileContextFileBytes: File provided as raw bytes.

func (FileContextFileBytes) MarshalJSON added in v0.274.0

func (s FileContextFileBytes) MarshalJSON() ([]byte, error)

type FileSearchTool

type FileSearchTool struct {
	// CorpusType: Optional. The type of the corpus. Default is FULLY_MANAGED.
	//
	// Possible values:
	//   "CORPUS_TYPE_UNSPECIFIED" - Unspecified corpus type.
	//   "USER_OWNED" - The corpus is created and owned by the user.
	//   "FULLY_MANAGED" - The corpus is created by the agent.
	CorpusType string `json:"corpusType,omitempty"`
	// Description: Optional. The tool description.
	Description string `json:"description,omitempty"`
	// FileCorpus: Optional. The corpus where files are stored. Format:
	// projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
	FileCorpus string `json:"fileCorpus,omitempty"`
	// Name: Required. The tool name.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CorpusType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CorpusType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

FileSearchTool: The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results.

func (FileSearchTool) MarshalJSON

func (s FileSearchTool) MarshalJSON() ([]byte, error)

type GenerateAppResourceRequest added in v0.274.0

type GenerateAppResourceRequest struct {
	// Agent: The agent resource to be used by the LLM assistant, can be empty for
	// generating a new agent.
	Agent *Agent `json:"agent,omitempty"`
	// AppGenerationConfig: Optional. The configuration to be used to generate the
	// agents and tools.
	AppGenerationConfig *GenerateAppResourceRequestAppGenerationConfig `json:"appGenerationConfig,omitempty"`
	// EvaluationGenerationConfig: Optional. The configuration to be used to
	// generate the evaluations.
	EvaluationGenerationConfig *GenerateAppResourceRequestEvaluationGenerationConfig `json:"evaluationGenerationConfig,omitempty"`
	// EvaluationPersonasGenerationConfig: Optional. The configuration to be used
	// to generate the evaluation personas.
	EvaluationPersonasGenerationConfig *GenerateAppResourceRequestEvaluationPersonasGenerationConfig `json:"evaluationPersonasGenerationConfig,omitempty"`
	// HillClimbingFixConfig: Optional. The configuration to be used for hill
	// climbing fixes.
	HillClimbingFixConfig *GenerateAppResourceRequestHillClimbingFixConfig `json:"hillClimbingFixConfig,omitempty"`
	// QualityReportGenerationConfig: Optional. The configuration to be used for
	// quality report generation.
	QualityReportGenerationConfig *GenerateAppResourceRequestQualityReportGenerationConfig `json:"qualityReportGenerationConfig,omitempty"`
	// RefineInstructions: Optional. List of refine instructions to be used to
	// refine the resource.
	RefineInstructions []*GenerateAppResourceRequestRefineInstructions `json:"refineInstructions,omitempty"`
	// Tool: The tool resource to be used by the LLM assistant, can be empty for
	// generating a new tool.
	Tool *Tool `json:"tool,omitempty"`
	// ToolGenerationConfig: Optional. The configuration to be used to generate the
	// tool.
	ToolGenerationConfig *GenerateAppResourceRequestToolGenerationConfig `json:"toolGenerationConfig,omitempty"`
	// Toolset: The toolset resource to be used by the LLM assistant, can be empty
	// for generating a new toolset.
	Toolset *Toolset `json:"toolset,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Agent") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Agent") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateAppResourceRequest: Request message for AgentService.GenerateAppResource.

func (GenerateAppResourceRequest) MarshalJSON added in v0.274.0

func (s GenerateAppResourceRequest) MarshalJSON() ([]byte, error)

type GenerateAppResourceRequestAppGenerationConfig added in v0.274.0

type GenerateAppResourceRequestAppGenerationConfig struct {
	// Context: Optional. The context which describes the requirements of the
	// agents & tools to be generated.
	Context string `json:"context,omitempty"`
	// DatasetId: Optional. The insights dataset to be used to fetch conversation
	// data for generating the agents & tools. Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}`.
	DatasetId string `json:"datasetId,omitempty"`
	// FileContexts: Optional. The files to be used as context.
	FileContexts []*FileContext `json:"fileContexts,omitempty"`
	// GcsLocation: Optional. The Cloud Storage location to store the generated
	// question answer data to be used by the Datastore tool. This data is
	// generated only when using conversation data as an input source. The location
	// must be in the same project as the app. Format: `gs://...`.
	GcsLocation string `json:"gcsLocation,omitempty"`
	// GenerateEvaluations: Optional. Whether to generate the evaluations for the
	// app. If true, the provided context will be used to generate the evaluations
	// data.
	GenerateEvaluations bool `json:"generateEvaluations,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Context") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Context") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateAppResourceRequestAppGenerationConfig: The configuration to be used to generate the app.

func (GenerateAppResourceRequestAppGenerationConfig) MarshalJSON added in v0.274.0

type GenerateAppResourceRequestEvaluationGenerationConfig added in v0.274.0

type GenerateAppResourceRequestEvaluationGenerationConfig struct {
	// DatasetId: Optional. The insights dataset to be used to fetch conversation
	// data for generating the evaluations. Format:
	// `projects/{project}/locations/{location}/datasets/{dataset}`.
	DatasetId string `json:"datasetId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DatasetId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DatasetId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateAppResourceRequestEvaluationGenerationConfig: The configuration to be used to generate the evaluations.

func (GenerateAppResourceRequestEvaluationGenerationConfig) MarshalJSON added in v0.274.0

type GenerateAppResourceRequestEvaluationPersonasGenerationConfig added in v0.274.0

type GenerateAppResourceRequestEvaluationPersonasGenerationConfig struct {
}

GenerateAppResourceRequestEvaluationPersonasGenerationConfig: The configuration to be used to generate the evaluation personas.

type GenerateAppResourceRequestHillClimbingFixConfig added in v0.274.0

type GenerateAppResourceRequestHillClimbingFixConfig struct {
	// QualityReport: Required. The quality report used to inform the instruction
	// following fix.
	QualityReport *QualityReport `json:"qualityReport,omitempty"`
	// ForceSendFields is a list of field names (e.g. "QualityReport") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "QualityReport") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateAppResourceRequestHillClimbingFixConfig: The configuration to be used for hill climbing fixes.

func (GenerateAppResourceRequestHillClimbingFixConfig) MarshalJSON added in v0.274.0

type GenerateAppResourceRequestQualityReportGenerationConfig added in v0.274.0

type GenerateAppResourceRequestQualityReportGenerationConfig struct {
	// EvaluationRun: Required. The evaluation run used to inform quality report
	// analysis.
	EvaluationRun string `json:"evaluationRun,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EvaluationRun") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EvaluationRun") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateAppResourceRequestQualityReportGenerationConfig: The configuration to be used for quality report generation.

func (GenerateAppResourceRequestQualityReportGenerationConfig) MarshalJSON added in v0.274.0

type GenerateAppResourceRequestRefineInstructions added in v0.274.0

type GenerateAppResourceRequestRefineInstructions struct {
	// EndIndex: Required. The last character (inclusive) of the text to refine.
	EndIndex int64 `json:"endIndex,omitempty,string"`
	// FieldMask: Required. The field of the resource being refined. Only one field
	// is allowed per RefineInstructions. If refining agent instructions, the field
	// mask should be "instructions".
	FieldMask string `json:"fieldMask,omitempty"`
	// Instructions: Required. The instructions to refine the resource.
	Instructions string `json:"instructions,omitempty"`
	// StartIndex: Required. The first character (inclusive) of the text to refine.
	StartIndex int64 `json:"startIndex,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "EndIndex") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EndIndex") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateAppResourceRequestRefineInstructions: The instructions to be used to refine a part of the resource. The part of the resource can be specified with a start index, end index and a field mask. For example, if you want to refine a part of the agent instructions you can specify the index of the first character of the instructions, the index of the last character of the instructions and the field mask as "instructions".

func (GenerateAppResourceRequestRefineInstructions) MarshalJSON added in v0.274.0

type GenerateAppResourceRequestToolGenerationConfig added in v0.274.0

type GenerateAppResourceRequestToolGenerationConfig struct {
	// Context: Optional. The context which describes the tool to be generated.
	// This can be empty if the tool request & response are provided.
	Context string `json:"context,omitempty"`
	// FileContexts: Optional. The files to be used as context.
	FileContexts []*FileContext `json:"fileContexts,omitempty"`
	// OpenApiToolsetGenerationConfig: Optional. The configuration to be used to
	// generate an Open API schema.
	OpenApiToolsetGenerationConfig *GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig `json:"openApiToolsetGenerationConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Context") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Context") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateAppResourceRequestToolGenerationConfig: The configuration to be used to generate a tool.

func (GenerateAppResourceRequestToolGenerationConfig) MarshalJSON added in v0.274.0

type GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig added in v0.274.0

type GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig struct {
	// OperationGenerationConfigs: Required. The list of operations to be added to
	// the Open API schema.
	OperationGenerationConfigs []*GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig `json:"operationGenerationConfigs,omitempty"`
	// Uri: Required. The base uri of the tool.
	Uri string `json:"uri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "OperationGenerationConfigs")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "OperationGenerationConfigs") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig:

The configuration to be used to generate an Open API schema.

func (GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfig) MarshalJSON added in v0.274.0

type GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig added in v0.274.0

type GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig struct {
	// Method: Required. The uri of the tool. This should include query and path
	// parameters if any.
	Method string `json:"method,omitempty"`
	// Path: Required. The path of the tool to be appended to the base uri. This
	// should include query and path parameters if any.
	Path string `json:"path,omitempty"`
	// RequestJson: Required. A sample request to the tool in JSON format. Skip if
	// the tool does not support request body.
	RequestJson string `json:"requestJson,omitempty"`
	// ResponseJson: Required. A sample response from the tool in JSON format.
	ResponseJson string `json:"responseJson,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Method") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Method") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigO perationGenerationConfig: The configuration to be used to generate an operation in the Open API schema.

func (GenerateAppResourceRequestToolGenerationConfigOpenApiToolsetGenerationConfigOperationGenerationConfig) MarshalJSON added in v0.274.0

type GenerateAppResourceResponse

type GenerateAppResourceResponse struct {
	// Agent: Agent generated by the LLM assistant.
	Agent *Agent `json:"agent,omitempty"`
	// AppResources: The app resources generated by the LLM assistant.
	AppResources *GenerateAppResourceResponseAppResources `json:"appResources,omitempty"`
	// AppSnapshot: App snapshot generated by the LLM assistant. This snapshot
	// contains the app, agents & tools generated by the LLM assistant.
	AppSnapshot *AppSnapshot `json:"appSnapshot,omitempty"`
	// Evaluations: Evaluations generated by the LLM assistant.
	Evaluations *GenerateAppResourceResponseEvaluations `json:"evaluations,omitempty"`
	// GenerateResultInfo: Additional information about the generated result.
	GenerateResultInfo *GenerateAppResourceResponseGenerateResultInfo `json:"generateResultInfo,omitempty"`
	// QualityReport: The quality report generated by the LLM assistant.
	QualityReport *QualityReport `json:"qualityReport,omitempty"`
	// Tools: The list of tools generated by the LLM assistant.
	Tools *GenerateAppResourceResponseTools `json:"tools,omitempty"`
	// Toolset: Toolset generated by the LLM assistant. Supports Open API toolset
	// schema generation.
	Toolset *Toolset `json:"toolset,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Agent") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Agent") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateAppResourceResponse: Response message for AgentService.GenerateAppResource.

func (GenerateAppResourceResponse) MarshalJSON

func (s GenerateAppResourceResponse) MarshalJSON() ([]byte, error)

type GenerateAppResourceResponseAppResources

type GenerateAppResourceResponseAppResources struct {
	// AppSnapshot: The app snapshot generated by the LLM assistant. This snapshot
	// contains the app, agents & tools generated by the LLM assistant.
	AppSnapshot *AppSnapshot `json:"appSnapshot,omitempty"`
	// Evaluations: The list of evaluations generated by the LLM assistant.
	Evaluations []*Evaluation `json:"evaluations,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AppSnapshot") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppSnapshot") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateAppResourceResponseAppResources: The list of app resources generated by the LLM assistant.

func (GenerateAppResourceResponseAppResources) MarshalJSON

func (s GenerateAppResourceResponseAppResources) MarshalJSON() ([]byte, error)

type GenerateAppResourceResponseEvaluations

type GenerateAppResourceResponseEvaluations struct {
	// Evaluations: The list of generated evaluations.
	Evaluations []*Evaluation `json:"evaluations,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Evaluations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Evaluations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateAppResourceResponseEvaluations: The list of evaluations generated by the LLM assistant.

func (GenerateAppResourceResponseEvaluations) MarshalJSON

func (s GenerateAppResourceResponseEvaluations) MarshalJSON() ([]byte, error)

type GenerateAppResourceResponseGenerateResultInfo

type GenerateAppResourceResponseGenerateResultInfo struct {
	// Explanation: An explanation of the changes in the generated resource.
	Explanation string `json:"explanation,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Explanation") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Explanation") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateAppResourceResponseGenerateResultInfo: This provides additional information about the generated result.

func (GenerateAppResourceResponseGenerateResultInfo) MarshalJSON

type GenerateAppResourceResponseTools

type GenerateAppResourceResponseTools struct {
	// Tools: The list of tools generated by the LLM assistant.
	Tools []*Tool `json:"tools,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Tools") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Tools") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateAppResourceResponseTools: The list of tools generated by the LLM assistant.

func (GenerateAppResourceResponseTools) MarshalJSON

func (s GenerateAppResourceResponseTools) MarshalJSON() ([]byte, error)

type GenerateChatTokenRequest

type GenerateChatTokenRequest struct {
	// Deployment: Required. The deployment of the app to use for the session.
	// Format:
	// projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
	Deployment string `json:"deployment,omitempty"`
	// LiveHandoffEnabled: Optional. Indicates if live handoff is enabled for the
	// session.
	LiveHandoffEnabled bool `json:"liveHandoffEnabled,omitempty"`
	// RecaptchaToken: Optional. The reCAPTCHA token generated by the client-side
	// chat widget.
	RecaptchaToken string `json:"recaptchaToken,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Deployment") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Deployment") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateChatTokenRequest: Request message for WidgetService.GenerateChatToken.

func (GenerateChatTokenRequest) MarshalJSON

func (s GenerateChatTokenRequest) MarshalJSON() ([]byte, error)

type GenerateChatTokenResponse

type GenerateChatTokenResponse struct {
	// ChatToken: The session scoped token for chat widget to authenticate with
	// Session APIs.
	ChatToken string `json:"chatToken,omitempty"`
	// ExpireTime: The time at which the chat token expires.
	ExpireTime string `json:"expireTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ChatToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ChatToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateChatTokenResponse: Response message for WidgetService.GenerateChatToken.

func (GenerateChatTokenResponse) MarshalJSON

func (s GenerateChatTokenResponse) MarshalJSON() ([]byte, error)

type GenerateEvaluationOperationMetadata

type GenerateEvaluationOperationMetadata struct {
}

GenerateEvaluationOperationMetadata: Operation metadata for EvaluationService.GenerateEvaluation.

type GenerateEvaluationRequest

type GenerateEvaluationRequest struct {
	// Source: Optional. Indicate the source of the conversation. If not set, all
	// sources will be searched.
	//
	// Possible values:
	//   "SOURCE_UNSPECIFIED" - Unspecified source.
	//   "LIVE" - The conversation is from the live end user.
	//   "SIMULATOR" - The conversation is from the simulator.
	//   "EVAL" - The conversation is from the evaluation.
	//   "AGENT_TOOL" - The conversation is from an agent tool. Agent tool runs the
	// agent in a separate session, which is persisted for testing and debugging
	// purposes.
	Source string `json:"source,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Source") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Source") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateEvaluationRequest: Request message for EvaluationService.GenerateEvaluation.

func (GenerateEvaluationRequest) MarshalJSON

func (s GenerateEvaluationRequest) MarshalJSON() ([]byte, error)

type GoogleSearchSuggestions

type GoogleSearchSuggestions struct {
	// Htmls: Compliant HTML and CSS styling for search suggestions. The provided
	// HTML and CSS automatically adapts to your device settings, displaying in
	// either light or dark mode indicated by `@media(prefers-color-scheme)`.
	Htmls []string `json:"htmls,omitempty"`
	// WebSearchQueries: List of queries used to perform the google search along
	// with the search result URIs forming the search suggestions.
	WebSearchQueries []*WebSearchQuery `json:"webSearchQueries,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Htmls") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Htmls") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleSearchSuggestions: Search suggestions from Google Search Tool.

func (GoogleSearchSuggestions) MarshalJSON

func (s GoogleSearchSuggestions) MarshalJSON() ([]byte, error)

type GoogleSearchTool

type GoogleSearchTool struct {
	// ContextUrls: Optional. Content will be fetched directly from these URLs for
	// context and grounding. Example: "https://example.com/path.html". A maximum
	// of 20 URLs are allowed.
	ContextUrls []string `json:"contextUrls,omitempty"`
	// Description: Optional. Description of the tool's purpose.
	Description string `json:"description,omitempty"`
	// ExcludeDomains: Optional. List of domains to be excluded from the search
	// results. Example: "example.com". A maximum of 2000 domains can be excluded.
	ExcludeDomains []string `json:"excludeDomains,omitempty"`
	// Name: Required. The name of the tool.
	Name string `json:"name,omitempty"`
	// PreferredDomains: Optional. Specifies domains to restrict search results to.
	// Example: "example.com", "another.site". A maximum of 20 domains can be
	// specified.
	PreferredDomains []string `json:"preferredDomains,omitempty"`
	// PromptConfig: Optional. Prompt instructions passed to planner on how the
	// search results should be processed for text and voice.
	PromptConfig *GoogleSearchToolPromptConfig `json:"promptConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ContextUrls") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ContextUrls") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleSearchTool: Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search.

func (GoogleSearchTool) MarshalJSON

func (s GoogleSearchTool) MarshalJSON() ([]byte, error)

type GoogleSearchToolPromptConfig added in v0.267.0

type GoogleSearchToolPromptConfig struct {
	// TextPrompt: Optional. Defines the prompt used for the system instructions
	// when interacting with the agent in chat conversations. If not set, default
	// prompt will be used.
	TextPrompt string `json:"textPrompt,omitempty"`
	// VoicePrompt: Optional. Defines the prompt used for the system instructions
	// when interacting with the agent in voice conversations. If not set, default
	// prompt will be used.
	VoicePrompt string `json:"voicePrompt,omitempty"`
	// ForceSendFields is a list of field names (e.g. "TextPrompt") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "TextPrompt") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleSearchToolPromptConfig: Prompt settings used by the model when processing or summarizing the google search results.

func (GoogleSearchToolPromptConfig) MarshalJSON added in v0.267.0

func (s GoogleSearchToolPromptConfig) MarshalJSON() ([]byte, error)

type Guardrail

type Guardrail struct {
	// Action: Optional. Action to take when the guardrail is triggered.
	Action *TriggerAction `json:"action,omitempty"`
	// CodeCallback: Optional. Guardrail that potentially blocks the conversation
	// based on the result of the callback execution.
	CodeCallback *GuardrailCodeCallback `json:"codeCallback,omitempty"`
	// ContentFilter: Optional. Guardrail that bans certain content from being used
	// in the conversation.
	ContentFilter *GuardrailContentFilter `json:"contentFilter,omitempty"`
	// CreateTime: Output only. Timestamp when the guardrail was created.
	CreateTime string `json:"createTime,omitempty"`
	// Description: Optional. Description of the guardrail.
	Description string `json:"description,omitempty"`
	// DisplayName: Required. Display name of the guardrail.
	DisplayName string `json:"displayName,omitempty"`
	// Enabled: Optional. Whether the guardrail is enabled.
	Enabled bool `json:"enabled,omitempty"`
	// Etag: Etag used to ensure the object hasn't changed during a
	// read-modify-write operation. If the etag is empty, the update will overwrite
	// any concurrent changes.
	Etag string `json:"etag,omitempty"`
	// LlmPolicy: Optional. Guardrail that blocks the conversation if the LLM
	// response is considered violating the policy based on the LLM classification.
	LlmPolicy *GuardrailLlmPolicy `json:"llmPolicy,omitempty"`
	// LlmPromptSecurity: Optional. Guardrail that blocks the conversation if the
	// prompt is considered unsafe based on the LLM classification.
	LlmPromptSecurity *GuardrailLlmPromptSecurity `json:"llmPromptSecurity,omitempty"`
	// ModelSafety: Optional. Guardrail that blocks the conversation if the LLM
	// response is considered unsafe based on the model safety settings.
	ModelSafety *GuardrailModelSafety `json:"modelSafety,omitempty"`
	// Name: Identifier. The unique identifier of the guardrail. Format:
	// `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
	Name string `json:"name,omitempty"`
	// UpdateTime: Output only. Timestamp when the guardrail was last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Action") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Action") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Guardrail: Guardrail contains a list of checks and balances to keep the agents safe and secure.

func (Guardrail) MarshalJSON

func (s Guardrail) MarshalJSON() ([]byte, error)

type GuardrailCodeCallback

type GuardrailCodeCallback struct {
	// AfterAgentCallback: Optional. The callback to execute after the agent is
	// called. Each callback function is expected to return a structure (e.g., a
	// dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'.
	// - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt
	// further processing.
	AfterAgentCallback *Callback `json:"afterAgentCallback,omitempty"`
	// AfterModelCallback: Optional. The callback to execute after the model is
	// called. If there are multiple calls to the model, the callback will be
	// executed multiple times. Each callback function is expected to return a
	// structure (e.g., a dict or object) containing at least: - 'decision': Either
	// 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER'
	// decision may halt further processing.
	AfterModelCallback *Callback `json:"afterModelCallback,omitempty"`
	// BeforeAgentCallback: Optional. The callback to execute before the agent is
	// called. Each callback function is expected to return a structure (e.g., a
	// dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'.
	// - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt
	// further processing.
	BeforeAgentCallback *Callback `json:"beforeAgentCallback,omitempty"`
	// BeforeModelCallback: Optional. The callback to execute before the model is
	// called. If there are multiple calls to the model, the callback will be
	// executed multiple times. Each callback function is expected to return a
	// structure (e.g., a dict or object) containing at least: - 'decision': Either
	// 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER'
	// decision may halt further processing.
	BeforeModelCallback *Callback `json:"beforeModelCallback,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AfterAgentCallback") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AfterAgentCallback") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GuardrailCodeCallback: Guardrail that blocks the conversation based on the code callbacks provided.

func (GuardrailCodeCallback) MarshalJSON

func (s GuardrailCodeCallback) MarshalJSON() ([]byte, error)

type GuardrailContentFilter

type GuardrailContentFilter struct {
	// BannedContents: Optional. List of banned phrases. Applies to both user
	// inputs and agent responses.
	BannedContents []string `json:"bannedContents,omitempty"`
	// BannedContentsInAgentResponse: Optional. List of banned phrases. Applies
	// only to agent responses.
	BannedContentsInAgentResponse []string `json:"bannedContentsInAgentResponse,omitempty"`
	// BannedContentsInUserInput: Optional. List of banned phrases. Applies only to
	// user inputs.
	BannedContentsInUserInput []string `json:"bannedContentsInUserInput,omitempty"`
	// DisregardDiacritics: Optional. If true, diacritics are ignored during
	// matching.
	DisregardDiacritics bool `json:"disregardDiacritics,omitempty"`
	// MatchType: Required. Match type for the content filter.
	//
	// Possible values:
	//   "MATCH_TYPE_UNSPECIFIED" - Match type is not specified.
	//   "SIMPLE_STRING_MATCH" - Content is matched for substrings character by
	// character.
	//   "WORD_BOUNDARY_STRING_MATCH" - Content only matches if the pattern found
	// in the text is surrounded by word delimiters. Banned phrases can also
	// contain word delimiters.
	//   "REGEXP_MATCH" - Content is matched using regular expression syntax.
	MatchType string `json:"matchType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BannedContents") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BannedContents") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GuardrailContentFilter: Guardrail that bans certain content from being used in the conversation.

func (GuardrailContentFilter) MarshalJSON

func (s GuardrailContentFilter) MarshalJSON() ([]byte, error)

type GuardrailLlmPolicy

type GuardrailLlmPolicy struct {
	// AllowShortUtterance: Optional. By default, the LLM policy check is bypassed
	// for short utterances. Enabling this setting applies the policy check to all
	// utterances, including those that would normally be skipped.
	AllowShortUtterance bool `json:"allowShortUtterance,omitempty"`
	// FailOpen: Optional. If an error occurs during the policy check, fail open
	// and do not trigger the guardrail.
	FailOpen bool `json:"failOpen,omitempty"`
	// MaxConversationMessages: Optional. When checking this policy, consider the
	// last 'n' messages in the conversation. When not set a default value of 10
	// will be used.
	MaxConversationMessages int64 `json:"maxConversationMessages,omitempty"`
	// ModelSettings: Optional. Model settings.
	ModelSettings *ModelSettings `json:"modelSettings,omitempty"`
	// PolicyScope: Required. Defines when to apply the policy check during the
	// conversation. If set to `POLICY_SCOPE_UNSPECIFIED`, the policy will be
	// applied to the user input. When applying the policy to the agent response,
	// additional latency will be introduced before the agent can respond.
	//
	// Possible values:
	//   "POLICY_SCOPE_UNSPECIFIED" - Policy scope is not specified.
	//   "USER_QUERY" - Policy check is triggered on user input.
	//   "AGENT_RESPONSE" - Policy check is triggered on agent response. Applying
	// this policy scope will introduce additional latency before the agent can
	// respond.
	//   "USER_QUERY_AND_AGENT_RESPONSE" - Policy check is triggered on both user
	// input and agent response. Applying this policy scope will introduce
	// additional latency before the agent can respond.
	PolicyScope string `json:"policyScope,omitempty"`
	// Prompt: Required. Policy prompt.
	Prompt string `json:"prompt,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowShortUtterance") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllowShortUtterance") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GuardrailLlmPolicy: Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification.

func (GuardrailLlmPolicy) MarshalJSON

func (s GuardrailLlmPolicy) MarshalJSON() ([]byte, error)

type GuardrailLlmPromptSecurity

type GuardrailLlmPromptSecurity struct {
	// CustomPolicy: Optional. Use a user-defined LlmPolicy to configure the
	// security guardrail.
	CustomPolicy *GuardrailLlmPolicy `json:"customPolicy,omitempty"`
	// DefaultSettings: Optional. Use the system's predefined default security
	// settings. To select this mode, include an empty 'default_settings' message
	// in the request. The 'default_prompt_template' field within will be populated
	// by the server in the response.
	DefaultSettings *GuardrailLlmPromptSecurityDefaultSecuritySettings `json:"defaultSettings,omitempty"`
	// FailOpen: Optional. Determines the behavior when the guardrail encounters an
	// LLM error. - If true: the guardrail is bypassed. - If false (default): the
	// guardrail triggers/blocks. Note: If a custom policy is provided, this field
	// is ignored in favor of the policy's 'fail_open' configuration.
	FailOpen bool `json:"failOpen,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CustomPolicy") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CustomPolicy") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GuardrailLlmPromptSecurity: Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification.

func (GuardrailLlmPromptSecurity) MarshalJSON

func (s GuardrailLlmPromptSecurity) MarshalJSON() ([]byte, error)

type GuardrailLlmPromptSecurityDefaultSecuritySettings

type GuardrailLlmPromptSecurityDefaultSecuritySettings struct {
	// DefaultPromptTemplate: Output only. The default prompt template used by the
	// system. This field is for display purposes to show the user what prompt the
	// system uses by default. It is OUTPUT_ONLY.
	DefaultPromptTemplate string `json:"defaultPromptTemplate,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DefaultPromptTemplate") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DefaultPromptTemplate") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GuardrailLlmPromptSecurityDefaultSecuritySettings: Configuration for default system security settings.

func (GuardrailLlmPromptSecurityDefaultSecuritySettings) MarshalJSON

type GuardrailModelSafety

type GuardrailModelSafety struct {
	// SafetySettings: Required. List of safety settings.
	SafetySettings []*GuardrailModelSafetySafetySetting `json:"safetySettings,omitempty"`
	// ForceSendFields is a list of field names (e.g. "SafetySettings") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "SafetySettings") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GuardrailModelSafety: Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe.

func (GuardrailModelSafety) MarshalJSON

func (s GuardrailModelSafety) MarshalJSON() ([]byte, error)

type GuardrailModelSafetySafetySetting

type GuardrailModelSafetySafetySetting struct {
	// Category: Required. The harm category.
	//
	// Possible values:
	//   "HARM_CATEGORY_UNSPECIFIED" - The harm category is unspecified.
	//   "HARM_CATEGORY_HATE_SPEECH" - The harm category is hate speech.
	//   "HARM_CATEGORY_DANGEROUS_CONTENT" - The harm category is dangerous
	// content.
	//   "HARM_CATEGORY_HARASSMENT" - The harm category is harassment.
	//   "HARM_CATEGORY_SEXUALLY_EXPLICIT" - The harm category is sexually explicit
	// content.
	Category string `json:"category,omitempty"`
	// Threshold: Required. The harm block threshold.
	//
	// Possible values:
	//   "HARM_BLOCK_THRESHOLD_UNSPECIFIED" - Unspecified harm block threshold.
	//   "BLOCK_LOW_AND_ABOVE" - Block low threshold and above (i.e. block more).
	//   "BLOCK_MEDIUM_AND_ABOVE" - Block medium threshold and above.
	//   "BLOCK_ONLY_HIGH" - Block only high threshold (i.e. block less).
	//   "BLOCK_NONE" - Block none.
	//   "OFF" - Turn off the safety filter.
	Threshold string `json:"threshold,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Category") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Category") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GuardrailModelSafetySafetySetting: Safety setting.

func (GuardrailModelSafetySafetySetting) MarshalJSON

func (s GuardrailModelSafetySafetySetting) MarshalJSON() ([]byte, error)

type Image

type Image struct {
	// Data: Required. Raw bytes of the image.
	Data string `json:"data,omitempty"`
	// MimeType: Required. The IANA standard MIME type of the source data.
	// Supported image types includes: * image/png * image/jpeg * image/webp
	MimeType string `json:"mimeType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Data") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Data") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Image: Represents an image input or output in the conversation.

func (Image) MarshalJSON

func (s Image) MarshalJSON() ([]byte, error)

type ImportAppRequest

type ImportAppRequest struct {
	// AppContent: Raw bytes representing the compressed zip file with the app
	// folder structure.
	AppContent string `json:"appContent,omitempty"`
	// AppId: Optional. The ID to use for the imported app. * If not specified, a
	// unique ID will be automatically assigned for the app. * Otherwise, the
	// imported app will use this ID as the final component of its resource name.
	// If an app with the same ID already exists at the specified location in the
	// project, the content of the existing app will be replaced.
	AppId string `json:"appId,omitempty"`
	// DisplayName: Optional. The display name of the app to import. * If the app
	// is created on import, and the display name is specified, the imported app
	// will use this display name. If a conflict is detected with an existing app,
	// a timestamp will be appended to the display name to make it unique. * If the
	// app is a reimport, this field should not be set. Providing a display name
	// during reimport will result in an INVALID_ARGUMENT error.
	DisplayName string `json:"displayName,omitempty"`
	// GcsUri: The Google Cloud Storage (https://cloud.google.com/storage/docs/)
	// URI from which to import app. The format of this URI must be `gs:///`.
	GcsUri string `json:"gcsUri,omitempty"`
	// IgnoreAppLock: Optional. Flag for overriding the app lock during import. If
	// set to true, the import process will ignore the app lock.
	IgnoreAppLock bool `json:"ignoreAppLock,omitempty"`
	// ImportOptions: Optional. Options governing the import process for the app.
	ImportOptions *ImportAppRequestImportOptions `json:"importOptions,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AppContent") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppContent") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImportAppRequest: Request message for AgentService.ImportApp.

func (ImportAppRequest) MarshalJSON

func (s ImportAppRequest) MarshalJSON() ([]byte, error)

type ImportAppRequestImportOptions

type ImportAppRequestImportOptions struct {
	// ConflictResolutionStrategy: Optional. The strategy to use when resolving
	// conflicts during import.
	//
	// Possible values:
	//   "CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED" - The conflict resolution
	// strategy is unspecified.
	//   "REPLACE" - Replace existing data with imported data. If an app with the
	// same `app_id` already exists, its content will be updated based on the
	// imported app. - Resources (App, Agents, Tools, Examples, Guardrails,
	// Toolsets) in the imported app that have the same display name as existing
	// resources will overwrite the existing ones. - Imported resources with new
	// display names will be created. - Existing resources that do not have a
	// matching display name in the imported app will remain untouched.
	//   "OVERWRITE" - Overwrite existing data with imported data. If an app with
	// the same `app_id` already exists, its content will be overwritten with the
	// imported app. - Existing resources (Agents, Tools, Examples, Guardrails,
	// Toolsets) in the app will be deleted. - Imported resources will be created
	// as new resources.
	ConflictResolutionStrategy string `json:"conflictResolutionStrategy,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConflictResolutionStrategy")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConflictResolutionStrategy") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImportAppRequestImportOptions: Configuration options for the app import process. These options control how the import behaves, particularly when conflicts arise with existing app data.

func (ImportAppRequestImportOptions) MarshalJSON

func (s ImportAppRequestImportOptions) MarshalJSON() ([]byte, error)

type ImportAppResponse

type ImportAppResponse struct {
	// Name: The resource name of the app that was imported.
	Name string `json:"name,omitempty"`
	// Warnings: Warning messages generated during the import process. If errors
	// occur for specific resources, they will not be included in the imported app
	// and the error will be mentioned here.
	Warnings []string `json:"warnings,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImportAppResponse: Response message for AgentService.ImportApp.

func (ImportAppResponse) MarshalJSON

func (s ImportAppResponse) MarshalJSON() ([]byte, error)

type ImportEvaluationsOperationMetadata

type ImportEvaluationsOperationMetadata struct {
	// CreateTime: Output only. The time the operation was created.
	CreateTime string `json:"createTime,omitempty"`
	// EndTime: Output only. The time the operation finished running.
	EndTime string `json:"endTime,omitempty"`
	// StatusMessage: Output only. Human-readable status of the operation, if any.
	StatusMessage string `json:"statusMessage,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImportEvaluationsOperationMetadata: Represents the metadata of the long-running operation for EvaluationService.ImportEvaluations.

func (ImportEvaluationsOperationMetadata) MarshalJSON

func (s ImportEvaluationsOperationMetadata) MarshalJSON() ([]byte, error)

type ImportEvaluationsRequest

type ImportEvaluationsRequest struct {
	// ConversationList: The conversations to import the evaluations from.
	ConversationList *ImportEvaluationsRequestConversationList `json:"conversationList,omitempty"`
	// CsvContent: Raw bytes representing the csv file with the evaluations
	// structure.
	CsvContent string `json:"csvContent,omitempty"`
	// GcsUri: The Google Cloud Storage (https://cloud.google.com/storage/docs/)
	// URI from which to import evaluations. The format of this URI must be
	// `gs:///`.
	GcsUri string `json:"gcsUri,omitempty"`
	// ImportOptions: Optional. Options governing the import process for the
	// evaluations.
	ImportOptions *ImportEvaluationsRequestImportOptions `json:"importOptions,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConversationList") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConversationList") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImportEvaluationsRequest: Request message for EvaluationService.ImportEvaluations.

func (ImportEvaluationsRequest) MarshalJSON

func (s ImportEvaluationsRequest) MarshalJSON() ([]byte, error)

type ImportEvaluationsRequestConversationList

type ImportEvaluationsRequestConversationList struct {
	// Conversations: Optional. Conversation resource names.
	Conversations []string `json:"conversations,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Conversations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Conversations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImportEvaluationsRequestConversationList: A list of conversation resource names.

func (ImportEvaluationsRequestConversationList) MarshalJSON

type ImportEvaluationsRequestImportOptions

type ImportEvaluationsRequestImportOptions struct {
	// ConflictResolutionStrategy: Optional. The strategy to use when resolving
	// conflicts during import.
	//
	// Possible values:
	//   "CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED" - The conflict resolution
	// strategy is unspecified.
	//   "OVERWRITE" - Overwrite the existing evaluation with the new one.
	//   "SKIP" - Keep the existing evaluation and skip the new one.
	//   "DUPLICATE" - Keep the existing evaluation and duplicate the new one as a
	// new evaluation.
	ConflictResolutionStrategy string `json:"conflictResolutionStrategy,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConflictResolutionStrategy")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConflictResolutionStrategy") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImportEvaluationsRequestImportOptions: Configuration options for the evaluation import process. These options control how the import behaves, particularly when conflicts arise with existing evaluations data.

func (ImportEvaluationsRequestImportOptions) MarshalJSON

func (s ImportEvaluationsRequestImportOptions) MarshalJSON() ([]byte, error)

type ImportEvaluationsResponse

type ImportEvaluationsResponse struct {
	// ErrorMessages: Optional. A list of error messages associated with
	// evaluations that failed to be imported.
	ErrorMessages []string `json:"errorMessages,omitempty"`
	// EvaluationResultImportFailureCount: The number of evaluation results that
	// either failed to import entirely or completed import with one or more
	// errors.
	EvaluationResultImportFailureCount int64 `json:"evaluationResultImportFailureCount,omitempty"`
	// EvaluationResults: The list of evaluation results that were imported into
	// the app.
	EvaluationResults []*EvaluationResult `json:"evaluationResults,omitempty"`
	// EvaluationRunImportFailureCount: The number of evaluation runs that either
	// failed to import entirely or completed import with one or more errors.
	EvaluationRunImportFailureCount int64 `json:"evaluationRunImportFailureCount,omitempty"`
	// EvaluationRuns: The list of evaluation runs that were imported into the app.
	EvaluationRuns []*EvaluationRun `json:"evaluationRuns,omitempty"`
	// Evaluations: The list of evaluations that were imported into the app.
	Evaluations []*Evaluation `json:"evaluations,omitempty"`
	// ImportFailureCount: The number of evaluations that either failed to import
	// entirely or completed import with one or more errors.
	ImportFailureCount int64 `json:"importFailureCount,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ErrorMessages") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ErrorMessages") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImportEvaluationsResponse: Response message for EvaluationService.ImportEvaluations.

func (ImportEvaluationsResponse) MarshalJSON

func (s ImportEvaluationsResponse) MarshalJSON() ([]byte, error)

type InputAudioConfig

type InputAudioConfig struct {
	// AudioEncoding: Required. The encoding of the input audio data.
	//
	// Possible values:
	//   "AUDIO_ENCODING_UNSPECIFIED" - Unspecified audio encoding.
	//   "LINEAR16" - 16-bit linear PCM audio encoding.
	//   "MULAW" - 8-bit samples that compand 14-bit audio samples using G.711
	// PCMU/mu-law.
	//   "ALAW" - 8-bit samples that compand 14-bit audio samples using G.711
	// PCMU/A-law.
	AudioEncoding string `json:"audioEncoding,omitempty"`
	// NoiseSuppressionLevel: Optional. Whether to enable noise suppression on the
	// input audio. Available values are "low", "moderate", "high", "very_high".
	NoiseSuppressionLevel string `json:"noiseSuppressionLevel,omitempty"`
	// SampleRateHertz: Required. The sample rate (in Hertz) of the input audio
	// data.
	SampleRateHertz int64 `json:"sampleRateHertz,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AudioEncoding") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AudioEncoding") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InputAudioConfig: InputAudioConfig configures how the CES agent should interpret the incoming audio data.

func (InputAudioConfig) MarshalJSON

func (s InputAudioConfig) MarshalJSON() ([]byte, error)

type LanguageSettings

type LanguageSettings struct {
	// DefaultLanguageCode: Optional. The default language code of the app.
	DefaultLanguageCode string `json:"defaultLanguageCode,omitempty"`
	// EnableMultilingualSupport: Optional. Enables multilingual support. If true,
	// agents in the app will use pre-built instructions to improve handling of
	// multilingual input.
	EnableMultilingualSupport bool `json:"enableMultilingualSupport,omitempty"`
	// FallbackAction: Optional. Deprecated: This feature is no longer supported.
	// Use `enable_multilingual_support` instead to improve handling of
	// multilingual input. The action to perform when an agent receives input in an
	// unsupported language. This can be a predefined action or a custom tool call.
	// Valid values are: - A tool's full resource name, which triggers a specific
	// tool execution. - A predefined system action, such as "escalate" or "exit",
	// which triggers an EndSession signal with corresponding metadata to terminate
	// the conversation.
	FallbackAction string `json:"fallbackAction,omitempty"`
	// SupportedLanguageCodes: Optional. List of languages codes supported by the
	// app, in addition to the `default_language_code`.
	SupportedLanguageCodes []string `json:"supportedLanguageCodes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DefaultLanguageCode") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DefaultLanguageCode") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

LanguageSettings: Language settings of the app.

func (LanguageSettings) MarshalJSON

func (s LanguageSettings) MarshalJSON() ([]byte, error)

type LatencyReport

type LatencyReport struct {
	// CallbackLatencies: Output only. Unordered list. Latency metrics for each
	// callback.
	CallbackLatencies []*LatencyReportCallbackLatency `json:"callbackLatencies,omitempty"`
	// GuardrailLatencies: Output only. Unordered list. Latency metrics for each
	// guardrail.
	GuardrailLatencies []*LatencyReportGuardrailLatency `json:"guardrailLatencies,omitempty"`
	// LlmCallLatencies: Output only. Unordered list. Latency metrics for each LLM
	// call.
	LlmCallLatencies []*LatencyReportLlmCallLatency `json:"llmCallLatencies,omitempty"`
	// SessionCount: Output only. The total number of sessions considered in the
	// latency report.
	SessionCount int64 `json:"sessionCount,omitempty"`
	// ToolLatencies: Output only. Unordered list. Latency metrics for each tool.
	ToolLatencies []*LatencyReportToolLatency `json:"toolLatencies,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CallbackLatencies") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CallbackLatencies") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

LatencyReport: Latency report for the evaluation run.

func (LatencyReport) MarshalJSON

func (s LatencyReport) MarshalJSON() ([]byte, error)

type LatencyReportCallbackLatency

type LatencyReportCallbackLatency struct {
	// LatencyMetrics: Output only. The latency metrics for the callback.
	LatencyMetrics *LatencyReportLatencyMetrics `json:"latencyMetrics,omitempty"`
	// Stage: Output only. The stage of the callback.
	Stage string `json:"stage,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LatencyMetrics") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LatencyMetrics") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

LatencyReportCallbackLatency: Latency metrics for a single callback.

func (LatencyReportCallbackLatency) MarshalJSON

func (s LatencyReportCallbackLatency) MarshalJSON() ([]byte, error)

type LatencyReportGuardrailLatency

type LatencyReportGuardrailLatency struct {
	// Guardrail: Output only. The name of the guardrail. Format:
	// `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`.
	Guardrail string `json:"guardrail,omitempty"`
	// GuardrailDisplayName: Output only. The display name of the guardrail.
	GuardrailDisplayName string `json:"guardrailDisplayName,omitempty"`
	// LatencyMetrics: Output only. The latency metrics for the guardrail.
	LatencyMetrics *LatencyReportLatencyMetrics `json:"latencyMetrics,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Guardrail") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Guardrail") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

LatencyReportGuardrailLatency: Latency metrics for a single guardrail.

func (LatencyReportGuardrailLatency) MarshalJSON

func (s LatencyReportGuardrailLatency) MarshalJSON() ([]byte, error)

type LatencyReportLatencyMetrics

type LatencyReportLatencyMetrics struct {
	// CallCount: Output only. The number of times the resource was called.
	CallCount int64 `json:"callCount,omitempty"`
	// P50Latency: Output only. The 50th percentile latency.
	P50Latency string `json:"p50Latency,omitempty"`
	// P90Latency: Output only. The 90th percentile latency.
	P90Latency string `json:"p90Latency,omitempty"`
	// P99Latency: Output only. The 99th percentile latency.
	P99Latency string `json:"p99Latency,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CallCount") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CallCount") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

LatencyReportLatencyMetrics: Latency metrics for a component.

func (LatencyReportLatencyMetrics) MarshalJSON

func (s LatencyReportLatencyMetrics) MarshalJSON() ([]byte, error)

type LatencyReportLlmCallLatency

type LatencyReportLlmCallLatency struct {
	// LatencyMetrics: Output only. The latency metrics for the LLM call.
	LatencyMetrics *LatencyReportLatencyMetrics `json:"latencyMetrics,omitempty"`
	// Model: Output only. The name of the model.
	Model string `json:"model,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LatencyMetrics") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LatencyMetrics") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

LatencyReportLlmCallLatency: Latency metrics for a single LLM call.

func (LatencyReportLlmCallLatency) MarshalJSON

func (s LatencyReportLlmCallLatency) MarshalJSON() ([]byte, error)

type LatencyReportToolLatency

type LatencyReportToolLatency struct {
	// LatencyMetrics: Output only. The latency metrics for the tool.
	LatencyMetrics *LatencyReportLatencyMetrics `json:"latencyMetrics,omitempty"`
	// Tool: Output only. Format:
	// `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`.
	Tool string `json:"tool,omitempty"`
	// ToolDisplayName: Output only. The display name of the tool.
	ToolDisplayName string `json:"toolDisplayName,omitempty"`
	// ToolsetTool: Output only. The toolset tool identifier.
	ToolsetTool *ToolsetTool `json:"toolsetTool,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LatencyMetrics") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LatencyMetrics") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

LatencyReportToolLatency: Latency metrics for a single tool.

func (LatencyReportToolLatency) MarshalJSON

func (s LatencyReportToolLatency) MarshalJSON() ([]byte, error)

type ListAgentsResponse

type ListAgentsResponse struct {
	// Agents: The list of agents.
	Agents []*Agent `json:"agents,omitempty"`
	// NextPageToken: A token that can be sent as ListAgentsRequest.page_token to
	// retrieve the next page. Absence of this field indicates there are no
	// subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Agents") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Agents") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListAgentsResponse: Response message for AgentService.ListAgents.

func (ListAgentsResponse) MarshalJSON

func (s ListAgentsResponse) MarshalJSON() ([]byte, error)

type ListAppVersionsResponse

type ListAppVersionsResponse struct {
	// AppVersions: The list of app versions.
	AppVersions []*AppVersion `json:"appVersions,omitempty"`
	// NextPageToken: A token that can be sent as ListAppVersionsRequest.page_token
	// to retrieve the next page. Absence of this field indicates there are no
	// subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AppVersions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppVersions") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListAppVersionsResponse: Response message for AgentService.ListAppVersions.

func (ListAppVersionsResponse) MarshalJSON

func (s ListAppVersionsResponse) MarshalJSON() ([]byte, error)

type ListAppsResponse

type ListAppsResponse struct {
	// Apps: The list of apps.
	Apps []*App `json:"apps,omitempty"`
	// NextPageToken: A token that can be sent as ListAppsRequest.page_token to
	// retrieve the next page. Absence of this field indicates there are no
	// subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: Unordered list. Locations that could not be reached.
	Unreachable []string `json:"unreachable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Apps") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Apps") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListAppsResponse: Response message for AgentService.ListApps.

func (ListAppsResponse) MarshalJSON

func (s ListAppsResponse) MarshalJSON() ([]byte, error)

type ListChangelogsResponse

type ListChangelogsResponse struct {
	// Changelogs: The list of changelogs.
	Changelogs []*Changelog `json:"changelogs,omitempty"`
	// NextPageToken: A token that can be sent as ListChangelogsRequest.page_token
	// to retrieve the next page. Absence of this field indicates there are no
	// subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Changelogs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Changelogs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListChangelogsResponse: Response message for AgentService.ListChangelogs.

func (ListChangelogsResponse) MarshalJSON

func (s ListChangelogsResponse) MarshalJSON() ([]byte, error)

type ListConversationsResponse

type ListConversationsResponse struct {
	// Conversations: The list of conversations.
	Conversations []*Conversation `json:"conversations,omitempty"`
	// NextPageToken: A token that can be sent as
	// ListConversationsRequest.page_token to retrieve the next page. Absence of
	// this field indicates there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Conversations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Conversations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListConversationsResponse: Response message for AgentService.ListConversations.

func (ListConversationsResponse) MarshalJSON

func (s ListConversationsResponse) MarshalJSON() ([]byte, error)

type ListDeploymentsResponse

type ListDeploymentsResponse struct {
	// Deployments: The list of deployments.
	Deployments []*Deployment `json:"deployments,omitempty"`
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Deployments") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Deployments") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListDeploymentsResponse: Response message for AgentService.ListDeployments.

func (ListDeploymentsResponse) MarshalJSON

func (s ListDeploymentsResponse) MarshalJSON() ([]byte, error)

type ListEvaluationDatasetsResponse

type ListEvaluationDatasetsResponse struct {
	// EvaluationDatasets: The list of evaluation datasets.
	EvaluationDatasets []*EvaluationDataset `json:"evaluationDatasets,omitempty"`
	// NextPageToken: A token that can be sent as
	// ListEvaluationDatasetsRequest.page_token to retrieve the next page. Absence
	// of this field indicates there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "EvaluationDatasets") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EvaluationDatasets") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListEvaluationDatasetsResponse: Response message for EvaluationService.ListEvaluationDatasets.

func (ListEvaluationDatasetsResponse) MarshalJSON

func (s ListEvaluationDatasetsResponse) MarshalJSON() ([]byte, error)

type ListEvaluationExpectationsResponse

type ListEvaluationExpectationsResponse struct {
	// EvaluationExpectations: The list of evaluation expectations.
	EvaluationExpectations []*EvaluationExpectation `json:"evaluationExpectations,omitempty"`
	// NextPageToken: A token that can be sent as
	// ListEvaluationExpectationsRequest.page_token to retrieve the next page.
	// Absence of this field indicates there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "EvaluationExpectations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EvaluationExpectations") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListEvaluationExpectationsResponse: Response message for EvaluationService.ListEvaluationExpectations.

func (ListEvaluationExpectationsResponse) MarshalJSON

func (s ListEvaluationExpectationsResponse) MarshalJSON() ([]byte, error)

type ListEvaluationResultsResponse

type ListEvaluationResultsResponse struct {
	// EvaluationResults: The list of evaluation results.
	EvaluationResults []*EvaluationResult `json:"evaluationResults,omitempty"`
	// NextPageToken: A token that can be sent as
	// ListEvaluationResultsRequest.page_token to retrieve the next page. Absence
	// of this field indicates there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "EvaluationResults") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EvaluationResults") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListEvaluationResultsResponse: Response message for EvaluationService.ListEvaluationResults.

func (ListEvaluationResultsResponse) MarshalJSON

func (s ListEvaluationResultsResponse) MarshalJSON() ([]byte, error)

type ListEvaluationRunsResponse

type ListEvaluationRunsResponse struct {
	// EvaluationRuns: The list of evaluation runs.
	EvaluationRuns []*EvaluationRun `json:"evaluationRuns,omitempty"`
	// NextPageToken: A token that can be sent as
	// ListEvaluationRunsRequest.page_token to retrieve the next page. Absence of
	// this field indicates there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "EvaluationRuns") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EvaluationRuns") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListEvaluationRunsResponse: Response message for EvaluationService.ListEvaluationRuns.

func (ListEvaluationRunsResponse) MarshalJSON

func (s ListEvaluationRunsResponse) MarshalJSON() ([]byte, error)

type ListEvaluationsResponse

type ListEvaluationsResponse struct {
	// Evaluations: The list of evaluations.
	Evaluations []*Evaluation `json:"evaluations,omitempty"`
	// NextPageToken: A token that can be sent as ListEvaluationsRequest.page_token
	// to retrieve the next page. Absence of this field indicates there are no
	// subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Evaluations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Evaluations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListEvaluationsResponse: Response message for EvaluationService.ListEvaluations.

func (ListEvaluationsResponse) MarshalJSON

func (s ListEvaluationsResponse) MarshalJSON() ([]byte, error)

type ListExamplesResponse

type ListExamplesResponse struct {
	// Examples: The list of examples.
	Examples []*Example `json:"examples,omitempty"`
	// NextPageToken: A token that can be sent as ListExamplesRequest.page_token to
	// retrieve the next page. Absence of this field indicates there are no
	// subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Examples") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Examples") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListExamplesResponse: Response message for AgentService.ListExamples.

func (ListExamplesResponse) MarshalJSON

func (s ListExamplesResponse) MarshalJSON() ([]byte, error)

type ListGuardrailsResponse

type ListGuardrailsResponse struct {
	// Guardrails: The list of guardrails.
	Guardrails []*Guardrail `json:"guardrails,omitempty"`
	// NextPageToken: A token that can be sent as ListGuardrailsRequest.page_token
	// to retrieve the next page. Absence of this field indicates there are no
	// subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Guardrails") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Guardrails") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListGuardrailsResponse: Response message for AgentService.ListGuardrails.

func (ListGuardrailsResponse) MarshalJSON

func (s ListGuardrailsResponse) MarshalJSON() ([]byte, error)

type ListLocationsResponse

type ListLocationsResponse struct {
	// Locations: A list of locations that matches the specified filter in the
	// request.
	Locations []*Location `json:"locations,omitempty"`
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Locations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Locations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListLocationsResponse: The response message for Locations.ListLocations.

func (ListLocationsResponse) MarshalJSON

func (s ListLocationsResponse) MarshalJSON() ([]byte, error)

type ListOperationsResponse

type ListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Operations: A list of operations that matches the specified filter in the
	// request.
	Operations []*Operation `json:"operations,omitempty"`
	// Unreachable: Unordered list. Unreachable resources. Populated when the
	// request sets `ListOperationsRequest.return_partial_success` and reads across
	// collections. For example, when attempting to list all resources across all
	// supported locations.
	Unreachable []string `json:"unreachable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (ListOperationsResponse) MarshalJSON

func (s ListOperationsResponse) MarshalJSON() ([]byte, error)

type ListScheduledEvaluationRunsResponse

type ListScheduledEvaluationRunsResponse struct {
	// NextPageToken: A token that can be sent as
	// ListScheduledEvaluationRunsRequest.page_token to retrieve the next page.
	// Absence of this field indicates there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// ScheduledEvaluationRuns: The list of scheduled evaluation runs.
	ScheduledEvaluationRuns []*ScheduledEvaluationRun `json:"scheduledEvaluationRuns,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListScheduledEvaluationRunsResponse: Response message for EvaluationService.ListScheduledEvaluationRuns.

func (ListScheduledEvaluationRunsResponse) MarshalJSON

func (s ListScheduledEvaluationRunsResponse) MarshalJSON() ([]byte, error)

type ListToolsResponse

type ListToolsResponse struct {
	// NextPageToken: A token that can be sent as ListToolsRequest.page_token to
	// retrieve the next page. Absence of this field indicates there are no
	// subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Tools: The list of tools.
	Tools []*Tool `json:"tools,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListToolsResponse: Response message for AgentService.ListTools.

func (ListToolsResponse) MarshalJSON

func (s ListToolsResponse) MarshalJSON() ([]byte, error)

type ListToolsetsResponse

type ListToolsetsResponse struct {
	// NextPageToken: A token that can be sent as ListToolsetsRequest.page_token to
	// retrieve the next page. Absence of this field indicates there are no
	// subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Toolsets: The list of toolsets.
	Toolsets []*Toolset `json:"toolsets,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListToolsetsResponse: Response message for AgentService.ListToolsets.

func (ListToolsetsResponse) MarshalJSON

func (s ListToolsetsResponse) MarshalJSON() ([]byte, error)

type Location

type Location struct {
	// DisplayName: The friendly name for this location, typically a nearby city
	// name. For example, "Tokyo".
	DisplayName string `json:"displayName,omitempty"`
	// Labels: Cross-service attributes for the location. For example
	// {"cloud.googleapis.com/region": "us-east1"}
	Labels map[string]string `json:"labels,omitempty"`
	// LocationId: The canonical id for this location. For example: "us-east1".
	LocationId string `json:"locationId,omitempty"`
	// Metadata: Service-specific metadata. For example the available capacity at
	// the given location.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: Resource name for the location, which may vary between
	// implementations. For example:
	// "projects/example-project/locations/us-east1"
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Location: A resource that represents a Google Cloud location.

func (Location) MarshalJSON

func (s Location) MarshalJSON() ([]byte, error)

type LoggingSettings

type LoggingSettings struct {
	// AudioRecordingConfig: Optional. Configuration for how audio interactions
	// should be recorded.
	AudioRecordingConfig *AudioRecordingConfig `json:"audioRecordingConfig,omitempty"`
	// BigqueryExportSettings: Optional. Settings to describe the BigQuery export
	// behaviors for the app. The conversation data will be exported to BigQuery
	// tables if it is enabled.
	BigqueryExportSettings *BigQueryExportSettings `json:"bigqueryExportSettings,omitempty"`
	// CloudLoggingSettings: Optional. Settings to describe the Cloud Logging
	// behaviors for the app.
	CloudLoggingSettings *CloudLoggingSettings `json:"cloudLoggingSettings,omitempty"`
	// ConversationLoggingSettings: Optional. Settings to describe the conversation
	// logging behaviors for the app.
	ConversationLoggingSettings *ConversationLoggingSettings `json:"conversationLoggingSettings,omitempty"`
	// EvaluationAudioRecordingConfig: Optional. Configuration for how audio
	// interactions should be recorded for the evaluation. By default, audio
	// recording is not enabled for evaluation sessions.
	EvaluationAudioRecordingConfig *AudioRecordingConfig `json:"evaluationAudioRecordingConfig,omitempty"`
	// MetricAnalysisSettings: Optional. Settings to describe the conversation data
	// collection behaviors for the LLM analysis pipeline for the app.
	MetricAnalysisSettings *MetricAnalysisSettings `json:"metricAnalysisSettings,omitempty"`
	// RedactionConfig: Optional. Configuration for how sensitive data should be
	// redacted.
	RedactionConfig *RedactionConfig `json:"redactionConfig,omitempty"`
	// UnredactedAudioRecordingConfig: Optional. Configures recording of unredacted
	// audio. Use this to maintain a raw backup with restricted access when audio
	// redaction is enabled, typically for auditing or monitoring purposes.
	UnredactedAudioRecordingConfig *AudioRecordingConfig `json:"unredactedAudioRecordingConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AudioRecordingConfig") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AudioRecordingConfig") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

LoggingSettings: Settings to describe the logging behaviors for the app.

func (LoggingSettings) MarshalJSON

func (s LoggingSettings) MarshalJSON() ([]byte, error)

type McpTool

type McpTool struct {
	// ApiAuthentication: Optional. Authentication information required to execute
	// the tool against the MCP server. For bearer token authentication, the token
	// applies only to tool execution, not to listing tools. This requires that
	// tools can be listed without authentication.
	ApiAuthentication *ApiAuthentication `json:"apiAuthentication,omitempty"`
	// CustomHeaders: Optional. The custom headers to send in the request to the
	// MCP server. The values must be in the format `$context.variables.` and can
	// be set in the session variables. See
	// https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection
	// for more details.
	CustomHeaders map[string]string `json:"customHeaders,omitempty"`
	// Description: Optional. The description of the MCP tool.
	Description string `json:"description,omitempty"`
	// InputSchema: Optional. The schema of the input arguments of the MCP tool.
	InputSchema *Schema `json:"inputSchema,omitempty"`
	// Name: Required. The name of the MCP tool.
	Name string `json:"name,omitempty"`
	// OutputSchema: Optional. The schema of the output arguments of the MCP tool.
	OutputSchema *Schema `json:"outputSchema,omitempty"`
	// ServerAddress: Required. The server address of the MCP server, e.g.,
	// "https://example.com/mcp/". If the server is built with the MCP SDK, the url
	// should be suffixed with "/mcp/". Only Streamable HTTP transport based
	// servers are supported. This is the same as the server_address in the
	// McpToolset. See
	// https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http
	// for more details.
	ServerAddress string `json:"serverAddress,omitempty"`
	// ServiceDirectoryConfig: Optional. Service Directory configuration for
	// VPC-SC, used to resolve service names within a perimeter.
	ServiceDirectoryConfig *ServiceDirectoryConfig `json:"serviceDirectoryConfig,omitempty"`
	// TlsConfig: Optional. The TLS configuration. Includes the custom server
	// certificates that the client should trust.
	TlsConfig *TlsConfig `json:"tlsConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiAuthentication") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApiAuthentication") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

McpTool: An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details.

func (McpTool) MarshalJSON

func (s McpTool) MarshalJSON() ([]byte, error)

type McpToolset

type McpToolset struct {
	// ApiAuthentication: Optional. Authentication information required to access
	// tools and execute a tool against the MCP server. For bearer token
	// authentication, the token applies only to tool execution, not to listing
	// tools. This requires that tools can be listed without authentication.
	ApiAuthentication *ApiAuthentication `json:"apiAuthentication,omitempty"`
	// CustomHeaders: Optional. The custom headers to send in the request to the
	// MCP server. The values must be in the format `$context.variables.` and can
	// be set in the session variables. See
	// https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection
	// for more details.
	CustomHeaders map[string]string `json:"customHeaders,omitempty"`
	// ServerAddress: Required. The address of the MCP server, for example,
	// "https://example.com/mcp/". If the server is built with the MCP SDK, the url
	// should be suffixed with "/mcp/". Only Streamable HTTP transport based
	// servers are supported. See
	// https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http
	// for more details.
	ServerAddress string `json:"serverAddress,omitempty"`
	// ServiceDirectoryConfig: Optional. Service Directory configuration for
	// VPC-SC, used to resolve service names within a perimeter.
	ServiceDirectoryConfig *ServiceDirectoryConfig `json:"serviceDirectoryConfig,omitempty"`
	// TlsConfig: Optional. The TLS configuration. Includes the custom server
	// certificates that the client should trust.
	TlsConfig *TlsConfig `json:"tlsConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiAuthentication") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApiAuthentication") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

McpToolset: A toolset that contains a list of tools that are offered by the MCP server.

func (McpToolset) MarshalJSON

func (s McpToolset) MarshalJSON() ([]byte, error)

type Message

type Message struct {
	// Chunks: Optional. Content of the message as a series of chunks.
	Chunks []*Chunk `json:"chunks,omitempty"`
	// EventTime: Optional. Timestamp when the message was sent or received. Should
	// not be used if the message is part of an example.
	EventTime string `json:"eventTime,omitempty"`
	// Role: Optional. The role within the conversation, e.g., user, agent.
	Role string `json:"role,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Chunks") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Chunks") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Message: A message within a conversation.

func (Message) MarshalJSON

func (s Message) MarshalJSON() ([]byte, error)

type MetricAnalysisSettings

type MetricAnalysisSettings struct {
	// LlmMetricsOptedOut: Optional. Whether to collect conversation data for llm
	// analysis metrics. If true, conversation data will not be collected for llm
	// analysis metrics; otherwise, conversation data will be collected.
	LlmMetricsOptedOut bool `json:"llmMetricsOptedOut,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LlmMetricsOptedOut") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LlmMetricsOptedOut") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

MetricAnalysisSettings: Settings to describe the conversation data collection behaviors for LLM analysis metrics pipeline.

func (MetricAnalysisSettings) MarshalJSON

func (s MetricAnalysisSettings) MarshalJSON() ([]byte, error)

type MockConfig added in v0.276.0

type MockConfig struct {
	// MockedToolCalls: Optional. All tool calls to mock for the duration of the
	// session.
	MockedToolCalls []*MockedToolCall `json:"mockedToolCalls,omitempty"`
	// UnmatchedToolCallBehavior: Required. Beavhior for tool calls that don't
	// match any args patterns in mocked_tool_calls.
	//
	// Possible values:
	//   "UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED" - Default value. This value is
	// unused.
	//   "FAIL" - Throw an error for any tool calls that don't match a mock
	// expected input pattern.
	//   "PASS_THROUGH" - For unmatched tool calls, pass the tool call through to
	// real tool.
	UnmatchedToolCallBehavior string `json:"unmatchedToolCallBehavior,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MockedToolCalls") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MockedToolCalls") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

MockConfig: Mock tool calls configuration for the session.

func (MockConfig) MarshalJSON added in v0.276.0

func (s MockConfig) MarshalJSON() ([]byte, error)

type MockedToolCall added in v0.276.0

type MockedToolCall struct {
	// ExpectedArgsPattern: Required. A pattern to match against the args / inputs
	// of all dispatched tool calls. If the tool call inputs match this pattern,
	// then mock output will be returned.
	ExpectedArgsPattern googleapi.RawMessage `json:"expectedArgsPattern,omitempty"`
	// MockResponse: Optional. The mock response / output to return if the tool
	// call args / inputs match the pattern.
	MockResponse googleapi.RawMessage `json:"mockResponse,omitempty"`
	// Tool: Optional. Deprecated. Use tool_identifier instead.
	Tool string `json:"tool,omitempty"`
	// ToolId: Optional. The name of the tool to mock. Format:
	// `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
	ToolId string `json:"toolId,omitempty"`
	// Toolset: Optional. The toolset to mock.
	Toolset *ToolsetTool `json:"toolset,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExpectedArgsPattern") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExpectedArgsPattern") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

MockedToolCall: A mocked tool call. Expresses the target tool + a pattern to match against that tool's args / inputs. If the pattern matches, then the mock response will be returned.

func (MockedToolCall) MarshalJSON added in v0.276.0

func (s MockedToolCall) MarshalJSON() ([]byte, error)

type ModelSettings

type ModelSettings struct {
	// Model: Optional. The LLM model that the agent should use. If not set, the
	// agent will inherit the model from its parent agent.
	Model string `json:"model,omitempty"`
	// Temperature: Optional. If set, this temperature will be used for the LLM
	// model. Temperature controls the randomness of the model's responses. Lower
	// temperatures produce responses that are more predictable. Higher
	// temperatures produce responses that are more creative.
	Temperature float64 `json:"temperature,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Model") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Model") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ModelSettings: Model settings contains various configurations for the LLM model.

func (ModelSettings) MarshalJSON

func (s ModelSettings) MarshalJSON() ([]byte, error)

func (*ModelSettings) UnmarshalJSON

func (s *ModelSettings) UnmarshalJSON(data []byte) error

type OAuthConfig

type OAuthConfig struct {
	// ClientId: Required. The client ID from the OAuth provider.
	ClientId string `json:"clientId,omitempty"`
	// ClientSecretVersion: Required. The name of the SecretManager secret version
	// resource storing the client secret. Format:
	// `projects/{project}/secrets/{secret}/versions/{version}` Note: You should
	// grant `roles/secretmanager.secretAccessor` role to the CES service agent
	// `service-@gcp-sa-ces.iam.gserviceaccount.com`.
	ClientSecretVersion string `json:"clientSecretVersion,omitempty"`
	// OauthGrantType: Required. OAuth grant types.
	//
	// Possible values:
	//   "OAUTH_GRANT_TYPE_UNSPECIFIED" - Unspecified. Defaults to
	// CLIENT_CREDENTIAL.
	//   "CLIENT_CREDENTIAL" - Represents the [client credential
	// flow](https://oauth.net/2/grant-types/client-credentials).
	OauthGrantType string `json:"oauthGrantType,omitempty"`
	// Scopes: Optional. The OAuth scopes to grant.
	Scopes []string `json:"scopes,omitempty"`
	// TokenEndpoint: Required. The token endpoint in the OAuth provider to
	// exchange for an access token.
	TokenEndpoint string `json:"tokenEndpoint,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ClientId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ClientId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OAuthConfig: Configurations for authentication with OAuth.

func (OAuthConfig) MarshalJSON

func (s OAuthConfig) MarshalJSON() ([]byte, error)

type OpenApiTool

type OpenApiTool struct {
	// ApiAuthentication: Optional. Authentication information required by the API.
	ApiAuthentication *ApiAuthentication `json:"apiAuthentication,omitempty"`
	// Description: Optional. The description of the tool. If not provided, the
	// description of the tool will be derived from the OpenAPI schema, from
	// `operation.description` or `operation.summary`.
	Description string `json:"description,omitempty"`
	// IgnoreUnknownFields: Optional. If true, the agent will ignore unknown fields
	// in the API response.
	IgnoreUnknownFields bool `json:"ignoreUnknownFields,omitempty"`
	// Name: Optional. The name of the tool. If not provided, the name of the tool
	// will be derived from the OpenAPI schema, from `operation.operationId`.
	Name string `json:"name,omitempty"`
	// OpenApiSchema: Required. The OpenAPI schema in JSON or YAML format.
	OpenApiSchema string `json:"openApiSchema,omitempty"`
	// ServiceDirectoryConfig: Optional. Service Directory configuration.
	ServiceDirectoryConfig *ServiceDirectoryConfig `json:"serviceDirectoryConfig,omitempty"`
	// TlsConfig: Optional. The TLS configuration. Includes the custom server
	// certificates that the client will trust.
	TlsConfig *TlsConfig `json:"tlsConfig,omitempty"`
	// Url: Optional. The server URL of the Open API schema. This field is only set
	// in tools in the environment dependencies during the export process if the
	// schema contains a server url. During the import process, if this url is
	// present in the environment dependencies and the schema has the $env_var
	// placeholder, it will replace the placeholder in the schema.
	Url string `json:"url,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiAuthentication") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApiAuthentication") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OpenApiTool: A remote API tool defined by an OpenAPI schema.

func (OpenApiTool) MarshalJSON

func (s OpenApiTool) MarshalJSON() ([]byte, error)

type OpenApiToolset

type OpenApiToolset struct {
	// ApiAuthentication: Optional. Authentication information required by the API.
	ApiAuthentication *ApiAuthentication `json:"apiAuthentication,omitempty"`
	// IgnoreUnknownFields: Optional. If true, the agent will ignore unknown fields
	// in the API response for all operations defined in the OpenAPI schema.
	IgnoreUnknownFields bool `json:"ignoreUnknownFields,omitempty"`
	// OpenApiSchema: Required. The OpenAPI schema of the toolset.
	OpenApiSchema string `json:"openApiSchema,omitempty"`
	// ServiceDirectoryConfig: Optional. Service Directory configuration.
	ServiceDirectoryConfig *ServiceDirectoryConfig `json:"serviceDirectoryConfig,omitempty"`
	// TlsConfig: Optional. The TLS configuration. Includes the custom server
	// certificates
	TlsConfig *TlsConfig `json:"tlsConfig,omitempty"`
	// Url: Optional. The server URL of the Open API schema. This field is only set
	// in toolsets in the environment dependencies during the export process if the
	// schema contains a server url. During the import process, if this url is
	// present in the environment dependencies and the schema has the $env_var
	// placeholder, it will replace the placeholder in the schema.
	Url string `json:"url,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiAuthentication") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApiAuthentication") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OpenApiToolset: A toolset that contains a list of tools that are defined by an OpenAPI schema.

func (OpenApiToolset) MarshalJSON

func (s OpenApiToolset) MarshalJSON() ([]byte, error)

type Operation

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in progress.
	// If `true`, the operation is completed, and either `error` or `response` is
	// available.
	Done bool `json:"done,omitempty"`
	// Error: The error result of the operation in case of failure or cancellation.
	Error *Status `json:"error,omitempty"`
	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as create
	// time. Some services might not provide such metadata. Any method that returns
	// a long-running operation should document the metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: The server-assigned name, which is only unique within the same service
	// that originally returns it. If you use the default HTTP mapping, the `name`
	// should be a resource name ending with `operations/{unique_id}`.
	Name string `json:"name,omitempty"`
	// Response: The normal, successful response of the operation. If the original
	// method returns no data on success, such as `Delete`, the response is
	// `google.protobuf.Empty`. If the original method is standard
	// `Get`/`Create`/`Update`, the response should be the resource. For other
	// methods, the response should have the type `XxxResponse`, where `Xxx` is the
	// original method name. For example, if the original method name is
	// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Done") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Done") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (Operation) MarshalJSON

func (s Operation) MarshalJSON() ([]byte, error)

type OperationMetadata

type OperationMetadata struct {
	// CreateTime: Output only. The time the operation was created.
	CreateTime string `json:"createTime,omitempty"`
	// EndTime: Output only. The time the operation finished running.
	EndTime string `json:"endTime,omitempty"`
	// RequestedCancellation: Output only. Identifies whether the user has
	// requested cancellation of the operation. Operations that have been cancelled
	// successfully have google.longrunning.Operation.error value with a
	// google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
	RequestedCancellation bool `json:"requestedCancellation,omitempty"`
	// StatusMessage: Output only. Human-readable status of the operation, if any.
	StatusMessage string `json:"statusMessage,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OperationMetadata: Represents the metadata of the long-running operation.

func (OperationMetadata) MarshalJSON

func (s OperationMetadata) MarshalJSON() ([]byte, error)

type OptimizationConfig

type OptimizationConfig struct {
	// AssistantSession: Output only. The assistant session to use for the
	// optimization based on this evaluation run. Format:
	// `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assist
	// antSession}`
	AssistantSession string `json:"assistantSession,omitempty"`
	// ErrorMessage: Output only. The error message if the optimization run failed.
	ErrorMessage string `json:"errorMessage,omitempty"`
	// GenerateLossReport: Optional. Whether to generate a loss report.
	GenerateLossReport bool `json:"generateLossReport,omitempty"`
	// LossReport: Output only. The generated loss report.
	LossReport googleapi.RawMessage `json:"lossReport,omitempty"`
	// ReportSummary: Output only. The summary of the loss report.
	ReportSummary string `json:"reportSummary,omitempty"`
	// ShouldSuggestFix: Output only. Whether to suggest a fix for the losses.
	ShouldSuggestFix bool `json:"shouldSuggestFix,omitempty"`
	// Status: Output only. The status of the optimization run.
	//
	// Possible values:
	//   "OPTIMIZATION_STATUS_UNSPECIFIED" - Optimization status is not specified.
	//   "RUNNING" - Optimization is running.
	//   "COMPLETED" - Optimization has completed.
	//   "ERROR" - Optimization failed due to an internal error.
	Status string `json:"status,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AssistantSession") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AssistantSession") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OptimizationConfig: Configuration for running the optimization step after the evaluation run.

func (OptimizationConfig) MarshalJSON

func (s OptimizationConfig) MarshalJSON() ([]byte, error)

type OutputAudioConfig

type OutputAudioConfig struct {
	// AudioEncoding: Required. The encoding of the output audio data.
	//
	// Possible values:
	//   "AUDIO_ENCODING_UNSPECIFIED" - Unspecified audio encoding.
	//   "LINEAR16" - 16-bit linear PCM audio encoding.
	//   "MULAW" - 8-bit samples that compand 14-bit audio samples using G.711
	// PCMU/mu-law.
	//   "ALAW" - 8-bit samples that compand 14-bit audio samples using G.711
	// PCMU/A-law.
	AudioEncoding string `json:"audioEncoding,omitempty"`
	// SampleRateHertz: Required. The sample rate (in Hertz) of the output audio
	// data.
	SampleRateHertz int64 `json:"sampleRateHertz,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AudioEncoding") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AudioEncoding") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OutputAudioConfig: OutputAudioConfig configures how the CES agent should synthesize outgoing audio responses.

func (OutputAudioConfig) MarshalJSON

func (s OutputAudioConfig) MarshalJSON() ([]byte, error)

type PersonaRunConfig

type PersonaRunConfig struct {
	// Persona: Optional. The persona to use for the evaluation. Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evalu
	// ationPersona}`
	Persona string `json:"persona,omitempty"`
	// TaskCount: Optional. The number of tasks to run for the persona.
	TaskCount int64 `json:"taskCount,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Persona") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Persona") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PersonaRunConfig: Configuration for running an evaluation for a specific persona.

func (PersonaRunConfig) MarshalJSON

func (s PersonaRunConfig) MarshalJSON() ([]byte, error)

type ProjectsLocationsAppsAgentsCreateCall

type ProjectsLocationsAppsAgentsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsAgentsCreateCall) AgentId

AgentId sets the optional parameter "agentId": The ID to use for the agent, which will become the final component of the agent's resource name. If not provided, a unique ID will be automatically assigned for the agent.

func (*ProjectsLocationsAppsAgentsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsAgentsCreateCall) Do

Do executes the "ces.projects.locations.apps.agents.create" call. Any non-2xx status code is an error. Response headers are in either *Agent.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsAgentsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsAgentsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsAgentsDeleteCall

type ProjectsLocationsAppsAgentsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsAgentsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsAgentsDeleteCall) Do

Do executes the "ces.projects.locations.apps.agents.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsAgentsDeleteCall) Etag

Etag sets the optional parameter "etag": The current etag of the agent. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the agent, deletion will be blocked and an ABORTED error will be returned.

func (*ProjectsLocationsAppsAgentsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsAgentsDeleteCall) Force

Force sets the optional parameter "force": Indicates whether to forcefully delete the agent, even if it is still referenced by other app/agents/examples. * If `force = false`, the deletion fails if other agents/examples reference it. * If `force = true`, delete the agent and remove it from all referencing apps/agents/examples.

func (*ProjectsLocationsAppsAgentsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsAgentsGetCall

type ProjectsLocationsAppsAgentsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsAgentsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsAgentsGetCall) Do

Do executes the "ces.projects.locations.apps.agents.get" call. Any non-2xx status code is an error. Response headers are in either *Agent.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsAgentsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsAgentsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsAgentsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsAppsAgentsListCall

type ProjectsLocationsAppsAgentsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsAgentsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsAgentsListCall) Do

Do executes the "ces.projects.locations.apps.agents.list" call. Any non-2xx status code is an error. Response headers are in either *ListAgentsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsAgentsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsAgentsListCall) Filter

Filter sets the optional parameter "filter": Filter to be applied when listing the agents. See https://google.aip.dev/160 for more details.

func (*ProjectsLocationsAppsAgentsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsAgentsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsAgentsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsAppsAgentsListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsAppsAgentsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list AgentService.ListAgents call.

func (*ProjectsLocationsAppsAgentsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsAppsAgentsPatchCall

type ProjectsLocationsAppsAgentsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsAgentsPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsAgentsPatchCall) Do

Do executes the "ces.projects.locations.apps.agents.patch" call. Any non-2xx status code is an error. Response headers are in either *Agent.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsAgentsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsAgentsPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsAgentsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

type ProjectsLocationsAppsAgentsService

type ProjectsLocationsAppsAgentsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsAppsAgentsService

func NewProjectsLocationsAppsAgentsService(s *Service) *ProjectsLocationsAppsAgentsService

func (*ProjectsLocationsAppsAgentsService) Create

Create: Creates a new agent in the given app.

- parent: The resource name of the app to create an agent in.

func (*ProjectsLocationsAppsAgentsService) Delete

Delete: Deletes the specified agent.

- name: The resource name of the agent to delete.

func (*ProjectsLocationsAppsAgentsService) Get

Get: Gets details of the specified agent.

- name: The resource name of the agent to retrieve.

func (*ProjectsLocationsAppsAgentsService) List

List: Lists agents in the given app.

- parent: The resource name of the app to list agents from.

func (*ProjectsLocationsAppsAgentsService) Patch

Patch: Updates the specified agent.

  • name: Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`.

type ProjectsLocationsAppsChangelogsGetCall

type ProjectsLocationsAppsChangelogsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsChangelogsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsChangelogsGetCall) Do

Do executes the "ces.projects.locations.apps.changelogs.get" call. Any non-2xx status code is an error. Response headers are in either *Changelog.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsChangelogsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsChangelogsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsChangelogsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsAppsChangelogsListCall

type ProjectsLocationsAppsChangelogsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsChangelogsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsChangelogsListCall) Do

Do executes the "ces.projects.locations.apps.changelogs.list" call. Any non-2xx status code is an error. Response headers are in either *ListChangelogsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsChangelogsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsChangelogsListCall) Filter

Filter sets the optional parameter "filter": Filter to be applied when listing the changelogs. See https://google.aip.dev/160 for more details. The filter string can be used to filter by `action`, `resource_type`, `resource_name`, `author`, and `create_time`. The `:` comparator can be used for case-insensitive partial matching on string fields, while `=` performs an exact case-sensitive match. Examples: * `action:update` (case-insensitive partial match) * `action=/proxy/https/pkg.go.dev/google.golang.org/api/ces/&#34;Create&#34; (case-sensitive exact match) * `resource_type:agent` * `resource_name:my-agent` * `author:me@example.com` * `create_time > "2025-01-01T00:00:00Z" * `create_time <= "2025-01-01T00:00:00Z" AND resource_type:tool`

func (*ProjectsLocationsAppsChangelogsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsChangelogsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsChangelogsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsAppsChangelogsListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsAppsChangelogsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list AgentService.ListChangelogs call.

func (*ProjectsLocationsAppsChangelogsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsAppsChangelogsService

type ProjectsLocationsAppsChangelogsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsAppsChangelogsService

func NewProjectsLocationsAppsChangelogsService(s *Service) *ProjectsLocationsAppsChangelogsService

func (*ProjectsLocationsAppsChangelogsService) Get

Get: Gets the specified changelog.

- name: The resource name of the changelog to retrieve.

func (*ProjectsLocationsAppsChangelogsService) List

List: Lists the changelogs of the specified app.

- parent: The resource name of the app to list changelogs from.

type ProjectsLocationsAppsConversationsBatchDeleteCall

type ProjectsLocationsAppsConversationsBatchDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsConversationsBatchDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsConversationsBatchDeleteCall) Do

Do executes the "ces.projects.locations.apps.conversations.batchDelete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsConversationsBatchDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsConversationsBatchDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsConversationsDeleteCall

type ProjectsLocationsAppsConversationsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsConversationsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsConversationsDeleteCall) Do

Do executes the "ces.projects.locations.apps.conversations.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsConversationsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsConversationsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsConversationsDeleteCall) Source

Source sets the optional parameter "source": Indicate the source of the conversation. If not set, Source.Live will be applied by default.

Possible values:

"SOURCE_UNSPECIFIED" - Unspecified source.
"LIVE" - The conversation is from the live end user.
"SIMULATOR" - The conversation is from the simulator.
"EVAL" - The conversation is from the evaluation.
"AGENT_TOOL" - The conversation is from an agent tool. Agent tool runs the

agent in a separate session, which is persisted for testing and debugging purposes.

type ProjectsLocationsAppsConversationsGenerateEvaluationCall

type ProjectsLocationsAppsConversationsGenerateEvaluationCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsConversationsGenerateEvaluationCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsConversationsGenerateEvaluationCall) Do

Do executes the "ces.projects.locations.apps.conversations.generateEvaluation" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsConversationsGenerateEvaluationCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsConversationsGenerateEvaluationCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsConversationsGetCall

type ProjectsLocationsAppsConversationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsConversationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsConversationsGetCall) Do

Do executes the "ces.projects.locations.apps.conversations.get" call. Any non-2xx status code is an error. Response headers are in either *Conversation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsConversationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsConversationsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsConversationsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsConversationsGetCall) Source

Source sets the optional parameter "source": Indicate the source of the conversation. If not set, all source will be searched.

Possible values:

"SOURCE_UNSPECIFIED" - Unspecified source.
"LIVE" - The conversation is from the live end user.
"SIMULATOR" - The conversation is from the simulator.
"EVAL" - The conversation is from the evaluation.
"AGENT_TOOL" - The conversation is from an agent tool. Agent tool runs the

agent in a separate session, which is persisted for testing and debugging purposes.

type ProjectsLocationsAppsConversationsListCall

type ProjectsLocationsAppsConversationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsConversationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsConversationsListCall) Do

Do executes the "ces.projects.locations.apps.conversations.list" call. Any non-2xx status code is an error. Response headers are in either *ListConversationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsConversationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsConversationsListCall) Filter

Filter sets the optional parameter "filter": Filter to be applied when listing the conversations. See https://google.aip.dev/160 for more details.

func (*ProjectsLocationsAppsConversationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsConversationsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsConversationsListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsAppsConversationsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list AgentService.ListConversations call.

func (*ProjectsLocationsAppsConversationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsAppsConversationsListCall) Source

Source sets the optional parameter "source": Indicate the source of the conversation. If not set, Source.Live will be applied by default. Will be deprecated in favor of `sources` field.

Possible values:

"SOURCE_UNSPECIFIED" - Unspecified source.
"LIVE" - The conversation is from the live end user.
"SIMULATOR" - The conversation is from the simulator.
"EVAL" - The conversation is from the evaluation.
"AGENT_TOOL" - The conversation is from an agent tool. Agent tool runs the

agent in a separate session, which is persisted for testing and debugging purposes.

func (*ProjectsLocationsAppsConversationsListCall) Sources added in v0.267.0

Sources sets the optional parameter "sources": Indicate the sources of the conversations. If not set, all available sources will be applied by default.

Possible values:

"SOURCE_UNSPECIFIED" - Unspecified source.
"LIVE" - The conversation is from the live end user.
"SIMULATOR" - The conversation is from the simulator.
"EVAL" - The conversation is from the evaluation.
"AGENT_TOOL" - The conversation is from an agent tool. Agent tool runs the

agent in a separate session, which is persisted for testing and debugging purposes.

type ProjectsLocationsAppsConversationsService

type ProjectsLocationsAppsConversationsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsAppsConversationsService

func NewProjectsLocationsAppsConversationsService(s *Service) *ProjectsLocationsAppsConversationsService

func (*ProjectsLocationsAppsConversationsService) BatchDelete

BatchDelete: Batch deletes the specified conversations.

  • parent: The resource name of the app to delete conversations from. Format: `projects/{project}/locations/{location}/apps/{app}`.

func (*ProjectsLocationsAppsConversationsService) Delete

Delete: Deletes the specified conversation.

- name: The resource name of the conversation to delete.

func (*ProjectsLocationsAppsConversationsService) GenerateEvaluation

GenerateEvaluation: Creates a golden evaluation from a conversation.

  • conversation: The conversation to create the golden evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversa tion}`.

func (*ProjectsLocationsAppsConversationsService) Get

Get: Gets details of the specified conversation.

- name: The resource name of the conversation to retrieve.

func (*ProjectsLocationsAppsConversationsService) List

List: Lists conversations in the given app.

- parent: The resource name of the app to list conversations from.

type ProjectsLocationsAppsCreateCall

type ProjectsLocationsAppsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsCreateCall) AppId

AppId sets the optional parameter "appId": The ID to use for the app, which will become the final component of the app's resource name. If not provided, a unique ID will be automatically assigned for the app.

func (*ProjectsLocationsAppsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsCreateCall) Do

Do executes the "ces.projects.locations.apps.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsDeleteCall

type ProjectsLocationsAppsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsDeleteCall) Do

Do executes the "ces.projects.locations.apps.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsDeleteCall) Etag

Etag sets the optional parameter "etag": The current etag of the app. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app, deletion will be blocked and an ABORTED error will be returned.

func (*ProjectsLocationsAppsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsDeploymentsCreateCall

type ProjectsLocationsAppsDeploymentsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsDeploymentsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsDeploymentsCreateCall) DeploymentId

DeploymentId sets the optional parameter "deploymentId": The ID to use for the deployment, which will become the final component of the deployment's resource name. If not provided, a unique ID will be automatically assigned for the deployment.

func (*ProjectsLocationsAppsDeploymentsCreateCall) Do

Do executes the "ces.projects.locations.apps.deployments.create" call. Any non-2xx status code is an error. Response headers are in either *Deployment.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsDeploymentsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsDeploymentsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsDeploymentsDeleteCall

type ProjectsLocationsAppsDeploymentsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsDeploymentsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsDeploymentsDeleteCall) Do

Do executes the "ces.projects.locations.apps.deployments.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsDeploymentsDeleteCall) Etag

Etag sets the optional parameter "etag": The etag of the deployment. If an etag is provided and does not match the current etag of the deployment, deletion will be blocked and an ABORTED error will be returned.

func (*ProjectsLocationsAppsDeploymentsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsDeploymentsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsDeploymentsGetCall

type ProjectsLocationsAppsDeploymentsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsDeploymentsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsDeploymentsGetCall) Do

Do executes the "ces.projects.locations.apps.deployments.get" call. Any non-2xx status code is an error. Response headers are in either *Deployment.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsDeploymentsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsDeploymentsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsDeploymentsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsAppsDeploymentsListCall

type ProjectsLocationsAppsDeploymentsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsDeploymentsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsDeploymentsListCall) Do

Do executes the "ces.projects.locations.apps.deployments.list" call. Any non-2xx status code is an error. Response headers are in either *ListDeploymentsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsDeploymentsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsDeploymentsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsDeploymentsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsDeploymentsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsAppsDeploymentsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

func (*ProjectsLocationsAppsDeploymentsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeployments` must match the call that provided the page token.

func (*ProjectsLocationsAppsDeploymentsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsAppsDeploymentsPatchCall

type ProjectsLocationsAppsDeploymentsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsDeploymentsPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsDeploymentsPatchCall) Do

Do executes the "ces.projects.locations.apps.deployments.patch" call. Any non-2xx status code is an error. Response headers are in either *Deployment.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsDeploymentsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsDeploymentsPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsDeploymentsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": The list of fields to update.

type ProjectsLocationsAppsDeploymentsService

type ProjectsLocationsAppsDeploymentsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsAppsDeploymentsService

func NewProjectsLocationsAppsDeploymentsService(s *Service) *ProjectsLocationsAppsDeploymentsService

func (*ProjectsLocationsAppsDeploymentsService) Create

Create: Creates a new deployment in the given app.

  • parent: The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`.

func (*ProjectsLocationsAppsDeploymentsService) Delete

Delete: Deletes the specified deployment.

  • name: The name of the deployment to delete. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment }`.

func (*ProjectsLocationsAppsDeploymentsService) Get

Get: Gets details of the specified deployment.

  • name: The name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment }`.

func (*ProjectsLocationsAppsDeploymentsService) List

List: Lists deployments in the given app.

  • parent: The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`.

func (*ProjectsLocationsAppsDeploymentsService) Patch

Patch: Updates the specified deployment.

  • name: Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment }`.

type ProjectsLocationsAppsEvaluationDatasetsCreateCall

type ProjectsLocationsAppsEvaluationDatasetsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationDatasetsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationDatasetsCreateCall) Do

Do executes the "ces.projects.locations.apps.evaluationDatasets.create" call. Any non-2xx status code is an error. Response headers are in either *EvaluationDataset.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationDatasetsCreateCall) EvaluationDatasetId

EvaluationDatasetId sets the optional parameter "evaluationDatasetId": The ID to use for the evaluation dataset, which will become the final component of the evaluation dataset's resource name. If not provided, a unique ID will be automatically assigned for the evaluation.

func (*ProjectsLocationsAppsEvaluationDatasetsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationDatasetsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsEvaluationDatasetsDeleteCall

type ProjectsLocationsAppsEvaluationDatasetsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationDatasetsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationDatasetsDeleteCall) Do

Do executes the "ces.projects.locations.apps.evaluationDatasets.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationDatasetsDeleteCall) Etag

Etag sets the optional parameter "etag": The current etag of the evaluation dataset. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the evaluation dataset, deletion will be blocked and an ABORTED error will be returned.

func (*ProjectsLocationsAppsEvaluationDatasetsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationDatasetsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsEvaluationDatasetsGetCall

type ProjectsLocationsAppsEvaluationDatasetsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationDatasetsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationDatasetsGetCall) Do

Do executes the "ces.projects.locations.apps.evaluationDatasets.get" call. Any non-2xx status code is an error. Response headers are in either *EvaluationDataset.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationDatasetsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationDatasetsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsEvaluationDatasetsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsAppsEvaluationDatasetsListCall

type ProjectsLocationsAppsEvaluationDatasetsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationDatasetsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationDatasetsListCall) Do

Do executes the "ces.projects.locations.apps.evaluationDatasets.list" call. Any non-2xx status code is an error. Response headers are in either *ListEvaluationDatasetsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationDatasetsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationDatasetsListCall) Filter

Filter sets the optional parameter "filter": Filter to be applied when listing the evaluation datasets. See https://google.aip.dev/160 for more details.

func (*ProjectsLocationsAppsEvaluationDatasetsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsEvaluationDatasetsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsEvaluationDatasetsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsAppsEvaluationDatasetsListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsAppsEvaluationDatasetsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list EvaluationService.ListEvaluationDatasets call.

func (*ProjectsLocationsAppsEvaluationDatasetsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsAppsEvaluationDatasetsPatchCall

type ProjectsLocationsAppsEvaluationDatasetsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationDatasetsPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationDatasetsPatchCall) Do

Do executes the "ces.projects.locations.apps.evaluationDatasets.patch" call. Any non-2xx status code is an error. Response headers are in either *EvaluationDataset.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationDatasetsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationDatasetsPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsEvaluationDatasetsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

type ProjectsLocationsAppsEvaluationDatasetsService

type ProjectsLocationsAppsEvaluationDatasetsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsAppsEvaluationDatasetsService

func NewProjectsLocationsAppsEvaluationDatasetsService(s *Service) *ProjectsLocationsAppsEvaluationDatasetsService

func (*ProjectsLocationsAppsEvaluationDatasetsService) Create

Create: Creates an evaluation dataset.

  • parent: The app to create the evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}`.

func (*ProjectsLocationsAppsEvaluationDatasetsService) Delete

Delete: Deletes an evaluation dataset.

- name: The resource name of the evaluation dataset to delete.

func (*ProjectsLocationsAppsEvaluationDatasetsService) Get

Get: Gets details of the specified evaluation dataset.

- name: The resource name of the evaluation dataset to retrieve.

func (*ProjectsLocationsAppsEvaluationDatasetsService) List

List: Lists all evaluation datasets in the given app.

- parent: The resource name of the app to list evaluation datasets from.

func (*ProjectsLocationsAppsEvaluationDatasetsService) Patch

Patch: Updates an evaluation dataset.

  • name: Identifier. The unique identifier of this evaluation dataset. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{eva luationDataset}`.

type ProjectsLocationsAppsEvaluationExpectationsCreateCall

type ProjectsLocationsAppsEvaluationExpectationsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationExpectationsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationExpectationsCreateCall) Do

Do executes the "ces.projects.locations.apps.evaluationExpectations.create" call. Any non-2xx status code is an error. Response headers are in either *EvaluationExpectation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationExpectationsCreateCall) EvaluationExpectationId

EvaluationExpectationId sets the optional parameter "evaluationExpectationId": The ID to use for the evaluation expectation, which will become the final component of the evaluation expectation's resource name. If not provided, a unique ID will be automatically assigned for the evaluation expectation.

func (*ProjectsLocationsAppsEvaluationExpectationsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationExpectationsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsEvaluationExpectationsDeleteCall

type ProjectsLocationsAppsEvaluationExpectationsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationExpectationsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationExpectationsDeleteCall) Do

Do executes the "ces.projects.locations.apps.evaluationExpectations.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationExpectationsDeleteCall) Etag

Etag sets the optional parameter "etag": The current etag of the evaluation expectation. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the evaluation expectation, deletion will be blocked and an ABORTED error will be returned.

func (*ProjectsLocationsAppsEvaluationExpectationsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationExpectationsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsEvaluationExpectationsGetCall

type ProjectsLocationsAppsEvaluationExpectationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationExpectationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationExpectationsGetCall) Do

Do executes the "ces.projects.locations.apps.evaluationExpectations.get" call. Any non-2xx status code is an error. Response headers are in either *EvaluationExpectation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationExpectationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationExpectationsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsEvaluationExpectationsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsAppsEvaluationExpectationsListCall

type ProjectsLocationsAppsEvaluationExpectationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationExpectationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationExpectationsListCall) Do

Do executes the "ces.projects.locations.apps.evaluationExpectations.list" call. Any non-2xx status code is an error. Response headers are in either *ListEvaluationExpectationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationExpectationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationExpectationsListCall) Filter

Filter sets the optional parameter "filter": Filter to be applied when listing the evaluation expectations. See https://google.aip.dev/160 for more details.

func (*ProjectsLocationsAppsEvaluationExpectationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsEvaluationExpectationsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsEvaluationExpectationsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsAppsEvaluationExpectationsListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsAppsEvaluationExpectationsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list EvaluationService.ListEvaluationExpectations call.

func (*ProjectsLocationsAppsEvaluationExpectationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsAppsEvaluationExpectationsPatchCall

type ProjectsLocationsAppsEvaluationExpectationsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationExpectationsPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationExpectationsPatchCall) Do

Do executes the "ces.projects.locations.apps.evaluationExpectations.patch" call. Any non-2xx status code is an error. Response headers are in either *EvaluationExpectation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationExpectationsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationExpectationsPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsEvaluationExpectationsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

type ProjectsLocationsAppsEvaluationExpectationsService

type ProjectsLocationsAppsEvaluationExpectationsService struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationExpectationsService) Create

Create: Creates an evaluation expectation.

  • parent: The app to create the evaluation expectation for. Format: `projects/{project}/locations/{location}/apps/{app}`.

func (*ProjectsLocationsAppsEvaluationExpectationsService) Delete

Delete: Deletes an evaluation expectation.

- name: The resource name of the evaluation expectation to delete.

func (*ProjectsLocationsAppsEvaluationExpectationsService) Get

Get: Gets details of the specified evaluation expectation.

- name: The resource name of the evaluation expectation to retrieve.

func (*ProjectsLocationsAppsEvaluationExpectationsService) List

List: Lists all evaluation expectations in the given app.

- parent: The resource name of the app to list evaluation expectations from.

func (*ProjectsLocationsAppsEvaluationExpectationsService) Patch

Patch: Updates an evaluation expectation.

  • name: Identifier. The unique identifier of this evaluation expectation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/ {evaluation_expectation}`.

type ProjectsLocationsAppsEvaluationRunsDeleteCall

type ProjectsLocationsAppsEvaluationRunsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationRunsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationRunsDeleteCall) Do

Do executes the "ces.projects.locations.apps.evaluationRuns.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationRunsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationRunsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsEvaluationRunsExportCall added in v0.279.0

type ProjectsLocationsAppsEvaluationRunsExportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationRunsExportCall) Context added in v0.279.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationRunsExportCall) Do added in v0.279.0

Do executes the "ces.projects.locations.apps.evaluationRuns.export" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationRunsExportCall) Fields added in v0.279.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationRunsExportCall) Header added in v0.279.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsEvaluationRunsGetCall

type ProjectsLocationsAppsEvaluationRunsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationRunsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationRunsGetCall) Do

Do executes the "ces.projects.locations.apps.evaluationRuns.get" call. Any non-2xx status code is an error. Response headers are in either *EvaluationRun.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationRunsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationRunsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsEvaluationRunsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsAppsEvaluationRunsListCall

type ProjectsLocationsAppsEvaluationRunsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationRunsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationRunsListCall) Do

Do executes the "ces.projects.locations.apps.evaluationRuns.list" call. Any non-2xx status code is an error. Response headers are in either *ListEvaluationRunsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationRunsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationRunsListCall) Filter

Filter sets the optional parameter "filter": Filter to be applied when listing the evaluation runs. See https://google.aip.dev/160 for more details.

func (*ProjectsLocationsAppsEvaluationRunsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsEvaluationRunsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsEvaluationRunsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsAppsEvaluationRunsListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsAppsEvaluationRunsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list EvaluationService.ListEvaluationRuns call.

func (*ProjectsLocationsAppsEvaluationRunsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsAppsEvaluationRunsService

type ProjectsLocationsAppsEvaluationRunsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsAppsEvaluationRunsService

func NewProjectsLocationsAppsEvaluationRunsService(s *Service) *ProjectsLocationsAppsEvaluationRunsService

func (*ProjectsLocationsAppsEvaluationRunsService) Delete

Delete: Deletes an evaluation run.

- name: The resource name of the evaluation run to delete.

func (*ProjectsLocationsAppsEvaluationRunsService) Export added in v0.279.0

Export: Exports evaluations runs.

  • parent: The resource name of the app to export evaluation runs from. Format: `projects/{project}/locations/{location}/apps/{app}`.

func (*ProjectsLocationsAppsEvaluationRunsService) Get

Get: Gets details of the specified evaluation run.

- name: The resource name of the evaluation run to retrieve.

func (*ProjectsLocationsAppsEvaluationRunsService) List

List: Lists all evaluation runs in the given app.

- parent: The resource name of the app to list evaluation runs from.

type ProjectsLocationsAppsEvaluationsCreateCall

type ProjectsLocationsAppsEvaluationsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationsCreateCall) Do

Do executes the "ces.projects.locations.apps.evaluations.create" call. Any non-2xx status code is an error. Response headers are in either *Evaluation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationsCreateCall) EvaluationId

EvaluationId sets the optional parameter "evaluationId": The ID to use for the evaluation, which will become the final component of the evaluation's resource name. If not provided, a unique ID will be automatically assigned for the evaluation.

func (*ProjectsLocationsAppsEvaluationsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsEvaluationsDeleteCall

type ProjectsLocationsAppsEvaluationsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationsDeleteCall) Do

Do executes the "ces.projects.locations.apps.evaluations.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationsDeleteCall) Etag

Etag sets the optional parameter "etag": The current etag of the evaluation. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the evaluation, deletion will be blocked and an ABORTED error will be returned.

func (*ProjectsLocationsAppsEvaluationsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationsDeleteCall) Force

Force sets the optional parameter "force": Indicates whether to forcefully delete the evaluation, even if it is still referenced by evaluation datasets. * If `force = false`, the deletion will fail if any datasets still reference the evaluation. * If `force = true`, all existing references from datasets will be removed and the evaluation will be deleted.

func (*ProjectsLocationsAppsEvaluationsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsEvaluationsExportCall added in v0.276.0

type ProjectsLocationsAppsEvaluationsExportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationsExportCall) Context added in v0.276.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationsExportCall) Do added in v0.276.0

Do executes the "ces.projects.locations.apps.evaluations.export" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationsExportCall) Fields added in v0.276.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationsExportCall) Header added in v0.276.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsEvaluationsGetCall

type ProjectsLocationsAppsEvaluationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationsGetCall) Do

Do executes the "ces.projects.locations.apps.evaluations.get" call. Any non-2xx status code is an error. Response headers are in either *Evaluation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsEvaluationsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsAppsEvaluationsListCall

type ProjectsLocationsAppsEvaluationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationsListCall) Do

Do executes the "ces.projects.locations.apps.evaluations.list" call. Any non-2xx status code is an error. Response headers are in either *ListEvaluationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationsListCall) EvaluationFilter added in v0.270.0

EvaluationFilter sets the optional parameter "evaluationFilter": Filter to be applied on the evaluation when listing the evaluations. See https://google.aip.dev/160 for more details. Supported fields: evaluation_datasets

func (*ProjectsLocationsAppsEvaluationsListCall) EvaluationRunFilter added in v0.270.0

EvaluationRunFilter sets the optional parameter "evaluationRunFilter": Filter string for fields on the associated EvaluationRun resources. See https://google.aip.dev/160 for more details. Supported fields: create_time, initiated_by, app_version_display_name

func (*ProjectsLocationsAppsEvaluationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationsListCall) Filter

Filter sets the optional parameter "filter": Deprecated: Use evaluation_filter and evaluation_run_filter instead.

func (*ProjectsLocationsAppsEvaluationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsEvaluationsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsEvaluationsListCall) LastTenResults

LastTenResults sets the optional parameter "lastTenResults": Whether to include the last 10 evaluation results for each evaluation in the response.

func (*ProjectsLocationsAppsEvaluationsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsAppsEvaluationsListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsAppsEvaluationsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list EvaluationService.ListEvaluations call.

func (*ProjectsLocationsAppsEvaluationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsAppsEvaluationsPatchCall

type ProjectsLocationsAppsEvaluationsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationsPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationsPatchCall) Do

Do executes the "ces.projects.locations.apps.evaluations.patch" call. Any non-2xx status code is an error. Response headers are in either *Evaluation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationsPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsEvaluationsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

type ProjectsLocationsAppsEvaluationsResultsDeleteCall

type ProjectsLocationsAppsEvaluationsResultsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationsResultsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationsResultsDeleteCall) Do

Do executes the "ces.projects.locations.apps.evaluations.results.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationsResultsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationsResultsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsEvaluationsResultsExportCall added in v0.279.0

type ProjectsLocationsAppsEvaluationsResultsExportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationsResultsExportCall) Context added in v0.279.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationsResultsExportCall) Do added in v0.279.0

Do executes the "ces.projects.locations.apps.evaluations.results.export" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationsResultsExportCall) Fields added in v0.279.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationsResultsExportCall) Header added in v0.279.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsEvaluationsResultsGetCall

type ProjectsLocationsAppsEvaluationsResultsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationsResultsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationsResultsGetCall) Do

Do executes the "ces.projects.locations.apps.evaluations.results.get" call. Any non-2xx status code is an error. Response headers are in either *EvaluationResult.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationsResultsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationsResultsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsEvaluationsResultsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsAppsEvaluationsResultsListCall

type ProjectsLocationsAppsEvaluationsResultsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationsResultsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationsResultsListCall) Do

Do executes the "ces.projects.locations.apps.evaluations.results.list" call. Any non-2xx status code is an error. Response headers are in either *ListEvaluationResultsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationsResultsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationsResultsListCall) Filter

Filter sets the optional parameter "filter": Filter to be applied when listing the evaluation results. See https://google.aip.dev/160 for more details.

func (*ProjectsLocationsAppsEvaluationsResultsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsEvaluationsResultsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsEvaluationsResultsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsAppsEvaluationsResultsListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsAppsEvaluationsResultsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list EvaluationService.ListEvaluationResults call.

func (*ProjectsLocationsAppsEvaluationsResultsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsAppsEvaluationsResultsService

type ProjectsLocationsAppsEvaluationsResultsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsAppsEvaluationsResultsService

func NewProjectsLocationsAppsEvaluationsResultsService(s *Service) *ProjectsLocationsAppsEvaluationsResultsService

func (*ProjectsLocationsAppsEvaluationsResultsService) Delete

Delete: Deletes an evaluation result.

- name: The resource name of the evaluation result to delete.

func (*ProjectsLocationsAppsEvaluationsResultsService) Export added in v0.279.0

Export: Exports evaluations results.

  • parent: The resource name of the evaluation to export evaluation results from. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation }`.

func (*ProjectsLocationsAppsEvaluationsResultsService) Get

Get: Gets details of the specified evaluation result.

- name: The resource name of the evaluation result to retrieve.

func (*ProjectsLocationsAppsEvaluationsResultsService) List

List: Lists all evaluation results for a given evaluation.

  • parent: The resource name of the evaluation to list evaluation results from. To filter by evaluation run, use `-` as the evaluation ID and specify the evaluation run ID in the filter. For example: `projects/{project}/locations/{location}/apps/{app}/evaluations/-`.

type ProjectsLocationsAppsEvaluationsService

type ProjectsLocationsAppsEvaluationsService struct {
	Results *ProjectsLocationsAppsEvaluationsResultsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsAppsEvaluationsService

func NewProjectsLocationsAppsEvaluationsService(s *Service) *ProjectsLocationsAppsEvaluationsService

func (*ProjectsLocationsAppsEvaluationsService) Create

Create: Creates an evaluation.

  • parent: The app to create the evaluation for. Format: `projects/{project}/locations/{location}/apps/{app}`.

func (*ProjectsLocationsAppsEvaluationsService) Delete

Delete: Deletes an evaluation.

- name: The resource name of the evaluation to delete.

func (*ProjectsLocationsAppsEvaluationsService) Export added in v0.276.0

Export: Exports evaluations.

  • parent: The resource name of the app to export evaluations from. Format: `projects/{project}/locations/{location}/apps/{app}`.

func (*ProjectsLocationsAppsEvaluationsService) Get

Get: Gets details of the specified evaluation.

- name: The resource name of the evaluation to retrieve.

func (*ProjectsLocationsAppsEvaluationsService) List

List: Lists all evaluations in the given app.

- parent: The resource name of the app to list evaluations from.

func (*ProjectsLocationsAppsEvaluationsService) Patch

Patch: Updates an evaluation.

  • name: Identifier. The unique identifier of this evaluation. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation }`.

func (*ProjectsLocationsAppsEvaluationsService) UploadEvaluationAudio added in v0.270.0

UploadEvaluationAudio: Uploads audio for use in Golden Evaluations. Stores the audio in the Cloud Storage bucket defined in 'App.logging_settings.evaluation_audio_recording_config.gcs_bucket' and returns a transcript.

  • name: The resource name of the Evaluation for which to upload the evaluation audio. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation }`.

type ProjectsLocationsAppsEvaluationsUploadEvaluationAudioCall added in v0.270.0

type ProjectsLocationsAppsEvaluationsUploadEvaluationAudioCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsEvaluationsUploadEvaluationAudioCall) Context added in v0.270.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsEvaluationsUploadEvaluationAudioCall) Do added in v0.270.0

Do executes the "ces.projects.locations.apps.evaluations.uploadEvaluationAudio" call. Any non-2xx status code is an error. Response headers are in either *UploadEvaluationAudioResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsEvaluationsUploadEvaluationAudioCall) Fields added in v0.270.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsEvaluationsUploadEvaluationAudioCall) Header added in v0.270.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsExamplesCreateCall

type ProjectsLocationsAppsExamplesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsExamplesCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsExamplesCreateCall) Do

Do executes the "ces.projects.locations.apps.examples.create" call. Any non-2xx status code is an error. Response headers are in either *Example.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsExamplesCreateCall) ExampleId

ExampleId sets the optional parameter "exampleId": The ID to use for the example, which will become the final component of the example's resource name. If not provided, a unique ID will be automatically assigned for the example.

func (*ProjectsLocationsAppsExamplesCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsExamplesCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsExamplesDeleteCall

type ProjectsLocationsAppsExamplesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsExamplesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsExamplesDeleteCall) Do

Do executes the "ces.projects.locations.apps.examples.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsExamplesDeleteCall) Etag

Etag sets the optional parameter "etag": The current etag of the example. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the example, deletion will be blocked and an ABORTED error will be returned.

func (*ProjectsLocationsAppsExamplesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsExamplesDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsExamplesGetCall

type ProjectsLocationsAppsExamplesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsExamplesGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsExamplesGetCall) Do

Do executes the "ces.projects.locations.apps.examples.get" call. Any non-2xx status code is an error. Response headers are in either *Example.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsExamplesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsExamplesGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsExamplesGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsAppsExamplesListCall

type ProjectsLocationsAppsExamplesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsExamplesListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsExamplesListCall) Do

Do executes the "ces.projects.locations.apps.examples.list" call. Any non-2xx status code is an error. Response headers are in either *ListExamplesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsExamplesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsExamplesListCall) Filter

Filter sets the optional parameter "filter": Filter to be applied when listing the examples. See https://google.aip.dev/160 for more details.

func (*ProjectsLocationsAppsExamplesListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsExamplesListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsExamplesListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsAppsExamplesListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsAppsExamplesListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list AgentService.ListExamples call.

func (*ProjectsLocationsAppsExamplesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsAppsExamplesPatchCall

type ProjectsLocationsAppsExamplesPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsExamplesPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsExamplesPatchCall) Do

Do executes the "ces.projects.locations.apps.examples.patch" call. Any non-2xx status code is an error. Response headers are in either *Example.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsExamplesPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsExamplesPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsExamplesPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

type ProjectsLocationsAppsExamplesService

type ProjectsLocationsAppsExamplesService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsAppsExamplesService

func NewProjectsLocationsAppsExamplesService(s *Service) *ProjectsLocationsAppsExamplesService

func (*ProjectsLocationsAppsExamplesService) Create

Create: Creates a new example in the given app.

- parent: The resource name of the app to create an example in.

func (*ProjectsLocationsAppsExamplesService) Delete

Delete: Deletes the specified example.

- name: The resource name of the example to delete.

func (*ProjectsLocationsAppsExamplesService) Get

Get: Gets details of the specified example.

- name: The resource name of the example to retrieve.

func (*ProjectsLocationsAppsExamplesService) List

List: Lists examples in the given app.

- parent: The resource name of the app to list examples from.

func (*ProjectsLocationsAppsExamplesService) Patch

Patch: Updates the specified example.

  • name: Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`.

type ProjectsLocationsAppsExecuteToolCall

type ProjectsLocationsAppsExecuteToolCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsExecuteToolCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsExecuteToolCall) Do

Do executes the "ces.projects.locations.apps.executeTool" call. Any non-2xx status code is an error. Response headers are in either *ExecuteToolResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsExecuteToolCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsExecuteToolCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsExportAppCall

type ProjectsLocationsAppsExportAppCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsExportAppCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsExportAppCall) Do

Do executes the "ces.projects.locations.apps.exportApp" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsExportAppCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsExportAppCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsGenerateAppResourceCall added in v0.274.0

type ProjectsLocationsAppsGenerateAppResourceCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsGenerateAppResourceCall) Context added in v0.274.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsGenerateAppResourceCall) Do added in v0.274.0

Do executes the "ces.projects.locations.apps.generateAppResource" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsGenerateAppResourceCall) Fields added in v0.274.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsGenerateAppResourceCall) Header added in v0.274.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsGetCall

type ProjectsLocationsAppsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsGetCall) Do

Do executes the "ces.projects.locations.apps.get" call. Any non-2xx status code is an error. Response headers are in either *App.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsAppsGuardrailsCreateCall

type ProjectsLocationsAppsGuardrailsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsGuardrailsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsGuardrailsCreateCall) Do

Do executes the "ces.projects.locations.apps.guardrails.create" call. Any non-2xx status code is an error. Response headers are in either *Guardrail.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsGuardrailsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsGuardrailsCreateCall) GuardrailId

GuardrailId sets the optional parameter "guardrailId": The ID to use for the guardrail, which will become the final component of the guardrail's resource name. If not provided, a unique ID will be automatically assigned for the guardrail.

func (*ProjectsLocationsAppsGuardrailsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsGuardrailsDeleteCall

type ProjectsLocationsAppsGuardrailsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsGuardrailsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsGuardrailsDeleteCall) Do

Do executes the "ces.projects.locations.apps.guardrails.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsGuardrailsDeleteCall) Etag

Etag sets the optional parameter "etag": The current etag of the guardrail. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the guardrail, deletion will be blocked and an ABORTED error will be returned.

func (*ProjectsLocationsAppsGuardrailsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsGuardrailsDeleteCall) Force

Force sets the optional parameter "force": Indicates whether to forcefully delete the guardrail, even if it is still referenced by app/agents. * If `force = false`, the deletion fails if any apps/agents still reference the guardrail. * If `force = true`, all existing references from apps/agents will be removed and the guardrail will be deleted.

func (*ProjectsLocationsAppsGuardrailsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsGuardrailsGetCall

type ProjectsLocationsAppsGuardrailsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsGuardrailsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsGuardrailsGetCall) Do

Do executes the "ces.projects.locations.apps.guardrails.get" call. Any non-2xx status code is an error. Response headers are in either *Guardrail.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsGuardrailsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsGuardrailsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsGuardrailsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsAppsGuardrailsListCall

type ProjectsLocationsAppsGuardrailsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsGuardrailsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsGuardrailsListCall) Do

Do executes the "ces.projects.locations.apps.guardrails.list" call. Any non-2xx status code is an error. Response headers are in either *ListGuardrailsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsGuardrailsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsGuardrailsListCall) Filter

Filter sets the optional parameter "filter": Filter to be applied when listing the guardrails. See https://google.aip.dev/160 for more details.

func (*ProjectsLocationsAppsGuardrailsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsGuardrailsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsGuardrailsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsAppsGuardrailsListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsAppsGuardrailsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list AgentService.ListGuardrails call.

func (*ProjectsLocationsAppsGuardrailsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsAppsGuardrailsPatchCall

type ProjectsLocationsAppsGuardrailsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsGuardrailsPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsGuardrailsPatchCall) Do

Do executes the "ces.projects.locations.apps.guardrails.patch" call. Any non-2xx status code is an error. Response headers are in either *Guardrail.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsGuardrailsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsGuardrailsPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsGuardrailsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

type ProjectsLocationsAppsGuardrailsService

type ProjectsLocationsAppsGuardrailsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsAppsGuardrailsService

func NewProjectsLocationsAppsGuardrailsService(s *Service) *ProjectsLocationsAppsGuardrailsService

func (*ProjectsLocationsAppsGuardrailsService) Create

Create: Creates a new guardrail in the given app.

- parent: The resource name of the app to create a guardrail in.

func (*ProjectsLocationsAppsGuardrailsService) Delete

Delete: Deletes the specified guardrail.

- name: The resource name of the guardrail to delete.

func (*ProjectsLocationsAppsGuardrailsService) Get

Get: Gets details of the specified guardrail.

- name: The resource name of the guardrail to retrieve.

func (*ProjectsLocationsAppsGuardrailsService) List

List: Lists guardrails in the given app.

- parent: The resource name of the app to list guardrails from.

func (*ProjectsLocationsAppsGuardrailsService) Patch

Patch: Updates the specified guardrail.

  • name: Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`.

type ProjectsLocationsAppsImportAppCall

type ProjectsLocationsAppsImportAppCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsImportAppCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsImportAppCall) Do

Do executes the "ces.projects.locations.apps.importApp" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsImportAppCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsImportAppCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsImportEvaluationsCall

type ProjectsLocationsAppsImportEvaluationsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsImportEvaluationsCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsImportEvaluationsCall) Do

Do executes the "ces.projects.locations.apps.importEvaluations" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsImportEvaluationsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsImportEvaluationsCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsListCall

type ProjectsLocationsAppsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsListCall) Do

Do executes the "ces.projects.locations.apps.list" call. Any non-2xx status code is an error. Response headers are in either *ListAppsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsListCall) Filter

Filter sets the optional parameter "filter": Filter to be applied when listing the apps. See https://google.aip.dev/160 for more details.

func (*ProjectsLocationsAppsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsAppsListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsAppsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list AgentService.ListApps call.

func (*ProjectsLocationsAppsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsAppsPatchCall

type ProjectsLocationsAppsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsPatchCall) Do

Do executes the "ces.projects.locations.apps.patch" call. Any non-2xx status code is an error. Response headers are in either *App.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

type ProjectsLocationsAppsRetrieveToolSchemaCall

type ProjectsLocationsAppsRetrieveToolSchemaCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsRetrieveToolSchemaCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsRetrieveToolSchemaCall) Do

Do executes the "ces.projects.locations.apps.retrieveToolSchema" call. Any non-2xx status code is an error. Response headers are in either *RetrieveToolSchemaResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsRetrieveToolSchemaCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsRetrieveToolSchemaCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsRunEvaluationCall

type ProjectsLocationsAppsRunEvaluationCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsRunEvaluationCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsRunEvaluationCall) Do

Do executes the "ces.projects.locations.apps.runEvaluation" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsRunEvaluationCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsRunEvaluationCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsScheduledEvaluationRunsCreateCall

type ProjectsLocationsAppsScheduledEvaluationRunsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsScheduledEvaluationRunsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsScheduledEvaluationRunsCreateCall) Do

Do executes the "ces.projects.locations.apps.scheduledEvaluationRuns.create" call. Any non-2xx status code is an error. Response headers are in either *ScheduledEvaluationRun.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsScheduledEvaluationRunsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsScheduledEvaluationRunsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsScheduledEvaluationRunsCreateCall) ScheduledEvaluationRunId

ScheduledEvaluationRunId sets the optional parameter "scheduledEvaluationRunId": The ID to use for the scheduled evaluation run, which will become the final component of the scheduled evaluation run's resource name. If not provided, a unique ID will be automatically assigned.

type ProjectsLocationsAppsScheduledEvaluationRunsDeleteCall

type ProjectsLocationsAppsScheduledEvaluationRunsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsScheduledEvaluationRunsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsScheduledEvaluationRunsDeleteCall) Do

Do executes the "ces.projects.locations.apps.scheduledEvaluationRuns.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsScheduledEvaluationRunsDeleteCall) Etag

Etag sets the optional parameter "etag": The etag of the ScheduledEvaluationRun. If provided, it must match the server's etag.

func (*ProjectsLocationsAppsScheduledEvaluationRunsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsScheduledEvaluationRunsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsScheduledEvaluationRunsGetCall

type ProjectsLocationsAppsScheduledEvaluationRunsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsScheduledEvaluationRunsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsScheduledEvaluationRunsGetCall) Do

Do executes the "ces.projects.locations.apps.scheduledEvaluationRuns.get" call. Any non-2xx status code is an error. Response headers are in either *ScheduledEvaluationRun.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsScheduledEvaluationRunsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsScheduledEvaluationRunsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsScheduledEvaluationRunsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsAppsScheduledEvaluationRunsListCall

type ProjectsLocationsAppsScheduledEvaluationRunsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsScheduledEvaluationRunsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsScheduledEvaluationRunsListCall) Do

Do executes the "ces.projects.locations.apps.scheduledEvaluationRuns.list" call. Any non-2xx status code is an error. Response headers are in either *ListScheduledEvaluationRunsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsScheduledEvaluationRunsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsScheduledEvaluationRunsListCall) Filter

Filter sets the optional parameter "filter": Filter to be applied when listing the scheduled evaluation runs. See https://google.aip.dev/160 for more details. Currently supports filtering by: * request.evaluations:evaluation_id * request.evaluation_dataset:evaluation_dataset_id

func (*ProjectsLocationsAppsScheduledEvaluationRunsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsScheduledEvaluationRunsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsScheduledEvaluationRunsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Field to sort by. Supported fields are: "name" (ascending), "create_time" (descending), "update_time" (descending), "next_scheduled_execution" (ascending), and "last_completed_run.create_time" (descending). If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsAppsScheduledEvaluationRunsListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsAppsScheduledEvaluationRunsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list EvaluationService.ListScheduledEvaluationRuns call.

func (*ProjectsLocationsAppsScheduledEvaluationRunsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsAppsScheduledEvaluationRunsPatchCall

type ProjectsLocationsAppsScheduledEvaluationRunsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsScheduledEvaluationRunsPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsScheduledEvaluationRunsPatchCall) Do

Do executes the "ces.projects.locations.apps.scheduledEvaluationRuns.patch" call. Any non-2xx status code is an error. Response headers are in either *ScheduledEvaluationRun.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsScheduledEvaluationRunsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsScheduledEvaluationRunsPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsScheduledEvaluationRunsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

type ProjectsLocationsAppsScheduledEvaluationRunsService

type ProjectsLocationsAppsScheduledEvaluationRunsService struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsScheduledEvaluationRunsService) Create

Create: Creates a scheduled evaluation run.

  • parent: The app to create the scheduled evaluation run for. Format: `projects/{project}/locations/{location}/apps/{app}`.

func (*ProjectsLocationsAppsScheduledEvaluationRunsService) Delete

Delete: Deletes a scheduled evaluation run.

- name: The resource name of the scheduled evaluation run to delete.

func (*ProjectsLocationsAppsScheduledEvaluationRunsService) Get

Get: Gets details of the specified scheduled evaluation run.

- name: The resource name of the scheduled evaluation run to retrieve.

func (*ProjectsLocationsAppsScheduledEvaluationRunsService) List

List: Lists all scheduled evaluation runs in the given app.

  • parent: The resource name of the app to list scheduled evaluation runs from.

func (*ProjectsLocationsAppsScheduledEvaluationRunsService) Patch

Patch: Updates a scheduled evaluation run.

  • name: Identifier. The unique identifier of the scheduled evaluation run config. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluatio nRuns/{scheduledEvaluationRunId}.

type ProjectsLocationsAppsService

func NewProjectsLocationsAppsService

func NewProjectsLocationsAppsService(s *Service) *ProjectsLocationsAppsService

func (*ProjectsLocationsAppsService) Create

Create: Creates a new app in the given project and location.

- parent: The resource name of the location to create an app in.

func (*ProjectsLocationsAppsService) Delete

Delete: Deletes the specified app.

- name: The resource name of the app to delete.

func (*ProjectsLocationsAppsService) ExecuteTool

ExecuteTool: Executes the given tool with the given arguments.

  • parent: The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`.

func (*ProjectsLocationsAppsService) ExportApp

ExportApp: Exports the specified app.

- name: The resource name of the app to export.

func (*ProjectsLocationsAppsService) GenerateAppResource added in v0.274.0

func (r *ProjectsLocationsAppsService) GenerateAppResource(parent string, generateappresourcerequest *GenerateAppResourceRequest) *ProjectsLocationsAppsGenerateAppResourceCall

GenerateAppResource: Generates specific resources (e.g. agent) in the app using LLM assistant.

- parent: The resource name of the app to generate the resource for.

func (*ProjectsLocationsAppsService) Get

Get: Gets details of the specified app.

- name: The resource name of the app to retrieve.

func (*ProjectsLocationsAppsService) ImportApp

ImportApp: Imports the specified app.

- parent: The parent resource name with the location of the app to import.

func (*ProjectsLocationsAppsService) ImportEvaluations

func (r *ProjectsLocationsAppsService) ImportEvaluations(parent string, importevaluationsrequest *ImportEvaluationsRequest) *ProjectsLocationsAppsImportEvaluationsCall

ImportEvaluations: Imports evaluations into the app.

  • parent: The app to import the evaluations into. Format: `projects/{project}/locations/{location}/apps/{app}`.

func (*ProjectsLocationsAppsService) List

List: Lists apps in the given project and location.

- parent: The resource name of the location to list apps from.

func (*ProjectsLocationsAppsService) Patch

Patch: Updates the specified app.

  • name: Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`.

func (*ProjectsLocationsAppsService) RetrieveToolSchema

func (r *ProjectsLocationsAppsService) RetrieveToolSchema(parent string, retrievetoolschemarequest *RetrieveToolSchemaRequest) *ProjectsLocationsAppsRetrieveToolSchemaCall

RetrieveToolSchema: Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool.

  • parent: The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`.

func (*ProjectsLocationsAppsService) RunEvaluation

RunEvaluation: Runs an evaluation of the app.

  • app: The app to evaluate. Format: `projects/{project}/locations/{location}/apps/{app}`.

func (*ProjectsLocationsAppsService) TestPersonaVoice

TestPersonaVoice: Tests the voice of a persona. Also accepts a default persona.

  • app: the resource name of the app to test the persona voice for. Format: `projects/{project}/locations/{location}/apps/{app}`.

type ProjectsLocationsAppsSessionsGenerateChatTokenCall

type ProjectsLocationsAppsSessionsGenerateChatTokenCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsSessionsGenerateChatTokenCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsSessionsGenerateChatTokenCall) Do

Do executes the "ces.projects.locations.apps.sessions.generateChatToken" call. Any non-2xx status code is an error. Response headers are in either *GenerateChatTokenResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsSessionsGenerateChatTokenCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsSessionsGenerateChatTokenCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsSessionsRunSessionCall

type ProjectsLocationsAppsSessionsRunSessionCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsSessionsRunSessionCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsSessionsRunSessionCall) Do

Do executes the "ces.projects.locations.apps.sessions.runSession" call. Any non-2xx status code is an error. Response headers are in either *RunSessionResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsSessionsRunSessionCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsSessionsRunSessionCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsSessionsService

type ProjectsLocationsAppsSessionsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsAppsSessionsService

func NewProjectsLocationsAppsSessionsService(s *Service) *ProjectsLocationsAppsSessionsService

func (*ProjectsLocationsAppsSessionsService) GenerateChatToken

GenerateChatToken: Generates a session scoped token for chat widget to authenticate with Session APIs.

  • name: The session name to generate the chat token for. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}.

func (*ProjectsLocationsAppsSessionsService) RunSession

RunSession: Initiates a single-turn interaction with the CES agent within a session.

  • session: The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`.

func (*ProjectsLocationsAppsSessionsService) StreamRunSession added in v0.274.0

StreamRunSession: Initiates a single-turn interaction with the CES agent. Uses server-side streaming to deliver incremental results and partial responses as they are generated. By default, complete responses (e.g., messages from callbacks or full LLM responses) are sent to the client as soon as they are available. To enable streaming individual text chunks directly from the model, set enable_text_streaming to true.

  • session: The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`.

type ProjectsLocationsAppsSessionsStreamRunSessionCall added in v0.274.0

type ProjectsLocationsAppsSessionsStreamRunSessionCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsSessionsStreamRunSessionCall) Context added in v0.274.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsSessionsStreamRunSessionCall) Do added in v0.274.0

Do executes the "ces.projects.locations.apps.sessions.streamRunSession" call. Any non-2xx status code is an error. Response headers are in either *RunSessionResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsSessionsStreamRunSessionCall) Fields added in v0.274.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsSessionsStreamRunSessionCall) Header added in v0.274.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsTestPersonaVoiceCall

type ProjectsLocationsAppsTestPersonaVoiceCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsTestPersonaVoiceCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsTestPersonaVoiceCall) Do

Do executes the "ces.projects.locations.apps.testPersonaVoice" call. Any non-2xx status code is an error. Response headers are in either *TestPersonaVoiceResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsTestPersonaVoiceCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsTestPersonaVoiceCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsToolsCreateCall

type ProjectsLocationsAppsToolsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsToolsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsToolsCreateCall) Do

Do executes the "ces.projects.locations.apps.tools.create" call. Any non-2xx status code is an error. Response headers are in either *Tool.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsToolsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsToolsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsToolsCreateCall) ToolId

ToolId sets the optional parameter "toolId": The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.

type ProjectsLocationsAppsToolsDeleteCall

type ProjectsLocationsAppsToolsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsToolsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsToolsDeleteCall) Do

Do executes the "ces.projects.locations.apps.tools.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsToolsDeleteCall) Etag

Etag sets the optional parameter "etag": The current etag of the tool. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the tool, deletion will be blocked and an ABORTED error will be returned.

func (*ProjectsLocationsAppsToolsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsToolsDeleteCall) Force

Force sets the optional parameter "force": Indicates whether to forcefully delete the tool, even if it is still referenced by agents/examples. * If `force = false`, the deletion will fail if any agents still reference the tool. * If `force = true`, all existing references from agents will be removed and the tool will be deleted.

func (*ProjectsLocationsAppsToolsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsToolsGetCall

type ProjectsLocationsAppsToolsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsToolsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsToolsGetCall) Do

Do executes the "ces.projects.locations.apps.tools.get" call. Any non-2xx status code is an error. Response headers are in either *Tool.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsToolsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsToolsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsToolsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsAppsToolsListCall

type ProjectsLocationsAppsToolsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsToolsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsToolsListCall) Do

Do executes the "ces.projects.locations.apps.tools.list" call. Any non-2xx status code is an error. Response headers are in either *ListToolsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsToolsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsToolsListCall) Filter

Filter sets the optional parameter "filter": Filter to be applied when listing the tools. Use "include_system_tools=true" to include system tools in the response. See https://google.aip.dev/160 for more details.

func (*ProjectsLocationsAppsToolsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsToolsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsToolsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsAppsToolsListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsAppsToolsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list AgentService.ListTools call.

func (*ProjectsLocationsAppsToolsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsAppsToolsPatchCall

type ProjectsLocationsAppsToolsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsToolsPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsToolsPatchCall) Do

Do executes the "ces.projects.locations.apps.tools.patch" call. Any non-2xx status code is an error. Response headers are in either *Tool.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsToolsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsToolsPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsToolsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

type ProjectsLocationsAppsToolsService

type ProjectsLocationsAppsToolsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsAppsToolsService

func NewProjectsLocationsAppsToolsService(s *Service) *ProjectsLocationsAppsToolsService

func (*ProjectsLocationsAppsToolsService) Create

Create: Creates a new tool in the given app.

- parent: The resource name of the app to create a tool in.

func (*ProjectsLocationsAppsToolsService) Delete

Delete: Deletes the specified tool.

- name: The resource name of the tool to delete.

func (*ProjectsLocationsAppsToolsService) Get

Get: Gets details of the specified tool.

- name: The resource name of the tool to retrieve.

func (*ProjectsLocationsAppsToolsService) List

List: Lists tools in the given app.

- parent: The resource name of the app to list tools from.

func (*ProjectsLocationsAppsToolsService) Patch

Patch: Updates the specified tool.

  • name: Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tool s/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.

type ProjectsLocationsAppsToolsetsCreateCall

type ProjectsLocationsAppsToolsetsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsToolsetsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsToolsetsCreateCall) Do

Do executes the "ces.projects.locations.apps.toolsets.create" call. Any non-2xx status code is an error. Response headers are in either *Toolset.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsToolsetsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsToolsetsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsToolsetsCreateCall) ToolsetId

ToolsetId sets the optional parameter "toolsetId": The ID to use for the toolset, which will become the final component of the toolset's resource name. If not provided, a unique ID will be automatically assigned for the toolset.

type ProjectsLocationsAppsToolsetsDeleteCall

type ProjectsLocationsAppsToolsetsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsToolsetsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsToolsetsDeleteCall) Do

Do executes the "ces.projects.locations.apps.toolsets.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsToolsetsDeleteCall) Etag

Etag sets the optional parameter "etag": The current etag of the toolset. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the toolset, deletion will be blocked and an ABORTED error will be returned.

func (*ProjectsLocationsAppsToolsetsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsToolsetsDeleteCall) Force

Force sets the optional parameter "force": Indicates whether to forcefully delete the toolset, even if it is still referenced by app/agents. * If `force = false`, the deletion fails if any agents still reference the toolset. * If `force = true`, all existing references from agents will be removed and the toolset will be deleted.

func (*ProjectsLocationsAppsToolsetsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsToolsetsGetCall

type ProjectsLocationsAppsToolsetsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsToolsetsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsToolsetsGetCall) Do

Do executes the "ces.projects.locations.apps.toolsets.get" call. Any non-2xx status code is an error. Response headers are in either *Toolset.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsToolsetsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsToolsetsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsToolsetsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsAppsToolsetsListCall

type ProjectsLocationsAppsToolsetsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsToolsetsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsToolsetsListCall) Do

Do executes the "ces.projects.locations.apps.toolsets.list" call. Any non-2xx status code is an error. Response headers are in either *ListToolsetsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsToolsetsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsToolsetsListCall) Filter

Filter sets the optional parameter "filter": Filter to be applied when listing the toolsets. See https://google.aip.dev/160 for more details.

func (*ProjectsLocationsAppsToolsetsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsToolsetsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsToolsetsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsAppsToolsetsListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsAppsToolsetsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list AgentService.ListToolsets call.

func (*ProjectsLocationsAppsToolsetsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsAppsToolsetsPatchCall

type ProjectsLocationsAppsToolsetsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsToolsetsPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsToolsetsPatchCall) Do

Do executes the "ces.projects.locations.apps.toolsets.patch" call. Any non-2xx status code is an error. Response headers are in either *Toolset.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsToolsetsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsToolsetsPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsToolsetsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

type ProjectsLocationsAppsToolsetsRetrieveToolsCall

type ProjectsLocationsAppsToolsetsRetrieveToolsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsToolsetsRetrieveToolsCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsToolsetsRetrieveToolsCall) Do

Do executes the "ces.projects.locations.apps.toolsets.retrieveTools" call. Any non-2xx status code is an error. Response headers are in either *RetrieveToolsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsToolsetsRetrieveToolsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsToolsetsRetrieveToolsCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsToolsetsService

type ProjectsLocationsAppsToolsetsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsAppsToolsetsService

func NewProjectsLocationsAppsToolsetsService(s *Service) *ProjectsLocationsAppsToolsetsService

func (*ProjectsLocationsAppsToolsetsService) Create

Create: Creates a new toolset in the given app.

- parent: The resource name of the app to create a toolset in.

func (*ProjectsLocationsAppsToolsetsService) Delete

Delete: Deletes the specified toolset.

- name: The resource name of the toolset to delete.

func (*ProjectsLocationsAppsToolsetsService) Get

Get: Gets details of the specified toolset.

- name: The resource name of the toolset to retrieve.

func (*ProjectsLocationsAppsToolsetsService) List

List: Lists toolsets in the given app.

- parent: The resource name of the app to list toolsets from.

func (*ProjectsLocationsAppsToolsetsService) Patch

Patch: Updates the specified toolset.

  • name: Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`.

func (*ProjectsLocationsAppsToolsetsService) RetrieveTools

RetrieveTools: Retrieve the list of tools included in the specified toolset.

  • toolset: The name of the toolset to retrieve the tools for. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`.

type ProjectsLocationsAppsVersionsCreateCall

type ProjectsLocationsAppsVersionsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsVersionsCreateCall) AppVersionId

AppVersionId sets the optional parameter "appVersionId": The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.

func (*ProjectsLocationsAppsVersionsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsVersionsCreateCall) Do

Do executes the "ces.projects.locations.apps.versions.create" call. Any non-2xx status code is an error. Response headers are in either *AppVersion.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsVersionsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsVersionsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsVersionsDeleteCall

type ProjectsLocationsAppsVersionsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsVersionsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsVersionsDeleteCall) Do

Do executes the "ces.projects.locations.apps.versions.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsVersionsDeleteCall) Etag

Etag sets the optional parameter "etag": The current etag of the app version. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app version, deletion will be blocked and an ABORTED error will be returned.

func (*ProjectsLocationsAppsVersionsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsVersionsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsVersionsGetCall

type ProjectsLocationsAppsVersionsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsVersionsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsVersionsGetCall) Do

Do executes the "ces.projects.locations.apps.versions.get" call. Any non-2xx status code is an error. Response headers are in either *AppVersion.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsVersionsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsVersionsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsVersionsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsAppsVersionsListCall

type ProjectsLocationsAppsVersionsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsVersionsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsVersionsListCall) Do

Do executes the "ces.projects.locations.apps.versions.list" call. Any non-2xx status code is an error. Response headers are in either *ListAppVersionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsVersionsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsVersionsListCall) Filter

Filter sets the optional parameter "filter": Filter to be applied when listing the app versions. See https://google.aip.dev/160 for more details.

func (*ProjectsLocationsAppsVersionsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsAppsVersionsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsAppsVersionsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsAppsVersionsListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsAppsVersionsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list AgentService.ListAppVersions call.

func (*ProjectsLocationsAppsVersionsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsAppsVersionsRestoreCall

type ProjectsLocationsAppsVersionsRestoreCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsAppsVersionsRestoreCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsAppsVersionsRestoreCall) Do

Do executes the "ces.projects.locations.apps.versions.restore" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsAppsVersionsRestoreCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsAppsVersionsRestoreCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsAppsVersionsService

type ProjectsLocationsAppsVersionsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsAppsVersionsService

func NewProjectsLocationsAppsVersionsService(s *Service) *ProjectsLocationsAppsVersionsService

func (*ProjectsLocationsAppsVersionsService) Create

Create: Creates a new app version in the given app.

- parent: The resource name of the app to create an app version in.

func (*ProjectsLocationsAppsVersionsService) Delete

Delete: Deletes the specified app version.

- name: The resource name of the app version to delete.

func (*ProjectsLocationsAppsVersionsService) Get

Get: Gets details of the specified app version.

- name: The resource name of the app version to retrieve.

func (*ProjectsLocationsAppsVersionsService) List

List: Lists all app versions in the given app.

- parent: The resource name of the app to list app versions from.

func (*ProjectsLocationsAppsVersionsService) Restore

Restore: Restores the specified app version. This will create a new app version from the current draft app and overwrite the current draft with the specified app version.

- name: The resource name of the app version to restore.

type ProjectsLocationsGetCall

type ProjectsLocationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGetCall) Do

Do executes the "ces.projects.locations.get" call. Any non-2xx status code is an error. Response headers are in either *Location.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsGetCall) Header

func (c *ProjectsLocationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsGetCall) IfNoneMatch

func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsGetSecuritySettingsCall added in v0.270.0

type ProjectsLocationsGetSecuritySettingsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsGetSecuritySettingsCall) Context added in v0.270.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGetSecuritySettingsCall) Do added in v0.270.0

Do executes the "ces.projects.locations.getSecuritySettings" call. Any non-2xx status code is an error. Response headers are in either *SecuritySettings.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGetSecuritySettingsCall) Fields added in v0.270.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsGetSecuritySettingsCall) Header added in v0.270.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsGetSecuritySettingsCall) IfNoneMatch added in v0.270.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsListCall

type ProjectsLocationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsListCall) Do

Do executes the "ces.projects.locations.list" call. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsListCall) ExtraLocationTypes

func (c *ProjectsLocationsListCall) ExtraLocationTypes(extraLocationTypes ...string) *ProjectsLocationsListCall

ExtraLocationTypes sets the optional parameter "extraLocationTypes": Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.

func (*ProjectsLocationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsListCall) Filter

Filter sets the optional parameter "filter": A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).

func (*ProjectsLocationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsListCall) IfNoneMatch

func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

func (*ProjectsLocationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsOperationsCancelCall

type ProjectsLocationsOperationsCancelCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsCancelCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsCancelCall) Do

Do executes the "ces.projects.locations.operations.cancel" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsCancelCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsCancelCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsOperationsDeleteCall

type ProjectsLocationsOperationsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsDeleteCall) Do

Do executes the "ces.projects.locations.operations.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsOperationsGetCall

type ProjectsLocationsOperationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsGetCall) Do

Do executes the "ces.projects.locations.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOperationsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsOperationsListCall

type ProjectsLocationsOperationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsListCall) Do

Do executes the "ces.projects.locations.operations.list" call. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsListCall) Filter

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsOperationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOperationsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsOperationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsLocationsOperationsListCall) PageToken

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsLocationsOperationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsOperationsListCall) ReturnPartialSuccess

func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall

ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to "projects/example/locations/-". This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

type ProjectsLocationsOperationsService

type ProjectsLocationsOperationsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsOperationsService

func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService

func (*ProjectsLocationsOperationsService) Cancel

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsLocationsOperationsService) Delete

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*ProjectsLocationsOperationsService) Get

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService) List

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

type ProjectsLocationsService

type ProjectsLocationsService struct {
	Apps *ProjectsLocationsAppsService

	Operations *ProjectsLocationsOperationsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService) GetSecuritySettings added in v0.270.0

GetSecuritySettings: Retrieves the security settings for the project and location.

  • name: The resource name of the security settings to retrieve. Format: `projects/{project}/locations/{location}/securitySettings`.

func (*ProjectsLocationsService) List

List: Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

- name: The resource that owns the locations collection, if applicable.

func (*ProjectsLocationsService) UpdateSecuritySettings added in v0.270.0

func (r *ProjectsLocationsService) UpdateSecuritySettings(nameid string, securitysettings *SecuritySettings) *ProjectsLocationsUpdateSecuritySettingsCall

UpdateSecuritySettings: Updates the security settings for the project and location.

  • name: Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`.

type ProjectsLocationsUpdateSecuritySettingsCall added in v0.270.0

type ProjectsLocationsUpdateSecuritySettingsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsUpdateSecuritySettingsCall) Context added in v0.270.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsUpdateSecuritySettingsCall) Do added in v0.270.0

Do executes the "ces.projects.locations.updateSecuritySettings" call. Any non-2xx status code is an error. Response headers are in either *SecuritySettings.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsUpdateSecuritySettingsCall) Fields added in v0.270.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsUpdateSecuritySettingsCall) Header added in v0.270.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsUpdateSecuritySettingsCall) UpdateMask added in v0.270.0

UpdateMask sets the optional parameter "updateMask": Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

type ProjectsService

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type PythonCodeCondition

type PythonCodeCondition struct {
	// PythonCode: Required. The python code to execute.
	PythonCode string `json:"pythonCode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PythonCode") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "PythonCode") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PythonCodeCondition: Python code block to evaluate the condition.

func (PythonCodeCondition) MarshalJSON

func (s PythonCodeCondition) MarshalJSON() ([]byte, error)

type PythonFunction

type PythonFunction struct {
	// Description: Output only. The description of the Python function, parsed
	// from the python code's docstring.
	Description string `json:"description,omitempty"`
	// Name: Optional. The name of the Python function to execute. Must match a
	// Python function name defined in the python code. Case sensitive. If the name
	// is not provided, the first function defined in the python code will be used.
	Name string `json:"name,omitempty"`
	// PythonCode: Optional. The Python code to execute for the tool.
	PythonCode string `json:"pythonCode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PythonFunction: A Python function tool.

func (PythonFunction) MarshalJSON

func (s PythonFunction) MarshalJSON() ([]byte, error)

type QualityReport added in v0.274.0

type QualityReport struct {
	// EvaluationRuns: Optional. A list of evaluation runs used to generate the
	// quality report. Format:
	// `projects/{project}/locations/{location}/evaluationRuns/{evaluationRun}`.
	EvaluationRuns []string `json:"evaluationRuns,omitempty"`
	// GeneralIssues: Optional. General issues not specific to any agent.
	GeneralIssues []*QualityReportIssue `json:"generalIssues,omitempty"`
	// Issues: Optional. The issues grouped by agent.
	Issues []*QualityReportAgentIssues `json:"issues,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EvaluationRuns") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EvaluationRuns") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

QualityReport: The report describing any identified quality issues in the app.

func (QualityReport) MarshalJSON added in v0.274.0

func (s QualityReport) MarshalJSON() ([]byte, error)

type QualityReportAgentIssues added in v0.274.0

type QualityReportAgentIssues struct {
	// Agent: Optional. The name of the agent to which the issues are related.
	// Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
	Agent string `json:"agent,omitempty"`
	// Issues: Optional. List of issues found for this agent.
	Issues []*QualityReportIssue `json:"issues,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Agent") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Agent") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

QualityReportAgentIssues: Issues identified for a single agent.

func (QualityReportAgentIssues) MarshalJSON added in v0.274.0

func (s QualityReportAgentIssues) MarshalJSON() ([]byte, error)

type QualityReportIssue added in v0.274.0

type QualityReportIssue struct {
	// Description: Optional. Description of the issue found.
	Description string `json:"description,omitempty"`
	// OccurrenceCount: Optional. How many times this issue occurred.
	OccurrenceCount int64 `json:"occurrenceCount,omitempty"`
	// ProposedSolution: Optional. Proposed solution to fix the issue by modifying
	// instructions or tools.
	ProposedSolution string `json:"proposedSolution,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

QualityReportIssue: The issue identified.

func (QualityReportIssue) MarshalJSON added in v0.274.0

func (s QualityReportIssue) MarshalJSON() ([]byte, error)

type RedactionConfig

type RedactionConfig struct {
	// DeidentifyTemplate: Optional. DLP (https://cloud.google.com/dlp/docs)
	// deidentify template name to instruct on how to de-identify content. Format:
	// `projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_temp
	// late}`
	DeidentifyTemplate string `json:"deidentifyTemplate,omitempty"`
	// EnableRedaction: Optional. If true, redaction will be applied in various
	// logging scenarios, including conversation history, Cloud Logging and audio
	// recording.
	EnableRedaction bool `json:"enableRedaction,omitempty"`
	// InspectTemplate: Optional. DLP (https://cloud.google.com/dlp/docs) inspect
	// template name to configure detection of sensitive data types. Format:
	// `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}`
	InspectTemplate string `json:"inspectTemplate,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DeidentifyTemplate") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DeidentifyTemplate") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RedactionConfig: Configuration to instruct how sensitive data should be handled.

func (RedactionConfig) MarshalJSON

func (s RedactionConfig) MarshalJSON() ([]byte, error)

type RemoteAgentTool added in v0.279.0

type RemoteAgentTool struct {
	// AgentCard: Required. The agent card of the remote agent that this tool
	// invokes.
	AgentCard *AgentCard `json:"agentCard,omitempty"`
	// Description: Required. The description of the tool.
	Description string `json:"description,omitempty"`
	// Name: Required. The name of the tool.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AgentCard") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AgentCard") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RemoteAgentTool: Represents a tool that allows the agent to call another remote agent.

func (RemoteAgentTool) MarshalJSON added in v0.279.0

func (s RemoteAgentTool) MarshalJSON() ([]byte, error)

type RestoreAppVersionRequest

type RestoreAppVersionRequest struct {
}

RestoreAppVersionRequest: Request message for AgentService.RestoreAppVersion

type RetrieveToolSchemaRequest

type RetrieveToolSchemaRequest struct {
	// Tool: Optional. The name of the tool to retrieve the schema for. Format:
	// projects/{project}/locations/{location}/apps/{app}/tools/{tool}
	Tool string `json:"tool,omitempty"`
	// ToolsetTool: Optional. The toolset tool to retrieve the schema for. Only one
	// tool should match the predicate from the toolset. Otherwise, an error will
	// be returned.
	ToolsetTool *ToolsetTool `json:"toolsetTool,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Tool") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Tool") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RetrieveToolSchemaRequest: Request message for ToolService.RetrieveToolSchema.

func (RetrieveToolSchemaRequest) MarshalJSON

func (s RetrieveToolSchemaRequest) MarshalJSON() ([]byte, error)

type RetrieveToolSchemaResponse

type RetrieveToolSchemaResponse struct {
	// InputSchema: The schema of the tool input parameters.
	InputSchema *Schema `json:"inputSchema,omitempty"`
	// OutputSchema: The schema of the tool output parameters.
	OutputSchema *Schema `json:"outputSchema,omitempty"`
	// Tool: The name of the tool that the schema is for. Format:
	// `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
	Tool string `json:"tool,omitempty"`
	// ToolsetTool: The toolset tool that the schema is for.
	ToolsetTool *ToolsetTool `json:"toolsetTool,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "InputSchema") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "InputSchema") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RetrieveToolSchemaResponse: Response message for ToolService.RetrieveToolSchema.

func (RetrieveToolSchemaResponse) MarshalJSON

func (s RetrieveToolSchemaResponse) MarshalJSON() ([]byte, error)

type RetrieveToolsRequest

type RetrieveToolsRequest struct {
	// ToolIds: Optional. The identifiers of the tools to retrieve from the
	// toolset. If empty, all tools in the toolset will be returned.
	ToolIds []string `json:"toolIds,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ToolIds") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ToolIds") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RetrieveToolsRequest: Request message for ToolService.RetrieveTools.

func (RetrieveToolsRequest) MarshalJSON

func (s RetrieveToolsRequest) MarshalJSON() ([]byte, error)

type RetrieveToolsResponse

type RetrieveToolsResponse struct {
	// Tools: The list of tools that are included in the specified toolset.
	Tools []*Tool `json:"tools,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Tools") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Tools") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RetrieveToolsResponse: Response message for ToolService.RetrieveTools.

func (RetrieveToolsResponse) MarshalJSON

func (s RetrieveToolsResponse) MarshalJSON() ([]byte, error)

type RunEvaluationRequest

type RunEvaluationRequest struct {
	// App: Required. The app to evaluate. Format:
	// `projects/{project}/locations/{location}/apps/{app}`
	App string `json:"app,omitempty"`
	// AppVersion: Optional. The app version to evaluate. Format:
	// `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
	AppVersion string `json:"appVersion,omitempty"`
	// Config: Optional. The configuration to use for the run.
	Config *EvaluationConfig `json:"config,omitempty"`
	// DisplayName: Optional. The display name of the evaluation run.
	DisplayName string `json:"displayName,omitempty"`
	// EvaluationDataset: Optional. An evaluation dataset to run. Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evalu
	// ationDataset}`
	EvaluationDataset string `json:"evaluationDataset,omitempty"`
	// Evaluations: Optional. List of evaluations to run. Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`
	Evaluations []string `json:"evaluations,omitempty"`
	// GenerateLatencyReport: Optional. Whether to generate a latency report for
	// the evaluation run.
	GenerateLatencyReport bool `json:"generateLatencyReport,omitempty"`
	// GoldenRunMethod: Optional. The method to run the evaluation if it is a
	// golden evaluation. If not set, default to STABLE.
	//
	// Possible values:
	//   "GOLDEN_RUN_METHOD_UNSPECIFIED" - Run method is not specified.
	//   "STABLE" - Run the evaluation as stable replay, where each turn is a
	// unique session with the previous expected turns injected as context.
	//   "NAIVE" - Run the evaluation as naive replay, where the run is a single
	// session with no context injected.
	GoldenRunMethod string `json:"goldenRunMethod,omitempty"`
	// OptimizationConfig: Optional. Configuration for running the optimization
	// step after the evaluation run. If not set, the optimization step will not be
	// run.
	OptimizationConfig *OptimizationConfig `json:"optimizationConfig,omitempty"`
	// PersonaRunConfigs: Optional. The configuration to use for the run per
	// persona.
	PersonaRunConfigs []*PersonaRunConfig `json:"personaRunConfigs,omitempty"`
	// RunCount: Optional. The number of times to run the evaluation. If not set,
	// the default value is 1 per golden, and 5 per scenario.
	RunCount int64 `json:"runCount,omitempty"`
	// ScheduledEvaluationRun: Optional. The resource name of the
	// `ScheduledEvaluationRun` that is triggering this evaluation run. If this
	// field is set, the `scheduled_evaluation_run` field on the created
	// `EvaluationRun` resource will be populated from this value. Format:
	// `projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{
	// scheduled_evaluation_run}`
	ScheduledEvaluationRun string `json:"scheduledEvaluationRun,omitempty"`
	// ForceSendFields is a list of field names (e.g. "App") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "App") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RunEvaluationRequest: Request message for EvaluationService.RunEvaluation.

func (RunEvaluationRequest) MarshalJSON

func (s RunEvaluationRequest) MarshalJSON() ([]byte, error)

type RunSessionRequest

type RunSessionRequest struct {
	// Config: Required. The configuration for the session.
	Config *SessionConfig `json:"config,omitempty"`
	// Inputs: Required. Inputs for the session.
	Inputs []*SessionInput `json:"inputs,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Config") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Config") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RunSessionRequest: Request message for SessionService.RunSession.

func (RunSessionRequest) MarshalJSON

func (s RunSessionRequest) MarshalJSON() ([]byte, error)

type RunSessionResponse

type RunSessionResponse struct {
	// Outputs: Outputs for the session.
	Outputs []*SessionOutput `json:"outputs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Outputs") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Outputs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RunSessionResponse: Response message for SessionService.RunSession.

func (RunSessionResponse) MarshalJSON

func (s RunSessionResponse) MarshalJSON() ([]byte, error)

type ScheduledEvaluationRun

type ScheduledEvaluationRun struct {
	// Active: Optional. Whether this config is active
	Active bool `json:"active,omitempty"`
	// CreateTime: Output only. Timestamp when the scheduled evaluation run was
	// created.
	CreateTime string `json:"createTime,omitempty"`
	// CreatedBy: Output only. The user who created the scheduled evaluation run.
	CreatedBy string `json:"createdBy,omitempty"`
	// Description: Optional. User-defined description of the scheduled evaluation
	// run.
	Description string `json:"description,omitempty"`
	// DisplayName: Required. User-defined display name of the scheduled evaluation
	// run config.
	DisplayName string `json:"displayName,omitempty"`
	// Etag: Output only. Etag used to ensure the object hasn't changed during a
	// read-modify-write operation. If the etag is empty, the update will overwrite
	// any concurrent changes.
	Etag string `json:"etag,omitempty"`
	// LastCompletedRun: Output only. The last successful EvaluationRun of this
	// scheduled execution. Format:
	// `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluatio
	// nRun}`
	LastCompletedRun string `json:"lastCompletedRun,omitempty"`
	// LastUpdatedBy: Output only. The user who last updated the evaluation.
	LastUpdatedBy string `json:"lastUpdatedBy,omitempty"`
	// Name: Identifier. The unique identifier of the scheduled evaluation run
	// config. Format:
	// projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationR
	// uns/{scheduledEvaluationRunId}
	Name string `json:"name,omitempty"`
	// NextScheduledExecutionTime: Output only. The next time this is scheduled to
	// execute
	NextScheduledExecutionTime string `json:"nextScheduledExecutionTime,omitempty"`
	// Request: Required. The RunEvaluationRequest to schedule
	Request *RunEvaluationRequest `json:"request,omitempty"`
	// SchedulingConfig: Required. Configuration for the timing and frequency with
	// which to execute the evaluations.
	SchedulingConfig *ScheduledEvaluationRunSchedulingConfig `json:"schedulingConfig,omitempty"`
	// TotalExecutions: Output only. The total number of times this run has been
	// executed
	TotalExecutions int64 `json:"totalExecutions,omitempty"`
	// UpdateTime: Output only. Timestamp when the evaluation was last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Active") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Active") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ScheduledEvaluationRun: Represents a scheduled evaluation run configuration.

func (ScheduledEvaluationRun) MarshalJSON

func (s ScheduledEvaluationRun) MarshalJSON() ([]byte, error)

type ScheduledEvaluationRunSchedulingConfig

type ScheduledEvaluationRunSchedulingConfig struct {
	// DaysOfWeek: Optional. The days of the week to run the eval. Applicable only
	// for Weekly and Biweekly frequencies. 1 is Monday, 2 is Tuesday, ..., 7 is
	// Sunday.
	DaysOfWeek []int64 `json:"daysOfWeek,omitempty"`
	// Frequency: Required. The frequency with which to run the eval
	//
	// Possible values:
	//   "FREQUENCY_UNSPECIFIED" - The frequency is unspecified.
	//   "NONE" - Indicates a one-time scheduled run that should not repeat
	//   "DAILY" - Run the evaluation daily.
	//   "WEEKLY" - Run the evaluation weekly.
	//   "BIWEEKLY" - Run the evaluation biweekly.
	Frequency string `json:"frequency,omitempty"`
	// StartTime: Required. Timestamp when the eval should start.
	StartTime string `json:"startTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DaysOfWeek") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DaysOfWeek") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ScheduledEvaluationRunSchedulingConfig: Eval scheduling configuration details

func (ScheduledEvaluationRunSchedulingConfig) MarshalJSON

func (s ScheduledEvaluationRunSchedulingConfig) MarshalJSON() ([]byte, error)

type Schema

type Schema struct {
	// AdditionalProperties: Optional. Can either be a boolean or an object,
	// controls the presence of additional properties.
	AdditionalProperties *Schema `json:"additionalProperties,omitempty"`
	// AnyOf: Optional. The value should be validated against any (one or more) of
	// the subschemas in the list.
	AnyOf []*Schema `json:"anyOf,omitempty"`
	// Default: Optional. Default value of the data.
	Default interface{} `json:"default,omitempty"`
	// Defs: Optional. A map of definitions for use by `ref`. Only allowed at the
	// root of the schema.
	Defs map[string]Schema `json:"defs,omitempty"`
	// Description: Optional. The description of the data.
	Description string `json:"description,omitempty"`
	// Enum: Optional. Possible values of the element of primitive type with enum
	// format. Examples: 1. We can define direction as : {type:STRING, format:enum,
	// enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as
	// : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
	Enum []string `json:"enum,omitempty"`
	// Items: Optional. Schema of the elements of Type.ARRAY.
	Items *Schema `json:"items,omitempty"`
	// MaxItems: Optional. Maximum number of the elements for Type.ARRAY.
	MaxItems int64 `json:"maxItems,omitempty,string"`
	// Maximum: Optional. Maximum value for Type.INTEGER and Type.NUMBER.
	Maximum float64 `json:"maximum,omitempty"`
	// MinItems: Optional. Minimum number of the elements for Type.ARRAY.
	MinItems int64 `json:"minItems,omitempty,string"`
	// Minimum: Optional. Minimum value for Type.INTEGER and Type.NUMBER.
	Minimum float64 `json:"minimum,omitempty"`
	// Nullable: Optional. Indicates if the value may be null.
	Nullable bool `json:"nullable,omitempty"`
	// PrefixItems: Optional. Schemas of initial elements of Type.ARRAY.
	PrefixItems []*Schema `json:"prefixItems,omitempty"`
	// Properties: Optional. Properties of Type.OBJECT.
	Properties map[string]Schema `json:"properties,omitempty"`
	// Ref: Optional. Allows indirect references between schema nodes. The value
	// should be a valid reference to a child of the root `defs`. For example, the
	// following schema defines a reference to a schema node named "Pet": “` type:
	// object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties:
	// name: type: string “` The value of the "pet" property is a reference to the
	// schema node named "Pet". See details in
	// https://json-schema.org/understanding-json-schema/structuring.
	Ref string `json:"ref,omitempty"`
	// Required: Optional. Required properties of Type.OBJECT.
	Required []string `json:"required,omitempty"`
	// Title: Optional. The title of the schema.
	Title string `json:"title,omitempty"`
	// Type: Required. The type of the data.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Type unspecified.
	//   "STRING" - String type.
	//   "INTEGER" - Integer type.
	//   "NUMBER" - Number type.
	//   "BOOLEAN" - Boolean type.
	//   "OBJECT" - Object type.
	//   "ARRAY" - Array type.
	Type string `json:"type,omitempty"`
	// UniqueItems: Optional. Indicate the items in the array must be unique. Only
	// applies to TYPE.ARRAY.
	UniqueItems bool `json:"uniqueItems,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AdditionalProperties") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AdditionalProperties") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Schema: Represents a select subset of an OpenAPI 3.0 schema object.

func (Schema) MarshalJSON

func (s Schema) MarshalJSON() ([]byte, error)

func (*Schema) UnmarshalJSON

func (s *Schema) UnmarshalJSON(data []byte) error

type SecuritySettings added in v0.270.0

type SecuritySettings struct {
	// CreateTime: Output only. Create time of the security settings.
	CreateTime string `json:"createTime,omitempty"`
	// EndpointControlPolicy: Optional. Endpoint control related settings.
	EndpointControlPolicy *EndpointControlPolicy `json:"endpointControlPolicy,omitempty"`
	// Etag: Output only. Etag of the security settings.
	Etag string `json:"etag,omitempty"`
	// Name: Identifier. The unique identifier of the security settings. Format:
	// `projects/{project}/locations/{location}/securitySettings`
	Name string `json:"name,omitempty"`
	// UpdateTime: Output only. Last update time of the security settings.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SecuritySettings: Project/Location level security settings for CES.

func (SecuritySettings) MarshalJSON added in v0.270.0

func (s SecuritySettings) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type ServiceAccountAuthConfig

type ServiceAccountAuthConfig struct {
	// Scopes: Optional. The OAuth scopes to grant. If not specified, the default
	// scope `https://www.googleapis.com/auth/cloud-platform` is used.
	Scopes []string `json:"scopes,omitempty"`
	// ServiceAccount: Required. The email address of the service account used for
	// authentication. CES uses this service account to exchange an access token
	// and the access token is then sent in the `Authorization` header of the
	// request. The service account must have the
	// `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent
	// `service-@gcp-sa-ces.iam.gserviceaccount.com`.
	ServiceAccount string `json:"serviceAccount,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Scopes") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Scopes") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ServiceAccountAuthConfig: Configurations for authentication using a custom service account.

func (ServiceAccountAuthConfig) MarshalJSON

func (s ServiceAccountAuthConfig) MarshalJSON() ([]byte, error)

type ServiceAgentIdTokenAuthConfig

type ServiceAgentIdTokenAuthConfig struct {
}

ServiceAgentIdTokenAuthConfig: Configurations for authentication with ID token (https://cloud.google.com/docs/authentication/token-types#id) generated from service agent.

type ServiceDirectoryConfig

type ServiceDirectoryConfig struct {
	// Service: Required. The name of Service Directory
	// (https://cloud.google.com/service-directory) service. Format:
	// `projects/{project}/locations/{location}/namespaces/{namespace}/services/{ser
	// vice}`. Location of the service directory must be the same as the location
	// of the app.
	Service string `json:"service,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Service") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Service") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ServiceDirectoryConfig: Configuration for tools using Service Directory.

func (ServiceDirectoryConfig) MarshalJSON

func (s ServiceDirectoryConfig) MarshalJSON() ([]byte, error)

type SessionConfig

type SessionConfig struct {
	// Deployment: Optional. The deployment of the app to use for the session.
	// Format:
	// `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
	Deployment string `json:"deployment,omitempty"`
	// EnableTextStreaming: Optional. Whether to enable streaming text outputs from
	// the model. By default, text outputs from the model are collected before
	// sending to the client. NOTE: This is only supported for text (non-voice)
	// sessions via StreamRunSession or BidiRunSession.
	EnableTextStreaming bool `json:"enableTextStreaming,omitempty"`
	// EntryAgent: Optional. The entry agent to handle the session. If not
	// specified, the session will be handled by the root agent of the app. Format:
	// `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
	EntryAgent string `json:"entryAgent,omitempty"`
	// HistoricalContexts: Optional. The historical context of the session,
	// including user inputs, agent responses, and other messages. Typically, CES
	// agent would manage session automatically so client doesn't need to
	// explicitly populate this field. However, client can optionally override the
	// historical contexts to force the session start from certain state.
	HistoricalContexts []*Message `json:"historicalContexts,omitempty"`
	// InputAudioConfig: Optional. Configuration for processing the input audio.
	InputAudioConfig *InputAudioConfig `json:"inputAudioConfig,omitempty"`
	// OutputAudioConfig: Optional. Configuration for generating the output audio.
	OutputAudioConfig *OutputAudioConfig `json:"outputAudioConfig,omitempty"`
	// RemoteDialogflowQueryParameters: Optional. QueryParameters
	// (https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters)
	// to send to the remote Dialogflow
	// (https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents)
	// agent when the session control is transferred to the remote agent.
	RemoteDialogflowQueryParameters *SessionConfigRemoteDialogflowQueryParameters `json:"remoteDialogflowQueryParameters,omitempty"`
	// TimeZone: Optional. The time zone of the user. If provided, the agent will
	// use the time zone for date and time related variables. Otherwise, the agent
	// will use the time zone specified in the App.time_zone_settings. The format
	// is the IANA Time Zone Database time zone, e.g. "America/Los_Angeles".
	TimeZone string `json:"timeZone,omitempty"`
	// UseToolFakes: Optional. Whether to use tool fakes for the session. If this
	// field is set, the agent will attempt use tool fakes instead of calling the
	// real tools.
	UseToolFakes bool `json:"useToolFakes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Deployment") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Deployment") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SessionConfig: The configuration for the session.

func (SessionConfig) MarshalJSON

func (s SessionConfig) MarshalJSON() ([]byte, error)

type SessionConfigRemoteDialogflowQueryParameters

type SessionConfigRemoteDialogflowQueryParameters struct {
	// EndUserMetadata: Optional. The end user metadata to be sent in
	// QueryParameters
	// (https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters).
	EndUserMetadata googleapi.RawMessage `json:"endUserMetadata,omitempty"`
	// Payload: Optional. The payload to be sent in QueryParameters
	// (https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters).
	Payload googleapi.RawMessage `json:"payload,omitempty"`
	// WebhookHeaders: Optional. The HTTP headers to be sent as webhook_headers in
	// QueryParameters
	// (https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters).
	WebhookHeaders map[string]string `json:"webhookHeaders,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndUserMetadata") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EndUserMetadata") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SessionConfigRemoteDialogflowQueryParameters: QueryParameters (https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters) to send to the remote Dialogflow (https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent when the session control is transferred to the remote agent.

func (SessionConfigRemoteDialogflowQueryParameters) MarshalJSON

type SessionInput

type SessionInput struct {
	// Audio: Optional. Audio data from the end user.
	Audio string `json:"audio,omitempty"`
	// Blob: Optional. Blob data from the end user.
	Blob *Blob `json:"blob,omitempty"`
	// Dtmf: Optional. DTMF digits from the end user.
	Dtmf string `json:"dtmf,omitempty"`
	// Event: Optional. Event input.
	Event *Event `json:"event,omitempty"`
	// Image: Optional. Image data from the end user.
	Image *Image `json:"image,omitempty"`
	// Text: Optional. Text data from the end user.
	Text string `json:"text,omitempty"`
	// ToolResponses: Optional. Execution results for the tool calls from the
	// client.
	ToolResponses *ToolResponses `json:"toolResponses,omitempty"`
	// Variables: Optional. Contextual variables for the session, keyed by name.
	// Only variables declared in the app will be used by the CES agent.
	// Unrecognized variables will still be sent to the Dialogflow agent as
	// additional session parameters.
	Variables googleapi.RawMessage `json:"variables,omitempty"`
	// WillContinue: Optional. A flag to indicate if the current message is a
	// fragment of a larger input in the bidi streaming session. When set to
	// `true`, the agent defers processing until it receives a subsequent message
	// where `will_continue` is `false`, or until the system detects an endpoint in
	// the audio input. NOTE: This field does not apply to audio and DTMF inputs,
	// as they are always processed automatically based on the endpointing signal.
	WillContinue bool `json:"willContinue,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Audio") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Audio") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SessionInput: Input for the session.

func (SessionInput) MarshalJSON

func (s SessionInput) MarshalJSON() ([]byte, error)

type SessionOutput

type SessionOutput struct {
	// Audio: Output audio from the CES agent.
	Audio string `json:"audio,omitempty"`
	// Citations: Citations that provide the source information for the agent's
	// generated text.
	Citations *Citations `json:"citations,omitempty"`
	// DiagnosticInfo: Optional. Diagnostic information contains execution details
	// during the processing of the input. Only populated in the last SessionOutput
	// (with `turn_completed=true`) for each turn.
	DiagnosticInfo *SessionOutputDiagnosticInfo `json:"diagnosticInfo,omitempty"`
	// EndSession: Indicates the session has ended.
	EndSession *EndSession `json:"endSession,omitempty"`
	// GoogleSearchSuggestions: The suggestions returned from Google Search as a
	// result of invoking the GoogleSearchTool.
	GoogleSearchSuggestions *GoogleSearchSuggestions `json:"googleSearchSuggestions,omitempty"`
	// Payload: Custom payload with structured output from the CES agent.
	Payload googleapi.RawMessage `json:"payload,omitempty"`
	// Text: Output text from the CES agent.
	Text string `json:"text,omitempty"`
	// ToolCalls: Request for the client to execute the tools.
	ToolCalls *ToolCalls `json:"toolCalls,omitempty"`
	// TurnCompleted: If true, the CES agent has detected the end of the current
	// conversation turn and will provide no further output for this turn.
	TurnCompleted bool `json:"turnCompleted,omitempty"`
	// TurnIndex: Indicates the sequential order of conversation turn to which this
	// output belongs to, starting from 1.
	TurnIndex int64 `json:"turnIndex,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Audio") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Audio") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SessionOutput: Output for the session.

func (SessionOutput) MarshalJSON

func (s SessionOutput) MarshalJSON() ([]byte, error)

type SessionOutputDiagnosticInfo

type SessionOutputDiagnosticInfo struct {
	// Messages: List of the messages that happened during the processing.
	Messages []*Message `json:"messages,omitempty"`
	// RootSpan: A trace of the entire request processing, represented as a root
	// span. This span can contain nested child spans for specific operations.
	RootSpan *Span `json:"rootSpan,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Messages") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Messages") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SessionOutputDiagnosticInfo: Contains execution details during the processing.

func (SessionOutputDiagnosticInfo) MarshalJSON

func (s SessionOutputDiagnosticInfo) MarshalJSON() ([]byte, error)

type Span

type Span struct {
	// Attributes: Output only. Key-value attributes associated with the span.
	Attributes googleapi.RawMessage `json:"attributes,omitempty"`
	// ChildSpans: Output only. The child spans that are nested under this span.
	ChildSpans []*Span `json:"childSpans,omitempty"`
	// Duration: Output only. The duration of the span.
	Duration string `json:"duration,omitempty"`
	// EndTime: Output only. The end time of the span.
	EndTime string `json:"endTime,omitempty"`
	// Name: Output only. The name of the span.
	Name string `json:"name,omitempty"`
	// StartTime: Output only. The start time of the span.
	StartTime string `json:"startTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Attributes") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Attributes") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Span: A span is a unit of work or a single operation during the request processing.

func (Span) MarshalJSON

func (s Span) MarshalJSON() ([]byte, error)

type Status

type Status struct {
	// Code: The status code, which should be an enum value of google.rpc.Code.
	Code int64 `json:"code,omitempty"`
	// Details: A list of messages that carry the error details. There is a common
	// set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`
	// Message: A developer-facing error message, which should be in English. Any
	// user-facing error message should be localized and sent in the
	// google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Code") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (Status) MarshalJSON

func (s Status) MarshalJSON() ([]byte, error)

type SynthesizeSpeechConfig

type SynthesizeSpeechConfig struct {
	// SpeakingRate: Optional. The speaking rate/speed in the range [0.25, 2.0].
	// 1.0 is the normal native speed supported by the specific voice. 2.0 is twice
	// as fast, and 0.5 is half as fast. Values outside of the range [0.25, 2.0]
	// will return an error.
	SpeakingRate float64 `json:"speakingRate,omitempty"`
	// Voice: Optional. The name of the voice. If not set, the service will choose
	// a voice based on the other parameters such as language_code. For the list of
	// available voices, please refer to Supported voices and languages
	// (https://cloud.google.com/text-to-speech/docs/voices) from Cloud
	// Text-to-Speech.
	Voice string `json:"voice,omitempty"`
	// ForceSendFields is a list of field names (e.g. "SpeakingRate") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "SpeakingRate") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SynthesizeSpeechConfig: Configuration for how the agent response should be synthesized.

func (SynthesizeSpeechConfig) MarshalJSON

func (s SynthesizeSpeechConfig) MarshalJSON() ([]byte, error)

func (*SynthesizeSpeechConfig) UnmarshalJSON

func (s *SynthesizeSpeechConfig) UnmarshalJSON(data []byte) error

type SystemTool

type SystemTool struct {
	// Description: Output only. The description of the system tool.
	Description string `json:"description,omitempty"`
	// Name: Required. The name of the system tool.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SystemTool: Pre-defined system tool.

func (SystemTool) MarshalJSON

func (s SystemTool) MarshalJSON() ([]byte, error)

type TestPersonaVoiceRequest

type TestPersonaVoiceRequest struct {
	// PersonaId: Required. The persona ID to test the voice for. Also accepts
	// "default".
	PersonaId string `json:"personaId,omitempty"`
	// Text: Required. The text to test the voice for.
	Text string `json:"text,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PersonaId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "PersonaId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TestPersonaVoiceRequest: Request message for EvaluationService.TestPersonaVoice.

func (TestPersonaVoiceRequest) MarshalJSON

func (s TestPersonaVoiceRequest) MarshalJSON() ([]byte, error)

type TestPersonaVoiceResponse

type TestPersonaVoiceResponse struct {
	// Audio: The audio data bytes of the synthesized voice.
	Audio string `json:"audio,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Audio") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Audio") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TestPersonaVoiceResponse: Response message for EvaluationService.TestPersonaVoice.

func (TestPersonaVoiceResponse) MarshalJSON

func (s TestPersonaVoiceResponse) MarshalJSON() ([]byte, error)

type TimeZoneSettings

type TimeZoneSettings struct {
	// TimeZone: Optional. The time zone of the app from the time zone database
	// (https://www.iana.org/time-zones), e.g., America/Los_Angeles, Europe/Paris.
	TimeZone string `json:"timeZone,omitempty"`
	// ForceSendFields is a list of field names (e.g. "TimeZone") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "TimeZone") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TimeZoneSettings: TimeZone settings of the app.

func (TimeZoneSettings) MarshalJSON

func (s TimeZoneSettings) MarshalJSON() ([]byte, error)

type TlsConfig

type TlsConfig struct {
	// CaCerts: Required. Specifies a list of allowed custom CA certificates for
	// HTTPS verification.
	CaCerts []*TlsConfigCaCert `json:"caCerts,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CaCerts") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CaCerts") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TlsConfig: The TLS configuration.

func (TlsConfig) MarshalJSON

func (s TlsConfig) MarshalJSON() ([]byte, error)

type TlsConfigCaCert

type TlsConfigCaCert struct {
	// Cert: Required. The allowed custom CA certificates (in DER format) for HTTPS
	// verification. This overrides the default SSL trust store. If this is empty
	// or unspecified, CES will use Google's default trust store to verify
	// certificates. N.B. Make sure the HTTPS server certificates are signed with
	// "subject alt name". For instance a certificate can be self-signed using the
	// following command: “` openssl x509 -req -days 200 -in example.com.csr \
	// -signkey example.com.key \ -out example.com.crt \ -extfile <(printf
	// "\nsubjectAltName='DNS:www.example.com'") “`
	Cert string `json:"cert,omitempty"`
	// DisplayName: Required. The name of the allowed custom CA certificates. This
	// can be used to disambiguate the custom CA certificates.
	DisplayName string `json:"displayName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Cert") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Cert") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TlsConfigCaCert: The CA certificate.

func (TlsConfigCaCert) MarshalJSON

func (s TlsConfigCaCert) MarshalJSON() ([]byte, error)

type Tool

type Tool struct {
	// AgentTool: Optional. The agent tool.
	AgentTool *AgentTool `json:"agentTool,omitempty"`
	// ClientFunction: Optional. The client function.
	ClientFunction *ClientFunction `json:"clientFunction,omitempty"`
	// ConnectorTool: Optional. The Integration Connector tool.
	ConnectorTool *ConnectorTool `json:"connectorTool,omitempty"`
	// CreateTime: Output only. Timestamp when the tool was created.
	CreateTime string `json:"createTime,omitempty"`
	// DataStoreTool: Optional. The data store tool.
	DataStoreTool *DataStoreTool `json:"dataStoreTool,omitempty"`
	// DisplayName: Output only. The display name of the tool, derived based on the
	// tool's type. For example, display name of a ClientFunction is derived from
	// its `name` property.
	DisplayName string `json:"displayName,omitempty"`
	// Etag: Etag used to ensure the object hasn't changed during a
	// read-modify-write operation. If the etag is empty, the update will overwrite
	// any concurrent changes.
	Etag string `json:"etag,omitempty"`
	// ExecutionType: Optional. The execution type of the tool.
	//
	// Possible values:
	//   "EXECUTION_TYPE_UNSPECIFIED" - The execution type is unspecified. Defaults
	// to `SYNCHRONOUS` if unspecified.
	//   "SYNCHRONOUS" - The tool is executed synchronously. The session is blocked
	// until the tool returns.
	//   "ASYNCHRONOUS" - The tool is executed asynchronously. The session will
	// continue while the tool is executing.
	ExecutionType string `json:"executionType,omitempty"`
	// FileSearchTool: Optional. The file search tool.
	FileSearchTool *FileSearchTool `json:"fileSearchTool,omitempty"`
	// GeneratedSummary: Output only. If the tool is generated by the LLM
	// assistant, this field contains a descriptive summary of the generation.
	GeneratedSummary string `json:"generatedSummary,omitempty"`
	// GoogleSearchTool: Optional. The google search tool.
	GoogleSearchTool *GoogleSearchTool `json:"googleSearchTool,omitempty"`
	// McpTool: Optional. The MCP tool. An MCP tool cannot be created or updated
	// directly and is managed by the MCP toolset.
	McpTool *McpTool `json:"mcpTool,omitempty"`
	// Name: Identifier. The resource name of the tool. Format: *
	// `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for
	// standalone tools. *
	// `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/
	// {tool}` for tools retrieved from a toolset. These tools are dynamic and
	// output-only; they cannot be referenced directly where a tool is expected.
	Name string `json:"name,omitempty"`
	// OpenApiTool: Optional. The open API tool.
	OpenApiTool *OpenApiTool `json:"openApiTool,omitempty"`
	// PythonFunction: Optional. The python function tool.
	PythonFunction *PythonFunction `json:"pythonFunction,omitempty"`
	// RemoteAgentTool: Optional. The remote agent tool.
	RemoteAgentTool *RemoteAgentTool `json:"remoteAgentTool,omitempty"`
	// SystemTool: Optional. The system tool.
	SystemTool *SystemTool `json:"systemTool,omitempty"`
	// Timeout: Optional. The timeout for the tool execution. If not set, the
	// default timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for
	// `ASYNCHRONOUS` tools.
	Timeout string `json:"timeout,omitempty"`
	// ToolFakeConfig: Optional. Configuration for tool behavior in fake mode.
	ToolFakeConfig *ToolFakeConfig `json:"toolFakeConfig,omitempty"`
	// UpdateTime: Output only. Timestamp when the tool was last updated.
	UpdateTime string `json:"updateTime,omitempty"`
	// WidgetTool: Optional. The widget tool.
	WidgetTool *WidgetTool `json:"widgetTool,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AgentTool") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AgentTool") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Tool: A tool represents an action that the CES agent can take to achieve certain goals.

func (Tool) MarshalJSON

func (s Tool) MarshalJSON() ([]byte, error)

type ToolCall

type ToolCall struct {
	// Args: Optional. The input parameters and values for the tool in JSON object
	// format.
	Args googleapi.RawMessage `json:"args,omitempty"`
	// DisplayName: Output only. Display name of the tool.
	DisplayName string `json:"displayName,omitempty"`
	// Id: Optional. The unique identifier of the tool call. If populated, the
	// client should return the execution result with the matching ID in
	// ToolResponse.
	Id string `json:"id,omitempty"`
	// Tool: Optional. The name of the tool to execute. Format:
	// `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
	Tool string `json:"tool,omitempty"`
	// ToolsetTool: Optional. The toolset tool to execute.
	ToolsetTool *ToolsetTool `json:"toolsetTool,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Args") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Args") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ToolCall: Request for the client or the agent to execute the specified tool.

func (ToolCall) MarshalJSON

func (s ToolCall) MarshalJSON() ([]byte, error)

type ToolCalls

type ToolCalls struct {
	// ToolCalls: Optional. The list of tool calls to execute.
	ToolCalls []*ToolCall `json:"toolCalls,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ToolCalls") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ToolCalls") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ToolCalls: Request for the client to execute the tools and return the execution results before continuing the session.

func (ToolCalls) MarshalJSON

func (s ToolCalls) MarshalJSON() ([]byte, error)

type ToolFakeConfig

type ToolFakeConfig struct {
	// CodeBlock: Optional. Code block which will be executed instead of a real
	// tool call.
	CodeBlock *CodeBlock `json:"codeBlock,omitempty"`
	// EnableFakeMode: Optional. Whether the tool is using fake mode.
	EnableFakeMode bool `json:"enableFakeMode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CodeBlock") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CodeBlock") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ToolFakeConfig: Configuration for tool behavior in fake mode.

func (ToolFakeConfig) MarshalJSON

func (s ToolFakeConfig) MarshalJSON() ([]byte, error)

type ToolResponse

type ToolResponse struct {
	// DisplayName: Output only. Display name of the tool.
	DisplayName string `json:"displayName,omitempty"`
	// Id: Optional. The matching ID of the tool call the response is for.
	Id string `json:"id,omitempty"`
	// Response: Required. The tool execution result in JSON object format. Use
	// "output" key to specify tool response and "error" key to specify error
	// details (if any). If "output" and "error" keys are not specified, then whole
	// "response" is treated as tool execution result.
	Response googleapi.RawMessage `json:"response,omitempty"`
	// Tool: Optional. The name of the tool to execute. Format:
	// `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
	Tool string `json:"tool,omitempty"`
	// ToolsetTool: Optional. The toolset tool that got executed.
	ToolsetTool *ToolsetTool `json:"toolsetTool,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ToolResponse: The execution result of a specific tool from the client or the agent.

func (ToolResponse) MarshalJSON

func (s ToolResponse) MarshalJSON() ([]byte, error)

type ToolResponses

type ToolResponses struct {
	// ToolResponses: Optional. The list of tool execution results.
	ToolResponses []*ToolResponse `json:"toolResponses,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ToolResponses") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ToolResponses") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ToolResponses: Execution results for the requested tool calls from the client.

func (ToolResponses) MarshalJSON

func (s ToolResponses) MarshalJSON() ([]byte, error)

type Toolset

type Toolset struct {
	// ConnectorToolset: Optional. A toolset that generates tools from an
	// Integration Connectors Connection.
	ConnectorToolset *ConnectorToolset `json:"connectorToolset,omitempty"`
	// CreateTime: Output only. Timestamp when the toolset was created.
	CreateTime string `json:"createTime,omitempty"`
	// Description: Optional. The description of the toolset.
	Description string `json:"description,omitempty"`
	// DisplayName: Optional. The display name of the toolset. Must be unique
	// within the same app.
	DisplayName string `json:"displayName,omitempty"`
	// Etag: ETag used to ensure the object hasn't changed during a
	// read-modify-write operation. If the etag is empty, the update will overwrite
	// any concurrent changes.
	Etag string `json:"etag,omitempty"`
	// ExecutionType: Optional. The execution type of the tools in the toolset.
	//
	// Possible values:
	//   "EXECUTION_TYPE_UNSPECIFIED" - The execution type is unspecified. Defaults
	// to `SYNCHRONOUS` if unspecified.
	//   "SYNCHRONOUS" - The tool is executed synchronously. The session is blocked
	// until the tool returns.
	//   "ASYNCHRONOUS" - The tool is executed asynchronously. The session will
	// continue while the tool is executing.
	ExecutionType string `json:"executionType,omitempty"`
	// McpToolset: Optional. A toolset that contains a list of tools that are
	// offered by the MCP server.
	McpToolset *McpToolset `json:"mcpToolset,omitempty"`
	// Name: Identifier. The unique identifier of the toolset. Format:
	// `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
	Name string `json:"name,omitempty"`
	// OpenApiToolset: Optional. A toolset that contains a list of tools that are
	// defined by an OpenAPI schema.
	OpenApiToolset *OpenApiToolset `json:"openApiToolset,omitempty"`
	// ToolFakeConfig: Optional. Configuration for tools behavior in fake mode.
	ToolFakeConfig *ToolFakeConfig `json:"toolFakeConfig,omitempty"`
	// UpdateTime: Output only. Timestamp when the toolset was last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ConnectorToolset") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConnectorToolset") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Toolset: A toolset represents a group of dynamically managed tools that can be used by the agent.

func (Toolset) MarshalJSON

func (s Toolset) MarshalJSON() ([]byte, error)

type ToolsetTool

type ToolsetTool struct {
	// ToolId: Optional. The tool ID to filter the tools to retrieve the schema
	// for.
	ToolId string `json:"toolId,omitempty"`
	// Toolset: Required. The resource name of the Toolset from which this tool is
	// derived. Format:
	// `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
	Toolset string `json:"toolset,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ToolId") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ToolId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ToolsetTool: A tool that is created from a toolset.

func (ToolsetTool) MarshalJSON

func (s ToolsetTool) MarshalJSON() ([]byte, error)

type TransferRule

type TransferRule struct {
	// ChildAgent: Required. The resource name of the child agent the rule applies
	// to. Format:
	// `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
	ChildAgent string `json:"childAgent,omitempty"`
	// DeterministicTransfer: Optional. A rule that immediately transfers to the
	// target agent when the condition is met.
	DeterministicTransfer *TransferRuleDeterministicTransfer `json:"deterministicTransfer,omitempty"`
	// Direction: Required. The direction of the transfer.
	//
	// Possible values:
	//   "DIRECTION_UNSPECIFIED" - Unspecified direction.
	//   "PARENT_TO_CHILD" - Transfer from the parent agent to the child agent.
	//   "CHILD_TO_PARENT" - Transfer from the child agent to the parent agent.
	Direction string `json:"direction,omitempty"`
	// DisablePlannerTransfer: Optional. Rule that prevents the planner from
	// transferring to the target agent.
	DisablePlannerTransfer *TransferRuleDisablePlannerTransfer `json:"disablePlannerTransfer,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ChildAgent") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ChildAgent") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TransferRule: Rule for transferring to a specific agent.

func (TransferRule) MarshalJSON

func (s TransferRule) MarshalJSON() ([]byte, error)

type TransferRuleDeterministicTransfer

type TransferRuleDeterministicTransfer struct {
	// ExpressionCondition: Optional. A rule that evaluates a session state
	// condition. If the condition evaluates to true, the transfer occurs.
	ExpressionCondition *ExpressionCondition `json:"expressionCondition,omitempty"`
	// PythonCodeCondition: Optional. A rule that uses Python code block to
	// evaluate the conditions. If the condition evaluates to true, the transfer
	// occurs.
	PythonCodeCondition *PythonCodeCondition `json:"pythonCodeCondition,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExpressionCondition") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExpressionCondition") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TransferRuleDeterministicTransfer: Deterministic transfer rule. When the condition evaluates to true, the transfer occurs.

func (TransferRuleDeterministicTransfer) MarshalJSON

func (s TransferRuleDeterministicTransfer) MarshalJSON() ([]byte, error)

type TransferRuleDisablePlannerTransfer

type TransferRuleDisablePlannerTransfer struct {
	// ExpressionCondition: Required. If the condition evaluates to true, planner
	// will not be allowed to transfer to the target agent.
	ExpressionCondition *ExpressionCondition `json:"expressionCondition,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExpressionCondition") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExpressionCondition") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TransferRuleDisablePlannerTransfer: A rule that prevents the planner from transferring to the target agent.

func (TransferRuleDisablePlannerTransfer) MarshalJSON

func (s TransferRuleDisablePlannerTransfer) MarshalJSON() ([]byte, error)

type TriggerAction

type TriggerAction struct {
	// GenerativeAnswer: Optional. Respond with a generative answer.
	GenerativeAnswer *TriggerActionGenerativeAnswer `json:"generativeAnswer,omitempty"`
	// RespondImmediately: Optional. Immediately respond with a preconfigured
	// response.
	RespondImmediately *TriggerActionRespondImmediately `json:"respondImmediately,omitempty"`
	// TransferAgent: Optional. Transfer the conversation to a different agent.
	TransferAgent *TriggerActionTransferAgent `json:"transferAgent,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GenerativeAnswer") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GenerativeAnswer") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TriggerAction: Action that is taken when a certain precondition is met.

func (TriggerAction) MarshalJSON

func (s TriggerAction) MarshalJSON() ([]byte, error)

type TriggerActionGenerativeAnswer

type TriggerActionGenerativeAnswer struct {
	// Prompt: Required. The prompt to use for the generative answer.
	Prompt string `json:"prompt,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Prompt") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Prompt") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TriggerActionGenerativeAnswer: The agent will immediately respond with a generative answer.

func (TriggerActionGenerativeAnswer) MarshalJSON

func (s TriggerActionGenerativeAnswer) MarshalJSON() ([]byte, error)

type TriggerActionRespondImmediately

type TriggerActionRespondImmediately struct {
	// Responses: Required. The canned responses for the agent to choose from. The
	// response is chosen randomly.
	Responses []*TriggerActionResponse `json:"responses,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Responses") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Responses") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TriggerActionRespondImmediately: The agent will immediately respond with a preconfigured response.

func (TriggerActionRespondImmediately) MarshalJSON

func (s TriggerActionRespondImmediately) MarshalJSON() ([]byte, error)

type TriggerActionResponse

type TriggerActionResponse struct {
	// Disabled: Optional. Whether the response is disabled. Disabled responses are
	// not used by the agent.
	Disabled bool `json:"disabled,omitempty"`
	// Text: Required. Text for the agent to respond with.
	Text string `json:"text,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Disabled") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Disabled") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TriggerActionResponse: Represents a response from the agent.

func (TriggerActionResponse) MarshalJSON

func (s TriggerActionResponse) MarshalJSON() ([]byte, error)

type TriggerActionTransferAgent

type TriggerActionTransferAgent struct {
	// Agent: Required. The name of the agent to transfer the conversation to. The
	// agent must be in the same app as the current agent. Format:
	// `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
	Agent string `json:"agent,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Agent") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Agent") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TriggerActionTransferAgent: The agent will transfer the conversation to a different agent.

func (TriggerActionTransferAgent) MarshalJSON

func (s TriggerActionTransferAgent) MarshalJSON() ([]byte, error)

type UploadEvaluationAudioRequest added in v0.270.0

type UploadEvaluationAudioRequest struct {
	// AudioContent: Required. The raw audio bytes. The format of the audio must be
	// single-channel LINEAR16 with a sample rate of 16kHz (default
	// InputAudioConfig).
	AudioContent string `json:"audioContent,omitempty"`
	// PreviousAudioGcsUri: Optional. The Google Cloud Storage URI of the
	// previously uploaded audio file to be deleted. Format: `gs:///`
	PreviousAudioGcsUri string `json:"previousAudioGcsUri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AudioContent") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AudioContent") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

UploadEvaluationAudioRequest: Request message for EvaluationService.UploadEvaluationAudio.

func (UploadEvaluationAudioRequest) MarshalJSON added in v0.270.0

func (s UploadEvaluationAudioRequest) MarshalJSON() ([]byte, error)

type UploadEvaluationAudioResponse added in v0.270.0

type UploadEvaluationAudioResponse struct {
	// AudioGcsUri: The Google Cloud Storage URI where the uploaded audio file is
	// stored. Format: `gs:///`
	AudioGcsUri string `json:"audioGcsUri,omitempty"`
	// Duration: The duration of the audio.
	Duration string `json:"duration,omitempty"`
	// Transcript: The transcript of the audio, generated by Cloud Speech-to-Text.
	Transcript string `json:"transcript,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AudioGcsUri") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AudioGcsUri") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

UploadEvaluationAudioResponse: Response message for EvaluationService.UploadEvaluationAudio.

func (UploadEvaluationAudioResponse) MarshalJSON added in v0.270.0

func (s UploadEvaluationAudioResponse) MarshalJSON() ([]byte, error)

type VpcScSettings added in v0.279.0

type VpcScSettings struct {
	// AllowedOrigins: Optional. The allowed HTTP(s) origins that OpenAPI tools in
	// the App are able to directly call when VPC Service Controls are enabled.
	// These strings must match the origin exactly, including the port if
	// specified. For example, "https://example.com" or "https://example.com:443".
	// This list does not yet apply to Python tools that may make direct HTTP
	// calls.
	AllowedOrigins []string `json:"allowedOrigins,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowedOrigins") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllowedOrigins") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

VpcScSettings: VPC-SC settings for the app.

func (VpcScSettings) MarshalJSON added in v0.279.0

func (s VpcScSettings) MarshalJSON() ([]byte, error)

type WebSearchQuery

type WebSearchQuery struct {
	// Query: The search query text.
	Query string `json:"query,omitempty"`
	// Uri: The URI to the Google Search results page for the query.
	Uri string `json:"uri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Query") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Query") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

WebSearchQuery: Represents a single web search query and its associated search uri.

func (WebSearchQuery) MarshalJSON

func (s WebSearchQuery) MarshalJSON() ([]byte, error)

type WidgetTool

type WidgetTool struct {
	// DataMapping: Optional. The mapping that defines how data from a source tool
	// is mapped to the widget's input parameters.
	DataMapping *WidgetToolDataMapping `json:"dataMapping,omitempty"`
	// Description: Optional. The description of the widget tool.
	Description string `json:"description,omitempty"`
	// Name: Required. The display name of the widget tool.
	Name string `json:"name,omitempty"`
	// Parameters: Optional. The input parameters of the widget tool.
	Parameters *Schema `json:"parameters,omitempty"`
	// TextResponseConfig: Optional. Configuration for always-included text
	// responses.
	TextResponseConfig *WidgetToolTextResponseConfig `json:"textResponseConfig,omitempty"`
	// UiConfig: Optional. Configuration for rendering the widget.
	UiConfig googleapi.RawMessage `json:"uiConfig,omitempty"`
	// WidgetType: Optional. The type of the widget tool. If not specified, the
	// default type will be CUSTOMIZED.
	//
	// Possible values:
	//   "WIDGET_TYPE_UNSPECIFIED" - Unspecified widget type.
	//   "CUSTOM" - Custom widget type.
	//   "PRODUCT_CAROUSEL" - Product carousel widget.
	//   "PRODUCT_DETAILS" - Product details widget.
	//   "QUICK_ACTIONS" - Quick actions widget.
	//   "PRODUCT_COMPARISON" - Product comparison widget.
	//   "ADVANCED_PRODUCT_DETAILS" - Advanced product details widget.
	//   "SHORT_FORM" - Short form widget.
	//   "OVERALL_SATISFACTION" - Overall satisfaction widget.
	//   "ORDER_SUMMARY" - Order summary widget.
	//   "APPOINTMENT_DETAILS" - Appointment details widget.
	//   "APPOINTMENT_SCHEDULER" - Appointment scheduler widget.
	//   "CONTACT_FORM" - Contact form widget.
	WidgetType string `json:"widgetType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DataMapping") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DataMapping") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

WidgetTool: Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent.

func (WidgetTool) MarshalJSON

func (s WidgetTool) MarshalJSON() ([]byte, error)

type WidgetToolDataMapping added in v0.272.0

type WidgetToolDataMapping struct {
	// FieldMappings: Optional. A map of widget input parameter fields to the
	// corresponding output fields of the source tool.
	FieldMappings map[string]string `json:"fieldMappings,omitempty"`
	// Mode: Optional. The mode of the data mapping.
	//
	// Possible values:
	//   "MODE_UNSPECIFIED" - Unspecified mode.
	//   "FIELD_MAPPING" - Use the `field_mappings` map for data transformation.
	//   "PYTHON_SCRIPT" - Use the `python_script` for data transformation.
	Mode string `json:"mode,omitempty"`
	// PythonFunction: Optional. Configuration for a Python function used to
	// transform the source tool's output into the widget's input format.
	PythonFunction *PythonFunction `json:"pythonFunction,omitempty"`
	// PythonScript: Deprecated: Use `python_function` instead.
	PythonScript string `json:"pythonScript,omitempty"`
	// SourceToolName: Optional. The resource name of the tool that provides the
	// data for the widget (e.g., a search tool or a custom function). Format:
	// `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`
	SourceToolName string `json:"sourceToolName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FieldMappings") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FieldMappings") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

WidgetToolDataMapping: Configuration for mapping data from a source tool to the widget's input parameters.

func (WidgetToolDataMapping) MarshalJSON added in v0.272.0

func (s WidgetToolDataMapping) MarshalJSON() ([]byte, error)

type WidgetToolTextResponseConfig added in v0.277.0

type WidgetToolTextResponseConfig struct {
	// StaticText: Optional. The static text response to return when type is
	// STATIC.
	StaticText string `json:"staticText,omitempty"`
	// TextResponseInstruction: Optional. Instruction for the LLM on how to
	// generate the text response. Used as the description for the text response
	// parameter if type is LLM_GENERATED.
	TextResponseInstruction string `json:"textResponseInstruction,omitempty"`
	// Type: Optional. The strategy for providing the text response.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Unspecified type.
	//   "NONE" - The LLM dynamically decides whether to generate a text response
	// alongside the widget based on the conversation context.
	//   "LLM_GENERATED" - The LLM is explicitly required to generate a text
	// response.
	//   "STATIC" - A pre-defined static text response is always used.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "StaticText") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "StaticText") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

WidgetToolTextResponseConfig: Configuration for the text response returned with the widget.

func (WidgetToolTextResponseConfig) MarshalJSON added in v0.277.0

func (s WidgetToolTextResponseConfig) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL