google-cloud-ces-v1 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/cloud/ces/v1/agent_card_pb.rb +26 -0
- data/lib/google/cloud/ces/v1/agent_pb.rb +1 -1
- data/lib/google/cloud/ces/v1/app_pb.rb +4 -1
- data/lib/google/cloud/ces/v1/common_pb.rb +3 -1
- data/lib/google/cloud/ces/v1/conversation_pb.rb +1 -1
- data/lib/google/cloud/ces/v1/deployment_pb.rb +7 -1
- data/lib/google/cloud/ces/v1/mcp_tool_pb.rb +2 -1
- data/lib/google/cloud/ces/v1/mcp_toolset_pb.rb +4 -1
- data/lib/google/cloud/ces/v1/mocks_pb.rb +26 -0
- data/lib/google/cloud/ces/v1/python_function_pb.rb +2 -1
- data/lib/google/cloud/ces/v1/session_service_pb.rb +6 -1
- data/lib/google/cloud/ces/v1/tool_pb.rb +3 -1
- data/lib/google/cloud/ces/v1/tool_service/client.rb +10 -2
- data/lib/google/cloud/ces/v1/tool_service/rest/client.rb +10 -2
- data/lib/google/cloud/ces/v1/tool_service_pb.rb +3 -1
- data/lib/google/cloud/ces/v1/toolset_pb.rb +2 -1
- data/lib/google/cloud/ces/v1/version.rb +1 -1
- data/lib/google/cloud/ces/v1/widget_tool_pb.rb +3 -1
- data/proto_docs/google/api/routing.rb +463 -0
- data/proto_docs/google/cloud/ces/v1/agent.rb +9 -0
- data/proto_docs/google/cloud/ces/v1/agent_card.rb +122 -0
- data/proto_docs/google/cloud/ces/v1/app.rb +108 -7
- data/proto_docs/google/cloud/ces/v1/common.rb +57 -0
- data/proto_docs/google/cloud/ces/v1/conversation.rb +13 -6
- data/proto_docs/google/cloud/ces/v1/deployment.rb +105 -0
- data/proto_docs/google/cloud/ces/v1/mcp_tool.rb +25 -0
- data/proto_docs/google/cloud/ces/v1/mcp_toolset.rb +47 -0
- data/proto_docs/google/cloud/ces/v1/mocks.rb +60 -0
- data/proto_docs/google/cloud/ces/v1/python_function.rb +3 -0
- data/proto_docs/google/cloud/ces/v1/session_service.rb +32 -0
- data/proto_docs/google/cloud/ces/v1/tool.rb +21 -11
- data/proto_docs/google/cloud/ces/v1/tool_service.rb +17 -0
- data/proto_docs/google/cloud/ces/v1/toolset.rb +5 -0
- data/proto_docs/google/cloud/ces/v1/widget_tool.rb +36 -0
- metadata +6 -1
|
@@ -112,10 +112,16 @@ module Google
|
|
|
112
112
|
# @!attribute [rw] client_certificate_settings
|
|
113
113
|
# @return [::Google::Cloud::Ces::V1::ClientCertificateSettings]
|
|
114
114
|
# Optional. The default client certificate settings for the app.
|
|
115
|
+
# @!attribute [rw] vpc_sc_settings
|
|
116
|
+
# @return [::Google::Cloud::Ces::V1::VpcScSettings]
|
|
117
|
+
# Optional. VPC-SC settings for the app.
|
|
115
118
|
# @!attribute [rw] locked
|
|
116
119
|
# @return [::Boolean]
|
|
117
120
|
# Optional. Indicates whether the app is locked for changes. If the app is
|
|
118
121
|
# locked, modifications to the app resources will be rejected.
|
|
122
|
+
# @!attribute [r] validation_errors
|
|
123
|
+
# @return [::Array<::String>]
|
|
124
|
+
# Output only. Misconfigurations or warnings in the app.
|
|
119
125
|
class App
|
|
120
126
|
include ::Google::Protobuf::MessageExts
|
|
121
127
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -321,12 +327,12 @@ module Google
|
|
|
321
327
|
# @!attribute [rw] disable_barge_in
|
|
322
328
|
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
323
329
|
# @return [::Boolean]
|
|
324
|
-
# Optional.
|
|
325
|
-
# input during agent response playback will be ignored.
|
|
326
|
-
#
|
|
327
|
-
# Deprecated: `disable_barge_in` is deprecated in favor of
|
|
330
|
+
# Optional. Deprecated: `disable_barge_in` is deprecated in favor of
|
|
328
331
|
# {::Google::Cloud::Ces::V1::ChannelProfile#disable_barge_in_control `disable_barge_in_control`}
|
|
329
332
|
# in ChannelProfile.
|
|
333
|
+
#
|
|
334
|
+
# Disables user barge-in while the agent is speaking. If true, user input
|
|
335
|
+
# during agent response playback will be ignored.
|
|
330
336
|
# @!attribute [rw] barge_in_awareness
|
|
331
337
|
# @return [::Boolean]
|
|
332
338
|
# Optional. If enabled, the agent will adapt its next response based on the
|
|
@@ -347,12 +353,30 @@ module Google
|
|
|
347
353
|
# For the list of available voices, please refer to [Supported voices and
|
|
348
354
|
# languages](https://cloud.google.com/text-to-speech/docs/voices) from Cloud
|
|
349
355
|
# Text-to-Speech.
|
|
356
|
+
# @!attribute [rw] voice_sample_gcs_uri
|
|
357
|
+
# @return [::String]
|
|
358
|
+
# Optional. The Cloud Storage URI to the audio sample for voice cloning. The
|
|
359
|
+
# audio sample should be a mono-channel, 24kHz WAV file.
|
|
360
|
+
#
|
|
361
|
+
# Note: Please make sure the CES service agent
|
|
362
|
+
# `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com` has
|
|
363
|
+
# `storage.objects.get` permission to the Cloud Storage object.
|
|
350
364
|
# @!attribute [rw] speaking_rate
|
|
351
365
|
# @return [::Float]
|
|
352
366
|
# Optional. The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the
|
|
353
367
|
# normal native speed supported by the specific voice. 2.0 is twice as fast,
|
|
354
368
|
# and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will
|
|
355
369
|
# return an error.
|
|
370
|
+
# @!attribute [rw] model
|
|
371
|
+
# @return [::String]
|
|
372
|
+
# Optional. The model used to synthesize audio.
|
|
373
|
+
# Currently supported values:
|
|
374
|
+
# - "gemini-3.1-flash-tts-preview"
|
|
375
|
+
# If empty, Chirp3-HD is used.
|
|
376
|
+
# @!attribute [rw] instruction
|
|
377
|
+
# @return [::String]
|
|
378
|
+
# Optional. The instruction used to synthesize speech when using a generative
|
|
379
|
+
# model.
|
|
356
380
|
class SynthesizeSpeechConfig
|
|
357
381
|
include ::Google::Protobuf::MessageExts
|
|
358
382
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -376,11 +400,25 @@ module Google
|
|
|
376
400
|
# Optional. Configuration for how sensitive data should be redacted.
|
|
377
401
|
# @!attribute [rw] audio_recording_config
|
|
378
402
|
# @return [::Google::Cloud::Ces::V1::AudioRecordingConfig]
|
|
379
|
-
# Optional. Configuration for how audio interactions should be recorded.
|
|
403
|
+
# Optional. Configuration for how audio interactions should be recorded. The
|
|
404
|
+
# audio is subject to redaction as configured in
|
|
405
|
+
# {::Google::Cloud::Ces::V1::LoggingSettings#redaction_config RedactionConfig}.
|
|
406
|
+
# @!attribute [rw] unredacted_audio_recording_config
|
|
407
|
+
# @return [::Google::Cloud::Ces::V1::AudioRecordingConfig]
|
|
408
|
+
# Optional. Configures an additional recording of unredacted audio. This can
|
|
409
|
+
# be used to maintain a raw audio copy when audio redaction is
|
|
410
|
+
# {::Google::Cloud::Ces::V1::RedactionConfig#enable_redaction enabled}, typically
|
|
411
|
+
# for auditing or monitoring purposes.
|
|
380
412
|
# @!attribute [rw] bigquery_export_settings
|
|
381
413
|
# @return [::Google::Cloud::Ces::V1::BigQueryExportSettings]
|
|
382
|
-
# Optional.
|
|
383
|
-
#
|
|
414
|
+
# Optional. Configures the BigQuery export behaviors for the app. The
|
|
415
|
+
# conversation data is subject to redaction as configured in
|
|
416
|
+
# {::Google::Cloud::Ces::V1::LoggingSettings#redaction_config RedactionConfig}.
|
|
417
|
+
# @!attribute [rw] unredacted_bigquery_export_settings
|
|
418
|
+
# @return [::Google::Cloud::Ces::V1::BigQueryExportSettings]
|
|
419
|
+
# Optional. Configures the BigQuery export behaviors for the app.
|
|
420
|
+
# The unredacted conversation data will be exported to BigQuery tables if it
|
|
421
|
+
# is enabled.
|
|
384
422
|
# @!attribute [rw] cloud_logging_settings
|
|
385
423
|
# @return [::Google::Cloud::Ces::V1::CloudLoggingSettings]
|
|
386
424
|
# Optional. Settings to describe the Cloud Logging behaviors for the app.
|
|
@@ -406,10 +444,56 @@ module Google
|
|
|
406
444
|
# @!attribute [rw] error_handling_strategy
|
|
407
445
|
# @return [::Google::Cloud::Ces::V1::ErrorHandlingSettings::ErrorHandlingStrategy]
|
|
408
446
|
# Optional. The strategy to use for error handling.
|
|
447
|
+
# @!attribute [rw] fallback_response_config
|
|
448
|
+
# @return [::Google::Cloud::Ces::V1::ErrorHandlingSettings::FallbackResponseConfig]
|
|
449
|
+
# Optional. Configuration for handling fallback responses.
|
|
450
|
+
# @!attribute [rw] end_session_config
|
|
451
|
+
# @return [::Google::Cloud::Ces::V1::ErrorHandlingSettings::EndSessionConfig]
|
|
452
|
+
# Optional. Configuration for ending the session in case of system errors
|
|
453
|
+
# (e.g. LLM errors).
|
|
409
454
|
class ErrorHandlingSettings
|
|
410
455
|
include ::Google::Protobuf::MessageExts
|
|
411
456
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
412
457
|
|
|
458
|
+
# Configuration for handling fallback responses.
|
|
459
|
+
# @!attribute [rw] custom_fallback_messages
|
|
460
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
|
461
|
+
# Optional. The fallback messages in case of system errors (e.g. LLM
|
|
462
|
+
# errors), mapped by [supported language
|
|
463
|
+
# code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language).
|
|
464
|
+
# @!attribute [rw] max_fallback_attempts
|
|
465
|
+
# @return [::Integer]
|
|
466
|
+
# Optional. The maximum number of fallback attempts to make before the
|
|
467
|
+
# agent emitting {::Google::Cloud::Ces::V1::EndSession EndSession} Signal.
|
|
468
|
+
class FallbackResponseConfig
|
|
469
|
+
include ::Google::Protobuf::MessageExts
|
|
470
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
471
|
+
|
|
472
|
+
# @!attribute [rw] key
|
|
473
|
+
# @return [::String]
|
|
474
|
+
# @!attribute [rw] value
|
|
475
|
+
# @return [::String]
|
|
476
|
+
class CustomFallbackMessagesEntry
|
|
477
|
+
include ::Google::Protobuf::MessageExts
|
|
478
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
479
|
+
end
|
|
480
|
+
end
|
|
481
|
+
|
|
482
|
+
# Configuration for ending the session in case of system errors (e.g. LLM
|
|
483
|
+
# errors).
|
|
484
|
+
# @!attribute [rw] escalate_session
|
|
485
|
+
# @return [::Boolean]
|
|
486
|
+
# Optional. Whether to escalate the session in
|
|
487
|
+
# {::Google::Cloud::Ces::V1::EndSession EndSession}. If session is escalated,
|
|
488
|
+
# {::Google::Cloud::Ces::V1::EndSession#metadata metadata in EndSession} will
|
|
489
|
+
# contain `session_escalated = true`. See
|
|
490
|
+
# https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent
|
|
491
|
+
# for details.
|
|
492
|
+
class EndSessionConfig
|
|
493
|
+
include ::Google::Protobuf::MessageExts
|
|
494
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
495
|
+
end
|
|
496
|
+
|
|
413
497
|
# Defines the strategy for handling errors.
|
|
414
498
|
module ErrorHandlingStrategy
|
|
415
499
|
# Unspecified error handling strategy.
|
|
@@ -563,10 +647,27 @@ module Google
|
|
|
563
647
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
564
648
|
end
|
|
565
649
|
|
|
650
|
+
# VPC-SC settings for the app.
|
|
651
|
+
# @!attribute [rw] allowed_origins
|
|
652
|
+
# @return [::Array<::String>]
|
|
653
|
+
# Optional. The allowed HTTP(s) origins that OpenAPI tools in the App are
|
|
654
|
+
# able to directly call when VPC Service Controls are enabled. These strings
|
|
655
|
+
# must match the origin exactly, including the port if specified. For
|
|
656
|
+
# example, "https://example.com" or "https://example.com:443". This list does
|
|
657
|
+
# not yet apply to Python tools that may make direct HTTP calls.
|
|
658
|
+
class VpcScSettings
|
|
659
|
+
include ::Google::Protobuf::MessageExts
|
|
660
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
661
|
+
end
|
|
662
|
+
|
|
566
663
|
# Settings to describe the conversation logging behaviors for the app.
|
|
567
664
|
# @!attribute [rw] disable_conversation_logging
|
|
568
665
|
# @return [::Boolean]
|
|
569
666
|
# Optional. Whether to disable conversation logging for the sessions.
|
|
667
|
+
# @!attribute [rw] retention_window
|
|
668
|
+
# @return [::Google::Protobuf::Duration]
|
|
669
|
+
# Optional. Controls the retention window for the conversation.
|
|
670
|
+
# If not set, the conversation will be retained for 365 days.
|
|
570
671
|
class ConversationLoggingSettings
|
|
571
672
|
include ::Google::Protobuf::MessageExts
|
|
572
673
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -202,6 +202,12 @@ module Google
|
|
|
202
202
|
# @return [::String]
|
|
203
203
|
# Optional. The noise suppression level of the channel profile.
|
|
204
204
|
# Available values are "low", "moderate", "high", "very_high".
|
|
205
|
+
# @!attribute [rw] whatsapp_config
|
|
206
|
+
# @return [::Google::Cloud::Ces::V1::ChannelProfile::WhatsAppConfig]
|
|
207
|
+
# Optional. Configuration specific to WhatsApp deployments.
|
|
208
|
+
# @!attribute [rw] instagram_config
|
|
209
|
+
# @return [::Google::Cloud::Ces::V1::ChannelProfile::InstagramConfig]
|
|
210
|
+
# Optional. Configuration specific to Instagram deployments.
|
|
205
211
|
class ChannelProfile
|
|
206
212
|
include ::Google::Protobuf::MessageExts
|
|
207
213
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -303,6 +309,48 @@ module Google
|
|
|
303
309
|
end
|
|
304
310
|
end
|
|
305
311
|
|
|
312
|
+
# Configuration specific to WhatsApp deployments.
|
|
313
|
+
# @!attribute [rw] waba_id
|
|
314
|
+
# @return [::String]
|
|
315
|
+
# Required. The WhatsApp Business Account ID.
|
|
316
|
+
# @!attribute [rw] phone_number_id
|
|
317
|
+
# @return [::String]
|
|
318
|
+
# Required. The Meta phone number ID.
|
|
319
|
+
# @!attribute [rw] phone_number
|
|
320
|
+
# @return [::String]
|
|
321
|
+
# Optional. The phone number in E.164 format.
|
|
322
|
+
# @!attribute [r] display_name
|
|
323
|
+
# @return [::String]
|
|
324
|
+
# Output only. The fetched Meta business page name.
|
|
325
|
+
# @!attribute [r] thumbnail_url
|
|
326
|
+
# @return [::String]
|
|
327
|
+
# Output only. The fetched Meta business profile thumbnail URL.
|
|
328
|
+
# @!attribute [r] description
|
|
329
|
+
# @return [::String]
|
|
330
|
+
# Output only. The description of the Meta business page or profile.
|
|
331
|
+
class WhatsAppConfig
|
|
332
|
+
include ::Google::Protobuf::MessageExts
|
|
333
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
334
|
+
end
|
|
335
|
+
|
|
336
|
+
# Configuration specific to Instagram deployments.
|
|
337
|
+
# @!attribute [rw] instagram_account_id
|
|
338
|
+
# @return [::String]
|
|
339
|
+
# Required. The Instagram Account ID.
|
|
340
|
+
# @!attribute [r] display_name
|
|
341
|
+
# @return [::String]
|
|
342
|
+
# Output only. The fetched Meta business page name.
|
|
343
|
+
# @!attribute [r] thumbnail_url
|
|
344
|
+
# @return [::String]
|
|
345
|
+
# Output only. The fetched Meta business profile thumbnail URL.
|
|
346
|
+
# @!attribute [r] description
|
|
347
|
+
# @return [::String]
|
|
348
|
+
# Output only. The description of the Meta business page or profile.
|
|
349
|
+
class InstagramConfig
|
|
350
|
+
include ::Google::Protobuf::MessageExts
|
|
351
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
352
|
+
end
|
|
353
|
+
|
|
306
354
|
# The type of the channel profile.
|
|
307
355
|
module ChannelType
|
|
308
356
|
# Unknown channel type.
|
|
@@ -323,11 +371,20 @@ module Google
|
|
|
323
371
|
# Contact Center as a Service (CCaaS) channel.
|
|
324
372
|
CONTACT_CENTER_AS_A_SERVICE = 6
|
|
325
373
|
|
|
374
|
+
# Contact Center as a Service (CCaaS Chat) channel.
|
|
375
|
+
CONTACT_CENTER_AS_A_SERVICE_CHAT = 11
|
|
376
|
+
|
|
326
377
|
# Five9 channel.
|
|
327
378
|
FIVE9 = 7
|
|
328
379
|
|
|
329
380
|
# Third party contact center integration channel.
|
|
330
381
|
CONTACT_CENTER_INTEGRATION = 8
|
|
382
|
+
|
|
383
|
+
# WhatsApp channel.
|
|
384
|
+
WHATSAPP = 9
|
|
385
|
+
|
|
386
|
+
# Instagram channel.
|
|
387
|
+
INSTAGRAM = 10
|
|
331
388
|
end
|
|
332
389
|
end
|
|
333
390
|
|
|
@@ -120,6 +120,10 @@ module Google
|
|
|
120
120
|
|
|
121
121
|
# The conversation is from the evaluation.
|
|
122
122
|
EVAL = 3
|
|
123
|
+
|
|
124
|
+
# The conversation is from an agent tool. Agent tool runs the agent in a
|
|
125
|
+
# separate session, which is persisted for testing and debugging purposes.
|
|
126
|
+
AGENT_TOOL = 4
|
|
123
127
|
end
|
|
124
128
|
|
|
125
129
|
# Type of the input message.
|
|
@@ -127,22 +131,25 @@ module Google
|
|
|
127
131
|
# Unspecified input type.
|
|
128
132
|
INPUT_TYPE_UNSPECIFIED = 0
|
|
129
133
|
|
|
130
|
-
#
|
|
134
|
+
# Text input.
|
|
131
135
|
INPUT_TYPE_TEXT = 1
|
|
132
136
|
|
|
133
|
-
#
|
|
137
|
+
# Event input.
|
|
138
|
+
INPUT_TYPE_EVENT = 7
|
|
139
|
+
|
|
140
|
+
# Audio input.
|
|
134
141
|
INPUT_TYPE_AUDIO = 2
|
|
135
142
|
|
|
136
|
-
#
|
|
143
|
+
# Image input.
|
|
137
144
|
INPUT_TYPE_IMAGE = 3
|
|
138
145
|
|
|
139
|
-
#
|
|
146
|
+
# Blob input.
|
|
140
147
|
INPUT_TYPE_BLOB = 4
|
|
141
148
|
|
|
142
|
-
#
|
|
149
|
+
# Client function tool response input.
|
|
143
150
|
INPUT_TYPE_TOOL_RESPONSE = 5
|
|
144
151
|
|
|
145
|
-
#
|
|
152
|
+
# Variables input.
|
|
146
153
|
INPUT_TYPE_VARIABLES = 6
|
|
147
154
|
end
|
|
148
155
|
end
|
|
@@ -21,6 +21,64 @@ module Google
|
|
|
21
21
|
module Cloud
|
|
22
22
|
module Ces
|
|
23
23
|
module V1
|
|
24
|
+
# Experiment for the deployment.
|
|
25
|
+
# @!attribute [rw] version_release
|
|
26
|
+
# @return [::Google::Cloud::Ces::V1::ExperimentConfig::VersionRelease]
|
|
27
|
+
# Optional. Version release for the experiment.
|
|
28
|
+
class ExperimentConfig
|
|
29
|
+
include ::Google::Protobuf::MessageExts
|
|
30
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
31
|
+
|
|
32
|
+
# Version release for the experiment.
|
|
33
|
+
# @!attribute [rw] state
|
|
34
|
+
# @return [::Google::Cloud::Ces::V1::ExperimentConfig::State]
|
|
35
|
+
# Optional. State of the version release.
|
|
36
|
+
# @!attribute [rw] traffic_allocations
|
|
37
|
+
# @return [::Array<::Google::Cloud::Ces::V1::ExperimentConfig::VersionRelease::TrafficAllocation>]
|
|
38
|
+
# Optional. Traffic allocations for the version release.
|
|
39
|
+
class VersionRelease
|
|
40
|
+
include ::Google::Protobuf::MessageExts
|
|
41
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
42
|
+
|
|
43
|
+
# Traffic allocation for the version release.
|
|
44
|
+
# @!attribute [rw] id
|
|
45
|
+
# @return [::String]
|
|
46
|
+
# Optional. Id of the traffic allocation.
|
|
47
|
+
# Free format string, up to 128 characters.
|
|
48
|
+
# @!attribute [rw] traffic_percentage
|
|
49
|
+
# @return [::Integer]
|
|
50
|
+
# Optional. Traffic percentage of the traffic allocation.
|
|
51
|
+
# Must be between 0 and 100.
|
|
52
|
+
# @!attribute [rw] app_version
|
|
53
|
+
# @return [::String]
|
|
54
|
+
# Optional. App version of the traffic allocation.
|
|
55
|
+
# Format:
|
|
56
|
+
# `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
|
|
57
|
+
class TrafficAllocation
|
|
58
|
+
include ::Google::Protobuf::MessageExts
|
|
59
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
60
|
+
end
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
# State of the experiment.
|
|
64
|
+
module State
|
|
65
|
+
# Unspecified state.
|
|
66
|
+
STATE_UNSPECIFIED = 0
|
|
67
|
+
|
|
68
|
+
# Deprecated: This state is no longer used.
|
|
69
|
+
PENDING = 1
|
|
70
|
+
|
|
71
|
+
# Running state. Experiment is running and valid.
|
|
72
|
+
RUNNING = 2
|
|
73
|
+
|
|
74
|
+
# Deprecated: This state is no longer used.
|
|
75
|
+
DONE = 3
|
|
76
|
+
|
|
77
|
+
# Deprecated: This state is no longer used.
|
|
78
|
+
EXPIRED = 4
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
|
|
24
82
|
# A deployment represents an immutable, queryable version of the app.
|
|
25
83
|
# It is used to deploy an app version with a specific channel profile.
|
|
26
84
|
# @!attribute [rw] name
|
|
@@ -52,10 +110,57 @@ module Google
|
|
|
52
110
|
# Output only. Etag used to ensure the object hasn't changed during a
|
|
53
111
|
# read-modify-write operation. If the etag is empty, the update will
|
|
54
112
|
# overwrite any concurrent changes.
|
|
113
|
+
# @!attribute [rw] experiment_config
|
|
114
|
+
# @return [::Google::Cloud::Ces::V1::ExperimentConfig]
|
|
115
|
+
# Optional. Experiment configuration for the deployment.
|
|
116
|
+
# @!attribute [rw] whatsapp_credentials
|
|
117
|
+
# @return [::Google::Cloud::Ces::V1::WhatsAppCredentials]
|
|
118
|
+
# Optional. Input only. Ephemeral WhatsApp credentials required when
|
|
119
|
+
# configuring a WhatsApp channel profile.
|
|
120
|
+
# @!attribute [rw] instagram_credentials
|
|
121
|
+
# @return [::Google::Cloud::Ces::V1::InstagramCredentials]
|
|
122
|
+
# Optional. Input only. Ephemeral Instagram credentials required when
|
|
123
|
+
# configuring a Instagram channel profile.
|
|
55
124
|
class Deployment
|
|
56
125
|
include ::Google::Protobuf::MessageExts
|
|
57
126
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
58
127
|
end
|
|
128
|
+
|
|
129
|
+
# Ephemeral Meta credentials for WhatsApp native integration.
|
|
130
|
+
# @!attribute [rw] auth_code
|
|
131
|
+
# @return [::String]
|
|
132
|
+
# Required. The Meta auth code provided by the embedded signup flow.
|
|
133
|
+
# @!attribute [rw] pin
|
|
134
|
+
# @return [::String]
|
|
135
|
+
# Required. The 6-digit PIN created by the user for two-step verification.
|
|
136
|
+
# @!attribute [rw] phone_number
|
|
137
|
+
# @return [::String]
|
|
138
|
+
# Required. The phone number to register with WhatsApp.
|
|
139
|
+
# @!attribute [rw] business_account_id
|
|
140
|
+
# @return [::String]
|
|
141
|
+
# Required. The Business Account ID to use for the phone number.
|
|
142
|
+
# @!attribute [rw] waba_id
|
|
143
|
+
# @return [::String]
|
|
144
|
+
# Required. The WhatsApp Business Account ID.
|
|
145
|
+
# @!attribute [rw] conversation_profile_id
|
|
146
|
+
# @return [::String]
|
|
147
|
+
# Required. The Conversation Profile ID to use for the deployment.
|
|
148
|
+
class WhatsAppCredentials
|
|
149
|
+
include ::Google::Protobuf::MessageExts
|
|
150
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
151
|
+
end
|
|
152
|
+
|
|
153
|
+
# Ephemeral Meta credentials for Instagram native integration.
|
|
154
|
+
# @!attribute [rw] auth_code
|
|
155
|
+
# @return [::String]
|
|
156
|
+
# Required. The Meta auth code provided by the embedded signup flow.
|
|
157
|
+
# @!attribute [rw] conversation_profile_id
|
|
158
|
+
# @return [::String]
|
|
159
|
+
# Required. The Conversation Profile ID to use for the deployment.
|
|
160
|
+
class InstagramCredentials
|
|
161
|
+
include ::Google::Protobuf::MessageExts
|
|
162
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
163
|
+
end
|
|
59
164
|
end
|
|
60
165
|
end
|
|
61
166
|
end
|
|
@@ -27,6 +27,10 @@ module Google
|
|
|
27
27
|
# @!attribute [rw] name
|
|
28
28
|
# @return [::String]
|
|
29
29
|
# Required. The name of the MCP tool.
|
|
30
|
+
# @!attribute [rw] name_override
|
|
31
|
+
# @return [::String]
|
|
32
|
+
# Optional. The name override of the MCP tool.
|
|
33
|
+
# This is populated if the name was overridden by a Toolset override.
|
|
30
34
|
# @!attribute [rw] description
|
|
31
35
|
# @return [::String]
|
|
32
36
|
# Optional. The description of the MCP tool.
|
|
@@ -66,6 +70,10 @@ module Google
|
|
|
66
70
|
# can be set in the session variables. See
|
|
67
71
|
# https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection
|
|
68
72
|
# for more details.
|
|
73
|
+
# @!attribute [r] state
|
|
74
|
+
# @return [::Google::Cloud::Ces::V1::McpTool::State]
|
|
75
|
+
# Output only. The dynamic availability state of the tool on the external
|
|
76
|
+
# server.
|
|
69
77
|
class McpTool
|
|
70
78
|
include ::Google::Protobuf::MessageExts
|
|
71
79
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -78,6 +86,23 @@ module Google
|
|
|
78
86
|
include ::Google::Protobuf::MessageExts
|
|
79
87
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
80
88
|
end
|
|
89
|
+
|
|
90
|
+
# Represents the dynamic availability state of the tool.
|
|
91
|
+
module State
|
|
92
|
+
# Default state.
|
|
93
|
+
STATE_UNSPECIFIED = 0
|
|
94
|
+
|
|
95
|
+
# The tool is available and actively offered by the server.
|
|
96
|
+
ACTIVE = 1
|
|
97
|
+
|
|
98
|
+
# The tool is configured or pinned, but currently not offered by the
|
|
99
|
+
# server.
|
|
100
|
+
INACTIVE = 2
|
|
101
|
+
|
|
102
|
+
# The tool exists on the server, but does not match the version on the
|
|
103
|
+
# server.
|
|
104
|
+
STALE = 3
|
|
105
|
+
end
|
|
81
106
|
end
|
|
82
107
|
end
|
|
83
108
|
end
|
|
@@ -52,6 +52,11 @@ module Google
|
|
|
52
52
|
# can be set in the session variables. See
|
|
53
53
|
# https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection
|
|
54
54
|
# for more details.
|
|
55
|
+
# @!attribute [rw] tool_overrides
|
|
56
|
+
# @return [::Array<::Google::Cloud::Ces::V1::McpToolOverride>]
|
|
57
|
+
# Optional. Overrides for individual tools within this toolset.
|
|
58
|
+
# This allows overriding specific details like descriptions, names,
|
|
59
|
+
# or pinning the tools' states so they aren't fully dynamic.
|
|
55
60
|
class McpToolset
|
|
56
61
|
include ::Google::Protobuf::MessageExts
|
|
57
62
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -65,6 +70,48 @@ module Google
|
|
|
65
70
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
66
71
|
end
|
|
67
72
|
end
|
|
73
|
+
|
|
74
|
+
# Overrides associated with a given tool in a Toolset.
|
|
75
|
+
# This enables "pinning" or "overriding" of tool definitions from the external
|
|
76
|
+
# dynamic server.
|
|
77
|
+
# @!attribute [rw] tool
|
|
78
|
+
# @return [::String]
|
|
79
|
+
# Required. The original name of the tool as it is emitted by the MCP server.
|
|
80
|
+
# @!attribute [rw] name_override
|
|
81
|
+
# @return [::String]
|
|
82
|
+
# Optional. If present, this tool uses this name in the Agent instead of the
|
|
83
|
+
# original name. This is primarily used as an alias if the MCP server offers
|
|
84
|
+
# poorly named tools.
|
|
85
|
+
# @!attribute [rw] description_override
|
|
86
|
+
# @return [::String]
|
|
87
|
+
# Optional. If present, this tool uses this description instead of the
|
|
88
|
+
# original description from the server.
|
|
89
|
+
# @!attribute [r] snapshot
|
|
90
|
+
# @return [::Google::Cloud::Ces::V1::McpToolDefinition]
|
|
91
|
+
# Output only. If present, this tool is "Pinned" and uses the snapshot values
|
|
92
|
+
# as fallbacks if the server becomes temporarily unavailable or if no
|
|
93
|
+
# Override is present.
|
|
94
|
+
class McpToolOverride
|
|
95
|
+
include ::Google::Protobuf::MessageExts
|
|
96
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
# Container for a tool's core definition elements that are snapshot.
|
|
100
|
+
# Schemas in the snapshot are used as-is and cannot be overridden.
|
|
101
|
+
# @!attribute [r] description
|
|
102
|
+
# @return [::String]
|
|
103
|
+
# Output only. The description of the MCP tool. This can be overridden
|
|
104
|
+
# by `description_override` in `McpToolOverride`.
|
|
105
|
+
# @!attribute [r] input_schema
|
|
106
|
+
# @return [::Google::Cloud::Ces::V1::Schema]
|
|
107
|
+
# Output only. The schema of the input arguments of the MCP tool.
|
|
108
|
+
# @!attribute [r] output_schema
|
|
109
|
+
# @return [::Google::Cloud::Ces::V1::Schema]
|
|
110
|
+
# Output only. The schema of the output arguments of the MCP tool.
|
|
111
|
+
class McpToolDefinition
|
|
112
|
+
include ::Google::Protobuf::MessageExts
|
|
113
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
114
|
+
end
|
|
68
115
|
end
|
|
69
116
|
end
|
|
70
117
|
end
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Cloud
|
|
22
|
+
module Ces
|
|
23
|
+
module V1
|
|
24
|
+
# A mocked tool call.
|
|
25
|
+
#
|
|
26
|
+
# Expresses the target tool + a pattern to match against that tool's
|
|
27
|
+
# args / inputs. If the pattern matches, then the mock response will be
|
|
28
|
+
# returned.
|
|
29
|
+
# @!attribute [rw] tool_id
|
|
30
|
+
# @return [::String]
|
|
31
|
+
# Optional. The name of the tool to mock.
|
|
32
|
+
# Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
|
|
33
|
+
#
|
|
34
|
+
# Note: The following fields are mutually exclusive: `tool_id`, `toolset`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
35
|
+
# @!attribute [rw] toolset
|
|
36
|
+
# @return [::Google::Cloud::Ces::V1::ToolsetTool]
|
|
37
|
+
# Optional. The toolset to mock.
|
|
38
|
+
#
|
|
39
|
+
# Note: The following fields are mutually exclusive: `toolset`, `tool_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
40
|
+
# @!attribute [rw] tool
|
|
41
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
42
|
+
# @return [::String]
|
|
43
|
+
# Optional. Deprecated. Use tool_identifier instead.
|
|
44
|
+
# @!attribute [rw] expected_args_pattern
|
|
45
|
+
# @return [::Google::Protobuf::Struct]
|
|
46
|
+
# Required. A pattern to match against the args / inputs of all dispatched
|
|
47
|
+
# tool calls. If the tool call inputs match this pattern, then mock output
|
|
48
|
+
# will be returned.
|
|
49
|
+
# @!attribute [rw] mock_response
|
|
50
|
+
# @return [::Google::Protobuf::Struct]
|
|
51
|
+
# Optional. The mock response / output to return if the tool call args /
|
|
52
|
+
# inputs match the pattern.
|
|
53
|
+
class MockedToolCall
|
|
54
|
+
include ::Google::Protobuf::MessageExts
|
|
55
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
end
|
|
@@ -34,6 +34,9 @@ module Google
|
|
|
34
34
|
# @return [::String]
|
|
35
35
|
# Output only. The description of the Python function, parsed from the python
|
|
36
36
|
# code's docstring.
|
|
37
|
+
# @!attribute [rw] service_directory_config
|
|
38
|
+
# @return [::Google::Cloud::Ces::V1::ServiceDirectoryConfig]
|
|
39
|
+
# Optional. Service Directory configuration for the tool.
|
|
37
40
|
class PythonFunction
|
|
38
41
|
include ::Google::Protobuf::MessageExts
|
|
39
42
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -21,6 +21,32 @@ module Google
|
|
|
21
21
|
module Cloud
|
|
22
22
|
module Ces
|
|
23
23
|
module V1
|
|
24
|
+
# Mock tool calls configuration for the session.
|
|
25
|
+
# @!attribute [rw] mocked_tool_calls
|
|
26
|
+
# @return [::Array<::Google::Cloud::Ces::V1::MockedToolCall>]
|
|
27
|
+
# Optional. All tool calls to mock for the duration of the session.
|
|
28
|
+
# @!attribute [rw] unmatched_tool_call_behavior
|
|
29
|
+
# @return [::Google::Cloud::Ces::V1::MockConfig::UnmatchedToolCallBehavior]
|
|
30
|
+
# Required. Beavhior for tool calls that don't match any args patterns in
|
|
31
|
+
# mocked_tool_calls.
|
|
32
|
+
class MockConfig
|
|
33
|
+
include ::Google::Protobuf::MessageExts
|
|
34
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
35
|
+
|
|
36
|
+
# What to do when a tool call doesn't match any mocked tool calls.
|
|
37
|
+
module UnmatchedToolCallBehavior
|
|
38
|
+
# Default value. This value is unused.
|
|
39
|
+
UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED = 0
|
|
40
|
+
|
|
41
|
+
# Throw an error for any tool calls that don't match a mock expected input
|
|
42
|
+
# pattern.
|
|
43
|
+
FAIL = 1
|
|
44
|
+
|
|
45
|
+
# For unmatched tool calls, pass the tool call through to real tool.
|
|
46
|
+
PASS_THROUGH = 2
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
|
|
24
50
|
# InputAudioConfig configures how the CES agent should interpret the incoming
|
|
25
51
|
# audio data.
|
|
26
52
|
# @!attribute [rw] audio_encoding
|
|
@@ -181,6 +207,9 @@ module Google
|
|
|
181
207
|
# @!attribute [rw] text
|
|
182
208
|
# @return [::String]
|
|
183
209
|
# Text used for citation.
|
|
210
|
+
# @!attribute [rw] requires_attribution
|
|
211
|
+
# @return [::Boolean]
|
|
212
|
+
# Whether this citation requires attribution to be shown to the end users.
|
|
184
213
|
class CitedChunk
|
|
185
214
|
include ::Google::Protobuf::MessageExts
|
|
186
215
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -308,6 +337,9 @@ module Google
|
|
|
308
337
|
# Optional. Diagnostic information contains execution details during the
|
|
309
338
|
# processing of the input. Only populated in the last SessionOutput (with
|
|
310
339
|
# `turn_completed=true`) for each turn.
|
|
340
|
+
# @!attribute [rw] context
|
|
341
|
+
# @return [::Array<::Google::Protobuf::Any>]
|
|
342
|
+
# Context messages for external supervision guardrails.
|
|
311
343
|
class SessionOutput
|
|
312
344
|
include ::Google::Protobuf::MessageExts
|
|
313
345
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|