google-apis-ces_v1 0.4.0 → 0.5.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9bc1b2541133ca9fa5fc618d0718d327745498fe274dd7f02f2ac0e098df68fd
4
- data.tar.gz: 93c6f06caee89e04cd285e82139b683258ff6c6db23e9dd5ba098c74ee87941e
3
+ metadata.gz: bf45178bf3c68ee20684f5f428ec6103cd30c68934e23dae9c935718726258ec
4
+ data.tar.gz: 977cfabdd6487dd54535811523e00265f1b9520ec195cd204af64b0706bb899b
5
5
  SHA512:
6
- metadata.gz: 5939499dc9722cdd27629556ceec809ef43a0ba5f5386a02a87decab0a439620cbb3f9f3202ad96e47217bd9e5766055d59d42162c01114996a905acb5de4247
7
- data.tar.gz: b7e5252f4e572a1a114fae6d9ad693c170a364728a9857f6a09a62af56a4e1fd5ce3a72171ac3685ce546dda7fa2194b6ef78dbfe815bb556e6cf680baabb620
6
+ metadata.gz: 0a03b9e31664a8f19bd65047e51044583ffd84030bb3878e3a3c1280379bc9b37ef1d5ef164afac6376c334dac79d97aeba41b36edf3bdc96fa450004677229e
7
+ data.tar.gz: df73ef5fb0e38b0d169728dc1d1ccde663a1ae28b26de32c0215ac7e4d3f3a63dceffb9c1f8775175d0aa72f5fb5d75d0fa37ca172214cb3fb8cfd059ba08a6f
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-ces_v1
2
2
 
3
+ ### v0.5.0 (2026-03-15)
4
+
5
+ * Regenerated from discovery document revision 20260312
6
+
3
7
  ### v0.4.0 (2026-03-08)
4
8
 
5
9
  * Regenerated from discovery document revision 20260227
data/OVERVIEW.md CHANGED
@@ -79,7 +79,7 @@ Gem names for modern clients are often of the form `google-cloud-<service_name>`
79
79
 
80
80
  **For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
81
81
 
82
- The [product documentation](https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference) may provide guidance regarding the preferred client library to use.
82
+ The [product documentation](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps) may provide guidance regarding the preferred client library to use.
83
83
 
84
84
  ## Supported Ruby versions
85
85
 
@@ -373,6 +373,38 @@ module Google
373
373
  end
374
374
  end
375
375
 
376
+ # Represents a tool that allows the agent to call another agent.
377
+ class AgentTool
378
+ include Google::Apis::Core::Hashable
379
+
380
+ # Optional. Description of the tool's purpose.
381
+ # Corresponds to the JSON property `description`
382
+ # @return [String]
383
+ attr_accessor :description
384
+
385
+ # Required. The name of the agent tool.
386
+ # Corresponds to the JSON property `name`
387
+ # @return [String]
388
+ attr_accessor :name
389
+
390
+ # Optional. The resource name of the root agent that is the entry point of the
391
+ # tool. Format: `projects/`project`/locations/`location`/agents/`agent``
392
+ # Corresponds to the JSON property `rootAgent`
393
+ # @return [String]
394
+ attr_accessor :root_agent
395
+
396
+ def initialize(**args)
397
+ update!(**args)
398
+ end
399
+
400
+ # Update properties of this object
401
+ def update!(**args)
402
+ @description = args[:description] if args.key?(:description)
403
+ @name = args[:name] if args.key?(:name)
404
+ @root_agent = args[:root_agent] if args.key?(:root_agent)
405
+ end
406
+ end
407
+
376
408
  # Represents an event indicating the transfer of a conversation to a different
377
409
  # agent.
378
410
  class AgentTransfer
@@ -2885,6 +2917,13 @@ module Google
2885
2917
  # @return [Hash<String,Object>]
2886
2918
  attr_accessor :args
2887
2919
 
2920
+ # Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-
2921
+ # engagement-ai/conversational-agents/ps/tool/python#environment for details) to
2922
+ # be passed to the Python tool.
2923
+ # Corresponds to the JSON property `context`
2924
+ # @return [Hash<String,Object>]
2925
+ attr_accessor :context
2926
+
2888
2927
  # Optional. The name of the tool to execute. Format: projects/`project`/
2889
2928
  # locations/`location`/apps/`app`/tools/`tool`
2890
2929
  # Corresponds to the JSON property `tool`
@@ -2908,6 +2947,7 @@ module Google
2908
2947
  # Update properties of this object
2909
2948
  def update!(**args)
2910
2949
  @args = args[:args] if args.key?(:args)
2950
+ @context = args[:context] if args.key?(:context)
2911
2951
  @tool = args[:tool] if args.key?(:tool)
2912
2952
  @toolset_tool = args[:toolset_tool] if args.key?(:toolset_tool)
2913
2953
  @variables = args[:variables] if args.key?(:variables)
@@ -2959,6 +2999,12 @@ module Google
2959
2999
  class ExportAppRequest
2960
3000
  include Google::Apis::Core::Hashable
2961
3001
 
3002
+ # Optional. The resource name of the app version to export. Format: `projects/`
3003
+ # project`/locations/`location`/apps/`app`/versions/`version``.
3004
+ # Corresponds to the JSON property `appVersion`
3005
+ # @return [String]
3006
+ attr_accessor :app_version
3007
+
2962
3008
  # Required. The format to export the app in.
2963
3009
  # Corresponds to the JSON property `exportFormat`
2964
3010
  # @return [String]
@@ -2977,6 +3023,7 @@ module Google
2977
3023
 
2978
3024
  # Update properties of this object
2979
3025
  def update!(**args)
3026
+ @app_version = args[:app_version] if args.key?(:app_version)
2980
3027
  @export_format = args[:export_format] if args.key?(:export_format)
2981
3028
  @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
2982
3029
  end
@@ -3078,6 +3125,12 @@ module Google
3078
3125
  # @return [String]
3079
3126
  attr_accessor :deployment
3080
3127
 
3128
+ # Optional. Indicates if live handoff is enabled for the session.
3129
+ # Corresponds to the JSON property `liveHandoffEnabled`
3130
+ # @return [Boolean]
3131
+ attr_accessor :live_handoff_enabled
3132
+ alias_method :live_handoff_enabled?, :live_handoff_enabled
3133
+
3081
3134
  # Optional. The reCAPTCHA token generated by the client-side chat widget.
3082
3135
  # Corresponds to the JSON property `recaptchaToken`
3083
3136
  # @return [String]
@@ -3090,6 +3143,7 @@ module Google
3090
3143
  # Update properties of this object
3091
3144
  def update!(**args)
3092
3145
  @deployment = args[:deployment] if args.key?(:deployment)
3146
+ @live_handoff_enabled = args[:live_handoff_enabled] if args.key?(:live_handoff_enabled)
3093
3147
  @recaptcha_token = args[:recaptcha_token] if args.key?(:recaptcha_token)
3094
3148
  end
3095
3149
  end
@@ -4232,6 +4286,14 @@ module Google
4232
4286
  # @return [Google::Apis::CesV1::ApiAuthentication]
4233
4287
  attr_accessor :api_authentication
4234
4288
 
4289
+ # Optional. The custom headers to send in the request to the MCP server. The
4290
+ # values must be in the format `$context.variables.` and can be set in the
4291
+ # session variables. See https://docs.cloud.google.com/customer-engagement-ai/
4292
+ # conversational-agents/ps/tool/open-api#openapi-injection for more details.
4293
+ # Corresponds to the JSON property `customHeaders`
4294
+ # @return [Hash<String,String>]
4295
+ attr_accessor :custom_headers
4296
+
4235
4297
  # Optional. The description of the MCP tool.
4236
4298
  # Corresponds to the JSON property `description`
4237
4299
  # @return [String]
@@ -4278,6 +4340,7 @@ module Google
4278
4340
  # Update properties of this object
4279
4341
  def update!(**args)
4280
4342
  @api_authentication = args[:api_authentication] if args.key?(:api_authentication)
4343
+ @custom_headers = args[:custom_headers] if args.key?(:custom_headers)
4281
4344
  @description = args[:description] if args.key?(:description)
4282
4345
  @input_schema = args[:input_schema] if args.key?(:input_schema)
4283
4346
  @name = args[:name] if args.key?(:name)
@@ -4297,6 +4360,14 @@ module Google
4297
4360
  # @return [Google::Apis::CesV1::ApiAuthentication]
4298
4361
  attr_accessor :api_authentication
4299
4362
 
4363
+ # Optional. The custom headers to send in the request to the MCP server. The
4364
+ # values must be in the format `$context.variables.` and can be set in the
4365
+ # session variables. See https://docs.cloud.google.com/customer-engagement-ai/
4366
+ # conversational-agents/ps/tool/open-api#openapi-injection for more details.
4367
+ # Corresponds to the JSON property `customHeaders`
4368
+ # @return [Hash<String,String>]
4369
+ attr_accessor :custom_headers
4370
+
4300
4371
  # Required. The address of the MCP server, for example, "https://example.com/mcp/
4301
4372
  # ". If the server is built with the MCP SDK, the url should be suffixed with "/
4302
4373
  # mcp/". Only Streamable HTTP transport based servers are supported. See https://
@@ -4323,6 +4394,7 @@ module Google
4323
4394
  # Update properties of this object
4324
4395
  def update!(**args)
4325
4396
  @api_authentication = args[:api_authentication] if args.key?(:api_authentication)
4397
+ @custom_headers = args[:custom_headers] if args.key?(:custom_headers)
4326
4398
  @server_address = args[:server_address] if args.key?(:server_address)
4327
4399
  @service_directory_config = args[:service_directory_config] if args.key?(:service_directory_config)
4328
4400
  @tls_config = args[:tls_config] if args.key?(:tls_config)
@@ -5995,6 +6067,11 @@ module Google
5995
6067
  class Tool
5996
6068
  include Google::Apis::Core::Hashable
5997
6069
 
6070
+ # Represents a tool that allows the agent to call another agent.
6071
+ # Corresponds to the JSON property `agentTool`
6072
+ # @return [Google::Apis::CesV1::AgentTool]
6073
+ attr_accessor :agent_tool
6074
+
5998
6075
  # Represents a client-side function that the agent can invoke. When the tool is
5999
6076
  # chosen by the agent, control is handed off to the client. The client is
6000
6077
  # responsible for executing the function and returning the result as a
@@ -6115,6 +6192,7 @@ module Google
6115
6192
 
6116
6193
  # Update properties of this object
6117
6194
  def update!(**args)
6195
+ @agent_tool = args[:agent_tool] if args.key?(:agent_tool)
6118
6196
  @client_function = args[:client_function] if args.key?(:client_function)
6119
6197
  @connector_tool = args[:connector_tool] if args.key?(:connector_tool)
6120
6198
  @create_time = args[:create_time] if args.key?(:create_time)
@@ -6636,6 +6714,12 @@ module Google
6636
6714
  class WidgetTool
6637
6715
  include Google::Apis::Core::Hashable
6638
6716
 
6717
+ # Configuration for mapping data from a source tool to the widget's input
6718
+ # parameters.
6719
+ # Corresponds to the JSON property `dataMapping`
6720
+ # @return [Google::Apis::CesV1::WidgetToolDataMapping]
6721
+ attr_accessor :data_mapping
6722
+
6639
6723
  # Optional. The description of the widget tool.
6640
6724
  # Corresponds to the JSON property `description`
6641
6725
  # @return [String]
@@ -6651,6 +6735,11 @@ module Google
6651
6735
  # @return [Google::Apis::CesV1::Schema]
6652
6736
  attr_accessor :parameters
6653
6737
 
6738
+ # Optional. Configuration for rendering the widget.
6739
+ # Corresponds to the JSON property `uiConfig`
6740
+ # @return [Hash<String,Object>]
6741
+ attr_accessor :ui_config
6742
+
6654
6743
  # Optional. The type of the widget tool. If not specified, the default type will
6655
6744
  # be CUSTOMIZED.
6656
6745
  # Corresponds to the JSON property `widgetType`
@@ -6663,12 +6752,57 @@ module Google
6663
6752
 
6664
6753
  # Update properties of this object
6665
6754
  def update!(**args)
6755
+ @data_mapping = args[:data_mapping] if args.key?(:data_mapping)
6666
6756
  @description = args[:description] if args.key?(:description)
6667
6757
  @name = args[:name] if args.key?(:name)
6668
6758
  @parameters = args[:parameters] if args.key?(:parameters)
6759
+ @ui_config = args[:ui_config] if args.key?(:ui_config)
6669
6760
  @widget_type = args[:widget_type] if args.key?(:widget_type)
6670
6761
  end
6671
6762
  end
6763
+
6764
+ # Configuration for mapping data from a source tool to the widget's input
6765
+ # parameters.
6766
+ class WidgetToolDataMapping
6767
+ include Google::Apis::Core::Hashable
6768
+
6769
+ # Optional. A map of widget input parameter fields to the corresponding output
6770
+ # fields of the source tool.
6771
+ # Corresponds to the JSON property `fieldMappings`
6772
+ # @return [Hash<String,String>]
6773
+ attr_accessor :field_mappings
6774
+
6775
+ # Optional. The mode of the data mapping.
6776
+ # Corresponds to the JSON property `mode`
6777
+ # @return [String]
6778
+ attr_accessor :mode
6779
+
6780
+ # Optional. A Python script used to transform the source tool's output into the
6781
+ # widget's input format. This is used when the mapping is too complex for simple
6782
+ # field mappings.
6783
+ # Corresponds to the JSON property `pythonScript`
6784
+ # @return [String]
6785
+ attr_accessor :python_script
6786
+
6787
+ # Optional. The resource name of the tool that provides the data for the widget (
6788
+ # e.g., a search tool or a custom function). Format: `projects/`project`/
6789
+ # locations/`location`/agents/`agent`/tools/`tool``
6790
+ # Corresponds to the JSON property `sourceToolName`
6791
+ # @return [String]
6792
+ attr_accessor :source_tool_name
6793
+
6794
+ def initialize(**args)
6795
+ update!(**args)
6796
+ end
6797
+
6798
+ # Update properties of this object
6799
+ def update!(**args)
6800
+ @field_mappings = args[:field_mappings] if args.key?(:field_mappings)
6801
+ @mode = args[:mode] if args.key?(:mode)
6802
+ @python_script = args[:python_script] if args.key?(:python_script)
6803
+ @source_tool_name = args[:source_tool_name] if args.key?(:source_tool_name)
6804
+ end
6805
+ end
6672
6806
  end
6673
6807
  end
6674
6808
  end
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module CesV1
18
18
  # Version of the google-apis-ces_v1 gem
19
- GEM_VERSION = "0.4.0"
19
+ GEM_VERSION = "0.5.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.18.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20260227"
25
+ REVISION = "20260312"
26
26
  end
27
27
  end
28
28
  end
@@ -58,6 +58,12 @@ module Google
58
58
  include Google::Apis::Core::JsonObjectSupport
59
59
  end
60
60
 
61
+ class AgentTool
62
+ class Representation < Google::Apis::Core::JsonRepresentation; end
63
+
64
+ include Google::Apis::Core::JsonObjectSupport
65
+ end
66
+
61
67
  class AgentTransfer
62
68
  class Representation < Google::Apis::Core::JsonRepresentation; end
63
69
 
@@ -1066,6 +1072,12 @@ module Google
1066
1072
  include Google::Apis::Core::JsonObjectSupport
1067
1073
  end
1068
1074
 
1075
+ class WidgetToolDataMapping
1076
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1077
+
1078
+ include Google::Apis::Core::JsonObjectSupport
1079
+ end
1080
+
1069
1081
  class Action
1070
1082
  # @private
1071
1083
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1150,6 +1162,15 @@ module Google
1150
1162
  end
1151
1163
  end
1152
1164
 
1165
+ class AgentTool
1166
+ # @private
1167
+ class Representation < Google::Apis::Core::JsonRepresentation
1168
+ property :description, as: 'description'
1169
+ property :name, as: 'name'
1170
+ property :root_agent, as: 'rootAgent'
1171
+ end
1172
+ end
1173
+
1153
1174
  class AgentTransfer
1154
1175
  # @private
1155
1176
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1853,6 +1874,7 @@ module Google
1853
1874
  # @private
1854
1875
  class Representation < Google::Apis::Core::JsonRepresentation
1855
1876
  hash :args, as: 'args'
1877
+ hash :context, as: 'context'
1856
1878
  property :tool, as: 'tool'
1857
1879
  property :toolset_tool, as: 'toolsetTool', class: Google::Apis::CesV1::ToolsetTool, decorator: Google::Apis::CesV1::ToolsetTool::Representation
1858
1880
 
@@ -1874,6 +1896,7 @@ module Google
1874
1896
  class ExportAppRequest
1875
1897
  # @private
1876
1898
  class Representation < Google::Apis::Core::JsonRepresentation
1899
+ property :app_version, as: 'appVersion'
1877
1900
  property :export_format, as: 'exportFormat'
1878
1901
  property :gcs_uri, as: 'gcsUri'
1879
1902
  end
@@ -1908,6 +1931,7 @@ module Google
1908
1931
  # @private
1909
1932
  class Representation < Google::Apis::Core::JsonRepresentation
1910
1933
  property :deployment, as: 'deployment'
1934
+ property :live_handoff_enabled, as: 'liveHandoffEnabled'
1911
1935
  property :recaptcha_token, as: 'recaptchaToken'
1912
1936
  end
1913
1937
  end
@@ -2248,6 +2272,7 @@ module Google
2248
2272
  class Representation < Google::Apis::Core::JsonRepresentation
2249
2273
  property :api_authentication, as: 'apiAuthentication', class: Google::Apis::CesV1::ApiAuthentication, decorator: Google::Apis::CesV1::ApiAuthentication::Representation
2250
2274
 
2275
+ hash :custom_headers, as: 'customHeaders'
2251
2276
  property :description, as: 'description'
2252
2277
  property :input_schema, as: 'inputSchema', class: Google::Apis::CesV1::Schema, decorator: Google::Apis::CesV1::Schema::Representation
2253
2278
 
@@ -2267,6 +2292,7 @@ module Google
2267
2292
  class Representation < Google::Apis::Core::JsonRepresentation
2268
2293
  property :api_authentication, as: 'apiAuthentication', class: Google::Apis::CesV1::ApiAuthentication, decorator: Google::Apis::CesV1::ApiAuthentication::Representation
2269
2294
 
2295
+ hash :custom_headers, as: 'customHeaders'
2270
2296
  property :server_address, as: 'serverAddress'
2271
2297
  property :service_directory_config, as: 'serviceDirectoryConfig', class: Google::Apis::CesV1::ServiceDirectoryConfig, decorator: Google::Apis::CesV1::ServiceDirectoryConfig::Representation
2272
2298
 
@@ -2742,6 +2768,8 @@ module Google
2742
2768
  class Tool
2743
2769
  # @private
2744
2770
  class Representation < Google::Apis::Core::JsonRepresentation
2771
+ property :agent_tool, as: 'agentTool', class: Google::Apis::CesV1::AgentTool, decorator: Google::Apis::CesV1::AgentTool::Representation
2772
+
2745
2773
  property :client_function, as: 'clientFunction', class: Google::Apis::CesV1::ClientFunction, decorator: Google::Apis::CesV1::ClientFunction::Representation
2746
2774
 
2747
2775
  property :connector_tool, as: 'connectorTool', class: Google::Apis::CesV1::ConnectorTool, decorator: Google::Apis::CesV1::ConnectorTool::Representation
@@ -2935,13 +2963,26 @@ module Google
2935
2963
  class WidgetTool
2936
2964
  # @private
2937
2965
  class Representation < Google::Apis::Core::JsonRepresentation
2966
+ property :data_mapping, as: 'dataMapping', class: Google::Apis::CesV1::WidgetToolDataMapping, decorator: Google::Apis::CesV1::WidgetToolDataMapping::Representation
2967
+
2938
2968
  property :description, as: 'description'
2939
2969
  property :name, as: 'name'
2940
2970
  property :parameters, as: 'parameters', class: Google::Apis::CesV1::Schema, decorator: Google::Apis::CesV1::Schema::Representation
2941
2971
 
2972
+ hash :ui_config, as: 'uiConfig'
2942
2973
  property :widget_type, as: 'widgetType'
2943
2974
  end
2944
2975
  end
2976
+
2977
+ class WidgetToolDataMapping
2978
+ # @private
2979
+ class Representation < Google::Apis::Core::JsonRepresentation
2980
+ hash :field_mappings, as: 'fieldMappings'
2981
+ property :mode, as: 'mode'
2982
+ property :python_script, as: 'pythonScript'
2983
+ property :source_tool_name, as: 'sourceToolName'
2984
+ end
2985
+ end
2945
2986
  end
2946
2987
  end
2947
2988
  end
@@ -30,7 +30,7 @@ module Google
30
30
  # Ces = Google::Apis::CesV1 # Alias the module
31
31
  # service = Ces::CustomerEngagementSuiteService.new
32
32
  #
33
- # @see https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference
33
+ # @see https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps
34
34
  class CustomerEngagementSuiteService < Google::Apis::Core::BaseService
35
35
  DEFAULT_ENDPOINT_TEMPLATE = "https://ces.$UNIVERSE_DOMAIN$/"
36
36
 
@@ -1491,7 +1491,7 @@ module Google
1491
1491
  execute_or_queue_command(command, &block)
1492
1492
  end
1493
1493
 
1494
- # Initiates a single turn interaction with the CES agent within a session.
1494
+ # Initiates a single-turn interaction with the CES agent within a session.
1495
1495
  # @param [String] session
1496
1496
  # Required. The unique identifier of the session. Format: `projects/`project`/
1497
1497
  # locations/`location`/apps/`app`/sessions/`session``
@@ -23,7 +23,7 @@ module Google
23
23
  #
24
24
  #
25
25
  #
26
- # @see https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference
26
+ # @see https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps
27
27
  module CesV1
28
28
  # Version of the Gemini Enterprise for Customer Experience API this client connects to.
29
29
  # This is NOT the gem version.
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-ces_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0
4
+ version: 0.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-ces_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-ces_v1/v0.4.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-ces_v1/v0.5.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-ces_v1
63
63
  rdoc_options: []
64
64
  require_paths: