google-apis-discoveryengine_v1alpha 0.28.0 → 0.30.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/discoveryengine_v1alpha/classes.rb +901 -8
- data/lib/google/apis/discoveryengine_v1alpha/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1alpha/representations.rb +492 -0
- data/lib/google/apis/discoveryengine_v1alpha/service.rb +1142 -114
- metadata +3 -3
@@ -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
|
@@ -974,6 +1055,22 @@ module Google
|
|
974
1055
|
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation]
|
975
1056
|
attr_accessor :conversation
|
976
1057
|
|
1058
|
+
# The filter syntax consists of an expression language for constructing a
|
1059
|
+
# predicate from one or more fields of the documents being filtered. Filter
|
1060
|
+
# expression is case-sensitive. This will be used to filter search results which
|
1061
|
+
# may affect the summary response. If this field is unrecognizable, an `
|
1062
|
+
# INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by
|
1063
|
+
# mapping the LHS filter key to a key property defined in the Vertex AI Search
|
1064
|
+
# backend -- this mapping is defined by the customer in their schema. For
|
1065
|
+
# example a media customer might have a field 'name' in their schema. In this
|
1066
|
+
# case the filter would look like this: filter --> name:'ANY("king kong")' For
|
1067
|
+
# more information about filtering including syntax and filter operators, see [
|
1068
|
+
# Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-
|
1069
|
+
# metadata)
|
1070
|
+
# Corresponds to the JSON property `filter`
|
1071
|
+
# @return [String]
|
1072
|
+
attr_accessor :filter
|
1073
|
+
|
977
1074
|
# Required. The resource name of the Conversation to get. Format: `projects/`
|
978
1075
|
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
979
1076
|
# data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
|
@@ -1030,6 +1127,7 @@ module Google
|
|
1030
1127
|
# Update properties of this object
|
1031
1128
|
def update!(**args)
|
1032
1129
|
@conversation = args[:conversation] if args.key?(:conversation)
|
1130
|
+
@filter = args[:filter] if args.key?(:filter)
|
1033
1131
|
@name = args[:name] if args.key?(:name)
|
1034
1132
|
@query = args[:query] if args.key?(:query)
|
1035
1133
|
@safe_search = args[:safe_search] if args.key?(:safe_search)
|
@@ -1157,6 +1255,61 @@ module Google
|
|
1157
1255
|
end
|
1158
1256
|
end
|
1159
1257
|
|
1258
|
+
# Metadata related to the progress of the SiteSearchEngineService.
|
1259
|
+
# CreateTargetSite operation. This will be returned by the google.longrunning.
|
1260
|
+
# Operation.metadata field.
|
1261
|
+
class GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata
|
1262
|
+
include Google::Apis::Core::Hashable
|
1263
|
+
|
1264
|
+
# Operation create time.
|
1265
|
+
# Corresponds to the JSON property `createTime`
|
1266
|
+
# @return [String]
|
1267
|
+
attr_accessor :create_time
|
1268
|
+
|
1269
|
+
# Operation last update time. If the operation is done, this is also the finish
|
1270
|
+
# time.
|
1271
|
+
# Corresponds to the JSON property `updateTime`
|
1272
|
+
# @return [String]
|
1273
|
+
attr_accessor :update_time
|
1274
|
+
|
1275
|
+
def initialize(**args)
|
1276
|
+
update!(**args)
|
1277
|
+
end
|
1278
|
+
|
1279
|
+
# Update properties of this object
|
1280
|
+
def update!(**args)
|
1281
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1282
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
1283
|
+
end
|
1284
|
+
end
|
1285
|
+
|
1286
|
+
# Request message for SiteSearchEngineService.CreateTargetSite method.
|
1287
|
+
class GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest
|
1288
|
+
include Google::Apis::Core::Hashable
|
1289
|
+
|
1290
|
+
# Required. Parent resource name of TargetSite, such as `projects/`project`/
|
1291
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/
|
1292
|
+
# siteSearchEngine`.
|
1293
|
+
# Corresponds to the JSON property `parent`
|
1294
|
+
# @return [String]
|
1295
|
+
attr_accessor :parent
|
1296
|
+
|
1297
|
+
# A target site for the SiteSearchEngine.
|
1298
|
+
# Corresponds to the JSON property `targetSite`
|
1299
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite]
|
1300
|
+
attr_accessor :target_site
|
1301
|
+
|
1302
|
+
def initialize(**args)
|
1303
|
+
update!(**args)
|
1304
|
+
end
|
1305
|
+
|
1306
|
+
# Update properties of this object
|
1307
|
+
def update!(**args)
|
1308
|
+
@parent = args[:parent] if args.key?(:parent)
|
1309
|
+
@target_site = args[:target_site] if args.key?(:target_site)
|
1310
|
+
end
|
1311
|
+
end
|
1312
|
+
|
1160
1313
|
# A custom attribute that is not explicitly modeled in a resource, e.g.
|
1161
1314
|
# UserEvent.
|
1162
1315
|
class GoogleCloudDiscoveryengineV1alphaCustomAttribute
|
@@ -1335,6 +1488,88 @@ module Google
|
|
1335
1488
|
end
|
1336
1489
|
end
|
1337
1490
|
|
1491
|
+
# Metadata related to the progress of the SiteSearchEngineService.
|
1492
|
+
# DeleteTargetSite operation. This will be returned by the google.longrunning.
|
1493
|
+
# Operation.metadata field.
|
1494
|
+
class GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata
|
1495
|
+
include Google::Apis::Core::Hashable
|
1496
|
+
|
1497
|
+
# Operation create time.
|
1498
|
+
# Corresponds to the JSON property `createTime`
|
1499
|
+
# @return [String]
|
1500
|
+
attr_accessor :create_time
|
1501
|
+
|
1502
|
+
# Operation last update time. If the operation is done, this is also the finish
|
1503
|
+
# time.
|
1504
|
+
# Corresponds to the JSON property `updateTime`
|
1505
|
+
# @return [String]
|
1506
|
+
attr_accessor :update_time
|
1507
|
+
|
1508
|
+
def initialize(**args)
|
1509
|
+
update!(**args)
|
1510
|
+
end
|
1511
|
+
|
1512
|
+
# Update properties of this object
|
1513
|
+
def update!(**args)
|
1514
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1515
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
1516
|
+
end
|
1517
|
+
end
|
1518
|
+
|
1519
|
+
# Metadata related to the progress of the SiteSearchEngineService.
|
1520
|
+
# DisableAdvancedSiteSearch operation. This will be returned by the google.
|
1521
|
+
# longrunning.Operation.metadata field.
|
1522
|
+
class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata
|
1523
|
+
include Google::Apis::Core::Hashable
|
1524
|
+
|
1525
|
+
# Operation create time.
|
1526
|
+
# Corresponds to the JSON property `createTime`
|
1527
|
+
# @return [String]
|
1528
|
+
attr_accessor :create_time
|
1529
|
+
|
1530
|
+
# Operation last update time. If the operation is done, this is also the finish
|
1531
|
+
# time.
|
1532
|
+
# Corresponds to the JSON property `updateTime`
|
1533
|
+
# @return [String]
|
1534
|
+
attr_accessor :update_time
|
1535
|
+
|
1536
|
+
def initialize(**args)
|
1537
|
+
update!(**args)
|
1538
|
+
end
|
1539
|
+
|
1540
|
+
# Update properties of this object
|
1541
|
+
def update!(**args)
|
1542
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1543
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
1544
|
+
end
|
1545
|
+
end
|
1546
|
+
|
1547
|
+
# Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
1548
|
+
class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest
|
1549
|
+
include Google::Apis::Core::Hashable
|
1550
|
+
|
1551
|
+
def initialize(**args)
|
1552
|
+
update!(**args)
|
1553
|
+
end
|
1554
|
+
|
1555
|
+
# Update properties of this object
|
1556
|
+
def update!(**args)
|
1557
|
+
end
|
1558
|
+
end
|
1559
|
+
|
1560
|
+
# Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
|
1561
|
+
class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse
|
1562
|
+
include Google::Apis::Core::Hashable
|
1563
|
+
|
1564
|
+
def initialize(**args)
|
1565
|
+
update!(**args)
|
1566
|
+
end
|
1567
|
+
|
1568
|
+
# Update properties of this object
|
1569
|
+
def update!(**args)
|
1570
|
+
end
|
1571
|
+
end
|
1572
|
+
|
1338
1573
|
# Document captures all raw metadata information of items to be recommended or
|
1339
1574
|
# searched.
|
1340
1575
|
class GoogleCloudDiscoveryengineV1alphaDocument
|
@@ -1518,6 +1753,60 @@ module Google
|
|
1518
1753
|
end
|
1519
1754
|
end
|
1520
1755
|
|
1756
|
+
# Metadata related to the progress of the SiteSearchEngineService.
|
1757
|
+
# EnableAdvancedSiteSearch operation. This will be returned by the google.
|
1758
|
+
# longrunning.Operation.metadata field.
|
1759
|
+
class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata
|
1760
|
+
include Google::Apis::Core::Hashable
|
1761
|
+
|
1762
|
+
# Operation create time.
|
1763
|
+
# Corresponds to the JSON property `createTime`
|
1764
|
+
# @return [String]
|
1765
|
+
attr_accessor :create_time
|
1766
|
+
|
1767
|
+
# Operation last update time. If the operation is done, this is also the finish
|
1768
|
+
# time.
|
1769
|
+
# Corresponds to the JSON property `updateTime`
|
1770
|
+
# @return [String]
|
1771
|
+
attr_accessor :update_time
|
1772
|
+
|
1773
|
+
def initialize(**args)
|
1774
|
+
update!(**args)
|
1775
|
+
end
|
1776
|
+
|
1777
|
+
# Update properties of this object
|
1778
|
+
def update!(**args)
|
1779
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1780
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
1781
|
+
end
|
1782
|
+
end
|
1783
|
+
|
1784
|
+
# Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
1785
|
+
class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest
|
1786
|
+
include Google::Apis::Core::Hashable
|
1787
|
+
|
1788
|
+
def initialize(**args)
|
1789
|
+
update!(**args)
|
1790
|
+
end
|
1791
|
+
|
1792
|
+
# Update properties of this object
|
1793
|
+
def update!(**args)
|
1794
|
+
end
|
1795
|
+
end
|
1796
|
+
|
1797
|
+
# Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
|
1798
|
+
class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse
|
1799
|
+
include Google::Apis::Core::Hashable
|
1800
|
+
|
1801
|
+
def initialize(**args)
|
1802
|
+
update!(**args)
|
1803
|
+
end
|
1804
|
+
|
1805
|
+
# Update properties of this object
|
1806
|
+
def update!(**args)
|
1807
|
+
end
|
1808
|
+
end
|
1809
|
+
|
1521
1810
|
# Metadata that describes the training and serving parameters of an Engine.
|
1522
1811
|
class GoogleCloudDiscoveryengineV1alphaEngine
|
1523
1812
|
include Google::Apis::Core::Hashable
|
@@ -1905,6 +2194,194 @@ module Google
|
|
1905
2194
|
end
|
1906
2195
|
end
|
1907
2196
|
|
2197
|
+
# Metadata related to the progress of the EstimateDataSize operation. This is
|
2198
|
+
# returned by the google.longrunning.Operation.metadata field.
|
2199
|
+
class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata
|
2200
|
+
include Google::Apis::Core::Hashable
|
2201
|
+
|
2202
|
+
# Operation create time.
|
2203
|
+
# Corresponds to the JSON property `createTime`
|
2204
|
+
# @return [String]
|
2205
|
+
attr_accessor :create_time
|
2206
|
+
|
2207
|
+
def initialize(**args)
|
2208
|
+
update!(**args)
|
2209
|
+
end
|
2210
|
+
|
2211
|
+
# Update properties of this object
|
2212
|
+
def update!(**args)
|
2213
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
2214
|
+
end
|
2215
|
+
end
|
2216
|
+
|
2217
|
+
# Request message for EstimateBillingService.EstimateDataSize method
|
2218
|
+
class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest
|
2219
|
+
include Google::Apis::Core::Hashable
|
2220
|
+
|
2221
|
+
# Data source contains files either in GCS or BigQuery.
|
2222
|
+
# Corresponds to the JSON property `fileDataSource`
|
2223
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource]
|
2224
|
+
attr_accessor :file_data_source
|
2225
|
+
|
2226
|
+
# Data source is a set of website patterns that we crawl to get the total number
|
2227
|
+
# of websites.
|
2228
|
+
# Corresponds to the JSON property `websiteDataSource`
|
2229
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource]
|
2230
|
+
attr_accessor :website_data_source
|
2231
|
+
|
2232
|
+
def initialize(**args)
|
2233
|
+
update!(**args)
|
2234
|
+
end
|
2235
|
+
|
2236
|
+
# Update properties of this object
|
2237
|
+
def update!(**args)
|
2238
|
+
@file_data_source = args[:file_data_source] if args.key?(:file_data_source)
|
2239
|
+
@website_data_source = args[:website_data_source] if args.key?(:website_data_source)
|
2240
|
+
end
|
2241
|
+
end
|
2242
|
+
|
2243
|
+
# Data source contains files either in GCS or BigQuery.
|
2244
|
+
class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource
|
2245
|
+
include Google::Apis::Core::Hashable
|
2246
|
+
|
2247
|
+
# BigQuery source import data from.
|
2248
|
+
# Corresponds to the JSON property `bigquerySource`
|
2249
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigQuerySource]
|
2250
|
+
attr_accessor :bigquery_source
|
2251
|
+
|
2252
|
+
# Cloud Storage location for input content.
|
2253
|
+
# Corresponds to the JSON property `gcsSource`
|
2254
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGcsSource]
|
2255
|
+
attr_accessor :gcs_source
|
2256
|
+
|
2257
|
+
def initialize(**args)
|
2258
|
+
update!(**args)
|
2259
|
+
end
|
2260
|
+
|
2261
|
+
# Update properties of this object
|
2262
|
+
def update!(**args)
|
2263
|
+
@bigquery_source = args[:bigquery_source] if args.key?(:bigquery_source)
|
2264
|
+
@gcs_source = args[:gcs_source] if args.key?(:gcs_source)
|
2265
|
+
end
|
2266
|
+
end
|
2267
|
+
|
2268
|
+
# Data source is a set of website patterns that we crawl to get the total number
|
2269
|
+
# of websites.
|
2270
|
+
class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource
|
2271
|
+
include Google::Apis::Core::Hashable
|
2272
|
+
|
2273
|
+
# Required. The URI patterns to estimate the data sizes. At most 10 patterns are
|
2274
|
+
# allowed, otherwise an INVALID_ARGUMENT error is thrown.
|
2275
|
+
# Corresponds to the JSON property `estimatorUriPatterns`
|
2276
|
+
# @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern>]
|
2277
|
+
attr_accessor :estimator_uri_patterns
|
2278
|
+
|
2279
|
+
def initialize(**args)
|
2280
|
+
update!(**args)
|
2281
|
+
end
|
2282
|
+
|
2283
|
+
# Update properties of this object
|
2284
|
+
def update!(**args)
|
2285
|
+
@estimator_uri_patterns = args[:estimator_uri_patterns] if args.key?(:estimator_uri_patterns)
|
2286
|
+
end
|
2287
|
+
end
|
2288
|
+
|
2289
|
+
# URI patterns that we use to crawl.
|
2290
|
+
class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern
|
2291
|
+
include Google::Apis::Core::Hashable
|
2292
|
+
|
2293
|
+
# Whether we infer the generated URI or use the exact provided one.
|
2294
|
+
# Corresponds to the JSON property `exactMatch`
|
2295
|
+
# @return [Boolean]
|
2296
|
+
attr_accessor :exact_match
|
2297
|
+
alias_method :exact_match?, :exact_match
|
2298
|
+
|
2299
|
+
# Whether the pattern is exclusive or not. If set to true, the pattern is
|
2300
|
+
# considered exclusive. If unset or set to false, the pattern is considered
|
2301
|
+
# inclusive by default.
|
2302
|
+
# Corresponds to the JSON property `exclusive`
|
2303
|
+
# @return [Boolean]
|
2304
|
+
attr_accessor :exclusive
|
2305
|
+
alias_method :exclusive?, :exclusive
|
2306
|
+
|
2307
|
+
# User provided URI pattern. For example, `foo.com/bar/*`.
|
2308
|
+
# Corresponds to the JSON property `providedUriPattern`
|
2309
|
+
# @return [String]
|
2310
|
+
attr_accessor :provided_uri_pattern
|
2311
|
+
|
2312
|
+
def initialize(**args)
|
2313
|
+
update!(**args)
|
2314
|
+
end
|
2315
|
+
|
2316
|
+
# Update properties of this object
|
2317
|
+
def update!(**args)
|
2318
|
+
@exact_match = args[:exact_match] if args.key?(:exact_match)
|
2319
|
+
@exclusive = args[:exclusive] if args.key?(:exclusive)
|
2320
|
+
@provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
|
2321
|
+
end
|
2322
|
+
end
|
2323
|
+
|
2324
|
+
# Response of the EstimateDataSize request. If the long running operation was
|
2325
|
+
# successful, then this message is returned by the google.longrunning.Operations.
|
2326
|
+
# response field if the operation was successful.
|
2327
|
+
class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse
|
2328
|
+
include Google::Apis::Core::Hashable
|
2329
|
+
|
2330
|
+
# Data size in terms of bytes.
|
2331
|
+
# Corresponds to the JSON property `dataSizeBytes`
|
2332
|
+
# @return [Fixnum]
|
2333
|
+
attr_accessor :data_size_bytes
|
2334
|
+
|
2335
|
+
# Total number of documents.
|
2336
|
+
# Corresponds to the JSON property `documentCount`
|
2337
|
+
# @return [Fixnum]
|
2338
|
+
attr_accessor :document_count
|
2339
|
+
|
2340
|
+
def initialize(**args)
|
2341
|
+
update!(**args)
|
2342
|
+
end
|
2343
|
+
|
2344
|
+
# Update properties of this object
|
2345
|
+
def update!(**args)
|
2346
|
+
@data_size_bytes = args[:data_size_bytes] if args.key?(:data_size_bytes)
|
2347
|
+
@document_count = args[:document_count] if args.key?(:document_count)
|
2348
|
+
end
|
2349
|
+
end
|
2350
|
+
|
2351
|
+
# Response message for SiteSearchEngineService.FetchDomainVerificationStatus
|
2352
|
+
# method.
|
2353
|
+
class GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse
|
2354
|
+
include Google::Apis::Core::Hashable
|
2355
|
+
|
2356
|
+
# A token that can be sent as `page_token` to retrieve the next page. If this
|
2357
|
+
# field is omitted, there are no subsequent pages.
|
2358
|
+
# Corresponds to the JSON property `nextPageToken`
|
2359
|
+
# @return [String]
|
2360
|
+
attr_accessor :next_page_token
|
2361
|
+
|
2362
|
+
# List of TargetSites containing the site verification status.
|
2363
|
+
# Corresponds to the JSON property `targetSites`
|
2364
|
+
# @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite>]
|
2365
|
+
attr_accessor :target_sites
|
2366
|
+
|
2367
|
+
# The total number of items matching the request. This will always be populated
|
2368
|
+
# in the response.
|
2369
|
+
# Corresponds to the JSON property `totalSize`
|
2370
|
+
# @return [Fixnum]
|
2371
|
+
attr_accessor :total_size
|
2372
|
+
|
2373
|
+
def initialize(**args)
|
2374
|
+
update!(**args)
|
2375
|
+
end
|
2376
|
+
|
2377
|
+
# Update properties of this object
|
2378
|
+
def update!(**args)
|
2379
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
2380
|
+
@target_sites = args[:target_sites] if args.key?(:target_sites)
|
2381
|
+
@total_size = args[:total_size] if args.key?(:total_size)
|
2382
|
+
end
|
2383
|
+
end
|
2384
|
+
|
1908
2385
|
# Configurations for fields of a schema. For example, configuring a field is
|
1909
2386
|
# indexable, or searchable.
|
1910
2387
|
class GoogleCloudDiscoveryengineV1alphaFieldConfig
|
@@ -2524,16 +3001,48 @@ module Google
|
|
2524
3001
|
class GoogleCloudDiscoveryengineV1alphaListSchemasResponse
|
2525
3002
|
include Google::Apis::Core::Hashable
|
2526
3003
|
|
2527
|
-
# A token that can be sent as ListSchemasRequest.page_token to retrieve the next
|
2528
|
-
# page. If this field is omitted, there are no subsequent pages.
|
3004
|
+
# A token that can be sent as ListSchemasRequest.page_token to retrieve the next
|
3005
|
+
# page. If this field is omitted, there are no subsequent pages.
|
3006
|
+
# Corresponds to the JSON property `nextPageToken`
|
3007
|
+
# @return [String]
|
3008
|
+
attr_accessor :next_page_token
|
3009
|
+
|
3010
|
+
# The Schemas.
|
3011
|
+
# Corresponds to the JSON property `schemas`
|
3012
|
+
# @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema>]
|
3013
|
+
attr_accessor :schemas
|
3014
|
+
|
3015
|
+
def initialize(**args)
|
3016
|
+
update!(**args)
|
3017
|
+
end
|
3018
|
+
|
3019
|
+
# Update properties of this object
|
3020
|
+
def update!(**args)
|
3021
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
3022
|
+
@schemas = args[:schemas] if args.key?(:schemas)
|
3023
|
+
end
|
3024
|
+
end
|
3025
|
+
|
3026
|
+
# Response message for SiteSearchEngineService.ListTargetSites method.
|
3027
|
+
class GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse
|
3028
|
+
include Google::Apis::Core::Hashable
|
3029
|
+
|
3030
|
+
# A token that can be sent as `page_token` to retrieve the next page. If this
|
3031
|
+
# field is omitted, there are no subsequent pages.
|
2529
3032
|
# Corresponds to the JSON property `nextPageToken`
|
2530
3033
|
# @return [String]
|
2531
3034
|
attr_accessor :next_page_token
|
2532
3035
|
|
2533
|
-
#
|
2534
|
-
# Corresponds to the JSON property `
|
2535
|
-
# @return [Array<Google::Apis::DiscoveryengineV1alpha::
|
2536
|
-
attr_accessor :
|
3036
|
+
# List of TargetSites.
|
3037
|
+
# Corresponds to the JSON property `targetSites`
|
3038
|
+
# @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite>]
|
3039
|
+
attr_accessor :target_sites
|
3040
|
+
|
3041
|
+
# The total number of items matching the request. This will always be populated
|
3042
|
+
# in the response.
|
3043
|
+
# Corresponds to the JSON property `totalSize`
|
3044
|
+
# @return [Fixnum]
|
3045
|
+
attr_accessor :total_size
|
2537
3046
|
|
2538
3047
|
def initialize(**args)
|
2539
3048
|
update!(**args)
|
@@ -2542,7 +3051,8 @@ module Google
|
|
2542
3051
|
# Update properties of this object
|
2543
3052
|
def update!(**args)
|
2544
3053
|
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
2545
|
-
@
|
3054
|
+
@target_sites = args[:target_sites] if args.key?(:target_sites)
|
3055
|
+
@total_size = args[:total_size] if args.key?(:total_size)
|
2546
3056
|
end
|
2547
3057
|
end
|
2548
3058
|
|
@@ -3862,6 +4372,16 @@ module Google
|
|
3862
4372
|
# @return [String]
|
3863
4373
|
attr_accessor :language_code
|
3864
4374
|
|
4375
|
+
# Specification of the prompt to use with the model.
|
4376
|
+
# Corresponds to the JSON property `modelPromptSpec`
|
4377
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec]
|
4378
|
+
attr_accessor :model_prompt_spec
|
4379
|
+
|
4380
|
+
# Specification of the model.
|
4381
|
+
# Corresponds to the JSON property `modelSpec`
|
4382
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec]
|
4383
|
+
attr_accessor :model_spec
|
4384
|
+
|
3865
4385
|
# The number of top results to generate the summary from. If the number of
|
3866
4386
|
# results returned is less than `summaryResultCount`, the summary is generated
|
3867
4387
|
# from all of the results. At most five results can be used to generate a
|
@@ -3880,10 +4400,51 @@ module Google
|
|
3880
4400
|
@ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
|
3881
4401
|
@include_citations = args[:include_citations] if args.key?(:include_citations)
|
3882
4402
|
@language_code = args[:language_code] if args.key?(:language_code)
|
4403
|
+
@model_prompt_spec = args[:model_prompt_spec] if args.key?(:model_prompt_spec)
|
4404
|
+
@model_spec = args[:model_spec] if args.key?(:model_spec)
|
3883
4405
|
@summary_result_count = args[:summary_result_count] if args.key?(:summary_result_count)
|
3884
4406
|
end
|
3885
4407
|
end
|
3886
4408
|
|
4409
|
+
# Specification of the prompt to use with the model.
|
4410
|
+
class GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec
|
4411
|
+
include Google::Apis::Core::Hashable
|
4412
|
+
|
4413
|
+
# Text at the beginning of the prompt that instructs the assistant. Examples are
|
4414
|
+
# available in the user guide.
|
4415
|
+
# Corresponds to the JSON property `preamble`
|
4416
|
+
# @return [String]
|
4417
|
+
attr_accessor :preamble
|
4418
|
+
|
4419
|
+
def initialize(**args)
|
4420
|
+
update!(**args)
|
4421
|
+
end
|
4422
|
+
|
4423
|
+
# Update properties of this object
|
4424
|
+
def update!(**args)
|
4425
|
+
@preamble = args[:preamble] if args.key?(:preamble)
|
4426
|
+
end
|
4427
|
+
end
|
4428
|
+
|
4429
|
+
# Specification of the model.
|
4430
|
+
class GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec
|
4431
|
+
include Google::Apis::Core::Hashable
|
4432
|
+
|
4433
|
+
# The string format of the model version. e.g. stable, preview, etc.
|
4434
|
+
# Corresponds to the JSON property `version`
|
4435
|
+
# @return [String]
|
4436
|
+
attr_accessor :version
|
4437
|
+
|
4438
|
+
def initialize(**args)
|
4439
|
+
update!(**args)
|
4440
|
+
end
|
4441
|
+
|
4442
|
+
# Update properties of this object
|
4443
|
+
def update!(**args)
|
4444
|
+
@version = args[:version] if args.key?(:version)
|
4445
|
+
end
|
4446
|
+
end
|
4447
|
+
|
3887
4448
|
# The specification that uses customized query embedding vector to do semantic
|
3888
4449
|
# document retrieval.
|
3889
4450
|
class GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec
|
@@ -4461,6 +5022,11 @@ module Google
|
|
4461
5022
|
# @return [String]
|
4462
5023
|
attr_accessor :summary_text
|
4463
5024
|
|
5025
|
+
# Summary with metadata information.
|
5026
|
+
# Corresponds to the JSON property `summaryWithMetadata`
|
5027
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata]
|
5028
|
+
attr_accessor :summary_with_metadata
|
5029
|
+
|
4464
5030
|
def initialize(**args)
|
4465
5031
|
update!(**args)
|
4466
5032
|
end
|
@@ -4470,6 +5036,110 @@ module Google
|
|
4470
5036
|
@safety_attributes = args[:safety_attributes] if args.key?(:safety_attributes)
|
4471
5037
|
@summary_skipped_reasons = args[:summary_skipped_reasons] if args.key?(:summary_skipped_reasons)
|
4472
5038
|
@summary_text = args[:summary_text] if args.key?(:summary_text)
|
5039
|
+
@summary_with_metadata = args[:summary_with_metadata] if args.key?(:summary_with_metadata)
|
5040
|
+
end
|
5041
|
+
end
|
5042
|
+
|
5043
|
+
# Citation info for a segment.
|
5044
|
+
class GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation
|
5045
|
+
include Google::Apis::Core::Hashable
|
5046
|
+
|
5047
|
+
# End of the attributed segment, exclusive.
|
5048
|
+
# Corresponds to the JSON property `endIndex`
|
5049
|
+
# @return [Fixnum]
|
5050
|
+
attr_accessor :end_index
|
5051
|
+
|
5052
|
+
# Citation sources for the attributed segment.
|
5053
|
+
# Corresponds to the JSON property `sources`
|
5054
|
+
# @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource>]
|
5055
|
+
attr_accessor :sources
|
5056
|
+
|
5057
|
+
# Index indicates the start of the segment, measured in bytes/unicode.
|
5058
|
+
# Corresponds to the JSON property `startIndex`
|
5059
|
+
# @return [Fixnum]
|
5060
|
+
attr_accessor :start_index
|
5061
|
+
|
5062
|
+
def initialize(**args)
|
5063
|
+
update!(**args)
|
5064
|
+
end
|
5065
|
+
|
5066
|
+
# Update properties of this object
|
5067
|
+
def update!(**args)
|
5068
|
+
@end_index = args[:end_index] if args.key?(:end_index)
|
5069
|
+
@sources = args[:sources] if args.key?(:sources)
|
5070
|
+
@start_index = args[:start_index] if args.key?(:start_index)
|
5071
|
+
end
|
5072
|
+
end
|
5073
|
+
|
5074
|
+
# Citation metadata.
|
5075
|
+
class GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata
|
5076
|
+
include Google::Apis::Core::Hashable
|
5077
|
+
|
5078
|
+
# Citations for segments.
|
5079
|
+
# Corresponds to the JSON property `citations`
|
5080
|
+
# @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation>]
|
5081
|
+
attr_accessor :citations
|
5082
|
+
|
5083
|
+
def initialize(**args)
|
5084
|
+
update!(**args)
|
5085
|
+
end
|
5086
|
+
|
5087
|
+
# Update properties of this object
|
5088
|
+
def update!(**args)
|
5089
|
+
@citations = args[:citations] if args.key?(:citations)
|
5090
|
+
end
|
5091
|
+
end
|
5092
|
+
|
5093
|
+
# Citation source.
|
5094
|
+
class GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource
|
5095
|
+
include Google::Apis::Core::Hashable
|
5096
|
+
|
5097
|
+
# Document reference index from SummaryWithMetadata.references. It is 0-indexed
|
5098
|
+
# and the value will be zero if the reference_index is not set explicitly.
|
5099
|
+
# Corresponds to the JSON property `referenceIndex`
|
5100
|
+
# @return [Fixnum]
|
5101
|
+
attr_accessor :reference_index
|
5102
|
+
|
5103
|
+
def initialize(**args)
|
5104
|
+
update!(**args)
|
5105
|
+
end
|
5106
|
+
|
5107
|
+
# Update properties of this object
|
5108
|
+
def update!(**args)
|
5109
|
+
@reference_index = args[:reference_index] if args.key?(:reference_index)
|
5110
|
+
end
|
5111
|
+
end
|
5112
|
+
|
5113
|
+
# Document reference.
|
5114
|
+
class GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference
|
5115
|
+
include Google::Apis::Core::Hashable
|
5116
|
+
|
5117
|
+
# Required. Document.name of the document. Full resource name of the referenced
|
5118
|
+
# document, in the format `projects/*/locations/*/collections/*/dataStores/*/
|
5119
|
+
# branches/*/documents/*`.
|
5120
|
+
# Corresponds to the JSON property `document`
|
5121
|
+
# @return [String]
|
5122
|
+
attr_accessor :document
|
5123
|
+
|
5124
|
+
# Title of the document.
|
5125
|
+
# Corresponds to the JSON property `title`
|
5126
|
+
# @return [String]
|
5127
|
+
attr_accessor :title
|
5128
|
+
|
5129
|
+
# GCS or HTTP uri for the document.
|
5130
|
+
# Corresponds to the JSON property `uri`
|
5131
|
+
# @return [String]
|
5132
|
+
attr_accessor :uri
|
5133
|
+
|
5134
|
+
def initialize(**args)
|
5135
|
+
update!(**args)
|
5136
|
+
end
|
5137
|
+
|
5138
|
+
# Update properties of this object
|
5139
|
+
def update!(**args)
|
5140
|
+
@document = args[:document] if args.key?(:document)
|
5141
|
+
@title = args[:title] if args.key?(:title)
|
5142
|
+
@uri = args[:uri] if args.key?(:uri)
|
4473
5143
|
end
|
4474
5144
|
end
|
4475
5145
|
|
@@ -4500,6 +5170,58 @@ module Google
|
|
4500
5170
|
end
|
4501
5171
|
end
|
4502
5172
|
|
5173
|
+
# Summary with metadata information.
|
5174
|
+
class GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata
|
5175
|
+
include Google::Apis::Core::Hashable
|
5176
|
+
|
5177
|
+
# Citation metadata.
|
5178
|
+
# Corresponds to the JSON property `citationMetadata`
|
5179
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata]
|
5180
|
+
attr_accessor :citation_metadata
|
5181
|
+
|
5182
|
+
# Document References.
|
5183
|
+
# Corresponds to the JSON property `references`
|
5184
|
+
# @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference>]
|
5185
|
+
attr_accessor :references
|
5186
|
+
|
5187
|
+
# Summary text with no citation information.
|
5188
|
+
# Corresponds to the JSON property `summary`
|
5189
|
+
# @return [String]
|
5190
|
+
attr_accessor :summary
|
5191
|
+
|
5192
|
+
def initialize(**args)
|
5193
|
+
update!(**args)
|
5194
|
+
end
|
5195
|
+
|
5196
|
+
# Update properties of this object
|
5197
|
+
def update!(**args)
|
5198
|
+
@citation_metadata = args[:citation_metadata] if args.key?(:citation_metadata)
|
5199
|
+
@references = args[:references] if args.key?(:references)
|
5200
|
+
@summary = args[:summary] if args.key?(:summary)
|
5201
|
+
end
|
5202
|
+
end
|
5203
|
+
|
5204
|
+
# SiteSearchEngine captures DataStore level site search persisting
|
5205
|
+
# configurations. It is a singleton value per data store.
|
5206
|
+
class GoogleCloudDiscoveryengineV1alphaSiteSearchEngine
|
5207
|
+
include Google::Apis::Core::Hashable
|
5208
|
+
|
5209
|
+
# The fully qualified resource name of the site search engine. Format: `projects/
|
5210
|
+
# */locations/*/dataStores/*/siteSearchEngine`
|
5211
|
+
# Corresponds to the JSON property `name`
|
5212
|
+
# @return [String]
|
5213
|
+
attr_accessor :name
|
5214
|
+
|
5215
|
+
def initialize(**args)
|
5216
|
+
update!(**args)
|
5217
|
+
end
|
5218
|
+
|
5219
|
+
# Update properties of this object
|
5220
|
+
def update!(**args)
|
5221
|
+
@name = args[:name] if args.key?(:name)
|
5222
|
+
end
|
5223
|
+
end
|
5224
|
+
|
4503
5225
|
# Verification information for target sites in advanced site search.
|
4504
5226
|
class GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo
|
4505
5227
|
include Google::Apis::Core::Hashable
|
@@ -4660,6 +5382,149 @@ module Google
|
|
4660
5382
|
end
|
4661
5383
|
end
|
4662
5384
|
|
5385
|
+
# Metadata related to the progress of the TrainCustomModel operation. This is
|
5386
|
+
# returned by the google.longrunning.Operation.metadata field.
|
5387
|
+
class GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata
|
5388
|
+
include Google::Apis::Core::Hashable
|
5389
|
+
|
5390
|
+
# Operation create time.
|
5391
|
+
# Corresponds to the JSON property `createTime`
|
5392
|
+
# @return [String]
|
5393
|
+
attr_accessor :create_time
|
5394
|
+
|
5395
|
+
# Operation last update time. If the operation is done, this is also the finish
|
5396
|
+
# time.
|
5397
|
+
# Corresponds to the JSON property `updateTime`
|
5398
|
+
# @return [String]
|
5399
|
+
attr_accessor :update_time
|
5400
|
+
|
5401
|
+
def initialize(**args)
|
5402
|
+
update!(**args)
|
5403
|
+
end
|
5404
|
+
|
5405
|
+
# Update properties of this object
|
5406
|
+
def update!(**args)
|
5407
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
5408
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
5409
|
+
end
|
5410
|
+
end
|
5411
|
+
|
5412
|
+
# Request message for SearchTuningService.TrainCustomModel method.
|
5413
|
+
class GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest
|
5414
|
+
include Google::Apis::Core::Hashable
|
5415
|
+
|
5416
|
+
# Configuration of destination for Import related errors.
|
5417
|
+
# Corresponds to the JSON property `errorConfig`
|
5418
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportErrorConfig]
|
5419
|
+
attr_accessor :error_config
|
5420
|
+
|
5421
|
+
# Gcs training data input.
|
5422
|
+
# Corresponds to the JSON property `gcsTrainingInput`
|
5423
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput]
|
5424
|
+
attr_accessor :gcs_training_input
|
5425
|
+
|
5426
|
+
# Model to be trained. Supported values are: * **search-tuning**: Fine tuning
|
5427
|
+
# the search system based on data provided.
|
5428
|
+
# Corresponds to the JSON property `modelType`
|
5429
|
+
# @return [String]
|
5430
|
+
attr_accessor :model_type
|
5431
|
+
|
5432
|
+
def initialize(**args)
|
5433
|
+
update!(**args)
|
5434
|
+
end
|
5435
|
+
|
5436
|
+
# Update properties of this object
|
5437
|
+
def update!(**args)
|
5438
|
+
@error_config = args[:error_config] if args.key?(:error_config)
|
5439
|
+
@gcs_training_input = args[:gcs_training_input] if args.key?(:gcs_training_input)
|
5440
|
+
@model_type = args[:model_type] if args.key?(:model_type)
|
5441
|
+
end
|
5442
|
+
end
|
5443
|
+
|
5444
|
+
# Gcs training data input.
|
5445
|
+
class GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput
|
5446
|
+
include Google::Apis::Core::Hashable
|
5447
|
+
|
5448
|
+
# The gcs corpus data which could be associated in train data. The data path
|
5449
|
+
# format is gs:///. A newline delimited jsonl/ndjson file. * For search-tuning
|
5450
|
+
# model, each line should have the _id, title and text. Example: `"_id": "doc1",
|
5451
|
+
# title: "relevant doc", "text": "relevant text"`
|
5452
|
+
# Corresponds to the JSON property `corpusDataPath`
|
5453
|
+
# @return [String]
|
5454
|
+
attr_accessor :corpus_data_path
|
5455
|
+
|
5456
|
+
# The gcs query data which could be associated in train data. The data path
|
5457
|
+
# format is gs:///. A newline delimited jsonl/ndjson file. * For search-tuning
|
5458
|
+
# model, each line should have the _id and text. Example: `"_id": "query1", "
|
5459
|
+
# text": "example query"`
|
5460
|
+
# Corresponds to the JSON property `queryDataPath`
|
5461
|
+
# @return [String]
|
5462
|
+
attr_accessor :query_data_path
|
5463
|
+
|
5464
|
+
# Gcs test data. Same format as train_data_path. If not provided, a random 80/20
|
5465
|
+
# train/test split will be performed on train_data_path.
|
5466
|
+
# Corresponds to the JSON property `testDataPath`
|
5467
|
+
# @return [String]
|
5468
|
+
attr_accessor :test_data_path
|
5469
|
+
|
5470
|
+
# Gcs training data path whose format should be gs:///. The file should be in
|
5471
|
+
# tsv format. Each line should have the doc_id and query_id and score (number). *
|
5472
|
+
# For search-tuning model, it should have the query-id corpus-id score as tsv
|
5473
|
+
# file header. The score should be a number in [0, inf+). The larger the number
|
5474
|
+
# is, the more relevant the pair is. Example: query-id\tcorpus-id\tscore query1\
|
5475
|
+
# tdoc1\t1
|
5476
|
+
# Corresponds to the JSON property `trainDataPath`
|
5477
|
+
# @return [String]
|
5478
|
+
attr_accessor :train_data_path
|
5479
|
+
|
5480
|
+
def initialize(**args)
|
5481
|
+
update!(**args)
|
5482
|
+
end
|
5483
|
+
|
5484
|
+
# Update properties of this object
|
5485
|
+
def update!(**args)
|
5486
|
+
@corpus_data_path = args[:corpus_data_path] if args.key?(:corpus_data_path)
|
5487
|
+
@query_data_path = args[:query_data_path] if args.key?(:query_data_path)
|
5488
|
+
@test_data_path = args[:test_data_path] if args.key?(:test_data_path)
|
5489
|
+
@train_data_path = args[:train_data_path] if args.key?(:train_data_path)
|
5490
|
+
end
|
5491
|
+
end
|
5492
|
+
|
5493
|
+
# Response of the TrainCustomModelRequest. This message is returned by the
|
5494
|
+
# google.longrunning.Operations.response field.
|
5495
|
+
class GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse
|
5496
|
+
include Google::Apis::Core::Hashable
|
5497
|
+
|
5498
|
+
# Configuration of destination for Import related errors.
|
5499
|
+
# Corresponds to the JSON property `errorConfig`
|
5500
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportErrorConfig]
|
5501
|
+
attr_accessor :error_config
|
5502
|
+
|
5503
|
+
# A sample of errors encountered while processing the data.
|
5504
|
+
# Corresponds to the JSON property `errorSamples`
|
5505
|
+
# @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus>]
|
5506
|
+
attr_accessor :error_samples
|
5507
|
+
|
5508
|
+
# The trained model status. Possible values are: * **bad-data**: The training
|
5509
|
+
# data quality is bad. * **no-improvement**: Tuning didn't improve performance.
|
5510
|
+
# Won't deploy. * **in-progress**: Model training is in progress. * **ready**:
|
5511
|
+
# The model is ready for serving.
|
5512
|
+
# Corresponds to the JSON property `modelStatus`
|
5513
|
+
# @return [String]
|
5514
|
+
attr_accessor :model_status
|
5515
|
+
|
5516
|
+
def initialize(**args)
|
5517
|
+
update!(**args)
|
5518
|
+
end
|
5519
|
+
|
5520
|
+
# Update properties of this object
|
5521
|
+
def update!(**args)
|
5522
|
+
@error_config = args[:error_config] if args.key?(:error_config)
|
5523
|
+
@error_samples = args[:error_samples] if args.key?(:error_samples)
|
5524
|
+
@model_status = args[:model_status] if args.key?(:model_status)
|
5525
|
+
end
|
5526
|
+
end
|
5527
|
+
|
4663
5528
|
# A transaction represents the entire purchase transaction.
|
4664
5529
|
class GoogleCloudDiscoveryengineV1alphaTransactionInfo
|
4665
5530
|
include Google::Apis::Core::Hashable
|
@@ -4793,6 +5658,34 @@ module Google
|
|
4793
5658
|
end
|
4794
5659
|
end
|
4795
5660
|
|
5661
|
+
# Metadata related to the progress of the SiteSearchEngineService.
|
5662
|
+
# UpdateTargetSite operation. This will be returned by the google.longrunning.
|
5663
|
+
# Operation.metadata field.
|
5664
|
+
class GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata
|
5665
|
+
include Google::Apis::Core::Hashable
|
5666
|
+
|
5667
|
+
# Operation create time.
|
5668
|
+
# Corresponds to the JSON property `createTime`
|
5669
|
+
# @return [String]
|
5670
|
+
attr_accessor :create_time
|
5671
|
+
|
5672
|
+
# Operation last update time. If the operation is done, this is also the finish
|
5673
|
+
# time.
|
5674
|
+
# Corresponds to the JSON property `updateTime`
|
5675
|
+
# @return [String]
|
5676
|
+
attr_accessor :update_time
|
5677
|
+
|
5678
|
+
def initialize(**args)
|
5679
|
+
update!(**args)
|
5680
|
+
end
|
5681
|
+
|
5682
|
+
# Update properties of this object
|
5683
|
+
def update!(**args)
|
5684
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
5685
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
5686
|
+
end
|
5687
|
+
end
|
5688
|
+
|
4796
5689
|
# UserEvent captures all metadata information Discovery Engine API needs to know
|
4797
5690
|
# about how end users interact with customers' website.
|
4798
5691
|
class GoogleCloudDiscoveryengineV1alphaUserEvent
|