Class: Google::Cloud::Ces::V1beta::Agent

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/ces/v1beta/agent.rb

Overview

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

Defined Under Namespace

Classes: AgentToolset, LlmAgent, RemoteDialogflowAgent

Instance Attribute Summary collapse

Instance Attribute Details

#after_agent_callbacks ⇒ ::Array<::Google::Cloud::Ces::V1beta::Callback>

Returns 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.

Returns:

  • (::Array<::Google::Cloud::Ces::V1beta::Callback>) —

    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.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#after_model_callbacks ⇒ ::Array<::Google::Cloud::Ces::V1beta::Callback>

Returns 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.

Returns:

  • (::Array<::Google::Cloud::Ces::V1beta::Callback>) —

    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.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#after_tool_callbacks ⇒ ::Array<::Google::Cloud::Ces::V1beta::Callback>

Returns 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.

Returns:

  • (::Array<::Google::Cloud::Ces::V1beta::Callback>) —

    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.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#before_agent_callbacks ⇒ ::Array<::Google::Cloud::Ces::V1beta::Callback>

Returns 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.

Returns:

  • (::Array<::Google::Cloud::Ces::V1beta::Callback>) —

    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.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#before_model_callbacks ⇒ ::Array<::Google::Cloud::Ces::V1beta::Callback>

Returns 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.

Returns:

  • (::Array<::Google::Cloud::Ces::V1beta::Callback>) —

    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.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#before_tool_callbacks ⇒ ::Array<::Google::Cloud::Ces::V1beta::Callback>

Returns 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.

Returns:

  • (::Array<::Google::Cloud::Ces::V1beta::Callback>) —

    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.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#child_agents ⇒ ::Array<::String>

Returns Optional. List of child agents in the agent tree. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}.

Returns:

  • (::Array<::String>) —

    Optional. List of child agents in the agent tree. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when the agent was created.

Returns:



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns Optional. Human-readable description of the agent.

Returns:

  • (::String) —

    Optional. Human-readable description of the agent.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Required. Display name of the agent.

Returns:

  • (::String) —

    Required. Display name of the agent.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#etag ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#generated_summary ⇒ ::String (readonly)

Returns Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation.

Returns:

  • (::String) —

    Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#guardrails ⇒ ::Array<::String>

Returns Optional. List of guardrails for the agent. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}.

Returns:

  • (::Array<::String>) —

    Optional. List of guardrails for the agent. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#instruction ⇒ ::String

Returns Optional. Instructions for the LLM model to guide the agent's behavior.

Returns:

  • (::String) —

    Optional. Instructions for the LLM model to guide the agent's behavior.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#llm_agent ⇒ ::Google::Cloud::Ces::V1beta::Agent::LlmAgent

Returns Optional. The default agent type.

Note: The following fields are mutually exclusive: llm_agent, remote_dialogflow_agent. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Ces::V1beta::Agent::LlmAgent) —

    Optional. The default agent type.

    Note: The following fields are mutually exclusive: llm_agent, remote_dialogflow_agent. If a field in that set is populated, all other fields in the set will automatically be cleared.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#model_settings ⇒ ::Google::Cloud::Ces::V1beta::ModelSettings

Returns Optional. Configurations for the LLM model.

Returns:



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

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

Returns:

  • (::String) —

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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#remote_dialogflow_agent ⇒ ::Google::Cloud::Ces::V1beta::Agent::RemoteDialogflowAgent

Returns Optional. The remote Dialogflow 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-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

Note: The following fields are mutually exclusive: remote_dialogflow_agent, llm_agent. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Ces::V1beta::Agent::RemoteDialogflowAgent) —

    Optional. The remote Dialogflow 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-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

    Note: The following fields are mutually exclusive: remote_dialogflow_agent, llm_agent. If a field in that set is populated, all other fields in the set will automatically be cleared.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#tools ⇒ ::Array<::String>

Returns Optional. List of available tools for the agent. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}.

Returns:

  • (::Array<::String>) —

    Optional. List of available tools for the agent. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#toolsets ⇒ ::Array<::Google::Cloud::Ces::V1beta::Agent::AgentToolset>

Returns Optional. List of toolsets for the agent.

Returns:



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#transfer_rules ⇒ ::Array<::Google::Cloud::Ces::V1beta::TransferRule>

Returns Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.

Returns:



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when the agent was last updated.

Returns:



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/ces/v1beta/agent.rb', line 134

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default agent type. The agent uses instructions and callbacks specified in
  # the agent to perform the task using a large language model.
  class LlmAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Required. The
  #     [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
  #     agent resource name.
  #     Format: `projects/{project}/locations/{location}/agents/{agent}`
  # @!attribute [rw] flow_id
  #   @return [::String]
  #     Optional. The flow ID of the flow in the Dialogflow agent.
  # @!attribute [rw] environment_id
  #   @return [::String]
  #     Optional. The environment ID of the Dialogflow agent to be used for the
  #     agent execution. If not specified, the draft environment will be used.
  # @!attribute [rw] input_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The mapping of the app variables names to the Dialogflow
  #     session parameters names to be sent to the Dialogflow agent as input.
  # @!attribute [rw] output_variable_mapping
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     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.
  # @!attribute [rw] respect_response_interruption_settings
  #   @return [::Boolean]
  #     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.
  class RemoteDialogflowAgent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class InputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class OutputVariableMappingEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A toolset with a selection of its tools.
  # @!attribute [rw] toolset
  #   @return [::String]
  #     Required. The resource name of the toolset.
  #     Format:
  #     `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
  # @!attribute [rw] tool_ids
  #   @return [::Array<::String>]
  #     Optional. The tools IDs to filter the toolset.
  class AgentToolset
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end