google-apis-discoveryengine_v1beta 0.28.0 → 0.29.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: 8a3a7f905a2cf4a974dba5d83c9aca64a5401ecc1748c9c9573ba62e581bbcbf
4
- data.tar.gz: 5efd43e1df5a8f74727fd533a1a8c8f9f206054849e934bcd958063ef2ec9ec4
3
+ metadata.gz: '05870d79748bf5f1eb41cc3468cb77a91a4dd87fa437b6b7ccd558d952d355b7'
4
+ data.tar.gz: 61404700282fae25f4c7c3a93a9bac8d25b6d36f4a9707eae5931bbba69bf3e3
5
5
  SHA512:
6
- metadata.gz: d8df7bc261909195ca8ee25290dd3c39e73a6e405657d950021511206c4e73120c3c41048a43153ebd4ccd7b5fda495e1691b9f1dcb8a10c1d522327e1ef806c
7
- data.tar.gz: 11134bf7d0c095eeb7370831e78c2636ac387a6e62015f3b92c5061a21ef980e72d477d7866eae0e0b651cddad4a251b2f3861ac0e35cc17281cc64d4e4c126c
6
+ metadata.gz: 1586d85ff91775521fdc00d34096187540d33550f7cfde1637d8fd3f30405bf9124b982f0118b1ddc85e16fe26b49eb2e6cac7fb455aad2d1d814c8e10e27084
7
+ data.tar.gz: 4bfd838c2bd55e06a67b18860e83e7bc6339cbf30ccb6c3e78540327ec5fc42ad7bd3ead221ffcd1be563c3ab82a01a9af46811a6c658df3be1ba15f9f8423a4
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-discoveryengine_v1beta
2
2
 
3
+ ### v0.29.0 (2023-12-10)
4
+
5
+ * Regenerated from discovery document revision 20231130
6
+
3
7
  ### v0.28.0 (2023-11-19)
4
8
 
5
9
  * Regenerated from discovery document revision 20231110
@@ -622,6 +622,53 @@ module Google
622
622
  end
623
623
  end
624
624
 
625
+ # Metadata related to the progress of the SiteSearchEngineService.
626
+ # BatchCreateTargetSite operation. This will be returned by the google.
627
+ # longrunning.Operation.metadata field.
628
+ class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata
629
+ include Google::Apis::Core::Hashable
630
+
631
+ # Operation create time.
632
+ # Corresponds to the JSON property `createTime`
633
+ # @return [String]
634
+ attr_accessor :create_time
635
+
636
+ # Operation last update time. If the operation is done, this is also the finish
637
+ # time.
638
+ # Corresponds to the JSON property `updateTime`
639
+ # @return [String]
640
+ attr_accessor :update_time
641
+
642
+ def initialize(**args)
643
+ update!(**args)
644
+ end
645
+
646
+ # Update properties of this object
647
+ def update!(**args)
648
+ @create_time = args[:create_time] if args.key?(:create_time)
649
+ @update_time = args[:update_time] if args.key?(:update_time)
650
+ end
651
+ end
652
+
653
+ # Response message for SiteSearchEngineService.BatchCreateTargetSites method.
654
+ class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
655
+ include Google::Apis::Core::Hashable
656
+
657
+ # TargetSites created.
658
+ # Corresponds to the JSON property `targetSites`
659
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaTargetSite>]
660
+ attr_accessor :target_sites
661
+
662
+ def initialize(**args)
663
+ update!(**args)
664
+ end
665
+
666
+ # Update properties of this object
667
+ def update!(**args)
668
+ @target_sites = args[:target_sites] if args.key?(:target_sites)
669
+ end
670
+ end
671
+
625
672
  # Metadata related to the progress of the DataStoreService.CreateDataStore
626
673
  # operation. This will be returned by the google.longrunning.Operation.metadata
627
674
  # field.
@@ -703,6 +750,34 @@ module Google
703
750
  end
704
751
  end
705
752
 
753
+ # Metadata related to the progress of the SiteSearchEngineService.
754
+ # CreateTargetSite operation. This will be returned by the google.longrunning.
755
+ # Operation.metadata field.
756
+ class GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata
757
+ include Google::Apis::Core::Hashable
758
+
759
+ # Operation create time.
760
+ # Corresponds to the JSON property `createTime`
761
+ # @return [String]
762
+ attr_accessor :create_time
763
+
764
+ # Operation last update time. If the operation is done, this is also the finish
765
+ # time.
766
+ # Corresponds to the JSON property `updateTime`
767
+ # @return [String]
768
+ attr_accessor :update_time
769
+
770
+ def initialize(**args)
771
+ update!(**args)
772
+ end
773
+
774
+ # Update properties of this object
775
+ def update!(**args)
776
+ @create_time = args[:create_time] if args.key?(:create_time)
777
+ @update_time = args[:update_time] if args.key?(:update_time)
778
+ end
779
+ end
780
+
706
781
  # DataStore captures global settings and configs at the DataStore level.
707
782
  class GoogleCloudDiscoveryengineV1alphaDataStore
708
783
  include Google::Apis::Core::Hashable
@@ -848,6 +923,116 @@ module Google
848
923
  end
849
924
  end
850
925
 
926
+ # Metadata related to the progress of the SiteSearchEngineService.
927
+ # DeleteTargetSite operation. This will be returned by the google.longrunning.
928
+ # Operation.metadata field.
929
+ class GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata
930
+ include Google::Apis::Core::Hashable
931
+
932
+ # Operation create time.
933
+ # Corresponds to the JSON property `createTime`
934
+ # @return [String]
935
+ attr_accessor :create_time
936
+
937
+ # Operation last update time. If the operation is done, this is also the finish
938
+ # time.
939
+ # Corresponds to the JSON property `updateTime`
940
+ # @return [String]
941
+ attr_accessor :update_time
942
+
943
+ def initialize(**args)
944
+ update!(**args)
945
+ end
946
+
947
+ # Update properties of this object
948
+ def update!(**args)
949
+ @create_time = args[:create_time] if args.key?(:create_time)
950
+ @update_time = args[:update_time] if args.key?(:update_time)
951
+ end
952
+ end
953
+
954
+ # Metadata related to the progress of the SiteSearchEngineService.
955
+ # DisableAdvancedSiteSearch operation. This will be returned by the google.
956
+ # longrunning.Operation.metadata field.
957
+ class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata
958
+ include Google::Apis::Core::Hashable
959
+
960
+ # Operation create time.
961
+ # Corresponds to the JSON property `createTime`
962
+ # @return [String]
963
+ attr_accessor :create_time
964
+
965
+ # Operation last update time. If the operation is done, this is also the finish
966
+ # time.
967
+ # Corresponds to the JSON property `updateTime`
968
+ # @return [String]
969
+ attr_accessor :update_time
970
+
971
+ def initialize(**args)
972
+ update!(**args)
973
+ end
974
+
975
+ # Update properties of this object
976
+ def update!(**args)
977
+ @create_time = args[:create_time] if args.key?(:create_time)
978
+ @update_time = args[:update_time] if args.key?(:update_time)
979
+ end
980
+ end
981
+
982
+ # Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
983
+ class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse
984
+ include Google::Apis::Core::Hashable
985
+
986
+ def initialize(**args)
987
+ update!(**args)
988
+ end
989
+
990
+ # Update properties of this object
991
+ def update!(**args)
992
+ end
993
+ end
994
+
995
+ # Metadata related to the progress of the SiteSearchEngineService.
996
+ # EnableAdvancedSiteSearch operation. This will be returned by the google.
997
+ # longrunning.Operation.metadata field.
998
+ class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata
999
+ include Google::Apis::Core::Hashable
1000
+
1001
+ # Operation create time.
1002
+ # Corresponds to the JSON property `createTime`
1003
+ # @return [String]
1004
+ attr_accessor :create_time
1005
+
1006
+ # Operation last update time. If the operation is done, this is also the finish
1007
+ # time.
1008
+ # Corresponds to the JSON property `updateTime`
1009
+ # @return [String]
1010
+ attr_accessor :update_time
1011
+
1012
+ def initialize(**args)
1013
+ update!(**args)
1014
+ end
1015
+
1016
+ # Update properties of this object
1017
+ def update!(**args)
1018
+ @create_time = args[:create_time] if args.key?(:create_time)
1019
+ @update_time = args[:update_time] if args.key?(:update_time)
1020
+ end
1021
+ end
1022
+
1023
+ # Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
1024
+ class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse
1025
+ include Google::Apis::Core::Hashable
1026
+
1027
+ def initialize(**args)
1028
+ update!(**args)
1029
+ end
1030
+
1031
+ # Update properties of this object
1032
+ def update!(**args)
1033
+ end
1034
+ end
1035
+
851
1036
  # Metadata that describes the training and serving parameters of an Engine.
852
1037
  class GoogleCloudDiscoveryengineV1alphaEngine
853
1038
  include Google::Apis::Core::Hashable
@@ -2018,6 +2203,34 @@ module Google
2018
2203
  end
2019
2204
  end
2020
2205
 
2206
+ # Metadata related to the progress of the SiteSearchEngineService.
2207
+ # UpdateTargetSite operation. This will be returned by the google.longrunning.
2208
+ # Operation.metadata field.
2209
+ class GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata
2210
+ include Google::Apis::Core::Hashable
2211
+
2212
+ # Operation create time.
2213
+ # Corresponds to the JSON property `createTime`
2214
+ # @return [String]
2215
+ attr_accessor :create_time
2216
+
2217
+ # Operation last update time. If the operation is done, this is also the finish
2218
+ # time.
2219
+ # Corresponds to the JSON property `updateTime`
2220
+ # @return [String]
2221
+ attr_accessor :update_time
2222
+
2223
+ def initialize(**args)
2224
+ update!(**args)
2225
+ end
2226
+
2227
+ # Update properties of this object
2228
+ def update!(**args)
2229
+ @create_time = args[:create_time] if args.key?(:create_time)
2230
+ @update_time = args[:update_time] if args.key?(:update_time)
2231
+ end
2232
+ end
2233
+
2021
2234
  # BigQuery source import data from.
2022
2235
  class GoogleCloudDiscoveryengineV1betaBigQuerySource
2023
2236
  include Google::Apis::Core::Hashable
@@ -2184,7 +2397,8 @@ module Google
2184
2397
  attr_accessor :messages
2185
2398
 
2186
2399
  # Immutable. Fully qualified name `project/*/locations/global/collections/`
2187
- # collection`/dataStore/*/conversations/*`
2400
+ # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
2401
+ # collections/`collection`/engines/*/conversations/*`.
2188
2402
  # Corresponds to the JSON property `name`
2189
2403
  # @return [String]
2190
2404
  attr_accessor :name
@@ -4095,6 +4309,11 @@ module Google
4095
4309
  # @return [String]
4096
4310
  attr_accessor :language_code
4097
4311
 
4312
+ # Specification of the model.
4313
+ # Corresponds to the JSON property `modelSpec`
4314
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec]
4315
+ attr_accessor :model_spec
4316
+
4098
4317
  # The number of top results to generate the summary from. If the number of
4099
4318
  # results returned is less than `summaryResultCount`, the summary is generated
4100
4319
  # from all of the results. At most five results can be used to generate a
@@ -4113,10 +4332,30 @@ module Google
4113
4332
  @ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
4114
4333
  @include_citations = args[:include_citations] if args.key?(:include_citations)
4115
4334
  @language_code = args[:language_code] if args.key?(:language_code)
4335
+ @model_spec = args[:model_spec] if args.key?(:model_spec)
4116
4336
  @summary_result_count = args[:summary_result_count] if args.key?(:summary_result_count)
4117
4337
  end
4118
4338
  end
4119
4339
 
4340
+ # Specification of the model.
4341
+ class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec
4342
+ include Google::Apis::Core::Hashable
4343
+
4344
+ # The string format of the model version. e.g. stable, latest, etc.
4345
+ # Corresponds to the JSON property `version`
4346
+ # @return [String]
4347
+ attr_accessor :version
4348
+
4349
+ def initialize(**args)
4350
+ update!(**args)
4351
+ end
4352
+
4353
+ # Update properties of this object
4354
+ def update!(**args)
4355
+ @version = args[:version] if args.key?(:version)
4356
+ end
4357
+ end
4358
+
4120
4359
  # The specification that uses customized query embedding vector to do semantic
4121
4360
  # document retrieval.
4122
4361
  class GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DiscoveryengineV1beta
18
18
  # Version of the google-apis-discoveryengine_v1beta gem
19
- GEM_VERSION = "0.28.0"
19
+ GEM_VERSION = "0.29.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20231110"
25
+ REVISION = "20231130"
26
26
  end
27
27
  end
28
28
  end
@@ -130,6 +130,18 @@ module Google
130
130
  include Google::Apis::Core::JsonObjectSupport
131
131
  end
132
132
 
133
+ class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata
134
+ class Representation < Google::Apis::Core::JsonRepresentation; end
135
+
136
+ include Google::Apis::Core::JsonObjectSupport
137
+ end
138
+
139
+ class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
140
+ class Representation < Google::Apis::Core::JsonRepresentation; end
141
+
142
+ include Google::Apis::Core::JsonObjectSupport
143
+ end
144
+
133
145
  class GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata
134
146
  class Representation < Google::Apis::Core::JsonRepresentation; end
135
147
 
@@ -148,6 +160,12 @@ module Google
148
160
  include Google::Apis::Core::JsonObjectSupport
149
161
  end
150
162
 
163
+ class GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata
164
+ class Representation < Google::Apis::Core::JsonRepresentation; end
165
+
166
+ include Google::Apis::Core::JsonObjectSupport
167
+ end
168
+
151
169
  class GoogleCloudDiscoveryengineV1alphaDataStore
152
170
  class Representation < Google::Apis::Core::JsonRepresentation; end
153
171
 
@@ -172,6 +190,36 @@ module Google
172
190
  include Google::Apis::Core::JsonObjectSupport
173
191
  end
174
192
 
193
+ class GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata
194
+ class Representation < Google::Apis::Core::JsonRepresentation; end
195
+
196
+ include Google::Apis::Core::JsonObjectSupport
197
+ end
198
+
199
+ class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata
200
+ class Representation < Google::Apis::Core::JsonRepresentation; end
201
+
202
+ include Google::Apis::Core::JsonObjectSupport
203
+ end
204
+
205
+ class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse
206
+ class Representation < Google::Apis::Core::JsonRepresentation; end
207
+
208
+ include Google::Apis::Core::JsonObjectSupport
209
+ end
210
+
211
+ class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata
212
+ class Representation < Google::Apis::Core::JsonRepresentation; end
213
+
214
+ include Google::Apis::Core::JsonObjectSupport
215
+ end
216
+
217
+ class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse
218
+ class Representation < Google::Apis::Core::JsonRepresentation; end
219
+
220
+ include Google::Apis::Core::JsonObjectSupport
221
+ end
222
+
175
223
  class GoogleCloudDiscoveryengineV1alphaEngine
176
224
  class Representation < Google::Apis::Core::JsonRepresentation; end
177
225
 
@@ -364,6 +412,12 @@ module Google
364
412
  include Google::Apis::Core::JsonObjectSupport
365
413
  end
366
414
 
415
+ class GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata
416
+ class Representation < Google::Apis::Core::JsonRepresentation; end
417
+
418
+ include Google::Apis::Core::JsonObjectSupport
419
+ end
420
+
367
421
  class GoogleCloudDiscoveryengineV1betaBigQuerySource
368
422
  class Representation < Google::Apis::Core::JsonRepresentation; end
369
423
 
@@ -664,6 +718,12 @@ module Google
664
718
  include Google::Apis::Core::JsonObjectSupport
665
719
  end
666
720
 
721
+ class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec
722
+ class Representation < Google::Apis::Core::JsonRepresentation; end
723
+
724
+ include Google::Apis::Core::JsonObjectSupport
725
+ end
726
+
667
727
  class GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec
668
728
  class Representation < Google::Apis::Core::JsonRepresentation; end
669
729
 
@@ -994,6 +1054,22 @@ module Google
994
1054
  end
995
1055
  end
996
1056
 
1057
+ class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata
1058
+ # @private
1059
+ class Representation < Google::Apis::Core::JsonRepresentation
1060
+ property :create_time, as: 'createTime'
1061
+ property :update_time, as: 'updateTime'
1062
+ end
1063
+ end
1064
+
1065
+ class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
1066
+ # @private
1067
+ class Representation < Google::Apis::Core::JsonRepresentation
1068
+ collection :target_sites, as: 'targetSites', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaTargetSite, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
1069
+
1070
+ end
1071
+ end
1072
+
997
1073
  class GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata
998
1074
  # @private
999
1075
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1018,6 +1094,14 @@ module Google
1018
1094
  end
1019
1095
  end
1020
1096
 
1097
+ class GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata
1098
+ # @private
1099
+ class Representation < Google::Apis::Core::JsonRepresentation
1100
+ property :create_time, as: 'createTime'
1101
+ property :update_time, as: 'updateTime'
1102
+ end
1103
+ end
1104
+
1021
1105
  class GoogleCloudDiscoveryengineV1alphaDataStore
1022
1106
  # @private
1023
1107
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1055,6 +1139,42 @@ module Google
1055
1139
  end
1056
1140
  end
1057
1141
 
1142
+ class GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata
1143
+ # @private
1144
+ class Representation < Google::Apis::Core::JsonRepresentation
1145
+ property :create_time, as: 'createTime'
1146
+ property :update_time, as: 'updateTime'
1147
+ end
1148
+ end
1149
+
1150
+ class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata
1151
+ # @private
1152
+ class Representation < Google::Apis::Core::JsonRepresentation
1153
+ property :create_time, as: 'createTime'
1154
+ property :update_time, as: 'updateTime'
1155
+ end
1156
+ end
1157
+
1158
+ class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse
1159
+ # @private
1160
+ class Representation < Google::Apis::Core::JsonRepresentation
1161
+ end
1162
+ end
1163
+
1164
+ class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata
1165
+ # @private
1166
+ class Representation < Google::Apis::Core::JsonRepresentation
1167
+ property :create_time, as: 'createTime'
1168
+ property :update_time, as: 'updateTime'
1169
+ end
1170
+ end
1171
+
1172
+ class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse
1173
+ # @private
1174
+ class Representation < Google::Apis::Core::JsonRepresentation
1175
+ end
1176
+ end
1177
+
1058
1178
  class GoogleCloudDiscoveryengineV1alphaEngine
1059
1179
  # @private
1060
1180
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1366,6 +1486,14 @@ module Google
1366
1486
  end
1367
1487
  end
1368
1488
 
1489
+ class GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata
1490
+ # @private
1491
+ class Representation < Google::Apis::Core::JsonRepresentation
1492
+ property :create_time, as: 'createTime'
1493
+ property :update_time, as: 'updateTime'
1494
+ end
1495
+ end
1496
+
1369
1497
  class GoogleCloudDiscoveryengineV1betaBigQuerySource
1370
1498
  # @private
1371
1499
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1887,10 +2015,19 @@ module Google
1887
2015
  property :ignore_non_summary_seeking_query, as: 'ignoreNonSummarySeekingQuery'
1888
2016
  property :include_citations, as: 'includeCitations'
1889
2017
  property :language_code, as: 'languageCode'
2018
+ property :model_spec, as: 'modelSpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec::Representation
2019
+
1890
2020
  property :summary_result_count, as: 'summaryResultCount'
1891
2021
  end
1892
2022
  end
1893
2023
 
2024
+ class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec
2025
+ # @private
2026
+ class Representation < Google::Apis::Core::JsonRepresentation
2027
+ property :version, as: 'version'
2028
+ end
2029
+ end
2030
+
1894
2031
  class GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec
1895
2032
  # @private
1896
2033
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -720,7 +720,8 @@ module Google
720
720
  # Conversation to update does not exist, a NOT_FOUND error is returned.
721
721
  # @param [String] name
722
722
  # Immutable. Fully qualified name `project/*/locations/global/collections/`
723
- # collection`/dataStore/*/conversations/*`
723
+ # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
724
+ # collections/`collection`/engines/*/conversations/*`.
724
725
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
725
726
  # @param [String] update_mask
726
727
  # Indicates which fields in the provided Conversation to update. The following
@@ -1496,6 +1497,234 @@ module Google
1496
1497
  execute_or_queue_command(command, &block)
1497
1498
  end
1498
1499
 
1500
+ # Converses a conversation.
1501
+ # @param [String] name
1502
+ # Required. The resource name of the Conversation to get. Format: `projects/`
1503
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
1504
+ # data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
1505
+ # /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
1506
+ # conversations/-` to activate auto session mode, which automatically creates a
1507
+ # new conversation inside a ConverseConversation session.
1508
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationRequest] google_cloud_discoveryengine_v1beta_converse_conversation_request_object
1509
+ # @param [String] fields
1510
+ # Selector specifying which fields to include in a partial response.
1511
+ # @param [String] quota_user
1512
+ # Available to use for quota purposes for server-side applications. Can be any
1513
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1514
+ # @param [Google::Apis::RequestOptions] options
1515
+ # Request-specific options
1516
+ #
1517
+ # @yield [result, err] Result & error if block supplied
1518
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse] parsed result object
1519
+ # @yieldparam err [StandardError] error object if request failed
1520
+ #
1521
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse]
1522
+ #
1523
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1524
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1525
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1526
+ def converse_project_location_collection_engine_conversation(name, google_cloud_discoveryengine_v1beta_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1527
+ command = make_simple_command(:post, 'v1beta/{+name}:converse', options)
1528
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationRequest::Representation
1529
+ command.request_object = google_cloud_discoveryengine_v1beta_converse_conversation_request_object
1530
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse::Representation
1531
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConverseConversationResponse
1532
+ command.params['name'] = name unless name.nil?
1533
+ command.query['fields'] = fields unless fields.nil?
1534
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1535
+ execute_or_queue_command(command, &block)
1536
+ end
1537
+
1538
+ # Creates a Conversation. If the Conversation to create already exists, an
1539
+ # ALREADY_EXISTS error is returned.
1540
+ # @param [String] parent
1541
+ # Required. Full resource name of parent data store. Format: `projects/`
1542
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
1543
+ # data_store_id``
1544
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
1545
+ # @param [String] fields
1546
+ # Selector specifying which fields to include in a partial response.
1547
+ # @param [String] quota_user
1548
+ # Available to use for quota purposes for server-side applications. Can be any
1549
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1550
+ # @param [Google::Apis::RequestOptions] options
1551
+ # Request-specific options
1552
+ #
1553
+ # @yield [result, err] Result & error if block supplied
1554
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
1555
+ # @yieldparam err [StandardError] error object if request failed
1556
+ #
1557
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
1558
+ #
1559
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1560
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1561
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1562
+ def create_project_location_collection_engine_conversation(parent, google_cloud_discoveryengine_v1beta_conversation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1563
+ command = make_simple_command(:post, 'v1beta/{+parent}/conversations', options)
1564
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
1565
+ command.request_object = google_cloud_discoveryengine_v1beta_conversation_object
1566
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
1567
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
1568
+ command.params['parent'] = parent unless parent.nil?
1569
+ command.query['fields'] = fields unless fields.nil?
1570
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1571
+ execute_or_queue_command(command, &block)
1572
+ end
1573
+
1574
+ # Deletes a Conversation. If the Conversation to delete does not exist, a
1575
+ # NOT_FOUND error is returned.
1576
+ # @param [String] name
1577
+ # Required. The resource name of the Conversation to delete. Format: `projects/`
1578
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
1579
+ # data_store_id`/conversations/`conversation_id``
1580
+ # @param [String] fields
1581
+ # Selector specifying which fields to include in a partial response.
1582
+ # @param [String] quota_user
1583
+ # Available to use for quota purposes for server-side applications. Can be any
1584
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1585
+ # @param [Google::Apis::RequestOptions] options
1586
+ # Request-specific options
1587
+ #
1588
+ # @yield [result, err] Result & error if block supplied
1589
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
1590
+ # @yieldparam err [StandardError] error object if request failed
1591
+ #
1592
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
1593
+ #
1594
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1595
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1596
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1597
+ def delete_project_location_collection_engine_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
1598
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
1599
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
1600
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
1601
+ command.params['name'] = name unless name.nil?
1602
+ command.query['fields'] = fields unless fields.nil?
1603
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1604
+ execute_or_queue_command(command, &block)
1605
+ end
1606
+
1607
+ # Gets a Conversation.
1608
+ # @param [String] name
1609
+ # Required. The resource name of the Conversation to get. Format: `projects/`
1610
+ # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
1611
+ # data_store_id`/conversations/`conversation_id``
1612
+ # @param [String] fields
1613
+ # Selector specifying which fields to include in a partial response.
1614
+ # @param [String] quota_user
1615
+ # Available to use for quota purposes for server-side applications. Can be any
1616
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1617
+ # @param [Google::Apis::RequestOptions] options
1618
+ # Request-specific options
1619
+ #
1620
+ # @yield [result, err] Result & error if block supplied
1621
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
1622
+ # @yieldparam err [StandardError] error object if request failed
1623
+ #
1624
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
1625
+ #
1626
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1627
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1628
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1629
+ def get_project_location_collection_engine_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
1630
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
1631
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
1632
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
1633
+ command.params['name'] = name unless name.nil?
1634
+ command.query['fields'] = fields unless fields.nil?
1635
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1636
+ execute_or_queue_command(command, &block)
1637
+ end
1638
+
1639
+ # Lists all Conversations by their parent DataStore.
1640
+ # @param [String] parent
1641
+ # Required. The data store resource name. Format: `projects/`project_number`/
1642
+ # locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
1643
+ # @param [String] filter
1644
+ # A filter to apply on the list results. The supported features are:
1645
+ # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
1646
+ # @param [String] order_by
1647
+ # A comma-separated list of fields to order by, sorted in ascending order. Use "
1648
+ # desc" after a field name for descending. Supported fields: * `update_time` * `
1649
+ # create_time` * `conversation_name` Example: "update_time desc" "create_time"
1650
+ # @param [Fixnum] page_size
1651
+ # Maximum number of results to return. If unspecified, defaults to 50. Max
1652
+ # allowed value is 1000.
1653
+ # @param [String] page_token
1654
+ # A page token, received from a previous `ListConversations` call. Provide this
1655
+ # to retrieve the subsequent page.
1656
+ # @param [String] fields
1657
+ # Selector specifying which fields to include in a partial response.
1658
+ # @param [String] quota_user
1659
+ # Available to use for quota purposes for server-side applications. Can be any
1660
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1661
+ # @param [Google::Apis::RequestOptions] options
1662
+ # Request-specific options
1663
+ #
1664
+ # @yield [result, err] Result & error if block supplied
1665
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse] parsed result object
1666
+ # @yieldparam err [StandardError] error object if request failed
1667
+ #
1668
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse]
1669
+ #
1670
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1671
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1672
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1673
+ def list_project_location_collection_engine_conversations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1674
+ command = make_simple_command(:get, 'v1beta/{+parent}/conversations', options)
1675
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse::Representation
1676
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListConversationsResponse
1677
+ command.params['parent'] = parent unless parent.nil?
1678
+ command.query['filter'] = filter unless filter.nil?
1679
+ command.query['orderBy'] = order_by unless order_by.nil?
1680
+ command.query['pageSize'] = page_size unless page_size.nil?
1681
+ command.query['pageToken'] = page_token unless page_token.nil?
1682
+ command.query['fields'] = fields unless fields.nil?
1683
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1684
+ execute_or_queue_command(command, &block)
1685
+ end
1686
+
1687
+ # Updates a Conversation. Conversation action type cannot be changed. If the
1688
+ # Conversation to update does not exist, a NOT_FOUND error is returned.
1689
+ # @param [String] name
1690
+ # Immutable. Fully qualified name `project/*/locations/global/collections/`
1691
+ # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
1692
+ # collections/`collection`/engines/*/conversations/*`.
1693
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
1694
+ # @param [String] update_mask
1695
+ # Indicates which fields in the provided Conversation to update. The following
1696
+ # are NOT supported: * conversation.name If not set or empty, all supported
1697
+ # fields are updated.
1698
+ # @param [String] fields
1699
+ # Selector specifying which fields to include in a partial response.
1700
+ # @param [String] quota_user
1701
+ # Available to use for quota purposes for server-side applications. Can be any
1702
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1703
+ # @param [Google::Apis::RequestOptions] options
1704
+ # Request-specific options
1705
+ #
1706
+ # @yield [result, err] Result & error if block supplied
1707
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] parsed result object
1708
+ # @yieldparam err [StandardError] error object if request failed
1709
+ #
1710
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
1711
+ #
1712
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1713
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1714
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1715
+ def patch_project_location_collection_engine_conversation(name, google_cloud_discoveryengine_v1beta_conversation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1716
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
1717
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
1718
+ command.request_object = google_cloud_discoveryengine_v1beta_conversation_object
1719
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation::Representation
1720
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation
1721
+ command.params['name'] = name unless name.nil?
1722
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1723
+ command.query['fields'] = fields unless fields.nil?
1724
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1725
+ execute_or_queue_command(command, &block)
1726
+ end
1727
+
1499
1728
  # Gets the latest state of a long-running operation. Clients can use this method
1500
1729
  # to poll the operation result at intervals as recommended by the API service.
1501
1730
  # @param [String] name
@@ -2316,7 +2545,8 @@ module Google
2316
2545
  # Conversation to update does not exist, a NOT_FOUND error is returned.
2317
2546
  # @param [String] name
2318
2547
  # Immutable. Fully qualified name `project/*/locations/global/collections/`
2319
- # collection`/dataStore/*/conversations/*`
2548
+ # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
2549
+ # collections/`collection`/engines/*/conversations/*`.
2320
2550
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation] google_cloud_discoveryengine_v1beta_conversation_object
2321
2551
  # @param [String] update_mask
2322
2552
  # Indicates which fields in the provided Conversation to update. The following
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.28.0
4
+ version: 0.29.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-11-19 00:00:00.000000000 Z
11
+ date: 2023-12-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -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-discoveryengine_v1beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.28.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.29.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
63
63
  post_install_message:
64
64
  rdoc_options: []