Class: Google::Cloud::Dialogflow::CX::V3::Agent

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

Overview

Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way.

After you create an agent, you can add Intents, [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.

Defined Under Namespace

Classes: AnswerFeedbackSettings, ClientCertificateSettings, GenAppBuilderSettings, GitIntegrationSettings, PersonalizationSettings

Instance Attribute Summary collapse

Instance Attribute Details

#advanced_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings

Returns Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

Returns:



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#answer_feedback_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::Agent::AnswerFeedbackSettings

Returns Optional. Answer feedback collection settings.

Returns:



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#avatar_uri ⇒ ::String

Returns The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

Returns:

  • (::String) —

    The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#client_certificate_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::Agent::ClientCertificateSettings

Returns Optional. Settings for custom client certificates.

Returns:



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#default_language_code ⇒ ::String

Returns Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.

Returns:

  • (::String) —

    Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

Returns:

  • (::String) —

    The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Required. The human-readable name of the agent, unique within the location.

Returns:

  • (::String) —

    Required. The human-readable name of the agent, unique within the location.



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#enable_multi_language_training ⇒ ::Boolean

Returns Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.

Returns:

  • (::Boolean) —

    Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#enable_spell_correction ⇒ ::Boolean

Returns Indicates if automatic spell correction is enabled in detect intent requests.

Returns:

  • (::Boolean) —

    Indicates if automatic spell correction is enabled in detect intent requests.



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#enable_stackdriver_logging ⇒ ::Boolean

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

Returns:

  • (::Boolean) —

    Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#gen_app_builder_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::Agent::GenAppBuilderSettings

Returns Gen App Builder-related agent-level settings.

Returns:



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#git_integration_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings

Returns Git integration settings for this agent.

Returns:



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#locked ⇒ ::Boolean

Returns Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [RestoreAgent][].

Returns:

  • (::Boolean) —

    Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [RestoreAgent][].



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

Returns:

  • (::String) —

    The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#personalization_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::Agent::PersonalizationSettings

Returns Optional. Settings for end user personalization.

Returns:



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#satisfies_pzi ⇒ ::Boolean (readonly)

Returns Optional. Output only. A read only boolean field reflecting Zone Isolation status of the agent.

Returns:

  • (::Boolean) —

    Optional. Output only. A read only boolean field reflecting Zone Isolation status of the agent.



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#satisfies_pzs ⇒ ::Boolean (readonly)

Returns Optional. Output only. A read only boolean field reflecting Zone Separation status of the agent.

Returns:

  • (::Boolean) —

    Optional. Output only. A read only boolean field reflecting Zone Separation status of the agent.



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#security_settings ⇒ ::String

Returns Name of the SecuritySettings reference for the agent. Format: projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>.

Returns:

  • (::String) —

    Name of the SecuritySettings reference for the agent. Format: projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>.



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#speech_to_text_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::SpeechToTextSettings

Returns Speech recognition related settings.

Returns:



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#start_flow ⇒ ::String

Returns Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.

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

Returns:

  • (::String) —

    Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.

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



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#start_playbook ⇒ ::String

Returns Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.

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

Returns:

  • (::String) —

    Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.

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



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#supported_language_codes ⇒ ::Array<::String>

Returns The list of all languages supported by the agent (except for the default_language_code).

Returns:

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

    The list of all languages supported by the agent (except for the default_language_code).



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#text_to_speech_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::TextToSpeechSettings

Returns Settings on instructing the speech synthesizer on how to generate the output audio content.

Returns:



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#time_zone ⇒ ::String

Returns Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

Returns:

  • (::String) —

    Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 169

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

  # Settings for connecting to Git repository for an agent.
  # @!attribute [rw] github_settings
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings::GithubSettings]
  #     GitHub settings.
  class GitIntegrationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Settings of integration with GitHub.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     The unique repository display name for the GitHub repository.
    # @!attribute [rw] repository_uri
    #   @return [::String]
    #     The GitHub repository URI related to the agent.
    # @!attribute [rw] tracking_branch
    #   @return [::String]
    #     The branch of the GitHub repository tracked for this agent.
    # @!attribute [rw] access_token
    #   @return [::String]
    #     The access token used to authenticate the access to the GitHub
    #     repository.
    # @!attribute [rw] branches
    #   @return [::Array<::String>]
    #     A list of branches configured to be used from Dialogflow.
    class GithubSettings
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for Gen App Builder.
  # @!attribute [rw] engine
  #   @return [::String]
  #     Required. The full name of the Gen App Builder engine related to this
  #     agent if there is one. Format: `projects/{Project ID}/locations/{Location
  #     ID}/collections/\\{Collection ID}/engines/\\{Engine ID}`
  class GenAppBuilderSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for answer feedback collection.
  # @!attribute [rw] enable_answer_feedback
  #   @return [::Boolean]
  #     Optional. If enabled, end users will be able to provide
  #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
  #     Dialogflow responses. Feature works only if interaction logging is
  #     enabled in the Dialogflow agent.
  class AnswerFeedbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for end user personalization.
  # @!attribute [rw] default_end_user_metadata
  #   @return [::Google::Protobuf::Struct]
  #     Optional. Default end user metadata, used when processing DetectIntent
  #     requests. Recommended to be filled as a template instead of hard-coded
  #     value, for example { "age": "$session.params.age" }. The data will be
  #     merged with the
  #     {::Google::Cloud::Dialogflow::CX::V3::QueryParameters#end_user_metadata QueryParameters.end_user_metadata}
  #     in
  #     {::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest#query_params DetectIntentRequest.query_params}
  #     during query processing.
  class PersonalizationSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Settings for custom client certificates.
  # @!attribute [rw] ssl_certificate
  #   @return [::String]
  #     Required. The ssl certificate encoded in PEM format. This string must
  #     include the begin header and end footer lines.
  # @!attribute [rw] private_key
  #   @return [::String]
  #     Required. The name of the SecretManager secret version resource storing
  #     the private key encoded in PEM format. Format:
  #     `projects/{project}/secrets/{secret}/versions/{version}`
  # @!attribute [rw] passphrase
  #   @return [::String]
  #     Optional. The name of the SecretManager secret version resource storing
  #     the passphrase. 'passphrase' should be left unset if the private key is
  #     not encrypted.
  #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
  class ClientCertificateSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end