google-apis-discoveryengine_v1alpha 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: 93e7fbde1650e01e4ec7c2d189af03d7fad06162c86f9b02115e2f359b97a7cb
4
- data.tar.gz: 45fec082dd8087b5140581b0efedd56e54cdaa4f6b8c7b792b1fc18c55380881
3
+ metadata.gz: 2adfc46570652a4e45febdabbc3bb6944df0eb93e6a2a73863e484a5899353c6
4
+ data.tar.gz: e4a5dd49b4921af29ef33c6d7d7fb15cef7089799c4e9bc2e29be563d86985c5
5
5
  SHA512:
6
- metadata.gz: b700adf161cf5a47b2d9943bc7f423915e54d44247d8ad23785db7121aa6fcffb49a9fa72e42c19fc4f19db25daedd4462a52fa096777ea98ccbc2fb40cc21ee
7
- data.tar.gz: f2aead65d4df0a71b408fdeb8e79e7fe1a3e6e4112cdcbf8040da632828e97cb4d304c67be0ee6f163b2b45fe80dc429fb0432cd171cbe3745d6696a3af460fd
6
+ metadata.gz: 1b825af8c6cef4c28d96f06b7fc0f6d445036cd33f2bf48b7e570d472f85ab69733c0a1c420aad4804caa94f38eaf0598062ee36232d419018e528b1d9d4b715
7
+ data.tar.gz: 5b2f498ff5b9028c7ab3a0ea4f3e22155c4cc3c7ff32f03a25d29fed970dc369b36f46ed238885cb97d5c8d75c71cae5debc4a25340a0d7ca549883423f49aa3
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-discoveryengine_v1alpha
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
@@ -642,6 +642,86 @@ module Google
642
642
  end
643
643
  end
644
644
 
645
+ # Metadata related to the progress of the SiteSearchEngineService.
646
+ # BatchCreateTargetSite operation. This will be returned by the google.
647
+ # longrunning.Operation.metadata field.
648
+ class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata
649
+ include Google::Apis::Core::Hashable
650
+
651
+ # Operation create time.
652
+ # Corresponds to the JSON property `createTime`
653
+ # @return [String]
654
+ attr_accessor :create_time
655
+
656
+ # Operation last update time. If the operation is done, this is also the finish
657
+ # time.
658
+ # Corresponds to the JSON property `updateTime`
659
+ # @return [String]
660
+ attr_accessor :update_time
661
+
662
+ def initialize(**args)
663
+ update!(**args)
664
+ end
665
+
666
+ # Update properties of this object
667
+ def update!(**args)
668
+ @create_time = args[:create_time] if args.key?(:create_time)
669
+ @update_time = args[:update_time] if args.key?(:update_time)
670
+ end
671
+ end
672
+
673
+ # Request message for SiteSearchEngineService.s method.
674
+ class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest
675
+ include Google::Apis::Core::Hashable
676
+
677
+ # Required. The request message specifying the resources to create. A maximum of
678
+ # 20 TargetSites can be created in a batch.
679
+ # Corresponds to the JSON property `requests`
680
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest>]
681
+ attr_accessor :requests
682
+
683
+ def initialize(**args)
684
+ update!(**args)
685
+ end
686
+
687
+ # Update properties of this object
688
+ def update!(**args)
689
+ @requests = args[:requests] if args.key?(:requests)
690
+ end
691
+ end
692
+
693
+ # Response message for SiteSearchEngineService.BatchCreateTargetSites method.
694
+ class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
695
+ include Google::Apis::Core::Hashable
696
+
697
+ # TargetSites created.
698
+ # Corresponds to the JSON property `targetSites`
699
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite>]
700
+ attr_accessor :target_sites
701
+
702
+ def initialize(**args)
703
+ update!(**args)
704
+ end
705
+
706
+ # Update properties of this object
707
+ def update!(**args)
708
+ @target_sites = args[:target_sites] if args.key?(:target_sites)
709
+ end
710
+ end
711
+
712
+ # Request message for SiteSearchEngineService.BatchVerifyTargetSites method.
713
+ class GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest
714
+ include Google::Apis::Core::Hashable
715
+
716
+ def initialize(**args)
717
+ update!(**args)
718
+ end
719
+
720
+ # Update properties of this object
721
+ def update!(**args)
722
+ end
723
+ end
724
+
645
725
  # BigQuery source import data from.
646
726
  class GoogleCloudDiscoveryengineV1alphaBigQuerySource
647
727
  include Google::Apis::Core::Hashable
@@ -872,7 +952,8 @@ module Google
872
952
  attr_accessor :messages
873
953
 
874
954
  # Immutable. Fully qualified name `project/*/locations/global/collections/`
875
- # collection`/dataStore/*/conversations/*`
955
+ # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
956
+ # collections/`collection`/engines/*/conversations/*`.
876
957
  # Corresponds to the JSON property `name`
877
958
  # @return [String]
878
959
  attr_accessor :name
@@ -1157,6 +1238,61 @@ module Google
1157
1238
  end
1158
1239
  end
1159
1240
 
1241
+ # Metadata related to the progress of the SiteSearchEngineService.
1242
+ # CreateTargetSite operation. This will be returned by the google.longrunning.
1243
+ # Operation.metadata field.
1244
+ class GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata
1245
+ include Google::Apis::Core::Hashable
1246
+
1247
+ # Operation create time.
1248
+ # Corresponds to the JSON property `createTime`
1249
+ # @return [String]
1250
+ attr_accessor :create_time
1251
+
1252
+ # Operation last update time. If the operation is done, this is also the finish
1253
+ # time.
1254
+ # Corresponds to the JSON property `updateTime`
1255
+ # @return [String]
1256
+ attr_accessor :update_time
1257
+
1258
+ def initialize(**args)
1259
+ update!(**args)
1260
+ end
1261
+
1262
+ # Update properties of this object
1263
+ def update!(**args)
1264
+ @create_time = args[:create_time] if args.key?(:create_time)
1265
+ @update_time = args[:update_time] if args.key?(:update_time)
1266
+ end
1267
+ end
1268
+
1269
+ # Request message for SiteSearchEngineService.CreateTargetSite method.
1270
+ class GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest
1271
+ include Google::Apis::Core::Hashable
1272
+
1273
+ # Required. Parent resource name of TargetSite, such as `projects/`project`/
1274
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/
1275
+ # siteSearchEngine`.
1276
+ # Corresponds to the JSON property `parent`
1277
+ # @return [String]
1278
+ attr_accessor :parent
1279
+
1280
+ # A target site for the SiteSearchEngine.
1281
+ # Corresponds to the JSON property `targetSite`
1282
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite]
1283
+ attr_accessor :target_site
1284
+
1285
+ def initialize(**args)
1286
+ update!(**args)
1287
+ end
1288
+
1289
+ # Update properties of this object
1290
+ def update!(**args)
1291
+ @parent = args[:parent] if args.key?(:parent)
1292
+ @target_site = args[:target_site] if args.key?(:target_site)
1293
+ end
1294
+ end
1295
+
1160
1296
  # A custom attribute that is not explicitly modeled in a resource, e.g.
1161
1297
  # UserEvent.
1162
1298
  class GoogleCloudDiscoveryengineV1alphaCustomAttribute
@@ -1335,6 +1471,88 @@ module Google
1335
1471
  end
1336
1472
  end
1337
1473
 
1474
+ # Metadata related to the progress of the SiteSearchEngineService.
1475
+ # DeleteTargetSite operation. This will be returned by the google.longrunning.
1476
+ # Operation.metadata field.
1477
+ class GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata
1478
+ include Google::Apis::Core::Hashable
1479
+
1480
+ # Operation create time.
1481
+ # Corresponds to the JSON property `createTime`
1482
+ # @return [String]
1483
+ attr_accessor :create_time
1484
+
1485
+ # Operation last update time. If the operation is done, this is also the finish
1486
+ # time.
1487
+ # Corresponds to the JSON property `updateTime`
1488
+ # @return [String]
1489
+ attr_accessor :update_time
1490
+
1491
+ def initialize(**args)
1492
+ update!(**args)
1493
+ end
1494
+
1495
+ # Update properties of this object
1496
+ def update!(**args)
1497
+ @create_time = args[:create_time] if args.key?(:create_time)
1498
+ @update_time = args[:update_time] if args.key?(:update_time)
1499
+ end
1500
+ end
1501
+
1502
+ # Metadata related to the progress of the SiteSearchEngineService.
1503
+ # DisableAdvancedSiteSearch operation. This will be returned by the google.
1504
+ # longrunning.Operation.metadata field.
1505
+ class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata
1506
+ include Google::Apis::Core::Hashable
1507
+
1508
+ # Operation create time.
1509
+ # Corresponds to the JSON property `createTime`
1510
+ # @return [String]
1511
+ attr_accessor :create_time
1512
+
1513
+ # Operation last update time. If the operation is done, this is also the finish
1514
+ # time.
1515
+ # Corresponds to the JSON property `updateTime`
1516
+ # @return [String]
1517
+ attr_accessor :update_time
1518
+
1519
+ def initialize(**args)
1520
+ update!(**args)
1521
+ end
1522
+
1523
+ # Update properties of this object
1524
+ def update!(**args)
1525
+ @create_time = args[:create_time] if args.key?(:create_time)
1526
+ @update_time = args[:update_time] if args.key?(:update_time)
1527
+ end
1528
+ end
1529
+
1530
+ # Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
1531
+ class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest
1532
+ include Google::Apis::Core::Hashable
1533
+
1534
+ def initialize(**args)
1535
+ update!(**args)
1536
+ end
1537
+
1538
+ # Update properties of this object
1539
+ def update!(**args)
1540
+ end
1541
+ end
1542
+
1543
+ # Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
1544
+ class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse
1545
+ include Google::Apis::Core::Hashable
1546
+
1547
+ def initialize(**args)
1548
+ update!(**args)
1549
+ end
1550
+
1551
+ # Update properties of this object
1552
+ def update!(**args)
1553
+ end
1554
+ end
1555
+
1338
1556
  # Document captures all raw metadata information of items to be recommended or
1339
1557
  # searched.
1340
1558
  class GoogleCloudDiscoveryengineV1alphaDocument
@@ -1518,6 +1736,60 @@ module Google
1518
1736
  end
1519
1737
  end
1520
1738
 
1739
+ # Metadata related to the progress of the SiteSearchEngineService.
1740
+ # EnableAdvancedSiteSearch operation. This will be returned by the google.
1741
+ # longrunning.Operation.metadata field.
1742
+ class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata
1743
+ include Google::Apis::Core::Hashable
1744
+
1745
+ # Operation create time.
1746
+ # Corresponds to the JSON property `createTime`
1747
+ # @return [String]
1748
+ attr_accessor :create_time
1749
+
1750
+ # Operation last update time. If the operation is done, this is also the finish
1751
+ # time.
1752
+ # Corresponds to the JSON property `updateTime`
1753
+ # @return [String]
1754
+ attr_accessor :update_time
1755
+
1756
+ def initialize(**args)
1757
+ update!(**args)
1758
+ end
1759
+
1760
+ # Update properties of this object
1761
+ def update!(**args)
1762
+ @create_time = args[:create_time] if args.key?(:create_time)
1763
+ @update_time = args[:update_time] if args.key?(:update_time)
1764
+ end
1765
+ end
1766
+
1767
+ # Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
1768
+ class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest
1769
+ include Google::Apis::Core::Hashable
1770
+
1771
+ def initialize(**args)
1772
+ update!(**args)
1773
+ end
1774
+
1775
+ # Update properties of this object
1776
+ def update!(**args)
1777
+ end
1778
+ end
1779
+
1780
+ # Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
1781
+ class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse
1782
+ include Google::Apis::Core::Hashable
1783
+
1784
+ def initialize(**args)
1785
+ update!(**args)
1786
+ end
1787
+
1788
+ # Update properties of this object
1789
+ def update!(**args)
1790
+ end
1791
+ end
1792
+
1521
1793
  # Metadata that describes the training and serving parameters of an Engine.
1522
1794
  class GoogleCloudDiscoveryengineV1alphaEngine
1523
1795
  include Google::Apis::Core::Hashable
@@ -1905,6 +2177,40 @@ module Google
1905
2177
  end
1906
2178
  end
1907
2179
 
2180
+ # Response message for SiteSearchEngineService.FetchDomainVerificationStatus
2181
+ # method.
2182
+ class GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse
2183
+ include Google::Apis::Core::Hashable
2184
+
2185
+ # A token that can be sent as `page_token` to retrieve the next page. If this
2186
+ # field is omitted, there are no subsequent pages.
2187
+ # Corresponds to the JSON property `nextPageToken`
2188
+ # @return [String]
2189
+ attr_accessor :next_page_token
2190
+
2191
+ # List of TargetSites containing the site verification status.
2192
+ # Corresponds to the JSON property `targetSites`
2193
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite>]
2194
+ attr_accessor :target_sites
2195
+
2196
+ # The total number of items matching the request. This will always be populated
2197
+ # in the response.
2198
+ # Corresponds to the JSON property `totalSize`
2199
+ # @return [Fixnum]
2200
+ attr_accessor :total_size
2201
+
2202
+ def initialize(**args)
2203
+ update!(**args)
2204
+ end
2205
+
2206
+ # Update properties of this object
2207
+ def update!(**args)
2208
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2209
+ @target_sites = args[:target_sites] if args.key?(:target_sites)
2210
+ @total_size = args[:total_size] if args.key?(:total_size)
2211
+ end
2212
+ end
2213
+
1908
2214
  # Configurations for fields of a schema. For example, configuring a field is
1909
2215
  # indexable, or searchable.
1910
2216
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
@@ -2546,6 +2852,39 @@ module Google
2546
2852
  end
2547
2853
  end
2548
2854
 
2855
+ # Response message for SiteSearchEngineService.ListTargetSites method.
2856
+ class GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse
2857
+ include Google::Apis::Core::Hashable
2858
+
2859
+ # A token that can be sent as `page_token` to retrieve the next page. If this
2860
+ # field is omitted, there are no subsequent pages.
2861
+ # Corresponds to the JSON property `nextPageToken`
2862
+ # @return [String]
2863
+ attr_accessor :next_page_token
2864
+
2865
+ # List of TargetSites.
2866
+ # Corresponds to the JSON property `targetSites`
2867
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite>]
2868
+ attr_accessor :target_sites
2869
+
2870
+ # The total number of items matching the request. This will always be populated
2871
+ # in the response.
2872
+ # Corresponds to the JSON property `totalSize`
2873
+ # @return [Fixnum]
2874
+ attr_accessor :total_size
2875
+
2876
+ def initialize(**args)
2877
+ update!(**args)
2878
+ end
2879
+
2880
+ # Update properties of this object
2881
+ def update!(**args)
2882
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2883
+ @target_sites = args[:target_sites] if args.key?(:target_sites)
2884
+ @total_size = args[:total_size] if args.key?(:total_size)
2885
+ end
2886
+ end
2887
+
2549
2888
  # Request message for WidgetService.LookupWidgetConfig method.
2550
2889
  class GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest
2551
2890
  include Google::Apis::Core::Hashable
@@ -3862,6 +4201,11 @@ module Google
3862
4201
  # @return [String]
3863
4202
  attr_accessor :language_code
3864
4203
 
4204
+ # Specification of the model.
4205
+ # Corresponds to the JSON property `modelSpec`
4206
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec]
4207
+ attr_accessor :model_spec
4208
+
3865
4209
  # The number of top results to generate the summary from. If the number of
3866
4210
  # results returned is less than `summaryResultCount`, the summary is generated
3867
4211
  # from all of the results. At most five results can be used to generate a
@@ -3880,10 +4224,30 @@ module Google
3880
4224
  @ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
3881
4225
  @include_citations = args[:include_citations] if args.key?(:include_citations)
3882
4226
  @language_code = args[:language_code] if args.key?(:language_code)
4227
+ @model_spec = args[:model_spec] if args.key?(:model_spec)
3883
4228
  @summary_result_count = args[:summary_result_count] if args.key?(:summary_result_count)
3884
4229
  end
3885
4230
  end
3886
4231
 
4232
+ # Specification of the model.
4233
+ class GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec
4234
+ include Google::Apis::Core::Hashable
4235
+
4236
+ # The string format of the model version. e.g. stable, latest, etc.
4237
+ # Corresponds to the JSON property `version`
4238
+ # @return [String]
4239
+ attr_accessor :version
4240
+
4241
+ def initialize(**args)
4242
+ update!(**args)
4243
+ end
4244
+
4245
+ # Update properties of this object
4246
+ def update!(**args)
4247
+ @version = args[:version] if args.key?(:version)
4248
+ end
4249
+ end
4250
+
3887
4251
  # The specification that uses customized query embedding vector to do semantic
3888
4252
  # document retrieval.
3889
4253
  class GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec
@@ -4500,6 +4864,27 @@ module Google
4500
4864
  end
4501
4865
  end
4502
4866
 
4867
+ # SiteSearchEngine captures DataStore level site search persisting
4868
+ # configurations. It is a singleton value per data store.
4869
+ class GoogleCloudDiscoveryengineV1alphaSiteSearchEngine
4870
+ include Google::Apis::Core::Hashable
4871
+
4872
+ # The fully qualified resource name of the site search engine. Format: `projects/
4873
+ # */locations/*/dataStores/*/siteSearchEngine`
4874
+ # Corresponds to the JSON property `name`
4875
+ # @return [String]
4876
+ attr_accessor :name
4877
+
4878
+ def initialize(**args)
4879
+ update!(**args)
4880
+ end
4881
+
4882
+ # Update properties of this object
4883
+ def update!(**args)
4884
+ @name = args[:name] if args.key?(:name)
4885
+ end
4886
+ end
4887
+
4503
4888
  # Verification information for target sites in advanced site search.
4504
4889
  class GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo
4505
4890
  include Google::Apis::Core::Hashable
@@ -4793,6 +5178,34 @@ module Google
4793
5178
  end
4794
5179
  end
4795
5180
 
5181
+ # Metadata related to the progress of the SiteSearchEngineService.
5182
+ # UpdateTargetSite operation. This will be returned by the google.longrunning.
5183
+ # Operation.metadata field.
5184
+ class GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata
5185
+ include Google::Apis::Core::Hashable
5186
+
5187
+ # Operation create time.
5188
+ # Corresponds to the JSON property `createTime`
5189
+ # @return [String]
5190
+ attr_accessor :create_time
5191
+
5192
+ # Operation last update time. If the operation is done, this is also the finish
5193
+ # time.
5194
+ # Corresponds to the JSON property `updateTime`
5195
+ # @return [String]
5196
+ attr_accessor :update_time
5197
+
5198
+ def initialize(**args)
5199
+ update!(**args)
5200
+ end
5201
+
5202
+ # Update properties of this object
5203
+ def update!(**args)
5204
+ @create_time = args[:create_time] if args.key?(:create_time)
5205
+ @update_time = args[:update_time] if args.key?(:update_time)
5206
+ end
5207
+ end
5208
+
4796
5209
  # UserEvent captures all metadata information Discovery Engine API needs to know
4797
5210
  # about how end users interact with customers' website.
4798
5211
  class GoogleCloudDiscoveryengineV1alphaUserEvent
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DiscoveryengineV1alpha
18
18
  # Version of the google-apis-discoveryengine_v1alpha 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