google-apis-discoveryengine_v1beta 0.55.0 → 0.56.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/discoveryengine_v1beta/classes.rb +1962 -137
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +811 -21
- data/lib/google/apis/discoveryengine_v1beta/service.rb +453 -0
- metadata +4 -4
@@ -485,6 +485,66 @@ module Google
|
|
485
485
|
end
|
486
486
|
end
|
487
487
|
|
488
|
+
# The error payload that is populated on LRO sync APIs, including the following:
|
489
|
+
# * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector`
|
490
|
+
# * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun`
|
491
|
+
class GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext
|
492
|
+
include Google::Apis::Core::Hashable
|
493
|
+
|
494
|
+
# The full resource name of the Connector Run. Format: `projects/*/locations/*/
|
495
|
+
# collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-
|
496
|
+
# generated.
|
497
|
+
# Corresponds to the JSON property `connectorRun`
|
498
|
+
# @return [String]
|
499
|
+
attr_accessor :connector_run
|
500
|
+
|
501
|
+
# The full resource name of the DataConnector. Format: `projects/*/locations/*/
|
502
|
+
# collections/*/dataConnector`.
|
503
|
+
# Corresponds to the JSON property `dataConnector`
|
504
|
+
# @return [String]
|
505
|
+
attr_accessor :data_connector
|
506
|
+
|
507
|
+
# The time when the connector run ended.
|
508
|
+
# Corresponds to the JSON property `endTime`
|
509
|
+
# @return [String]
|
510
|
+
attr_accessor :end_time
|
511
|
+
|
512
|
+
# The entity to sync for the connector run.
|
513
|
+
# Corresponds to the JSON property `entity`
|
514
|
+
# @return [String]
|
515
|
+
attr_accessor :entity
|
516
|
+
|
517
|
+
# The operation resource name of the LRO to sync the connector.
|
518
|
+
# Corresponds to the JSON property `operation`
|
519
|
+
# @return [String]
|
520
|
+
attr_accessor :operation
|
521
|
+
|
522
|
+
# The time when the connector run started.
|
523
|
+
# Corresponds to the JSON property `startTime`
|
524
|
+
# @return [String]
|
525
|
+
attr_accessor :start_time
|
526
|
+
|
527
|
+
# The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL`
|
528
|
+
# Corresponds to the JSON property `syncType`
|
529
|
+
# @return [String]
|
530
|
+
attr_accessor :sync_type
|
531
|
+
|
532
|
+
def initialize(**args)
|
533
|
+
update!(**args)
|
534
|
+
end
|
535
|
+
|
536
|
+
# Update properties of this object
|
537
|
+
def update!(**args)
|
538
|
+
@connector_run = args[:connector_run] if args.key?(:connector_run)
|
539
|
+
@data_connector = args[:data_connector] if args.key?(:data_connector)
|
540
|
+
@end_time = args[:end_time] if args.key?(:end_time)
|
541
|
+
@entity = args[:entity] if args.key?(:entity)
|
542
|
+
@operation = args[:operation] if args.key?(:operation)
|
543
|
+
@start_time = args[:start_time] if args.key?(:start_time)
|
544
|
+
@sync_type = args[:sync_type] if args.key?(:sync_type)
|
545
|
+
end
|
546
|
+
end
|
547
|
+
|
488
548
|
# A description of the context in which an error occurred.
|
489
549
|
class GoogleCloudDiscoveryengineLoggingErrorContext
|
490
550
|
include Google::Apis::Core::Hashable
|
@@ -515,6 +575,13 @@ module Google
|
|
515
575
|
class GoogleCloudDiscoveryengineLoggingErrorLog
|
516
576
|
include Google::Apis::Core::Hashable
|
517
577
|
|
578
|
+
# The error payload that is populated on LRO sync APIs, including the following:
|
579
|
+
# * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector`
|
580
|
+
# * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun`
|
581
|
+
# Corresponds to the JSON property `connectorRunPayload`
|
582
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext]
|
583
|
+
attr_accessor :connector_run_payload
|
584
|
+
|
518
585
|
# A description of the context in which an error occurred.
|
519
586
|
# Corresponds to the JSON property `context`
|
520
587
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineLoggingErrorContext]
|
@@ -574,6 +641,7 @@ module Google
|
|
574
641
|
|
575
642
|
# Update properties of this object
|
576
643
|
def update!(**args)
|
644
|
+
@connector_run_payload = args[:connector_run_payload] if args.key?(:connector_run_payload)
|
577
645
|
@context = args[:context] if args.key?(:context)
|
578
646
|
@import_payload = args[:import_payload] if args.key?(:import_payload)
|
579
647
|
@message = args[:message] if args.key?(:message)
|
@@ -775,13 +843,13 @@ module Google
|
|
775
843
|
attr_accessor :is_default
|
776
844
|
alias_method :is_default?, :is_default
|
777
845
|
|
778
|
-
#
|
846
|
+
# KMS key resource name which will be used to encrypt resources `projects/`
|
779
847
|
# project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
|
780
848
|
# Corresponds to the JSON property `kmsKey`
|
781
849
|
# @return [String]
|
782
850
|
attr_accessor :kms_key
|
783
851
|
|
784
|
-
#
|
852
|
+
# KMS key version resource name which will be used to encrypt resources `/
|
785
853
|
# cryptoKeyVersions/`keyVersion``.
|
786
854
|
# Corresponds to the JSON property `kmsKeyVersion`
|
787
855
|
# @return [String]
|
@@ -792,9 +860,9 @@ module Google
|
|
792
860
|
# @return [Fixnum]
|
793
861
|
attr_accessor :last_rotation_timestamp_micros
|
794
862
|
|
795
|
-
# Required.
|
796
|
-
# location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs
|
797
|
-
# cmekConfig``.
|
863
|
+
# Required. The name of the CmekConfig of the form `projects/`project`/locations/
|
864
|
+
# `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
|
865
|
+
# `cmekConfig``.
|
798
866
|
# Corresponds to the JSON property `name`
|
799
867
|
# @return [String]
|
800
868
|
attr_accessor :name
|
@@ -804,7 +872,7 @@ module Google
|
|
804
872
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1SingleRegionKey>]
|
805
873
|
attr_accessor :single_region_keys
|
806
874
|
|
807
|
-
# Output only.
|
875
|
+
# Output only. The states of the CmekConfig.
|
808
876
|
# Corresponds to the JSON property `state`
|
809
877
|
# @return [String]
|
810
878
|
attr_accessor :state
|
@@ -1038,6 +1106,13 @@ module Google
|
|
1038
1106
|
# @return [Float]
|
1039
1107
|
attr_accessor :fixed_boost
|
1040
1108
|
|
1109
|
+
# Specification for custom ranking based on customer specified attribute value.
|
1110
|
+
# It provides more controls for customized ranking than the simple (condition,
|
1111
|
+
# boost) combination above.
|
1112
|
+
# Corresponds to the JSON property `interpolationBoostSpec`
|
1113
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec]
|
1114
|
+
attr_accessor :interpolation_boost_spec
|
1115
|
+
|
1041
1116
|
def initialize(**args)
|
1042
1117
|
update!(**args)
|
1043
1118
|
end
|
@@ -1048,6 +1123,85 @@ module Google
|
|
1048
1123
|
@data_store = args[:data_store] if args.key?(:data_store)
|
1049
1124
|
@filter = args[:filter] if args.key?(:filter)
|
1050
1125
|
@fixed_boost = args[:fixed_boost] if args.key?(:fixed_boost)
|
1126
|
+
@interpolation_boost_spec = args[:interpolation_boost_spec] if args.key?(:interpolation_boost_spec)
|
1127
|
+
end
|
1128
|
+
end
|
1129
|
+
|
1130
|
+
# Specification for custom ranking based on customer specified attribute value.
|
1131
|
+
# It provides more controls for customized ranking than the simple (condition,
|
1132
|
+
# boost) combination above.
|
1133
|
+
class GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec
|
1134
|
+
include Google::Apis::Core::Hashable
|
1135
|
+
|
1136
|
+
# Optional. The attribute type to be used to determine the boost amount. The
|
1137
|
+
# attribute value can be derived from the field value of the specified
|
1138
|
+
# field_name. In the case of numerical it is straightforward i.e.
|
1139
|
+
# attribute_value = numerical_field_value. In the case of freshness however,
|
1140
|
+
# attribute_value = (time.now() - datetime_field_value).
|
1141
|
+
# Corresponds to the JSON property `attributeType`
|
1142
|
+
# @return [String]
|
1143
|
+
attr_accessor :attribute_type
|
1144
|
+
|
1145
|
+
# Optional. The control points used to define the curve. The monotonic function (
|
1146
|
+
# defined through the interpolation_type above) passes through the control
|
1147
|
+
# points listed here.
|
1148
|
+
# Corresponds to the JSON property `controlPoints`
|
1149
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint>]
|
1150
|
+
attr_accessor :control_points
|
1151
|
+
|
1152
|
+
# Optional. The name of the field whose value will be used to determine the
|
1153
|
+
# boost amount.
|
1154
|
+
# Corresponds to the JSON property `fieldName`
|
1155
|
+
# @return [String]
|
1156
|
+
attr_accessor :field_name
|
1157
|
+
|
1158
|
+
# Optional. The interpolation type to be applied to connect the control points
|
1159
|
+
# listed below.
|
1160
|
+
# Corresponds to the JSON property `interpolationType`
|
1161
|
+
# @return [String]
|
1162
|
+
attr_accessor :interpolation_type
|
1163
|
+
|
1164
|
+
def initialize(**args)
|
1165
|
+
update!(**args)
|
1166
|
+
end
|
1167
|
+
|
1168
|
+
# Update properties of this object
|
1169
|
+
def update!(**args)
|
1170
|
+
@attribute_type = args[:attribute_type] if args.key?(:attribute_type)
|
1171
|
+
@control_points = args[:control_points] if args.key?(:control_points)
|
1172
|
+
@field_name = args[:field_name] if args.key?(:field_name)
|
1173
|
+
@interpolation_type = args[:interpolation_type] if args.key?(:interpolation_type)
|
1174
|
+
end
|
1175
|
+
end
|
1176
|
+
|
1177
|
+
# The control points used to define the curve. The curve defined through these
|
1178
|
+
# control points can only be monotonically increasing or decreasing(constant
|
1179
|
+
# values are acceptable).
|
1180
|
+
class GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint
|
1181
|
+
include Google::Apis::Core::Hashable
|
1182
|
+
|
1183
|
+
# Optional. Can be one of: 1. The numerical field value. 2. The duration spec
|
1184
|
+
# for freshness: The value must be formatted as an XSD `dayTimeDuration` value (
|
1185
|
+
# a restricted subset of an ISO 8601 duration value). The pattern for this is: `
|
1186
|
+
# nDnM]`.
|
1187
|
+
# Corresponds to the JSON property `attributeValue`
|
1188
|
+
# @return [String]
|
1189
|
+
attr_accessor :attribute_value
|
1190
|
+
|
1191
|
+
# Optional. The value between -1 to 1 by which to boost the score if the
|
1192
|
+
# attribute_value evaluates to the value specified above.
|
1193
|
+
# Corresponds to the JSON property `boostAmount`
|
1194
|
+
# @return [Float]
|
1195
|
+
attr_accessor :boost_amount
|
1196
|
+
|
1197
|
+
def initialize(**args)
|
1198
|
+
update!(**args)
|
1199
|
+
end
|
1200
|
+
|
1201
|
+
# Update properties of this object
|
1202
|
+
def update!(**args)
|
1203
|
+
@attribute_value = args[:attribute_value] if args.key?(:attribute_value)
|
1204
|
+
@boost_amount = args[:boost_amount] if args.key?(:boost_amount)
|
1051
1205
|
end
|
1052
1206
|
end
|
1053
1207
|
|
@@ -1232,6 +1386,34 @@ module Google
|
|
1232
1386
|
end
|
1233
1387
|
end
|
1234
1388
|
|
1389
|
+
# Metadata related to the progress of the SiteSearchEngineService.CreateSitemap
|
1390
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
1391
|
+
# field.
|
1392
|
+
class GoogleCloudDiscoveryengineV1CreateSitemapMetadata
|
1393
|
+
include Google::Apis::Core::Hashable
|
1394
|
+
|
1395
|
+
# Operation create time.
|
1396
|
+
# Corresponds to the JSON property `createTime`
|
1397
|
+
# @return [String]
|
1398
|
+
attr_accessor :create_time
|
1399
|
+
|
1400
|
+
# Operation last update time. If the operation is done, this is also the finish
|
1401
|
+
# time.
|
1402
|
+
# Corresponds to the JSON property `updateTime`
|
1403
|
+
# @return [String]
|
1404
|
+
attr_accessor :update_time
|
1405
|
+
|
1406
|
+
def initialize(**args)
|
1407
|
+
update!(**args)
|
1408
|
+
end
|
1409
|
+
|
1410
|
+
# Update properties of this object
|
1411
|
+
def update!(**args)
|
1412
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1413
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
1414
|
+
end
|
1415
|
+
end
|
1416
|
+
|
1235
1417
|
# Metadata related to the progress of the SiteSearchEngineService.
|
1236
1418
|
# CreateTargetSite operation. This will be returned by the google.longrunning.
|
1237
1419
|
# Operation.metadata field.
|
@@ -1290,7 +1472,7 @@ module Google
|
|
1290
1472
|
# @return [String]
|
1291
1473
|
attr_accessor :create_time
|
1292
1474
|
|
1293
|
-
# Output only. The id of the default Schema
|
1475
|
+
# Output only. The id of the default Schema associated to this data store.
|
1294
1476
|
# Corresponds to the JSON property `defaultSchemaId`
|
1295
1477
|
# @return [String]
|
1296
1478
|
attr_accessor :default_schema_id
|
@@ -1309,6 +1491,19 @@ module Google
|
|
1309
1491
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DocumentProcessingConfig]
|
1310
1492
|
attr_accessor :document_processing_config
|
1311
1493
|
|
1494
|
+
# Config to data store for `HEALTHCARE_FHIR` vertical.
|
1495
|
+
# Corresponds to the JSON property `healthcareFhirConfig`
|
1496
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1HealthcareFhirConfig]
|
1497
|
+
attr_accessor :healthcare_fhir_config
|
1498
|
+
|
1499
|
+
# Immutable. The fully qualified resource name of the associated
|
1500
|
+
# IdentityMappingStore. This field can only be set for acl_enabled DataStores
|
1501
|
+
# with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/`project`/locations/`
|
1502
|
+
# location`/identityMappingStores/`identity_mapping_store``.
|
1503
|
+
# Corresponds to the JSON property `identityMappingStore`
|
1504
|
+
# @return [String]
|
1505
|
+
attr_accessor :identity_mapping_store
|
1506
|
+
|
1312
1507
|
# Immutable. The industry vertical that the data store registers.
|
1313
1508
|
# Corresponds to the JSON property `industryVertical`
|
1314
1509
|
# @return [String]
|
@@ -1373,6 +1568,8 @@ module Google
|
|
1373
1568
|
@default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
|
1374
1569
|
@display_name = args[:display_name] if args.key?(:display_name)
|
1375
1570
|
@document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
|
1571
|
+
@healthcare_fhir_config = args[:healthcare_fhir_config] if args.key?(:healthcare_fhir_config)
|
1572
|
+
@identity_mapping_store = args[:identity_mapping_store] if args.key?(:identity_mapping_store)
|
1376
1573
|
@industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
|
1377
1574
|
@is_infobot_faq_data_store = args[:is_infobot_faq_data_store] if args.key?(:is_infobot_faq_data_store)
|
1378
1575
|
@kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
|
@@ -1453,6 +1650,34 @@ module Google
|
|
1453
1650
|
end
|
1454
1651
|
end
|
1455
1652
|
|
1653
|
+
# Metadata related to the progress of the CmekConfigService.DeleteCmekConfig
|
1654
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
1655
|
+
# field.
|
1656
|
+
class GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata
|
1657
|
+
include Google::Apis::Core::Hashable
|
1658
|
+
|
1659
|
+
# Operation create time.
|
1660
|
+
# Corresponds to the JSON property `createTime`
|
1661
|
+
# @return [String]
|
1662
|
+
attr_accessor :create_time
|
1663
|
+
|
1664
|
+
# Operation last update time. If the operation is done, this is also the finish
|
1665
|
+
# time.
|
1666
|
+
# Corresponds to the JSON property `updateTime`
|
1667
|
+
# @return [String]
|
1668
|
+
attr_accessor :update_time
|
1669
|
+
|
1670
|
+
def initialize(**args)
|
1671
|
+
update!(**args)
|
1672
|
+
end
|
1673
|
+
|
1674
|
+
# Update properties of this object
|
1675
|
+
def update!(**args)
|
1676
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1677
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
1678
|
+
end
|
1679
|
+
end
|
1680
|
+
|
1456
1681
|
# Metadata related to the progress of the DataStoreService.DeleteDataStore
|
1457
1682
|
# operation. This will be returned by the google.longrunning.Operation.metadata
|
1458
1683
|
# field.
|
@@ -1562,6 +1787,34 @@ module Google
|
|
1562
1787
|
end
|
1563
1788
|
end
|
1564
1789
|
|
1790
|
+
# Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap
|
1791
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
1792
|
+
# field.
|
1793
|
+
class GoogleCloudDiscoveryengineV1DeleteSitemapMetadata
|
1794
|
+
include Google::Apis::Core::Hashable
|
1795
|
+
|
1796
|
+
# Operation create time.
|
1797
|
+
# Corresponds to the JSON property `createTime`
|
1798
|
+
# @return [String]
|
1799
|
+
attr_accessor :create_time
|
1800
|
+
|
1801
|
+
# Operation last update time. If the operation is done, this is also the finish
|
1802
|
+
# time.
|
1803
|
+
# Corresponds to the JSON property `updateTime`
|
1804
|
+
# @return [String]
|
1805
|
+
attr_accessor :update_time
|
1806
|
+
|
1807
|
+
def initialize(**args)
|
1808
|
+
update!(**args)
|
1809
|
+
end
|
1810
|
+
|
1811
|
+
# Update properties of this object
|
1812
|
+
def update!(**args)
|
1813
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1814
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
1815
|
+
end
|
1816
|
+
end
|
1817
|
+
|
1565
1818
|
# Metadata related to the progress of the SiteSearchEngineService.
|
1566
1819
|
# DeleteTargetSite operation. This will be returned by the google.longrunning.
|
1567
1820
|
# Operation.metadata field.
|
@@ -1964,6 +2217,17 @@ module Google
|
|
1964
2217
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig]
|
1965
2218
|
attr_accessor :agent_creation_config
|
1966
2219
|
|
2220
|
+
# Optional. If the flag set to true, we allow the agent and engine are in
|
2221
|
+
# different locations, otherwise the agent and engine are required to be in the
|
2222
|
+
# same location. The flag is set to false by default. Note that the `
|
2223
|
+
# allow_cross_region` are one-time consumed by and passed to EngineService.
|
2224
|
+
# CreateEngine. It means they cannot be retrieved using EngineService.GetEngine
|
2225
|
+
# or EngineService.ListEngines API after engine creation.
|
2226
|
+
# Corresponds to the JSON property `allowCrossRegion`
|
2227
|
+
# @return [Boolean]
|
2228
|
+
attr_accessor :allow_cross_region
|
2229
|
+
alias_method :allow_cross_region?, :allow_cross_region
|
2230
|
+
|
1967
2231
|
# The resource name of an exist Dialogflow agent to link to this Chat Engine.
|
1968
2232
|
# Customers can either provide `agent_creation_config` to create agent or
|
1969
2233
|
# provide an agent name that links the agent with the Chat engine. Format: `
|
@@ -1983,6 +2247,7 @@ module Google
|
|
1983
2247
|
# Update properties of this object
|
1984
2248
|
def update!(**args)
|
1985
2249
|
@agent_creation_config = args[:agent_creation_config] if args.key?(:agent_creation_config)
|
2250
|
+
@allow_cross_region = args[:allow_cross_region] if args.key?(:allow_cross_region)
|
1986
2251
|
@dialogflow_agent_to_link = args[:dialogflow_agent_to_link] if args.key?(:dialogflow_agent_to_link)
|
1987
2252
|
end
|
1988
2253
|
end
|
@@ -2101,6 +2366,70 @@ module Google
|
|
2101
2366
|
end
|
2102
2367
|
end
|
2103
2368
|
|
2369
|
+
# Config to data store for `HEALTHCARE_FHIR` vertical.
|
2370
|
+
class GoogleCloudDiscoveryengineV1HealthcareFhirConfig
|
2371
|
+
include Google::Apis::Core::Hashable
|
2372
|
+
|
2373
|
+
# Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set
|
2374
|
+
# to `true`, the predefined healthcare fhir schema can be extended for more
|
2375
|
+
# customized searching and filtering.
|
2376
|
+
# Corresponds to the JSON property `enableConfigurableSchema`
|
2377
|
+
# @return [Boolean]
|
2378
|
+
attr_accessor :enable_configurable_schema
|
2379
|
+
alias_method :enable_configurable_schema?, :enable_configurable_schema
|
2380
|
+
|
2381
|
+
# Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If
|
2382
|
+
# set to `true`, the batch ingestion will be processed in a static indexing mode
|
2383
|
+
# which is slower but more capable of handling larger volume.
|
2384
|
+
# Corresponds to the JSON property `enableStaticIndexingForBatchIngestion`
|
2385
|
+
# @return [Boolean]
|
2386
|
+
attr_accessor :enable_static_indexing_for_batch_ingestion
|
2387
|
+
alias_method :enable_static_indexing_for_batch_ingestion?, :enable_static_indexing_for_batch_ingestion
|
2388
|
+
|
2389
|
+
def initialize(**args)
|
2390
|
+
update!(**args)
|
2391
|
+
end
|
2392
|
+
|
2393
|
+
# Update properties of this object
|
2394
|
+
def update!(**args)
|
2395
|
+
@enable_configurable_schema = args[:enable_configurable_schema] if args.key?(:enable_configurable_schema)
|
2396
|
+
@enable_static_indexing_for_batch_ingestion = args[:enable_static_indexing_for_batch_ingestion] if args.key?(:enable_static_indexing_for_batch_ingestion)
|
2397
|
+
end
|
2398
|
+
end
|
2399
|
+
|
2400
|
+
# IdentityMappingEntry LongRunningOperation metadata for
|
2401
|
+
# IdentityMappingStoreService.ImportIdentityMappings and
|
2402
|
+
# IdentityMappingStoreService.PurgeIdentityMappings
|
2403
|
+
class GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata
|
2404
|
+
include Google::Apis::Core::Hashable
|
2405
|
+
|
2406
|
+
# The number of IdentityMappingEntries that failed to be processed.
|
2407
|
+
# Corresponds to the JSON property `failureCount`
|
2408
|
+
# @return [Fixnum]
|
2409
|
+
attr_accessor :failure_count
|
2410
|
+
|
2411
|
+
# The number of IdentityMappingEntries that were successfully processed.
|
2412
|
+
# Corresponds to the JSON property `successCount`
|
2413
|
+
# @return [Fixnum]
|
2414
|
+
attr_accessor :success_count
|
2415
|
+
|
2416
|
+
# The total number of IdentityMappingEntries that were processed.
|
2417
|
+
# Corresponds to the JSON property `totalCount`
|
2418
|
+
# @return [Fixnum]
|
2419
|
+
attr_accessor :total_count
|
2420
|
+
|
2421
|
+
def initialize(**args)
|
2422
|
+
update!(**args)
|
2423
|
+
end
|
2424
|
+
|
2425
|
+
# Update properties of this object
|
2426
|
+
def update!(**args)
|
2427
|
+
@failure_count = args[:failure_count] if args.key?(:failure_count)
|
2428
|
+
@success_count = args[:success_count] if args.key?(:success_count)
|
2429
|
+
@total_count = args[:total_count] if args.key?(:total_count)
|
2430
|
+
end
|
2431
|
+
end
|
2432
|
+
|
2104
2433
|
# Metadata related to the progress of the ImportCompletionSuggestions operation.
|
2105
2434
|
# This will be returned by the google.longrunning.Operation.metadata field.
|
2106
2435
|
class GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata
|
@@ -2260,6 +2589,25 @@ module Google
|
|
2260
2589
|
end
|
2261
2590
|
end
|
2262
2591
|
|
2592
|
+
# Response message for IdentityMappingStoreService.ImportIdentityMappings
|
2593
|
+
class GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse
|
2594
|
+
include Google::Apis::Core::Hashable
|
2595
|
+
|
2596
|
+
# A sample of errors encountered while processing the request.
|
2597
|
+
# Corresponds to the JSON property `errorSamples`
|
2598
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
|
2599
|
+
attr_accessor :error_samples
|
2600
|
+
|
2601
|
+
def initialize(**args)
|
2602
|
+
update!(**args)
|
2603
|
+
end
|
2604
|
+
|
2605
|
+
# Update properties of this object
|
2606
|
+
def update!(**args)
|
2607
|
+
@error_samples = args[:error_samples] if args.key?(:error_samples)
|
2608
|
+
end
|
2609
|
+
end
|
2610
|
+
|
2263
2611
|
# Metadata related to the progress of the ImportSuggestionDenyListEntries
|
2264
2612
|
# operation. This is returned by the google.longrunning.Operation.metadata field.
|
2265
2613
|
class GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata
|
@@ -3409,16 +3757,49 @@ module Google
|
|
3409
3757
|
end
|
3410
3758
|
end
|
3411
3759
|
|
3412
|
-
# A
|
3413
|
-
class
|
3760
|
+
# A sitemap for the SiteSearchEngine.
|
3761
|
+
class GoogleCloudDiscoveryengineV1Sitemap
|
3414
3762
|
include Google::Apis::Core::Hashable
|
3415
3763
|
|
3416
|
-
#
|
3417
|
-
#
|
3418
|
-
#
|
3419
|
-
|
3420
|
-
|
3421
|
-
#
|
3764
|
+
# Output only. The sitemap's creation time.
|
3765
|
+
# Corresponds to the JSON property `createTime`
|
3766
|
+
# @return [String]
|
3767
|
+
attr_accessor :create_time
|
3768
|
+
|
3769
|
+
# Output only. The fully qualified resource name of the sitemap. `projects/*/
|
3770
|
+
# locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `
|
3771
|
+
# sitemap_id` suffix is system-generated.
|
3772
|
+
# Corresponds to the JSON property `name`
|
3773
|
+
# @return [String]
|
3774
|
+
attr_accessor :name
|
3775
|
+
|
3776
|
+
# Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.
|
3777
|
+
# Corresponds to the JSON property `uri`
|
3778
|
+
# @return [String]
|
3779
|
+
attr_accessor :uri
|
3780
|
+
|
3781
|
+
def initialize(**args)
|
3782
|
+
update!(**args)
|
3783
|
+
end
|
3784
|
+
|
3785
|
+
# Update properties of this object
|
3786
|
+
def update!(**args)
|
3787
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
3788
|
+
@name = args[:name] if args.key?(:name)
|
3789
|
+
@uri = args[:uri] if args.key?(:uri)
|
3790
|
+
end
|
3791
|
+
end
|
3792
|
+
|
3793
|
+
# A target site for the SiteSearchEngine.
|
3794
|
+
class GoogleCloudDiscoveryengineV1TargetSite
|
3795
|
+
include Google::Apis::Core::Hashable
|
3796
|
+
|
3797
|
+
# Immutable. If set to false, a uri_pattern is generated to include all pages
|
3798
|
+
# whose address contains the provided_uri_pattern. If set to true, an
|
3799
|
+
# uri_pattern is generated to try to be an exact match of the
|
3800
|
+
# provided_uri_pattern or just the specific page if the provided_uri_pattern is
|
3801
|
+
# a specific one. provided_uri_pattern is always normalized to generate the URI
|
3802
|
+
# pattern to be used by the search engine.
|
3422
3803
|
# Corresponds to the JSON property `exactMatch`
|
3423
3804
|
# @return [Boolean]
|
3424
3805
|
attr_accessor :exact_match
|
@@ -3765,7 +4146,7 @@ module Google
|
|
3765
4146
|
# Required. Params needed to support actions in the format of (Key, Value) pairs.
|
3766
4147
|
# Required parameters for sources that support OAUTH, i.e. `gmail`, `
|
3767
4148
|
# google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `
|
3768
|
-
# client_id` * Value: type STRING. The client
|
4149
|
+
# client_id` * Value: type STRING. The client ID for the service provider to
|
3769
4150
|
# identify your application. * Key: `client_secret` * Value:type STRING. The
|
3770
4151
|
# client secret generated by the application's authorization server.
|
3771
4152
|
# Corresponds to the JSON property `actionParams`
|
@@ -3921,7 +4302,9 @@ module Google
|
|
3921
4302
|
class GoogleCloudDiscoveryengineV1alphaAnswerCitation
|
3922
4303
|
include Google::Apis::Core::Hashable
|
3923
4304
|
|
3924
|
-
# End of the attributed segment, exclusive.
|
4305
|
+
# End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode).
|
4306
|
+
# If there are multi-byte characters,such as non-ASCII characters, the index
|
4307
|
+
# measurement is longer than the string length.
|
3925
4308
|
# Corresponds to the JSON property `endIndex`
|
3926
4309
|
# @return [Fixnum]
|
3927
4310
|
attr_accessor :end_index
|
@@ -3932,6 +4315,8 @@ module Google
|
|
3932
4315
|
attr_accessor :sources
|
3933
4316
|
|
3934
4317
|
# Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
|
4318
|
+
# If there are multi-byte characters,such as non-ASCII characters, the index
|
4319
|
+
# measurement is longer than the string length.
|
3935
4320
|
# Corresponds to the JSON property `startIndex`
|
3936
4321
|
# @return [Fixnum]
|
3937
4322
|
attr_accessor :start_index
|
@@ -4191,6 +4576,16 @@ module Google
|
|
4191
4576
|
# @return [Hash<String,Object>]
|
4192
4577
|
attr_accessor :struct_data
|
4193
4578
|
|
4579
|
+
# Output only. The title of the document.
|
4580
|
+
# Corresponds to the JSON property `title`
|
4581
|
+
# @return [String]
|
4582
|
+
attr_accessor :title
|
4583
|
+
|
4584
|
+
# Output only. The URI of the document.
|
4585
|
+
# Corresponds to the JSON property `uri`
|
4586
|
+
# @return [String]
|
4587
|
+
attr_accessor :uri
|
4588
|
+
|
4194
4589
|
def initialize(**args)
|
4195
4590
|
update!(**args)
|
4196
4591
|
end
|
@@ -4199,6 +4594,8 @@ module Google
|
|
4199
4594
|
def update!(**args)
|
4200
4595
|
@document = args[:document] if args.key?(:document)
|
4201
4596
|
@struct_data = args[:struct_data] if args.key?(:struct_data)
|
4597
|
+
@title = args[:title] if args.key?(:title)
|
4598
|
+
@uri = args[:uri] if args.key?(:uri)
|
4202
4599
|
end
|
4203
4600
|
end
|
4204
4601
|
|
@@ -4491,6 +4888,25 @@ module Google
|
|
4491
4888
|
end
|
4492
4889
|
end
|
4493
4890
|
|
4891
|
+
# The configuration for the BAP connector.
|
4892
|
+
class GoogleCloudDiscoveryengineV1alphaBapConfig
|
4893
|
+
include Google::Apis::Core::Hashable
|
4894
|
+
|
4895
|
+
# Required. The supported connector modes for the associated BAP connection.
|
4896
|
+
# Corresponds to the JSON property `supportedConnectorModes`
|
4897
|
+
# @return [Array<String>]
|
4898
|
+
attr_accessor :supported_connector_modes
|
4899
|
+
|
4900
|
+
def initialize(**args)
|
4901
|
+
update!(**args)
|
4902
|
+
end
|
4903
|
+
|
4904
|
+
# Update properties of this object
|
4905
|
+
def update!(**args)
|
4906
|
+
@supported_connector_modes = args[:supported_connector_modes] if args.key?(:supported_connector_modes)
|
4907
|
+
end
|
4908
|
+
end
|
4909
|
+
|
4494
4910
|
# Metadata related to the progress of the SiteSearchEngineService.
|
4495
4911
|
# BatchCreateTargetSites operation. This will be returned by the google.
|
4496
4912
|
# longrunning.Operation.metadata field.
|
@@ -4548,13 +4964,13 @@ module Google
|
|
4548
4964
|
attr_accessor :is_default
|
4549
4965
|
alias_method :is_default?, :is_default
|
4550
4966
|
|
4551
|
-
#
|
4967
|
+
# KMS key resource name which will be used to encrypt resources `projects/`
|
4552
4968
|
# project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
|
4553
4969
|
# Corresponds to the JSON property `kmsKey`
|
4554
4970
|
# @return [String]
|
4555
4971
|
attr_accessor :kms_key
|
4556
4972
|
|
4557
|
-
#
|
4973
|
+
# KMS key version resource name which will be used to encrypt resources `/
|
4558
4974
|
# cryptoKeyVersions/`keyVersion``.
|
4559
4975
|
# Corresponds to the JSON property `kmsKeyVersion`
|
4560
4976
|
# @return [String]
|
@@ -4565,9 +4981,9 @@ module Google
|
|
4565
4981
|
# @return [Fixnum]
|
4566
4982
|
attr_accessor :last_rotation_timestamp_micros
|
4567
4983
|
|
4568
|
-
# Required.
|
4569
|
-
# location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs
|
4570
|
-
# cmekConfig``.
|
4984
|
+
# Required. The name of the CmekConfig of the form `projects/`project`/locations/
|
4985
|
+
# `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
|
4986
|
+
# `cmekConfig``.
|
4571
4987
|
# Corresponds to the JSON property `name`
|
4572
4988
|
# @return [String]
|
4573
4989
|
attr_accessor :name
|
@@ -4577,7 +4993,7 @@ module Google
|
|
4577
4993
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSingleRegionKey>]
|
4578
4994
|
attr_accessor :single_region_keys
|
4579
4995
|
|
4580
|
-
# Output only.
|
4996
|
+
# Output only. The states of the CmekConfig.
|
4581
4997
|
# Corresponds to the JSON property `state`
|
4582
4998
|
# @return [String]
|
4583
4999
|
attr_accessor :state
|
@@ -4810,6 +5226,11 @@ module Google
|
|
4810
5226
|
class GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun
|
4811
5227
|
include Google::Apis::Core::Hashable
|
4812
5228
|
|
5229
|
+
# The number of documents deleted.
|
5230
|
+
# Corresponds to the JSON property `deletedRecordCount`
|
5231
|
+
# @return [Fixnum]
|
5232
|
+
attr_accessor :deleted_record_count
|
5233
|
+
|
4813
5234
|
# The name of the source entity.
|
4814
5235
|
# Corresponds to the JSON property `entityName`
|
4815
5236
|
# @return [String]
|
@@ -4870,6 +5291,7 @@ module Google
|
|
4870
5291
|
|
4871
5292
|
# Update properties of this object
|
4872
5293
|
def update!(**args)
|
5294
|
+
@deleted_record_count = args[:deleted_record_count] if args.key?(:deleted_record_count)
|
4873
5295
|
@entity_name = args[:entity_name] if args.key?(:entity_name)
|
4874
5296
|
@error_record_count = args[:error_record_count] if args.key?(:error_record_count)
|
4875
5297
|
@errors = args[:errors] if args.key?(:errors)
|
@@ -5009,6 +5431,13 @@ module Google
|
|
5009
5431
|
# @return [Float]
|
5010
5432
|
attr_accessor :fixed_boost
|
5011
5433
|
|
5434
|
+
# Specification for custom ranking based on customer specified attribute value.
|
5435
|
+
# It provides more controls for customized ranking than the simple (condition,
|
5436
|
+
# boost) combination above.
|
5437
|
+
# Corresponds to the JSON property `interpolationBoostSpec`
|
5438
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec]
|
5439
|
+
attr_accessor :interpolation_boost_spec
|
5440
|
+
|
5012
5441
|
def initialize(**args)
|
5013
5442
|
update!(**args)
|
5014
5443
|
end
|
@@ -5019,6 +5448,85 @@ module Google
|
|
5019
5448
|
@data_store = args[:data_store] if args.key?(:data_store)
|
5020
5449
|
@filter = args[:filter] if args.key?(:filter)
|
5021
5450
|
@fixed_boost = args[:fixed_boost] if args.key?(:fixed_boost)
|
5451
|
+
@interpolation_boost_spec = args[:interpolation_boost_spec] if args.key?(:interpolation_boost_spec)
|
5452
|
+
end
|
5453
|
+
end
|
5454
|
+
|
5455
|
+
# Specification for custom ranking based on customer specified attribute value.
|
5456
|
+
# It provides more controls for customized ranking than the simple (condition,
|
5457
|
+
# boost) combination above.
|
5458
|
+
class GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec
|
5459
|
+
include Google::Apis::Core::Hashable
|
5460
|
+
|
5461
|
+
# Optional. The attribute type to be used to determine the boost amount. The
|
5462
|
+
# attribute value can be derived from the field value of the specified
|
5463
|
+
# field_name. In the case of numerical it is straightforward i.e.
|
5464
|
+
# attribute_value = numerical_field_value. In the case of freshness however,
|
5465
|
+
# attribute_value = (time.now() - datetime_field_value).
|
5466
|
+
# Corresponds to the JSON property `attributeType`
|
5467
|
+
# @return [String]
|
5468
|
+
attr_accessor :attribute_type
|
5469
|
+
|
5470
|
+
# Optional. The control points used to define the curve. The monotonic function (
|
5471
|
+
# defined through the interpolation_type above) passes through the control
|
5472
|
+
# points listed here.
|
5473
|
+
# Corresponds to the JSON property `controlPoints`
|
5474
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint>]
|
5475
|
+
attr_accessor :control_points
|
5476
|
+
|
5477
|
+
# Optional. The name of the field whose value will be used to determine the
|
5478
|
+
# boost amount.
|
5479
|
+
# Corresponds to the JSON property `fieldName`
|
5480
|
+
# @return [String]
|
5481
|
+
attr_accessor :field_name
|
5482
|
+
|
5483
|
+
# Optional. The interpolation type to be applied to connect the control points
|
5484
|
+
# listed below.
|
5485
|
+
# Corresponds to the JSON property `interpolationType`
|
5486
|
+
# @return [String]
|
5487
|
+
attr_accessor :interpolation_type
|
5488
|
+
|
5489
|
+
def initialize(**args)
|
5490
|
+
update!(**args)
|
5491
|
+
end
|
5492
|
+
|
5493
|
+
# Update properties of this object
|
5494
|
+
def update!(**args)
|
5495
|
+
@attribute_type = args[:attribute_type] if args.key?(:attribute_type)
|
5496
|
+
@control_points = args[:control_points] if args.key?(:control_points)
|
5497
|
+
@field_name = args[:field_name] if args.key?(:field_name)
|
5498
|
+
@interpolation_type = args[:interpolation_type] if args.key?(:interpolation_type)
|
5499
|
+
end
|
5500
|
+
end
|
5501
|
+
|
5502
|
+
# The control points used to define the curve. The curve defined through these
|
5503
|
+
# control points can only be monotonically increasing or decreasing(constant
|
5504
|
+
# values are acceptable).
|
5505
|
+
class GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint
|
5506
|
+
include Google::Apis::Core::Hashable
|
5507
|
+
|
5508
|
+
# Optional. Can be one of: 1. The numerical field value. 2. The duration spec
|
5509
|
+
# for freshness: The value must be formatted as an XSD `dayTimeDuration` value (
|
5510
|
+
# a restricted subset of an ISO 8601 duration value). The pattern for this is: `
|
5511
|
+
# nDnM]`.
|
5512
|
+
# Corresponds to the JSON property `attributeValue`
|
5513
|
+
# @return [String]
|
5514
|
+
attr_accessor :attribute_value
|
5515
|
+
|
5516
|
+
# Optional. The value between -1 to 1 by which to boost the score if the
|
5517
|
+
# attribute_value evaluates to the value specified above.
|
5518
|
+
# Corresponds to the JSON property `boostAmount`
|
5519
|
+
# @return [Float]
|
5520
|
+
attr_accessor :boost_amount
|
5521
|
+
|
5522
|
+
def initialize(**args)
|
5523
|
+
update!(**args)
|
5524
|
+
end
|
5525
|
+
|
5526
|
+
# Update properties of this object
|
5527
|
+
def update!(**args)
|
5528
|
+
@attribute_value = args[:attribute_value] if args.key?(:attribute_value)
|
5529
|
+
@boost_amount = args[:boost_amount] if args.key?(:boost_amount)
|
5022
5530
|
end
|
5023
5531
|
end
|
5024
5532
|
|
@@ -5334,6 +5842,11 @@ module Google
|
|
5334
5842
|
attr_accessor :auto_run_disabled
|
5335
5843
|
alias_method :auto_run_disabled?, :auto_run_disabled
|
5336
5844
|
|
5845
|
+
# The configuration for the BAP connector.
|
5846
|
+
# Corresponds to the JSON property `bapConfig`
|
5847
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaBapConfig]
|
5848
|
+
attr_accessor :bap_config
|
5849
|
+
|
5337
5850
|
# Output only. User actions that must be completed before the connector can
|
5338
5851
|
# start syncing data.
|
5339
5852
|
# Corresponds to the JSON property `blockingReasons`
|
@@ -5431,7 +5944,7 @@ module Google
|
|
5431
5944
|
# pairs. Required parameters for all data sources: * Key: `instance_uri` * Value:
|
5432
5945
|
# type STRING. The uri to access the data source. Required parameters for
|
5433
5946
|
# sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value:
|
5434
|
-
# type STRING. The client
|
5947
|
+
# type STRING. The client ID for the third party service provider to identify
|
5435
5948
|
# your application. * Key: `client_secret` * Value:type STRING. The client
|
5436
5949
|
# secret generated by the third party authorization server. * Key: `access_token`
|
5437
5950
|
# * Value: type STRING. OAuth token for UCS to access to the protected resource.
|
@@ -5500,6 +6013,7 @@ module Google
|
|
5500
6013
|
def update!(**args)
|
5501
6014
|
@action_config = args[:action_config] if args.key?(:action_config)
|
5502
6015
|
@auto_run_disabled = args[:auto_run_disabled] if args.key?(:auto_run_disabled)
|
6016
|
+
@bap_config = args[:bap_config] if args.key?(:bap_config)
|
5503
6017
|
@blocking_reasons = args[:blocking_reasons] if args.key?(:blocking_reasons)
|
5504
6018
|
@create_time = args[:create_time] if args.key?(:create_time)
|
5505
6019
|
@data_source = args[:data_source] if args.key?(:data_source)
|
@@ -5545,6 +6059,11 @@ module Google
|
|
5545
6059
|
# @return [String]
|
5546
6060
|
attr_accessor :entity_name
|
5547
6061
|
|
6062
|
+
# Config to data store for `HEALTHCARE_FHIR` vertical.
|
6063
|
+
# Corresponds to the JSON property `healthcareFhirConfig`
|
6064
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig]
|
6065
|
+
attr_accessor :healthcare_fhir_config
|
6066
|
+
|
5548
6067
|
# Attributes for indexing. Key: Field name. Value: The key property to map a
|
5549
6068
|
# field to, such as `title`, and `description`. Supported key properties: * `
|
5550
6069
|
# title`: The title for data record. This would be displayed on search results. *
|
@@ -5554,13 +6073,18 @@ module Google
|
|
5554
6073
|
# @return [Hash<String,String>]
|
5555
6074
|
attr_accessor :key_property_mappings
|
5556
6075
|
|
5557
|
-
# The parameters for the entity to facilitate data ingestion. E.g. for
|
6076
|
+
# The parameters for the entity to facilitate data ingestion. E.g. for BigQuery
|
5558
6077
|
# connectors: * Key: `document_id_column` * Value: type STRING. The value of the
|
5559
|
-
# column
|
6078
|
+
# column ID.
|
5560
6079
|
# Corresponds to the JSON property `params`
|
5561
6080
|
# @return [Hash<String,Object>]
|
5562
6081
|
attr_accessor :params
|
5563
6082
|
|
6083
|
+
# Defines the structure and layout of a type of document data.
|
6084
|
+
# Corresponds to the JSON property `startingSchema`
|
6085
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSchema]
|
6086
|
+
attr_accessor :starting_schema
|
6087
|
+
|
5564
6088
|
def initialize(**args)
|
5565
6089
|
update!(**args)
|
5566
6090
|
end
|
@@ -5569,8 +6093,10 @@ module Google
|
|
5569
6093
|
def update!(**args)
|
5570
6094
|
@data_store = args[:data_store] if args.key?(:data_store)
|
5571
6095
|
@entity_name = args[:entity_name] if args.key?(:entity_name)
|
6096
|
+
@healthcare_fhir_config = args[:healthcare_fhir_config] if args.key?(:healthcare_fhir_config)
|
5572
6097
|
@key_property_mappings = args[:key_property_mappings] if args.key?(:key_property_mappings)
|
5573
6098
|
@params = args[:params] if args.key?(:params)
|
6099
|
+
@starting_schema = args[:starting_schema] if args.key?(:starting_schema)
|
5574
6100
|
end
|
5575
6101
|
end
|
5576
6102
|
|
@@ -5615,7 +6141,7 @@ module Google
|
|
5615
6141
|
# @return [String]
|
5616
6142
|
attr_accessor :create_time
|
5617
6143
|
|
5618
|
-
# Output only. The id of the default Schema
|
6144
|
+
# Output only. The id of the default Schema associated to this data store.
|
5619
6145
|
# Corresponds to the JSON property `defaultSchemaId`
|
5620
6146
|
# @return [String]
|
5621
6147
|
attr_accessor :default_schema_id
|
@@ -5634,6 +6160,19 @@ module Google
|
|
5634
6160
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig]
|
5635
6161
|
attr_accessor :document_processing_config
|
5636
6162
|
|
6163
|
+
# Config to data store for `HEALTHCARE_FHIR` vertical.
|
6164
|
+
# Corresponds to the JSON property `healthcareFhirConfig`
|
6165
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig]
|
6166
|
+
attr_accessor :healthcare_fhir_config
|
6167
|
+
|
6168
|
+
# Immutable. The fully qualified resource name of the associated
|
6169
|
+
# IdentityMappingStore. This field can only be set for acl_enabled DataStores
|
6170
|
+
# with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/`project`/locations/`
|
6171
|
+
# location`/identityMappingStores/`identity_mapping_store``.
|
6172
|
+
# Corresponds to the JSON property `identityMappingStore`
|
6173
|
+
# @return [String]
|
6174
|
+
attr_accessor :identity_mapping_store
|
6175
|
+
|
5637
6176
|
# Identity Provider Config.
|
5638
6177
|
# Corresponds to the JSON property `idpConfig`
|
5639
6178
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaIdpConfig]
|
@@ -5714,6 +6253,8 @@ module Google
|
|
5714
6253
|
@default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
|
5715
6254
|
@display_name = args[:display_name] if args.key?(:display_name)
|
5716
6255
|
@document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
|
6256
|
+
@healthcare_fhir_config = args[:healthcare_fhir_config] if args.key?(:healthcare_fhir_config)
|
6257
|
+
@identity_mapping_store = args[:identity_mapping_store] if args.key?(:identity_mapping_store)
|
5717
6258
|
@idp_config = args[:idp_config] if args.key?(:idp_config)
|
5718
6259
|
@industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
|
5719
6260
|
@is_infobot_faq_data_store = args[:is_infobot_faq_data_store] if args.key?(:is_infobot_faq_data_store)
|
@@ -5824,6 +6365,34 @@ module Google
|
|
5824
6365
|
end
|
5825
6366
|
end
|
5826
6367
|
|
6368
|
+
# Metadata related to the progress of the CmekConfigService.DeleteCmekConfig
|
6369
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
6370
|
+
# field.
|
6371
|
+
class GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata
|
6372
|
+
include Google::Apis::Core::Hashable
|
6373
|
+
|
6374
|
+
# Operation create time.
|
6375
|
+
# Corresponds to the JSON property `createTime`
|
6376
|
+
# @return [String]
|
6377
|
+
attr_accessor :create_time
|
6378
|
+
|
6379
|
+
# Operation last update time. If the operation is done, this is also the finish
|
6380
|
+
# time.
|
6381
|
+
# Corresponds to the JSON property `updateTime`
|
6382
|
+
# @return [String]
|
6383
|
+
attr_accessor :update_time
|
6384
|
+
|
6385
|
+
def initialize(**args)
|
6386
|
+
update!(**args)
|
6387
|
+
end
|
6388
|
+
|
6389
|
+
# Update properties of this object
|
6390
|
+
def update!(**args)
|
6391
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
6392
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
6393
|
+
end
|
6394
|
+
end
|
6395
|
+
|
5827
6396
|
# Metadata related to the progress of the CollectionService.UpdateCollection
|
5828
6397
|
# operation. This will be returned by the google.longrunning.Operation.metadata
|
5829
6398
|
# field.
|
@@ -6486,6 +7055,17 @@ module Google
|
|
6486
7055
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig]
|
6487
7056
|
attr_accessor :agent_creation_config
|
6488
7057
|
|
7058
|
+
# Optional. If the flag set to true, we allow the agent and engine are in
|
7059
|
+
# different locations, otherwise the agent and engine are required to be in the
|
7060
|
+
# same location. The flag is set to false by default. Note that the `
|
7061
|
+
# allow_cross_region` are one-time consumed by and passed to EngineService.
|
7062
|
+
# CreateEngine. It means they cannot be retrieved using EngineService.GetEngine
|
7063
|
+
# or EngineService.ListEngines API after engine creation.
|
7064
|
+
# Corresponds to the JSON property `allowCrossRegion`
|
7065
|
+
# @return [Boolean]
|
7066
|
+
attr_accessor :allow_cross_region
|
7067
|
+
alias_method :allow_cross_region?, :allow_cross_region
|
7068
|
+
|
6489
7069
|
# The resource name of an exist Dialogflow agent to link to this Chat Engine.
|
6490
7070
|
# Customers can either provide `agent_creation_config` to create agent or
|
6491
7071
|
# provide an agent name that links the agent with the Chat engine. Format: `
|
@@ -6505,6 +7085,7 @@ module Google
|
|
6505
7085
|
# Update properties of this object
|
6506
7086
|
def update!(**args)
|
6507
7087
|
@agent_creation_config = args[:agent_creation_config] if args.key?(:agent_creation_config)
|
7088
|
+
@allow_cross_region = args[:allow_cross_region] if args.key?(:allow_cross_region)
|
6508
7089
|
@dialogflow_agent_to_link = args[:dialogflow_agent_to_link] if args.key?(:dialogflow_agent_to_link)
|
6509
7090
|
end
|
6510
7091
|
end
|
@@ -6920,44 +7501,6 @@ module Google
|
|
6920
7501
|
end
|
6921
7502
|
end
|
6922
7503
|
|
6923
|
-
# Response message for SiteSearchEngineService.FetchSitemaps method.
|
6924
|
-
class GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse
|
6925
|
-
include Google::Apis::Core::Hashable
|
6926
|
-
|
6927
|
-
# List of Sitemaps fetched.
|
6928
|
-
# Corresponds to the JSON property `sitemapsMetadata`
|
6929
|
-
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata>]
|
6930
|
-
attr_accessor :sitemaps_metadata
|
6931
|
-
|
6932
|
-
def initialize(**args)
|
6933
|
-
update!(**args)
|
6934
|
-
end
|
6935
|
-
|
6936
|
-
# Update properties of this object
|
6937
|
-
def update!(**args)
|
6938
|
-
@sitemaps_metadata = args[:sitemaps_metadata] if args.key?(:sitemaps_metadata)
|
6939
|
-
end
|
6940
|
-
end
|
6941
|
-
|
6942
|
-
# Contains a Sitemap and its metadata.
|
6943
|
-
class GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata
|
6944
|
-
include Google::Apis::Core::Hashable
|
6945
|
-
|
6946
|
-
# A sitemap for the SiteSearchEngine.
|
6947
|
-
# Corresponds to the JSON property `sitemap`
|
6948
|
-
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSitemap]
|
6949
|
-
attr_accessor :sitemap
|
6950
|
-
|
6951
|
-
def initialize(**args)
|
6952
|
-
update!(**args)
|
6953
|
-
end
|
6954
|
-
|
6955
|
-
# Update properties of this object
|
6956
|
-
def update!(**args)
|
6957
|
-
@sitemap = args[:sitemap] if args.key?(:sitemap)
|
6958
|
-
end
|
6959
|
-
end
|
6960
|
-
|
6961
7504
|
# Configurations for fields of a schema. For example, configuring a field is
|
6962
7505
|
# indexable, or searchable.
|
6963
7506
|
class GoogleCloudDiscoveryengineV1alphaFieldConfig
|
@@ -7156,6 +7699,70 @@ module Google
|
|
7156
7699
|
end
|
7157
7700
|
end
|
7158
7701
|
|
7702
|
+
# Config to data store for `HEALTHCARE_FHIR` vertical.
|
7703
|
+
class GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig
|
7704
|
+
include Google::Apis::Core::Hashable
|
7705
|
+
|
7706
|
+
# Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set
|
7707
|
+
# to `true`, the predefined healthcare fhir schema can be extended for more
|
7708
|
+
# customized searching and filtering.
|
7709
|
+
# Corresponds to the JSON property `enableConfigurableSchema`
|
7710
|
+
# @return [Boolean]
|
7711
|
+
attr_accessor :enable_configurable_schema
|
7712
|
+
alias_method :enable_configurable_schema?, :enable_configurable_schema
|
7713
|
+
|
7714
|
+
# Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If
|
7715
|
+
# set to `true`, the batch ingestion will be processed in a static indexing mode
|
7716
|
+
# which is slower but more capable of handling larger volume.
|
7717
|
+
# Corresponds to the JSON property `enableStaticIndexingForBatchIngestion`
|
7718
|
+
# @return [Boolean]
|
7719
|
+
attr_accessor :enable_static_indexing_for_batch_ingestion
|
7720
|
+
alias_method :enable_static_indexing_for_batch_ingestion?, :enable_static_indexing_for_batch_ingestion
|
7721
|
+
|
7722
|
+
def initialize(**args)
|
7723
|
+
update!(**args)
|
7724
|
+
end
|
7725
|
+
|
7726
|
+
# Update properties of this object
|
7727
|
+
def update!(**args)
|
7728
|
+
@enable_configurable_schema = args[:enable_configurable_schema] if args.key?(:enable_configurable_schema)
|
7729
|
+
@enable_static_indexing_for_batch_ingestion = args[:enable_static_indexing_for_batch_ingestion] if args.key?(:enable_static_indexing_for_batch_ingestion)
|
7730
|
+
end
|
7731
|
+
end
|
7732
|
+
|
7733
|
+
# IdentityMappingEntry LongRunningOperation metadata for
|
7734
|
+
# IdentityMappingStoreService.ImportIdentityMappings and
|
7735
|
+
# IdentityMappingStoreService.PurgeIdentityMappings
|
7736
|
+
class GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata
|
7737
|
+
include Google::Apis::Core::Hashable
|
7738
|
+
|
7739
|
+
# The number of IdentityMappingEntries that failed to be processed.
|
7740
|
+
# Corresponds to the JSON property `failureCount`
|
7741
|
+
# @return [Fixnum]
|
7742
|
+
attr_accessor :failure_count
|
7743
|
+
|
7744
|
+
# The number of IdentityMappingEntries that were successfully processed.
|
7745
|
+
# Corresponds to the JSON property `successCount`
|
7746
|
+
# @return [Fixnum]
|
7747
|
+
attr_accessor :success_count
|
7748
|
+
|
7749
|
+
# The total number of IdentityMappingEntries that were processed.
|
7750
|
+
# Corresponds to the JSON property `totalCount`
|
7751
|
+
# @return [Fixnum]
|
7752
|
+
attr_accessor :total_count
|
7753
|
+
|
7754
|
+
def initialize(**args)
|
7755
|
+
update!(**args)
|
7756
|
+
end
|
7757
|
+
|
7758
|
+
# Update properties of this object
|
7759
|
+
def update!(**args)
|
7760
|
+
@failure_count = args[:failure_count] if args.key?(:failure_count)
|
7761
|
+
@success_count = args[:success_count] if args.key?(:success_count)
|
7762
|
+
@total_count = args[:total_count] if args.key?(:total_count)
|
7763
|
+
end
|
7764
|
+
end
|
7765
|
+
|
7159
7766
|
# The configuration for the identity data synchronization runs.
|
7160
7767
|
class GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig
|
7161
7768
|
include Google::Apis::Core::Hashable
|
@@ -7400,20 +8007,39 @@ module Google
|
|
7400
8007
|
end
|
7401
8008
|
end
|
7402
8009
|
|
7403
|
-
#
|
7404
|
-
|
7405
|
-
class GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata
|
8010
|
+
# Response message for IdentityMappingStoreService.ImportIdentityMappings
|
8011
|
+
class GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse
|
7406
8012
|
include Google::Apis::Core::Hashable
|
7407
8013
|
|
7408
|
-
#
|
7409
|
-
# Corresponds to the JSON property `
|
7410
|
-
# @return [
|
7411
|
-
attr_accessor :
|
8014
|
+
# A sample of errors encountered while processing the request.
|
8015
|
+
# Corresponds to the JSON property `errorSamples`
|
8016
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
|
8017
|
+
attr_accessor :error_samples
|
7412
8018
|
|
7413
|
-
|
7414
|
-
|
7415
|
-
|
7416
|
-
|
8019
|
+
def initialize(**args)
|
8020
|
+
update!(**args)
|
8021
|
+
end
|
8022
|
+
|
8023
|
+
# Update properties of this object
|
8024
|
+
def update!(**args)
|
8025
|
+
@error_samples = args[:error_samples] if args.key?(:error_samples)
|
8026
|
+
end
|
8027
|
+
end
|
8028
|
+
|
8029
|
+
# Metadata related to the progress of the ImportSampleQueries operation. This
|
8030
|
+
# will be returned by the google.longrunning.Operation.metadata field.
|
8031
|
+
class GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata
|
8032
|
+
include Google::Apis::Core::Hashable
|
8033
|
+
|
8034
|
+
# ImportSampleQueries operation create time.
|
8035
|
+
# Corresponds to the JSON property `createTime`
|
8036
|
+
# @return [String]
|
8037
|
+
attr_accessor :create_time
|
8038
|
+
|
8039
|
+
# Count of SampleQuerys that failed to be imported.
|
8040
|
+
# Corresponds to the JSON property `failureCount`
|
8041
|
+
# @return [Fixnum]
|
8042
|
+
attr_accessor :failure_count
|
7417
8043
|
|
7418
8044
|
# Count of SampleQuerys successfully imported.
|
7419
8045
|
# Corresponds to the JSON property `successCount`
|
@@ -8327,6 +8953,16 @@ module Google
|
|
8327
8953
|
# @return [Fixnum]
|
8328
8954
|
attr_accessor :invalid_uris_count
|
8329
8955
|
|
8956
|
+
# URIs that have no index meta tag. Sample limited to 1000.
|
8957
|
+
# Corresponds to the JSON property `noindexUris`
|
8958
|
+
# @return [Array<String>]
|
8959
|
+
attr_accessor :noindex_uris
|
8960
|
+
|
8961
|
+
# Total number of URIs that have no index meta tag.
|
8962
|
+
# Corresponds to the JSON property `noindexUrisCount`
|
8963
|
+
# @return [Fixnum]
|
8964
|
+
attr_accessor :noindex_uris_count
|
8965
|
+
|
8330
8966
|
# Total number of URIs that have yet to be crawled.
|
8331
8967
|
# Corresponds to the JSON property `pendingCount`
|
8332
8968
|
# @return [Fixnum]
|
@@ -8374,6 +9010,8 @@ module Google
|
|
8374
9010
|
@create_time = args[:create_time] if args.key?(:create_time)
|
8375
9011
|
@invalid_uris = args[:invalid_uris] if args.key?(:invalid_uris)
|
8376
9012
|
@invalid_uris_count = args[:invalid_uris_count] if args.key?(:invalid_uris_count)
|
9013
|
+
@noindex_uris = args[:noindex_uris] if args.key?(:noindex_uris)
|
9014
|
+
@noindex_uris_count = args[:noindex_uris_count] if args.key?(:noindex_uris_count)
|
8377
9015
|
@pending_count = args[:pending_count] if args.key?(:pending_count)
|
8378
9016
|
@quota_exceeded_count = args[:quota_exceeded_count] if args.key?(:quota_exceeded_count)
|
8379
9017
|
@success_count = args[:success_count] if args.key?(:success_count)
|
@@ -8706,6 +9344,11 @@ module Google
|
|
8706
9344
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec>]
|
8707
9345
|
attr_accessor :data_store_specs
|
8708
9346
|
|
9347
|
+
# Specifies features for display, like match highlighting.
|
9348
|
+
# Corresponds to the JSON property `displaySpec`
|
9349
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec]
|
9350
|
+
attr_accessor :display_spec
|
9351
|
+
|
8709
9352
|
# The specification that uses customized query embedding vector to do semantic
|
8710
9353
|
# document retrieval.
|
8711
9354
|
# Corresponds to the JSON property `embeddingSpec`
|
@@ -8824,21 +9467,41 @@ module Google
|
|
8824
9467
|
attr_accessor :query_expansion_spec
|
8825
9468
|
|
8826
9469
|
# The ranking expression controls the customized ranking on retrieval documents.
|
8827
|
-
# This overrides ServingConfig.ranking_expression. The
|
8828
|
-
#
|
8829
|
-
#
|
8830
|
-
#
|
8831
|
-
#
|
8832
|
-
#
|
8833
|
-
#
|
8834
|
-
#
|
8835
|
-
#
|
8836
|
-
#
|
8837
|
-
#
|
9470
|
+
# This overrides ServingConfig.ranking_expression. The syntax and supported
|
9471
|
+
# features depend on the ranking_expression_backend value. If
|
9472
|
+
# ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
|
9473
|
+
# If ranking expression is not provided or set to BYOE, it should be a single
|
9474
|
+
# function or multiple functions that are joined by "+". * ranking_expression =
|
9475
|
+
# function, ` " + ", function `; Supported functions: * double * relevance_score
|
9476
|
+
# * double * dotProduct(embedding_field_path) Function variables: * `
|
9477
|
+
# relevance_score`: pre-defined keywords, used for measure relevance between
|
9478
|
+
# query and document. * `embedding_field_path`: the document embedding field
|
9479
|
+
# used with query embedding vector. * `dotProduct`: embedding function between
|
9480
|
+
# embedding_field_path and query embedding vector. Example ranking expression:
|
9481
|
+
# If document has an embedding field doc_embedding, the ranking expression could
|
9482
|
+
# be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX ===
|
9483
|
+
# If ranking expression is set to CLEARBOX, the following expression types (and
|
9484
|
+
# combinations of those chained using + or * operators) are supported: * double *
|
9485
|
+
# signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal
|
9486
|
+
# rank transformation with second argument being a denominator constant. *
|
9487
|
+
# is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1,
|
9488
|
+
# signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns
|
9489
|
+
# signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(
|
9490
|
+
# fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score,
|
9491
|
+
# 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: *
|
9492
|
+
# gecko_score -- semantic similarity adjustment * bm25_score -- keyword match
|
9493
|
+
# adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank --
|
9494
|
+
# predicted conversion rate adjustment as a rank * freshness_rank -- freshness
|
9495
|
+
# adjustment as a rank * base_rank -- the default rank of the result
|
8838
9496
|
# Corresponds to the JSON property `rankingExpression`
|
8839
9497
|
# @return [String]
|
8840
9498
|
attr_accessor :ranking_expression
|
8841
9499
|
|
9500
|
+
# Optional. The backend to use for the ranking expression evaluation.
|
9501
|
+
# Corresponds to the JSON property `rankingExpressionBackend`
|
9502
|
+
# @return [String]
|
9503
|
+
attr_accessor :ranking_expression_backend
|
9504
|
+
|
8842
9505
|
# The Unicode country/region code (CLDR) of a location, such as "US" and "419".
|
8843
9506
|
# For more information, see [Standard fields](https://cloud.google.com/apis/
|
8844
9507
|
# design/standard_fields). If set, then results will be boosted based on the
|
@@ -8847,9 +9510,15 @@ module Google
|
|
8847
9510
|
# @return [String]
|
8848
9511
|
attr_accessor :region_code
|
8849
9512
|
|
9513
|
+
# The specification for returning the document relevance score.
|
9514
|
+
# Corresponds to the JSON property `relevanceScoreSpec`
|
9515
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec]
|
9516
|
+
attr_accessor :relevance_score_spec
|
9517
|
+
|
8850
9518
|
# The relevance threshold of the search results. Default to Google defined
|
8851
9519
|
# threshold, leveraging a balance of precision and recall to deliver both highly
|
8852
|
-
# accurate results and comprehensive coverage of relevant information.
|
9520
|
+
# accurate results and comprehensive coverage of relevant information. This
|
9521
|
+
# feature is not supported for healthcare search.
|
8853
9522
|
# Corresponds to the JSON property `relevanceThreshold`
|
8854
9523
|
# @return [String]
|
8855
9524
|
attr_accessor :relevance_threshold
|
@@ -8952,6 +9621,7 @@ module Google
|
|
8952
9621
|
@content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
|
8953
9622
|
@custom_fine_tuning_spec = args[:custom_fine_tuning_spec] if args.key?(:custom_fine_tuning_spec)
|
8954
9623
|
@data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
|
9624
|
+
@display_spec = args[:display_spec] if args.key?(:display_spec)
|
8955
9625
|
@embedding_spec = args[:embedding_spec] if args.key?(:embedding_spec)
|
8956
9626
|
@facet_specs = args[:facet_specs] if args.key?(:facet_specs)
|
8957
9627
|
@filter = args[:filter] if args.key?(:filter)
|
@@ -8968,7 +9638,9 @@ module Google
|
|
8968
9638
|
@query = args[:query] if args.key?(:query)
|
8969
9639
|
@query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
|
8970
9640
|
@ranking_expression = args[:ranking_expression] if args.key?(:ranking_expression)
|
9641
|
+
@ranking_expression_backend = args[:ranking_expression_backend] if args.key?(:ranking_expression_backend)
|
8971
9642
|
@region_code = args[:region_code] if args.key?(:region_code)
|
9643
|
+
@relevance_score_spec = args[:relevance_score_spec] if args.key?(:relevance_score_spec)
|
8972
9644
|
@relevance_threshold = args[:relevance_threshold] if args.key?(:relevance_threshold)
|
8973
9645
|
@safe_search = args[:safe_search] if args.key?(:safe_search)
|
8974
9646
|
@search_as_you_type_spec = args[:search_as_you_type_spec] if args.key?(:search_as_you_type_spec)
|
@@ -9506,6 +10178,25 @@ module Google
|
|
9506
10178
|
end
|
9507
10179
|
end
|
9508
10180
|
|
10181
|
+
# Specifies features for display, like match highlighting.
|
10182
|
+
class GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec
|
10183
|
+
include Google::Apis::Core::Hashable
|
10184
|
+
|
10185
|
+
# The condition under which match highlighting should occur.
|
10186
|
+
# Corresponds to the JSON property `matchHighlightingCondition`
|
10187
|
+
# @return [String]
|
10188
|
+
attr_accessor :match_highlighting_condition
|
10189
|
+
|
10190
|
+
def initialize(**args)
|
10191
|
+
update!(**args)
|
10192
|
+
end
|
10193
|
+
|
10194
|
+
# Update properties of this object
|
10195
|
+
def update!(**args)
|
10196
|
+
@match_highlighting_condition = args[:match_highlighting_condition] if args.key?(:match_highlighting_condition)
|
10197
|
+
end
|
10198
|
+
end
|
10199
|
+
|
9509
10200
|
# The specification that uses customized query embedding vector to do semantic
|
9510
10201
|
# document retrieval.
|
9511
10202
|
class GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec
|
@@ -9799,6 +10490,27 @@ module Google
|
|
9799
10490
|
end
|
9800
10491
|
end
|
9801
10492
|
|
10493
|
+
# The specification for returning the document relevance score.
|
10494
|
+
class GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec
|
10495
|
+
include Google::Apis::Core::Hashable
|
10496
|
+
|
10497
|
+
# Optional. Whether to return the relevance score for search results. The higher
|
10498
|
+
# the score, the more relevant the document is to the query.
|
10499
|
+
# Corresponds to the JSON property `returnRelevanceScore`
|
10500
|
+
# @return [Boolean]
|
10501
|
+
attr_accessor :return_relevance_score
|
10502
|
+
alias_method :return_relevance_score?, :return_relevance_score
|
10503
|
+
|
10504
|
+
def initialize(**args)
|
10505
|
+
update!(**args)
|
10506
|
+
end
|
10507
|
+
|
10508
|
+
# Update properties of this object
|
10509
|
+
def update!(**args)
|
10510
|
+
@return_relevance_score = args[:return_relevance_score] if args.key?(:return_relevance_score)
|
10511
|
+
end
|
10512
|
+
end
|
10513
|
+
|
9802
10514
|
# Specification for search as you type in search requests.
|
9803
10515
|
class GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec
|
9804
10516
|
include Google::Apis::Core::Hashable
|
@@ -9840,7 +10552,7 @@ module Google
|
|
9840
10552
|
attr_accessor :query_id
|
9841
10553
|
|
9842
10554
|
# The number of top search results to persist. The persisted search results can
|
9843
|
-
# be used for the subsequent /answer api call. This field is
|
10555
|
+
# be used for the subsequent /answer api call. This field is similar to the `
|
9844
10556
|
# summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.
|
9845
10557
|
# summary_result_count. At most 10 results for documents mode, or 50 for chunks
|
9846
10558
|
# mode.
|
@@ -10642,20 +11354,26 @@ module Google
|
|
10642
11354
|
# @return [String]
|
10643
11355
|
attr_accessor :query
|
10644
11356
|
|
10645
|
-
# Specifies the autocomplete
|
10646
|
-
#
|
10647
|
-
#
|
10648
|
-
#
|
10649
|
-
#
|
10650
|
-
#
|
10651
|
-
#
|
10652
|
-
#
|
10653
|
-
#
|
10654
|
-
#
|
11357
|
+
# Specifies the autocomplete query model, which only applies to the QUERY
|
11358
|
+
# SuggestionType. This overrides any model specified in the Configuration >
|
11359
|
+
# Autocomplete section of the Cloud console. Currently supported values: * `
|
11360
|
+
# document` - Using suggestions generated from user-imported documents. * `
|
11361
|
+
# search-history` - Using suggestions generated from the past history of
|
11362
|
+
# SearchService.Search API calls. Do not use it when there is no traffic for
|
11363
|
+
# Search API. * `user-event` - Using suggestions generated from user-imported
|
11364
|
+
# search events. * `document-completable` - Using suggestions taken directly
|
11365
|
+
# from user-imported document fields marked as completable. Default values: * `
|
11366
|
+
# document` is the default model for regular dataStores. * `search-history` is
|
11367
|
+
# the default model for site search dataStores.
|
10655
11368
|
# Corresponds to the JSON property `queryModel`
|
10656
11369
|
# @return [String]
|
10657
11370
|
attr_accessor :query_model
|
10658
11371
|
|
11372
|
+
# Optional. Specification of each suggestion type.
|
11373
|
+
# Corresponds to the JSON property `suggestionTypeSpecs`
|
11374
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestSuggestionTypeSpec>]
|
11375
|
+
attr_accessor :suggestion_type_specs
|
11376
|
+
|
10659
11377
|
# Optional. Suggestion types to return. If empty or unspecified, query
|
10660
11378
|
# suggestions are returned. Only one suggestion type is supported at the moment.
|
10661
11379
|
# Corresponds to the JSON property `suggestionTypes`
|
@@ -10688,6 +11406,7 @@ module Google
|
|
10688
11406
|
@include_tail_suggestions = args[:include_tail_suggestions] if args.key?(:include_tail_suggestions)
|
10689
11407
|
@query = args[:query] if args.key?(:query)
|
10690
11408
|
@query_model = args[:query_model] if args.key?(:query_model)
|
11409
|
+
@suggestion_type_specs = args[:suggestion_type_specs] if args.key?(:suggestion_type_specs)
|
10691
11410
|
@suggestion_types = args[:suggestion_types] if args.key?(:suggestion_types)
|
10692
11411
|
@user_info = args[:user_info] if args.key?(:user_info)
|
10693
11412
|
@user_pseudo_id = args[:user_pseudo_id] if args.key?(:user_pseudo_id)
|
@@ -10750,6 +11469,31 @@ module Google
|
|
10750
11469
|
end
|
10751
11470
|
end
|
10752
11471
|
|
11472
|
+
# Specification of each suggestion type.
|
11473
|
+
class GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestSuggestionTypeSpec
|
11474
|
+
include Google::Apis::Core::Hashable
|
11475
|
+
|
11476
|
+
# Optional. Maximum number of suggestions to return for each suggestion type.
|
11477
|
+
# Corresponds to the JSON property `maxSuggestions`
|
11478
|
+
# @return [Fixnum]
|
11479
|
+
attr_accessor :max_suggestions
|
11480
|
+
|
11481
|
+
# Optional. Suggestion type.
|
11482
|
+
# Corresponds to the JSON property `suggestionType`
|
11483
|
+
# @return [String]
|
11484
|
+
attr_accessor :suggestion_type
|
11485
|
+
|
11486
|
+
def initialize(**args)
|
11487
|
+
update!(**args)
|
11488
|
+
end
|
11489
|
+
|
11490
|
+
# Update properties of this object
|
11491
|
+
def update!(**args)
|
11492
|
+
@max_suggestions = args[:max_suggestions] if args.key?(:max_suggestions)
|
11493
|
+
@suggestion_type = args[:suggestion_type] if args.key?(:suggestion_type)
|
11494
|
+
end
|
11495
|
+
end
|
11496
|
+
|
10753
11497
|
# Response message for CompletionService.AdvancedCompleteQuery method.
|
10754
11498
|
class GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse
|
10755
11499
|
include Google::Apis::Core::Hashable
|
@@ -10814,12 +11558,27 @@ module Google
|
|
10814
11558
|
# @return [String]
|
10815
11559
|
attr_accessor :data_store
|
10816
11560
|
|
11561
|
+
# The destination uri of the content suggestion.
|
11562
|
+
# Corresponds to the JSON property `destinationUri`
|
11563
|
+
# @return [String]
|
11564
|
+
attr_accessor :destination_uri
|
11565
|
+
|
10817
11566
|
# Document captures all raw metadata information of items to be recommended or
|
10818
11567
|
# searched.
|
10819
11568
|
# Corresponds to the JSON property `document`
|
10820
11569
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument]
|
10821
11570
|
attr_accessor :document
|
10822
11571
|
|
11572
|
+
# The icon uri of the content suggestion.
|
11573
|
+
# Corresponds to the JSON property `iconUri`
|
11574
|
+
# @return [String]
|
11575
|
+
attr_accessor :icon_uri
|
11576
|
+
|
11577
|
+
# The score of each suggestion. The score is in the range of [0, 1].
|
11578
|
+
# Corresponds to the JSON property `score`
|
11579
|
+
# @return [Float]
|
11580
|
+
attr_accessor :score
|
11581
|
+
|
10823
11582
|
# The suggestion for the query.
|
10824
11583
|
# Corresponds to the JSON property `suggestion`
|
10825
11584
|
# @return [String]
|
@@ -10833,7 +11592,10 @@ module Google
|
|
10833
11592
|
def update!(**args)
|
10834
11593
|
@content_type = args[:content_type] if args.key?(:content_type)
|
10835
11594
|
@data_store = args[:data_store] if args.key?(:data_store)
|
11595
|
+
@destination_uri = args[:destination_uri] if args.key?(:destination_uri)
|
10836
11596
|
@document = args[:document] if args.key?(:document)
|
11597
|
+
@icon_uri = args[:icon_uri] if args.key?(:icon_uri)
|
11598
|
+
@score = args[:score] if args.key?(:score)
|
10837
11599
|
@suggestion = args[:suggestion] if args.key?(:suggestion)
|
10838
11600
|
end
|
10839
11601
|
end
|
@@ -10847,6 +11609,16 @@ module Google
|
|
10847
11609
|
# @return [String]
|
10848
11610
|
attr_accessor :data_store
|
10849
11611
|
|
11612
|
+
# The destination uri of the person suggestion.
|
11613
|
+
# Corresponds to the JSON property `destinationUri`
|
11614
|
+
# @return [String]
|
11615
|
+
attr_accessor :destination_uri
|
11616
|
+
|
11617
|
+
# The photo uri of the person suggestion.
|
11618
|
+
# Corresponds to the JSON property `displayPhotoUri`
|
11619
|
+
# @return [String]
|
11620
|
+
attr_accessor :display_photo_uri
|
11621
|
+
|
10850
11622
|
# Document captures all raw metadata information of items to be recommended or
|
10851
11623
|
# searched.
|
10852
11624
|
# Corresponds to the JSON property `document`
|
@@ -10858,6 +11630,11 @@ module Google
|
|
10858
11630
|
# @return [String]
|
10859
11631
|
attr_accessor :person_type
|
10860
11632
|
|
11633
|
+
# The score of each suggestion. The score is in the range of [0, 1].
|
11634
|
+
# Corresponds to the JSON property `score`
|
11635
|
+
# @return [Float]
|
11636
|
+
attr_accessor :score
|
11637
|
+
|
10861
11638
|
# The suggestion for the query.
|
10862
11639
|
# Corresponds to the JSON property `suggestion`
|
10863
11640
|
# @return [String]
|
@@ -10870,8 +11647,11 @@ module Google
|
|
10870
11647
|
# Update properties of this object
|
10871
11648
|
def update!(**args)
|
10872
11649
|
@data_store = args[:data_store] if args.key?(:data_store)
|
11650
|
+
@destination_uri = args[:destination_uri] if args.key?(:destination_uri)
|
11651
|
+
@display_photo_uri = args[:display_photo_uri] if args.key?(:display_photo_uri)
|
10873
11652
|
@document = args[:document] if args.key?(:document)
|
10874
11653
|
@person_type = args[:person_type] if args.key?(:person_type)
|
11654
|
+
@score = args[:score] if args.key?(:score)
|
10875
11655
|
@suggestion = args[:suggestion] if args.key?(:suggestion)
|
10876
11656
|
end
|
10877
11657
|
end
|
@@ -10892,6 +11672,11 @@ module Google
|
|
10892
11672
|
# @return [Array<String>]
|
10893
11673
|
attr_accessor :data_store
|
10894
11674
|
|
11675
|
+
# The score of each suggestion. The score is in the range of [0, 1].
|
11676
|
+
# Corresponds to the JSON property `score`
|
11677
|
+
# @return [Float]
|
11678
|
+
attr_accessor :score
|
11679
|
+
|
10895
11680
|
# The suggestion for the query.
|
10896
11681
|
# Corresponds to the JSON property `suggestion`
|
10897
11682
|
# @return [String]
|
@@ -10905,6 +11690,7 @@ module Google
|
|
10905
11690
|
def update!(**args)
|
10906
11691
|
@completable_field_paths = args[:completable_field_paths] if args.key?(:completable_field_paths)
|
10907
11692
|
@data_store = args[:data_store] if args.key?(:data_store)
|
11693
|
+
@score = args[:score] if args.key?(:score)
|
10908
11694
|
@suggestion = args[:suggestion] if args.key?(:suggestion)
|
10909
11695
|
end
|
10910
11696
|
end
|
@@ -10918,6 +11704,11 @@ module Google
|
|
10918
11704
|
# @return [String]
|
10919
11705
|
attr_accessor :recent_search_time
|
10920
11706
|
|
11707
|
+
# The score of each suggestion. The score is in the range of [0, 1].
|
11708
|
+
# Corresponds to the JSON property `score`
|
11709
|
+
# @return [Float]
|
11710
|
+
attr_accessor :score
|
11711
|
+
|
10921
11712
|
# The suggestion for the query.
|
10922
11713
|
# Corresponds to the JSON property `suggestion`
|
10923
11714
|
# @return [String]
|
@@ -10930,6 +11721,7 @@ module Google
|
|
10930
11721
|
# Update properties of this object
|
10931
11722
|
def update!(**args)
|
10932
11723
|
@recent_search_time = args[:recent_search_time] if args.key?(:recent_search_time)
|
11724
|
+
@score = args[:score] if args.key?(:score)
|
10933
11725
|
@suggestion = args[:suggestion] if args.key?(:suggestion)
|
10934
11726
|
end
|
10935
11727
|
end
|
@@ -11123,7 +11915,9 @@ module Google
|
|
11123
11915
|
class GoogleCloudDiscoveryengineV1betaAnswerCitation
|
11124
11916
|
include Google::Apis::Core::Hashable
|
11125
11917
|
|
11126
|
-
# End of the attributed segment, exclusive.
|
11918
|
+
# End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode).
|
11919
|
+
# If there are multi-byte characters,such as non-ASCII characters, the index
|
11920
|
+
# measurement is longer than the string length.
|
11127
11921
|
# Corresponds to the JSON property `endIndex`
|
11128
11922
|
# @return [Fixnum]
|
11129
11923
|
attr_accessor :end_index
|
@@ -11134,6 +11928,8 @@ module Google
|
|
11134
11928
|
attr_accessor :sources
|
11135
11929
|
|
11136
11930
|
# Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
|
11931
|
+
# If there are multi-byte characters,such as non-ASCII characters, the index
|
11932
|
+
# measurement is longer than the string length.
|
11137
11933
|
# Corresponds to the JSON property `startIndex`
|
11138
11934
|
# @return [Fixnum]
|
11139
11935
|
attr_accessor :start_index
|
@@ -11239,6 +12035,11 @@ module Google
|
|
11239
12035
|
attr_accessor :asynchronous_mode
|
11240
12036
|
alias_method :asynchronous_mode?, :asynchronous_mode
|
11241
12037
|
|
12038
|
+
# End user specification.
|
12039
|
+
# Corresponds to the JSON property `endUserSpec`
|
12040
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpec]
|
12041
|
+
attr_accessor :end_user_spec
|
12042
|
+
|
11242
12043
|
# Grounding specification.
|
11243
12044
|
# Corresponds to the JSON property `groundingSpec`
|
11244
12045
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestGroundingSpec]
|
@@ -11314,6 +12115,7 @@ module Google
|
|
11314
12115
|
def update!(**args)
|
11315
12116
|
@answer_generation_spec = args[:answer_generation_spec] if args.key?(:answer_generation_spec)
|
11316
12117
|
@asynchronous_mode = args[:asynchronous_mode] if args.key?(:asynchronous_mode)
|
12118
|
+
@end_user_spec = args[:end_user_spec] if args.key?(:end_user_spec)
|
11317
12119
|
@grounding_spec = args[:grounding_spec] if args.key?(:grounding_spec)
|
11318
12120
|
@query = args[:query] if args.key?(:query)
|
11319
12121
|
@query_understanding_spec = args[:query_understanding_spec] if args.key?(:query_understanding_spec)
|
@@ -11454,6 +12256,90 @@ module Google
|
|
11454
12256
|
end
|
11455
12257
|
end
|
11456
12258
|
|
12259
|
+
# End user specification.
|
12260
|
+
class GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpec
|
12261
|
+
include Google::Apis::Core::Hashable
|
12262
|
+
|
12263
|
+
# Optional. End user metadata.
|
12264
|
+
# Corresponds to the JSON property `endUserMetadata`
|
12265
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaData>]
|
12266
|
+
attr_accessor :end_user_metadata
|
12267
|
+
|
12268
|
+
def initialize(**args)
|
12269
|
+
update!(**args)
|
12270
|
+
end
|
12271
|
+
|
12272
|
+
# Update properties of this object
|
12273
|
+
def update!(**args)
|
12274
|
+
@end_user_metadata = args[:end_user_metadata] if args.key?(:end_user_metadata)
|
12275
|
+
end
|
12276
|
+
end
|
12277
|
+
|
12278
|
+
# End user metadata.
|
12279
|
+
class GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaData
|
12280
|
+
include Google::Apis::Core::Hashable
|
12281
|
+
|
12282
|
+
# Chunk information.
|
12283
|
+
# Corresponds to the JSON property `chunkInfo`
|
12284
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo]
|
12285
|
+
attr_accessor :chunk_info
|
12286
|
+
|
12287
|
+
def initialize(**args)
|
12288
|
+
update!(**args)
|
12289
|
+
end
|
12290
|
+
|
12291
|
+
# Update properties of this object
|
12292
|
+
def update!(**args)
|
12293
|
+
@chunk_info = args[:chunk_info] if args.key?(:chunk_info)
|
12294
|
+
end
|
12295
|
+
end
|
12296
|
+
|
12297
|
+
# Chunk information.
|
12298
|
+
class GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo
|
12299
|
+
include Google::Apis::Core::Hashable
|
12300
|
+
|
12301
|
+
# Chunk textual content. It is limited to 8000 characters.
|
12302
|
+
# Corresponds to the JSON property `content`
|
12303
|
+
# @return [String]
|
12304
|
+
attr_accessor :content
|
12305
|
+
|
12306
|
+
# Document metadata contains the information of the document of the current
|
12307
|
+
# chunk.
|
12308
|
+
# Corresponds to the JSON property `documentMetadata`
|
12309
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata]
|
12310
|
+
attr_accessor :document_metadata
|
12311
|
+
|
12312
|
+
def initialize(**args)
|
12313
|
+
update!(**args)
|
12314
|
+
end
|
12315
|
+
|
12316
|
+
# Update properties of this object
|
12317
|
+
def update!(**args)
|
12318
|
+
@content = args[:content] if args.key?(:content)
|
12319
|
+
@document_metadata = args[:document_metadata] if args.key?(:document_metadata)
|
12320
|
+
end
|
12321
|
+
end
|
12322
|
+
|
12323
|
+
# Document metadata contains the information of the document of the current
|
12324
|
+
# chunk.
|
12325
|
+
class GoogleCloudDiscoveryengineV1betaAnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata
|
12326
|
+
include Google::Apis::Core::Hashable
|
12327
|
+
|
12328
|
+
# Title of the document.
|
12329
|
+
# Corresponds to the JSON property `title`
|
12330
|
+
# @return [String]
|
12331
|
+
attr_accessor :title
|
12332
|
+
|
12333
|
+
def initialize(**args)
|
12334
|
+
update!(**args)
|
12335
|
+
end
|
12336
|
+
|
12337
|
+
# Update properties of this object
|
12338
|
+
def update!(**args)
|
12339
|
+
@title = args[:title] if args.key?(:title)
|
12340
|
+
end
|
12341
|
+
end
|
12342
|
+
|
11457
12343
|
# Grounding specification.
|
11458
12344
|
class GoogleCloudDiscoveryengineV1betaAnswerQueryRequestGroundingSpec
|
11459
12345
|
include Google::Apis::Core::Hashable
|
@@ -12194,6 +13080,16 @@ module Google
|
|
12194
13080
|
# @return [Hash<String,Object>]
|
12195
13081
|
attr_accessor :struct_data
|
12196
13082
|
|
13083
|
+
# Output only. The title of the document.
|
13084
|
+
# Corresponds to the JSON property `title`
|
13085
|
+
# @return [String]
|
13086
|
+
attr_accessor :title
|
13087
|
+
|
13088
|
+
# Output only. The URI of the document.
|
13089
|
+
# Corresponds to the JSON property `uri`
|
13090
|
+
# @return [String]
|
13091
|
+
attr_accessor :uri
|
13092
|
+
|
12197
13093
|
def initialize(**args)
|
12198
13094
|
update!(**args)
|
12199
13095
|
end
|
@@ -12202,6 +13098,8 @@ module Google
|
|
12202
13098
|
def update!(**args)
|
12203
13099
|
@document = args[:document] if args.key?(:document)
|
12204
13100
|
@struct_data = args[:struct_data] if args.key?(:struct_data)
|
13101
|
+
@title = args[:title] if args.key?(:title)
|
13102
|
+
@uri = args[:uri] if args.key?(:uri)
|
12205
13103
|
end
|
12206
13104
|
end
|
12207
13105
|
|
@@ -13012,7 +13910,12 @@ module Google
|
|
13012
13910
|
# @return [String]
|
13013
13911
|
attr_accessor :claim_text
|
13014
13912
|
|
13015
|
-
# Position indicating the end of the claim in the answer candidate, exclusive
|
13913
|
+
# Position indicating the end of the claim in the answer candidate, exclusive,
|
13914
|
+
# in bytes. Note that this is not measured in characters and, therefore, must be
|
13915
|
+
# rendered as such. For example, if the claim text contains non-ASCII characters,
|
13916
|
+
# the start and end positions vary when measured in characters (programming-
|
13917
|
+
# language-dependent) and when measured in bytes (programming-language-
|
13918
|
+
# independent).
|
13016
13919
|
# Corresponds to the JSON property `endPos`
|
13017
13920
|
# @return [Fixnum]
|
13018
13921
|
attr_accessor :end_pos
|
@@ -13027,7 +13930,12 @@ module Google
|
|
13027
13930
|
alias_method :grounding_check_required?, :grounding_check_required
|
13028
13931
|
|
13029
13932
|
# Position indicating the start of the claim in the answer candidate, measured
|
13030
|
-
# in bytes.
|
13933
|
+
# in bytes. Note that this is not measured in characters and, therefore, must be
|
13934
|
+
# rendered in the user interface keeping in mind that some characters may take
|
13935
|
+
# more than one byte. For example, if the claim text contains non-ASCII
|
13936
|
+
# characters, the start and end positions vary when measured in characters (
|
13937
|
+
# programming-language-dependent) and when measured in bytes (programming-
|
13938
|
+
# language-independent).
|
13031
13939
|
# Corresponds to the JSON property `startPos`
|
13032
13940
|
# @return [Fixnum]
|
13033
13941
|
attr_accessor :start_pos
|
@@ -13296,13 +14204,13 @@ module Google
|
|
13296
14204
|
attr_accessor :is_default
|
13297
14205
|
alias_method :is_default?, :is_default
|
13298
14206
|
|
13299
|
-
#
|
14207
|
+
# KMS key resource name which will be used to encrypt resources `projects/`
|
13300
14208
|
# project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
|
13301
14209
|
# Corresponds to the JSON property `kmsKey`
|
13302
14210
|
# @return [String]
|
13303
14211
|
attr_accessor :kms_key
|
13304
14212
|
|
13305
|
-
#
|
14213
|
+
# KMS key version resource name which will be used to encrypt resources `/
|
13306
14214
|
# cryptoKeyVersions/`keyVersion``.
|
13307
14215
|
# Corresponds to the JSON property `kmsKeyVersion`
|
13308
14216
|
# @return [String]
|
@@ -13313,9 +14221,9 @@ module Google
|
|
13313
14221
|
# @return [Fixnum]
|
13314
14222
|
attr_accessor :last_rotation_timestamp_micros
|
13315
14223
|
|
13316
|
-
# Required.
|
13317
|
-
# location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs
|
13318
|
-
# cmekConfig``.
|
14224
|
+
# Required. The name of the CmekConfig of the form `projects/`project`/locations/
|
14225
|
+
# `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
|
14226
|
+
# `cmekConfig``.
|
13319
14227
|
# Corresponds to the JSON property `name`
|
13320
14228
|
# @return [String]
|
13321
14229
|
attr_accessor :name
|
@@ -13325,7 +14233,7 @@ module Google
|
|
13325
14233
|
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSingleRegionKey>]
|
13326
14234
|
attr_accessor :single_region_keys
|
13327
14235
|
|
13328
|
-
# Output only.
|
14236
|
+
# Output only. The states of the CmekConfig.
|
13329
14237
|
# Corresponds to the JSON property `state`
|
13330
14238
|
# @return [String]
|
13331
14239
|
attr_accessor :state
|
@@ -13701,6 +14609,13 @@ module Google
|
|
13701
14609
|
# @return [Float]
|
13702
14610
|
attr_accessor :fixed_boost
|
13703
14611
|
|
14612
|
+
# Specification for custom ranking based on customer specified attribute value.
|
14613
|
+
# It provides more controls for customized ranking than the simple (condition,
|
14614
|
+
# boost) combination above.
|
14615
|
+
# Corresponds to the JSON property `interpolationBoostSpec`
|
14616
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec]
|
14617
|
+
attr_accessor :interpolation_boost_spec
|
14618
|
+
|
13704
14619
|
def initialize(**args)
|
13705
14620
|
update!(**args)
|
13706
14621
|
end
|
@@ -13711,6 +14626,85 @@ module Google
|
|
13711
14626
|
@data_store = args[:data_store] if args.key?(:data_store)
|
13712
14627
|
@filter = args[:filter] if args.key?(:filter)
|
13713
14628
|
@fixed_boost = args[:fixed_boost] if args.key?(:fixed_boost)
|
14629
|
+
@interpolation_boost_spec = args[:interpolation_boost_spec] if args.key?(:interpolation_boost_spec)
|
14630
|
+
end
|
14631
|
+
end
|
14632
|
+
|
14633
|
+
# Specification for custom ranking based on customer specified attribute value.
|
14634
|
+
# It provides more controls for customized ranking than the simple (condition,
|
14635
|
+
# boost) combination above.
|
14636
|
+
class GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec
|
14637
|
+
include Google::Apis::Core::Hashable
|
14638
|
+
|
14639
|
+
# Optional. The attribute type to be used to determine the boost amount. The
|
14640
|
+
# attribute value can be derived from the field value of the specified
|
14641
|
+
# field_name. In the case of numerical it is straightforward i.e.
|
14642
|
+
# attribute_value = numerical_field_value. In the case of freshness however,
|
14643
|
+
# attribute_value = (time.now() - datetime_field_value).
|
14644
|
+
# Corresponds to the JSON property `attributeType`
|
14645
|
+
# @return [String]
|
14646
|
+
attr_accessor :attribute_type
|
14647
|
+
|
14648
|
+
# Optional. The control points used to define the curve. The monotonic function (
|
14649
|
+
# defined through the interpolation_type above) passes through the control
|
14650
|
+
# points listed here.
|
14651
|
+
# Corresponds to the JSON property `controlPoints`
|
14652
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint>]
|
14653
|
+
attr_accessor :control_points
|
14654
|
+
|
14655
|
+
# Optional. The name of the field whose value will be used to determine the
|
14656
|
+
# boost amount.
|
14657
|
+
# Corresponds to the JSON property `fieldName`
|
14658
|
+
# @return [String]
|
14659
|
+
attr_accessor :field_name
|
14660
|
+
|
14661
|
+
# Optional. The interpolation type to be applied to connect the control points
|
14662
|
+
# listed below.
|
14663
|
+
# Corresponds to the JSON property `interpolationType`
|
14664
|
+
# @return [String]
|
14665
|
+
attr_accessor :interpolation_type
|
14666
|
+
|
14667
|
+
def initialize(**args)
|
14668
|
+
update!(**args)
|
14669
|
+
end
|
14670
|
+
|
14671
|
+
# Update properties of this object
|
14672
|
+
def update!(**args)
|
14673
|
+
@attribute_type = args[:attribute_type] if args.key?(:attribute_type)
|
14674
|
+
@control_points = args[:control_points] if args.key?(:control_points)
|
14675
|
+
@field_name = args[:field_name] if args.key?(:field_name)
|
14676
|
+
@interpolation_type = args[:interpolation_type] if args.key?(:interpolation_type)
|
14677
|
+
end
|
14678
|
+
end
|
14679
|
+
|
14680
|
+
# The control points used to define the curve. The curve defined through these
|
14681
|
+
# control points can only be monotonically increasing or decreasing(constant
|
14682
|
+
# values are acceptable).
|
14683
|
+
class GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint
|
14684
|
+
include Google::Apis::Core::Hashable
|
14685
|
+
|
14686
|
+
# Optional. Can be one of: 1. The numerical field value. 2. The duration spec
|
14687
|
+
# for freshness: The value must be formatted as an XSD `dayTimeDuration` value (
|
14688
|
+
# a restricted subset of an ISO 8601 duration value). The pattern for this is: `
|
14689
|
+
# nDnM]`.
|
14690
|
+
# Corresponds to the JSON property `attributeValue`
|
14691
|
+
# @return [String]
|
14692
|
+
attr_accessor :attribute_value
|
14693
|
+
|
14694
|
+
# Optional. The value between -1 to 1 by which to boost the score if the
|
14695
|
+
# attribute_value evaluates to the value specified above.
|
14696
|
+
# Corresponds to the JSON property `boostAmount`
|
14697
|
+
# @return [Float]
|
14698
|
+
attr_accessor :boost_amount
|
14699
|
+
|
14700
|
+
def initialize(**args)
|
14701
|
+
update!(**args)
|
14702
|
+
end
|
14703
|
+
|
14704
|
+
# Update properties of this object
|
14705
|
+
def update!(**args)
|
14706
|
+
@attribute_value = args[:attribute_value] if args.key?(:attribute_value)
|
14707
|
+
@boost_amount = args[:boost_amount] if args.key?(:boost_amount)
|
13714
14708
|
end
|
13715
14709
|
end
|
13716
14710
|
|
@@ -14046,6 +15040,28 @@ module Google
|
|
14046
15040
|
end
|
14047
15041
|
end
|
14048
15042
|
|
15043
|
+
# The historical crawl rate timeseries data, used for monitoring.
|
15044
|
+
class GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries
|
15045
|
+
include Google::Apis::Core::Hashable
|
15046
|
+
|
15047
|
+
# A collection of data points that describes the time-varying values of a metric.
|
15048
|
+
# A time series is identified by a combination of a fully-specified monitored
|
15049
|
+
# resource and a fully-specified metric. This type is used for both listing and
|
15050
|
+
# creating time series.
|
15051
|
+
# Corresponds to the JSON property `qpsTimeSeries`
|
15052
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleMonitoringV3TimeSeries]
|
15053
|
+
attr_accessor :qps_time_series
|
15054
|
+
|
15055
|
+
def initialize(**args)
|
15056
|
+
update!(**args)
|
15057
|
+
end
|
15058
|
+
|
15059
|
+
# Update properties of this object
|
15060
|
+
def update!(**args)
|
15061
|
+
@qps_time_series = args[:qps_time_series] if args.key?(:qps_time_series)
|
15062
|
+
end
|
15063
|
+
end
|
15064
|
+
|
14049
15065
|
# Metadata related to the progress of the DataStoreService.CreateDataStore
|
14050
15066
|
# operation. This will be returned by the google.longrunning.Operation.metadata
|
14051
15067
|
# field.
|
@@ -14351,7 +15367,7 @@ module Google
|
|
14351
15367
|
# @return [String]
|
14352
15368
|
attr_accessor :create_time
|
14353
15369
|
|
14354
|
-
# Output only. The id of the default Schema
|
15370
|
+
# Output only. The id of the default Schema associated to this data store.
|
14355
15371
|
# Corresponds to the JSON property `defaultSchemaId`
|
14356
15372
|
# @return [String]
|
14357
15373
|
attr_accessor :default_schema_id
|
@@ -14370,6 +15386,19 @@ module Google
|
|
14370
15386
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig]
|
14371
15387
|
attr_accessor :document_processing_config
|
14372
15388
|
|
15389
|
+
# Config to data store for `HEALTHCARE_FHIR` vertical.
|
15390
|
+
# Corresponds to the JSON property `healthcareFhirConfig`
|
15391
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig]
|
15392
|
+
attr_accessor :healthcare_fhir_config
|
15393
|
+
|
15394
|
+
# Immutable. The fully qualified resource name of the associated
|
15395
|
+
# IdentityMappingStore. This field can only be set for acl_enabled DataStores
|
15396
|
+
# with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/`project`/locations/`
|
15397
|
+
# location`/identityMappingStores/`identity_mapping_store``.
|
15398
|
+
# Corresponds to the JSON property `identityMappingStore`
|
15399
|
+
# @return [String]
|
15400
|
+
attr_accessor :identity_mapping_store
|
15401
|
+
|
14373
15402
|
# Immutable. The industry vertical that the data store registers.
|
14374
15403
|
# Corresponds to the JSON property `industryVertical`
|
14375
15404
|
# @return [String]
|
@@ -14444,6 +15473,8 @@ module Google
|
|
14444
15473
|
@default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
|
14445
15474
|
@display_name = args[:display_name] if args.key?(:display_name)
|
14446
15475
|
@document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
|
15476
|
+
@healthcare_fhir_config = args[:healthcare_fhir_config] if args.key?(:healthcare_fhir_config)
|
15477
|
+
@identity_mapping_store = args[:identity_mapping_store] if args.key?(:identity_mapping_store)
|
14447
15478
|
@industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
|
14448
15479
|
@is_infobot_faq_data_store = args[:is_infobot_faq_data_store] if args.key?(:is_infobot_faq_data_store)
|
14449
15480
|
@kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
|
@@ -14526,6 +15557,33 @@ module Google
|
|
14526
15557
|
end
|
14527
15558
|
end
|
14528
15559
|
|
15560
|
+
# The historical dedicated crawl rate timeseries data, used for monitoring.
|
15561
|
+
# Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate
|
15562
|
+
# crawl is set.
|
15563
|
+
class GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries
|
15564
|
+
include Google::Apis::Core::Hashable
|
15565
|
+
|
15566
|
+
# The historical crawl rate timeseries data, used for monitoring.
|
15567
|
+
# Corresponds to the JSON property `autoRefreshCrawlRate`
|
15568
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries]
|
15569
|
+
attr_accessor :auto_refresh_crawl_rate
|
15570
|
+
|
15571
|
+
# The historical crawl rate timeseries data, used for monitoring.
|
15572
|
+
# Corresponds to the JSON property `userTriggeredCrawlRate`
|
15573
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries]
|
15574
|
+
attr_accessor :user_triggered_crawl_rate
|
15575
|
+
|
15576
|
+
def initialize(**args)
|
15577
|
+
update!(**args)
|
15578
|
+
end
|
15579
|
+
|
15580
|
+
# Update properties of this object
|
15581
|
+
def update!(**args)
|
15582
|
+
@auto_refresh_crawl_rate = args[:auto_refresh_crawl_rate] if args.key?(:auto_refresh_crawl_rate)
|
15583
|
+
@user_triggered_crawl_rate = args[:user_triggered_crawl_rate] if args.key?(:user_triggered_crawl_rate)
|
15584
|
+
end
|
15585
|
+
end
|
15586
|
+
|
14529
15587
|
# Metadata related to the progress of the DataStoreService.DeleteDataStore
|
14530
15588
|
# operation. This will be returned by the google.longrunning.Operation.metadata
|
14531
15589
|
# field.
|
@@ -15358,6 +16416,17 @@ module Google
|
|
15358
16416
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig]
|
15359
16417
|
attr_accessor :agent_creation_config
|
15360
16418
|
|
16419
|
+
# Optional. If the flag set to true, we allow the agent and engine are in
|
16420
|
+
# different locations, otherwise the agent and engine are required to be in the
|
16421
|
+
# same location. The flag is set to false by default. Note that the `
|
16422
|
+
# allow_cross_region` are one-time consumed by and passed to EngineService.
|
16423
|
+
# CreateEngine. It means they cannot be retrieved using EngineService.GetEngine
|
16424
|
+
# or EngineService.ListEngines API after engine creation.
|
16425
|
+
# Corresponds to the JSON property `allowCrossRegion`
|
16426
|
+
# @return [Boolean]
|
16427
|
+
attr_accessor :allow_cross_region
|
16428
|
+
alias_method :allow_cross_region?, :allow_cross_region
|
16429
|
+
|
15361
16430
|
# The resource name of an exist Dialogflow agent to link to this Chat Engine.
|
15362
16431
|
# Customers can either provide `agent_creation_config` to create agent or
|
15363
16432
|
# provide an agent name that links the agent with the Chat engine. Format: `
|
@@ -15377,6 +16446,7 @@ module Google
|
|
15377
16446
|
# Update properties of this object
|
15378
16447
|
def update!(**args)
|
15379
16448
|
@agent_creation_config = args[:agent_creation_config] if args.key?(:agent_creation_config)
|
16449
|
+
@allow_cross_region = args[:allow_cross_region] if args.key?(:allow_cross_region)
|
15380
16450
|
@dialogflow_agent_to_link = args[:dialogflow_agent_to_link] if args.key?(:dialogflow_agent_to_link)
|
15381
16451
|
end
|
15382
16452
|
end
|
@@ -16470,6 +17540,144 @@ module Google
|
|
16470
17540
|
end
|
16471
17541
|
end
|
16472
17542
|
|
17543
|
+
# Config to data store for `HEALTHCARE_FHIR` vertical.
|
17544
|
+
class GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig
|
17545
|
+
include Google::Apis::Core::Hashable
|
17546
|
+
|
17547
|
+
# Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set
|
17548
|
+
# to `true`, the predefined healthcare fhir schema can be extended for more
|
17549
|
+
# customized searching and filtering.
|
17550
|
+
# Corresponds to the JSON property `enableConfigurableSchema`
|
17551
|
+
# @return [Boolean]
|
17552
|
+
attr_accessor :enable_configurable_schema
|
17553
|
+
alias_method :enable_configurable_schema?, :enable_configurable_schema
|
17554
|
+
|
17555
|
+
# Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If
|
17556
|
+
# set to `true`, the batch ingestion will be processed in a static indexing mode
|
17557
|
+
# which is slower but more capable of handling larger volume.
|
17558
|
+
# Corresponds to the JSON property `enableStaticIndexingForBatchIngestion`
|
17559
|
+
# @return [Boolean]
|
17560
|
+
attr_accessor :enable_static_indexing_for_batch_ingestion
|
17561
|
+
alias_method :enable_static_indexing_for_batch_ingestion?, :enable_static_indexing_for_batch_ingestion
|
17562
|
+
|
17563
|
+
def initialize(**args)
|
17564
|
+
update!(**args)
|
17565
|
+
end
|
17566
|
+
|
17567
|
+
# Update properties of this object
|
17568
|
+
def update!(**args)
|
17569
|
+
@enable_configurable_schema = args[:enable_configurable_schema] if args.key?(:enable_configurable_schema)
|
17570
|
+
@enable_static_indexing_for_batch_ingestion = args[:enable_static_indexing_for_batch_ingestion] if args.key?(:enable_static_indexing_for_batch_ingestion)
|
17571
|
+
end
|
17572
|
+
end
|
17573
|
+
|
17574
|
+
# Identity Mapping Entry that maps an external identity to an internal identity.
|
17575
|
+
class GoogleCloudDiscoveryengineV1betaIdentityMappingEntry
|
17576
|
+
include Google::Apis::Core::Hashable
|
17577
|
+
|
17578
|
+
# Required. Identity outside the customer identity provider. The length limit of
|
17579
|
+
# external identity will be of 100 characters.
|
17580
|
+
# Corresponds to the JSON property `externalIdentity`
|
17581
|
+
# @return [String]
|
17582
|
+
attr_accessor :external_identity
|
17583
|
+
|
17584
|
+
# Group identifier. For Google Workspace user account, group_id should be the
|
17585
|
+
# google workspace group email. For non-google identity provider, group_id is
|
17586
|
+
# the mapped group identifier configured during the workforcepool config.
|
17587
|
+
# Corresponds to the JSON property `groupId`
|
17588
|
+
# @return [String]
|
17589
|
+
attr_accessor :group_id
|
17590
|
+
|
17591
|
+
# User identifier. For Google Workspace user account, user_id should be the
|
17592
|
+
# google workspace user email. For non-google identity provider, user_id is the
|
17593
|
+
# mapped user identifier configured during the workforcepool config.
|
17594
|
+
# Corresponds to the JSON property `userId`
|
17595
|
+
# @return [String]
|
17596
|
+
attr_accessor :user_id
|
17597
|
+
|
17598
|
+
def initialize(**args)
|
17599
|
+
update!(**args)
|
17600
|
+
end
|
17601
|
+
|
17602
|
+
# Update properties of this object
|
17603
|
+
def update!(**args)
|
17604
|
+
@external_identity = args[:external_identity] if args.key?(:external_identity)
|
17605
|
+
@group_id = args[:group_id] if args.key?(:group_id)
|
17606
|
+
@user_id = args[:user_id] if args.key?(:user_id)
|
17607
|
+
end
|
17608
|
+
end
|
17609
|
+
|
17610
|
+
# IdentityMappingEntry LongRunningOperation metadata for
|
17611
|
+
# IdentityMappingStoreService.ImportIdentityMappings and
|
17612
|
+
# IdentityMappingStoreService.PurgeIdentityMappings
|
17613
|
+
class GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata
|
17614
|
+
include Google::Apis::Core::Hashable
|
17615
|
+
|
17616
|
+
# The number of IdentityMappingEntries that failed to be processed.
|
17617
|
+
# Corresponds to the JSON property `failureCount`
|
17618
|
+
# @return [Fixnum]
|
17619
|
+
attr_accessor :failure_count
|
17620
|
+
|
17621
|
+
# The number of IdentityMappingEntries that were successfully processed.
|
17622
|
+
# Corresponds to the JSON property `successCount`
|
17623
|
+
# @return [Fixnum]
|
17624
|
+
attr_accessor :success_count
|
17625
|
+
|
17626
|
+
# The total number of IdentityMappingEntries that were processed.
|
17627
|
+
# Corresponds to the JSON property `totalCount`
|
17628
|
+
# @return [Fixnum]
|
17629
|
+
attr_accessor :total_count
|
17630
|
+
|
17631
|
+
def initialize(**args)
|
17632
|
+
update!(**args)
|
17633
|
+
end
|
17634
|
+
|
17635
|
+
# Update properties of this object
|
17636
|
+
def update!(**args)
|
17637
|
+
@failure_count = args[:failure_count] if args.key?(:failure_count)
|
17638
|
+
@success_count = args[:success_count] if args.key?(:success_count)
|
17639
|
+
@total_count = args[:total_count] if args.key?(:total_count)
|
17640
|
+
end
|
17641
|
+
end
|
17642
|
+
|
17643
|
+
# Identity Mapping Store which contains Identity Mapping Entries.
|
17644
|
+
class GoogleCloudDiscoveryengineV1betaIdentityMappingStore
|
17645
|
+
include Google::Apis::Core::Hashable
|
17646
|
+
|
17647
|
+
# Configurations used to enable CMEK data encryption with Cloud KMS keys.
|
17648
|
+
# Corresponds to the JSON property `cmekConfig`
|
17649
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig]
|
17650
|
+
attr_accessor :cmek_config
|
17651
|
+
|
17652
|
+
# Input only. The KMS key to be used to protect this Identity Mapping Store at
|
17653
|
+
# creation time. Must be set for requests that need to comply with CMEK Org
|
17654
|
+
# Policy protections. If this field is set and processed successfully, the
|
17655
|
+
# Identity Mapping Store will be protected by the KMS key, as indicated in the
|
17656
|
+
# cmek_config field.
|
17657
|
+
# Corresponds to the JSON property `kmsKeyName`
|
17658
|
+
# @return [String]
|
17659
|
+
attr_accessor :kms_key_name
|
17660
|
+
|
17661
|
+
# Immutable. The full resource name of the identity mapping store. Format: `
|
17662
|
+
# projects/`project`/locations/`location`/identityMappingStores/`
|
17663
|
+
# identity_mapping_store``. This field must be a UTF-8 encoded string with a
|
17664
|
+
# length limit of 1024 characters.
|
17665
|
+
# Corresponds to the JSON property `name`
|
17666
|
+
# @return [String]
|
17667
|
+
attr_accessor :name
|
17668
|
+
|
17669
|
+
def initialize(**args)
|
17670
|
+
update!(**args)
|
17671
|
+
end
|
17672
|
+
|
17673
|
+
# Update properties of this object
|
17674
|
+
def update!(**args)
|
17675
|
+
@cmek_config = args[:cmek_config] if args.key?(:cmek_config)
|
17676
|
+
@kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
|
17677
|
+
@name = args[:name] if args.key?(:name)
|
17678
|
+
end
|
17679
|
+
end
|
17680
|
+
|
16473
17681
|
# Metadata related to the progress of the ImportCompletionSuggestions operation.
|
16474
17682
|
# This will be returned by the google.longrunning.Operation.metadata field.
|
16475
17683
|
class GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata
|
@@ -16691,6 +17899,14 @@ module Google
|
|
16691
17899
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFirestoreSource]
|
16692
17900
|
attr_accessor :firestore_source
|
16693
17901
|
|
17902
|
+
# Optional. Whether to force refresh the unstructured content of the documents.
|
17903
|
+
# If set to `true`, the content part of the documents will be refreshed
|
17904
|
+
# regardless of the update status of the referencing content.
|
17905
|
+
# Corresponds to the JSON property `forceRefreshContent`
|
17906
|
+
# @return [Boolean]
|
17907
|
+
attr_accessor :force_refresh_content
|
17908
|
+
alias_method :force_refresh_content?, :force_refresh_content
|
17909
|
+
|
16694
17910
|
# Cloud Storage location for input content.
|
16695
17911
|
# Corresponds to the JSON property `gcsSource`
|
16696
17912
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGcsSource]
|
@@ -16751,6 +17967,7 @@ module Google
|
|
16751
17967
|
@error_config = args[:error_config] if args.key?(:error_config)
|
16752
17968
|
@fhir_store_source = args[:fhir_store_source] if args.key?(:fhir_store_source)
|
16753
17969
|
@firestore_source = args[:firestore_source] if args.key?(:firestore_source)
|
17970
|
+
@force_refresh_content = args[:force_refresh_content] if args.key?(:force_refresh_content)
|
16754
17971
|
@gcs_source = args[:gcs_source] if args.key?(:gcs_source)
|
16755
17972
|
@id_field = args[:id_field] if args.key?(:id_field)
|
16756
17973
|
@inline_source = args[:inline_source] if args.key?(:inline_source)
|
@@ -16828,6 +18045,63 @@ module Google
|
|
16828
18045
|
end
|
16829
18046
|
end
|
16830
18047
|
|
18048
|
+
# Request message for IdentityMappingStoreService.ImportIdentityMappings
|
18049
|
+
class GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequest
|
18050
|
+
include Google::Apis::Core::Hashable
|
18051
|
+
|
18052
|
+
# The inline source to import identity mapping entries from.
|
18053
|
+
# Corresponds to the JSON property `inlineSource`
|
18054
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequestInlineSource]
|
18055
|
+
attr_accessor :inline_source
|
18056
|
+
|
18057
|
+
def initialize(**args)
|
18058
|
+
update!(**args)
|
18059
|
+
end
|
18060
|
+
|
18061
|
+
# Update properties of this object
|
18062
|
+
def update!(**args)
|
18063
|
+
@inline_source = args[:inline_source] if args.key?(:inline_source)
|
18064
|
+
end
|
18065
|
+
end
|
18066
|
+
|
18067
|
+
# The inline source to import identity mapping entries from.
|
18068
|
+
class GoogleCloudDiscoveryengineV1betaImportIdentityMappingsRequestInlineSource
|
18069
|
+
include Google::Apis::Core::Hashable
|
18070
|
+
|
18071
|
+
# A maximum of 10000 entries can be imported at one time
|
18072
|
+
# Corresponds to the JSON property `identityMappingEntries`
|
18073
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaIdentityMappingEntry>]
|
18074
|
+
attr_accessor :identity_mapping_entries
|
18075
|
+
|
18076
|
+
def initialize(**args)
|
18077
|
+
update!(**args)
|
18078
|
+
end
|
18079
|
+
|
18080
|
+
# Update properties of this object
|
18081
|
+
def update!(**args)
|
18082
|
+
@identity_mapping_entries = args[:identity_mapping_entries] if args.key?(:identity_mapping_entries)
|
18083
|
+
end
|
18084
|
+
end
|
18085
|
+
|
18086
|
+
# Response message for IdentityMappingStoreService.ImportIdentityMappings
|
18087
|
+
class GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse
|
18088
|
+
include Google::Apis::Core::Hashable
|
18089
|
+
|
18090
|
+
# A sample of errors encountered while processing the request.
|
18091
|
+
# Corresponds to the JSON property `errorSamples`
|
18092
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
|
18093
|
+
attr_accessor :error_samples
|
18094
|
+
|
18095
|
+
def initialize(**args)
|
18096
|
+
update!(**args)
|
18097
|
+
end
|
18098
|
+
|
18099
|
+
# Update properties of this object
|
18100
|
+
def update!(**args)
|
18101
|
+
@error_samples = args[:error_samples] if args.key?(:error_samples)
|
18102
|
+
end
|
18103
|
+
end
|
18104
|
+
|
16831
18105
|
# Metadata related to the progress of the ImportSampleQueries operation. This
|
16832
18106
|
# will be returned by the google.longrunning.Operation.metadata field.
|
16833
18107
|
class GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata
|
@@ -17495,6 +18769,58 @@ module Google
|
|
17495
18769
|
end
|
17496
18770
|
end
|
17497
18771
|
|
18772
|
+
# Response message for IdentityMappingStoreService.ListIdentityMappingStores
|
18773
|
+
class GoogleCloudDiscoveryengineV1betaListIdentityMappingStoresResponse
|
18774
|
+
include Google::Apis::Core::Hashable
|
18775
|
+
|
18776
|
+
# The Identity Mapping Stores.
|
18777
|
+
# Corresponds to the JSON property `identityMappingStores`
|
18778
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaIdentityMappingStore>]
|
18779
|
+
attr_accessor :identity_mapping_stores
|
18780
|
+
|
18781
|
+
# A token that can be sent as `page_token` to retrieve the next page. If this
|
18782
|
+
# field is omitted, there are no subsequent pages.
|
18783
|
+
# Corresponds to the JSON property `nextPageToken`
|
18784
|
+
# @return [String]
|
18785
|
+
attr_accessor :next_page_token
|
18786
|
+
|
18787
|
+
def initialize(**args)
|
18788
|
+
update!(**args)
|
18789
|
+
end
|
18790
|
+
|
18791
|
+
# Update properties of this object
|
18792
|
+
def update!(**args)
|
18793
|
+
@identity_mapping_stores = args[:identity_mapping_stores] if args.key?(:identity_mapping_stores)
|
18794
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
18795
|
+
end
|
18796
|
+
end
|
18797
|
+
|
18798
|
+
# Response message for IdentityMappingStoreService.ListIdentityMappings
|
18799
|
+
class GoogleCloudDiscoveryengineV1betaListIdentityMappingsResponse
|
18800
|
+
include Google::Apis::Core::Hashable
|
18801
|
+
|
18802
|
+
# The Identity Mapping Entries.
|
18803
|
+
# Corresponds to the JSON property `identityMappingEntries`
|
18804
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaIdentityMappingEntry>]
|
18805
|
+
attr_accessor :identity_mapping_entries
|
18806
|
+
|
18807
|
+
# A token that can be sent as `page_token` to retrieve the next page. If this
|
18808
|
+
# field is omitted, there are no subsequent pages.
|
18809
|
+
# Corresponds to the JSON property `nextPageToken`
|
18810
|
+
# @return [String]
|
18811
|
+
attr_accessor :next_page_token
|
18812
|
+
|
18813
|
+
def initialize(**args)
|
18814
|
+
update!(**args)
|
18815
|
+
end
|
18816
|
+
|
18817
|
+
# Update properties of this object
|
18818
|
+
def update!(**args)
|
18819
|
+
@identity_mapping_entries = args[:identity_mapping_entries] if args.key?(:identity_mapping_entries)
|
18820
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
18821
|
+
end
|
18822
|
+
end
|
18823
|
+
|
17498
18824
|
# Response message for SampleQueryService.ListSampleQueries method.
|
17499
18825
|
class GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse
|
17500
18826
|
include Google::Apis::Core::Hashable
|
@@ -17706,6 +19032,105 @@ module Google
|
|
17706
19032
|
end
|
17707
19033
|
end
|
17708
19034
|
|
19035
|
+
# Request message for CrawlRateManagementService.ObtainCrawlRate method.
|
19036
|
+
class GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest
|
19037
|
+
include Google::Apis::Core::Hashable
|
19038
|
+
|
19039
|
+
# Required. The scope of the crawl rate that the user wants to monitor.
|
19040
|
+
# Currently, only domain and host name are supported. A domain name example: `
|
19041
|
+
# example.com`. A host name example: `www.example.com`. Please do not include `/`
|
19042
|
+
# in the domain or host name.
|
19043
|
+
# Corresponds to the JSON property `crawlRateScope`
|
19044
|
+
# @return [String]
|
19045
|
+
attr_accessor :crawl_rate_scope
|
19046
|
+
|
19047
|
+
def initialize(**args)
|
19048
|
+
update!(**args)
|
19049
|
+
end
|
19050
|
+
|
19051
|
+
# Update properties of this object
|
19052
|
+
def update!(**args)
|
19053
|
+
@crawl_rate_scope = args[:crawl_rate_scope] if args.key?(:crawl_rate_scope)
|
19054
|
+
end
|
19055
|
+
end
|
19056
|
+
|
19057
|
+
# Response message for CrawlRateManagementService.ObtainCrawlRate method. The
|
19058
|
+
# response contains organcic or dedicated crawl rate time series data for
|
19059
|
+
# monitoring, depending on whether dedicated crawl rate is set.
|
19060
|
+
class GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse
|
19061
|
+
include Google::Apis::Core::Hashable
|
19062
|
+
|
19063
|
+
# The historical dedicated crawl rate timeseries data, used for monitoring.
|
19064
|
+
# Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate
|
19065
|
+
# crawl is set.
|
19066
|
+
# Corresponds to the JSON property `dedicatedCrawlRateTimeSeries`
|
19067
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries]
|
19068
|
+
attr_accessor :dedicated_crawl_rate_time_series
|
19069
|
+
|
19070
|
+
# The `Status` type defines a logical error model that is suitable for different
|
19071
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
19072
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
19073
|
+
# data: error code, error message, and error details. You can find out more
|
19074
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
19075
|
+
# //cloud.google.com/apis/design/errors).
|
19076
|
+
# Corresponds to the JSON property `error`
|
19077
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus]
|
19078
|
+
attr_accessor :error
|
19079
|
+
|
19080
|
+
# The historical organic crawl rate timeseries data, used for monitoring.
|
19081
|
+
# Organic crawl is auto-determined by Google to crawl the user's website when
|
19082
|
+
# dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends
|
19083
|
+
# to the user's website.
|
19084
|
+
# Corresponds to the JSON property `organicCrawlRateTimeSeries`
|
19085
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries]
|
19086
|
+
attr_accessor :organic_crawl_rate_time_series
|
19087
|
+
|
19088
|
+
# Output only. The state of the response.
|
19089
|
+
# Corresponds to the JSON property `state`
|
19090
|
+
# @return [String]
|
19091
|
+
attr_accessor :state
|
19092
|
+
|
19093
|
+
def initialize(**args)
|
19094
|
+
update!(**args)
|
19095
|
+
end
|
19096
|
+
|
19097
|
+
# Update properties of this object
|
19098
|
+
def update!(**args)
|
19099
|
+
@dedicated_crawl_rate_time_series = args[:dedicated_crawl_rate_time_series] if args.key?(:dedicated_crawl_rate_time_series)
|
19100
|
+
@error = args[:error] if args.key?(:error)
|
19101
|
+
@organic_crawl_rate_time_series = args[:organic_crawl_rate_time_series] if args.key?(:organic_crawl_rate_time_series)
|
19102
|
+
@state = args[:state] if args.key?(:state)
|
19103
|
+
end
|
19104
|
+
end
|
19105
|
+
|
19106
|
+
# The historical organic crawl rate timeseries data, used for monitoring.
|
19107
|
+
# Organic crawl is auto-determined by Google to crawl the user's website when
|
19108
|
+
# dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends
|
19109
|
+
# to the user's website.
|
19110
|
+
class GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries
|
19111
|
+
include Google::Apis::Core::Hashable
|
19112
|
+
|
19113
|
+
# The historical crawl rate timeseries data, used for monitoring.
|
19114
|
+
# Corresponds to the JSON property `googleOrganicCrawlRate`
|
19115
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries]
|
19116
|
+
attr_accessor :google_organic_crawl_rate
|
19117
|
+
|
19118
|
+
# The historical crawl rate timeseries data, used for monitoring.
|
19119
|
+
# Corresponds to the JSON property `vertexAiOrganicCrawlRate`
|
19120
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries]
|
19121
|
+
attr_accessor :vertex_ai_organic_crawl_rate
|
19122
|
+
|
19123
|
+
def initialize(**args)
|
19124
|
+
update!(**args)
|
19125
|
+
end
|
19126
|
+
|
19127
|
+
# Update properties of this object
|
19128
|
+
def update!(**args)
|
19129
|
+
@google_organic_crawl_rate = args[:google_organic_crawl_rate] if args.key?(:google_organic_crawl_rate)
|
19130
|
+
@vertex_ai_organic_crawl_rate = args[:vertex_ai_organic_crawl_rate] if args.key?(:vertex_ai_organic_crawl_rate)
|
19131
|
+
end
|
19132
|
+
end
|
19133
|
+
|
17709
19134
|
# Detailed page information.
|
17710
19135
|
class GoogleCloudDiscoveryengineV1betaPageInfo
|
17711
19136
|
include Google::Apis::Core::Hashable
|
@@ -18102,21 +19527,82 @@ module Google
|
|
18102
19527
|
|
18103
19528
|
# Update properties of this object
|
18104
19529
|
def update!(**args)
|
18105
|
-
@purge_count = args[:purge_count] if args.key?(:purge_count)
|
18106
|
-
@purge_sample = args[:purge_sample] if args.key?(:purge_sample)
|
19530
|
+
@purge_count = args[:purge_count] if args.key?(:purge_count)
|
19531
|
+
@purge_sample = args[:purge_sample] if args.key?(:purge_sample)
|
19532
|
+
end
|
19533
|
+
end
|
19534
|
+
|
19535
|
+
# Configuration of destination for Purge related errors.
|
19536
|
+
class GoogleCloudDiscoveryengineV1betaPurgeErrorConfig
|
19537
|
+
include Google::Apis::Core::Hashable
|
19538
|
+
|
19539
|
+
# Cloud Storage prefix for purge errors. This must be an empty, existing Cloud
|
19540
|
+
# Storage directory. Purge errors are written to sharded files in this directory,
|
19541
|
+
# one per line, as a JSON-encoded `google.rpc.Status` message.
|
19542
|
+
# Corresponds to the JSON property `gcsPrefix`
|
19543
|
+
# @return [String]
|
19544
|
+
attr_accessor :gcs_prefix
|
19545
|
+
|
19546
|
+
def initialize(**args)
|
19547
|
+
update!(**args)
|
19548
|
+
end
|
19549
|
+
|
19550
|
+
# Update properties of this object
|
19551
|
+
def update!(**args)
|
19552
|
+
@gcs_prefix = args[:gcs_prefix] if args.key?(:gcs_prefix)
|
19553
|
+
end
|
19554
|
+
end
|
19555
|
+
|
19556
|
+
# Request message for IdentityMappingStoreService.PurgeIdentityMappings
|
19557
|
+
class GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequest
|
19558
|
+
include Google::Apis::Core::Hashable
|
19559
|
+
|
19560
|
+
# Filter matching identity mappings to purge. The eligible field for filtering
|
19561
|
+
# is: * `update_time`: in ISO 8601 "zulu" format. * `external_id` Examples: *
|
19562
|
+
# Deleting all identity mappings updated in a time range: `update_time > "2012-
|
19563
|
+
# 04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"` * Deleting
|
19564
|
+
# all identity mappings for a given external_id: `external_id = "id1"` *
|
19565
|
+
# Deleting all identity mappings inside an identity mapping store: `*` The
|
19566
|
+
# filtering fields are assumed to have an implicit AND. Should not be used with
|
19567
|
+
# source. An error will be thrown, if both are provided.
|
19568
|
+
# Corresponds to the JSON property `filter`
|
19569
|
+
# @return [String]
|
19570
|
+
attr_accessor :filter
|
19571
|
+
|
19572
|
+
# Actually performs the purge. If `force` is set to false, return the expected
|
19573
|
+
# purge count without deleting any identity mappings. This field is only
|
19574
|
+
# supported for purge with filter. For input source this field is ignored and
|
19575
|
+
# data will be purged regardless of the value of this field.
|
19576
|
+
# Corresponds to the JSON property `force`
|
19577
|
+
# @return [Boolean]
|
19578
|
+
attr_accessor :force
|
19579
|
+
alias_method :force?, :force
|
19580
|
+
|
19581
|
+
# The inline source to purge identity mapping entries from.
|
19582
|
+
# Corresponds to the JSON property `inlineSource`
|
19583
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequestInlineSource]
|
19584
|
+
attr_accessor :inline_source
|
19585
|
+
|
19586
|
+
def initialize(**args)
|
19587
|
+
update!(**args)
|
19588
|
+
end
|
19589
|
+
|
19590
|
+
# Update properties of this object
|
19591
|
+
def update!(**args)
|
19592
|
+
@filter = args[:filter] if args.key?(:filter)
|
19593
|
+
@force = args[:force] if args.key?(:force)
|
19594
|
+
@inline_source = args[:inline_source] if args.key?(:inline_source)
|
18107
19595
|
end
|
18108
19596
|
end
|
18109
19597
|
|
18110
|
-
#
|
18111
|
-
class
|
19598
|
+
# The inline source to purge identity mapping entries from.
|
19599
|
+
class GoogleCloudDiscoveryengineV1betaPurgeIdentityMappingsRequestInlineSource
|
18112
19600
|
include Google::Apis::Core::Hashable
|
18113
19601
|
|
18114
|
-
#
|
18115
|
-
#
|
18116
|
-
#
|
18117
|
-
|
18118
|
-
# @return [String]
|
18119
|
-
attr_accessor :gcs_prefix
|
19602
|
+
# A maximum of 10000 entries can be purged at one time
|
19603
|
+
# Corresponds to the JSON property `identityMappingEntries`
|
19604
|
+
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaIdentityMappingEntry>]
|
19605
|
+
attr_accessor :identity_mapping_entries
|
18120
19606
|
|
18121
19607
|
def initialize(**args)
|
18122
19608
|
update!(**args)
|
@@ -18124,7 +19610,7 @@ module Google
|
|
18124
19610
|
|
18125
19611
|
# Update properties of this object
|
18126
19612
|
def update!(**args)
|
18127
|
-
@
|
19613
|
+
@identity_mapping_entries = args[:identity_mapping_entries] if args.key?(:identity_mapping_entries)
|
18128
19614
|
end
|
18129
19615
|
end
|
18130
19616
|
|
@@ -18638,9 +20124,7 @@ module Google
|
|
18638
20124
|
class GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest
|
18639
20125
|
include Google::Apis::Core::Hashable
|
18640
20126
|
|
18641
|
-
# Optional.
|
18642
|
-
# locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`.
|
18643
|
-
# Only set to crawl private URIs.
|
20127
|
+
# Optional. Credential id to use for crawling.
|
18644
20128
|
# Corresponds to the JSON property `siteCredential`
|
18645
20129
|
# @return [String]
|
18646
20130
|
attr_accessor :site_credential
|
@@ -18663,6 +20147,154 @@ module Google
|
|
18663
20147
|
end
|
18664
20148
|
end
|
18665
20149
|
|
20150
|
+
# Metadata related to the progress of the CrawlRateManagementService.
|
20151
|
+
# RemoveDedicatedCrawlRate operation. This will be returned by the google.
|
20152
|
+
# longrunning.Operation.metadata field.
|
20153
|
+
class GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata
|
20154
|
+
include Google::Apis::Core::Hashable
|
20155
|
+
|
20156
|
+
# Operation create time.
|
20157
|
+
# Corresponds to the JSON property `createTime`
|
20158
|
+
# @return [String]
|
20159
|
+
attr_accessor :create_time
|
20160
|
+
|
20161
|
+
# Operation last update time. If the operation is done, this is also the finish
|
20162
|
+
# time.
|
20163
|
+
# Corresponds to the JSON property `updateTime`
|
20164
|
+
# @return [String]
|
20165
|
+
attr_accessor :update_time
|
20166
|
+
|
20167
|
+
def initialize(**args)
|
20168
|
+
update!(**args)
|
20169
|
+
end
|
20170
|
+
|
20171
|
+
# Update properties of this object
|
20172
|
+
def update!(**args)
|
20173
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
20174
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
20175
|
+
end
|
20176
|
+
end
|
20177
|
+
|
20178
|
+
# Request message for CrawlRateManagementService.RemoveDedicatedCrawlRate method.
|
20179
|
+
# The user can remove the dedicated crawl rate for a crawl_rate_scope they own,
|
20180
|
+
# and Google will fall back to organic crawl, and the crawl rate will be
|
20181
|
+
# determined by Google.
|
20182
|
+
class GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest
|
20183
|
+
include Google::Apis::Core::Hashable
|
20184
|
+
|
20185
|
+
# Required. The scope of the crawl rate change. Currently, only domain and host
|
20186
|
+
# name are supported. A domain name example: `example.com`. A host name example:
|
20187
|
+
# `www.example.com`. Please do not include `/` in the domain or host name.
|
20188
|
+
# Corresponds to the JSON property `crawlRateScope`
|
20189
|
+
# @return [String]
|
20190
|
+
attr_accessor :crawl_rate_scope
|
20191
|
+
|
20192
|
+
def initialize(**args)
|
20193
|
+
update!(**args)
|
20194
|
+
end
|
20195
|
+
|
20196
|
+
# Update properties of this object
|
20197
|
+
def update!(**args)
|
20198
|
+
@crawl_rate_scope = args[:crawl_rate_scope] if args.key?(:crawl_rate_scope)
|
20199
|
+
end
|
20200
|
+
end
|
20201
|
+
|
20202
|
+
# Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate
|
20203
|
+
# method. It simply returns the state of the response, and an error message if
|
20204
|
+
# the state is FAILED.
|
20205
|
+
class GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse
|
20206
|
+
include Google::Apis::Core::Hashable
|
20207
|
+
|
20208
|
+
# The `Status` type defines a logical error model that is suitable for different
|
20209
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
20210
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
20211
|
+
# data: error code, error message, and error details. You can find out more
|
20212
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
20213
|
+
# //cloud.google.com/apis/design/errors).
|
20214
|
+
# Corresponds to the JSON property `error`
|
20215
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus]
|
20216
|
+
attr_accessor :error
|
20217
|
+
|
20218
|
+
# Output only. The state of the response.
|
20219
|
+
# Corresponds to the JSON property `state`
|
20220
|
+
# @return [String]
|
20221
|
+
attr_accessor :state
|
20222
|
+
|
20223
|
+
def initialize(**args)
|
20224
|
+
update!(**args)
|
20225
|
+
end
|
20226
|
+
|
20227
|
+
# Update properties of this object
|
20228
|
+
def update!(**args)
|
20229
|
+
@error = args[:error] if args.key?(:error)
|
20230
|
+
@state = args[:state] if args.key?(:state)
|
20231
|
+
end
|
20232
|
+
end
|
20233
|
+
|
20234
|
+
# Request message for CompletionService.RemoveSuggestion method.
|
20235
|
+
class GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest
|
20236
|
+
include Google::Apis::Core::Hashable
|
20237
|
+
|
20238
|
+
# Remove all search history suggestions for the user.
|
20239
|
+
# Corresponds to the JSON property `removeAllSearchHistorySuggestions`
|
20240
|
+
# @return [Boolean]
|
20241
|
+
attr_accessor :remove_all_search_history_suggestions
|
20242
|
+
alias_method :remove_all_search_history_suggestions?, :remove_all_search_history_suggestions
|
20243
|
+
|
20244
|
+
# Required. Time at which the suggestion was removed. If not set, the current
|
20245
|
+
# time will be used.
|
20246
|
+
# Corresponds to the JSON property `removeTime`
|
20247
|
+
# @return [String]
|
20248
|
+
attr_accessor :remove_time
|
20249
|
+
|
20250
|
+
# The search history suggestion to be removed.
|
20251
|
+
# Corresponds to the JSON property `searchHistorySuggestion`
|
20252
|
+
# @return [String]
|
20253
|
+
attr_accessor :search_history_suggestion
|
20254
|
+
|
20255
|
+
# Information of an end user.
|
20256
|
+
# Corresponds to the JSON property `userInfo`
|
20257
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserInfo]
|
20258
|
+
attr_accessor :user_info
|
20259
|
+
|
20260
|
+
# Required. A unique identifier for tracking visitors. For example, this could
|
20261
|
+
# be implemented with an HTTP cookie, which should be able to uniquely identify
|
20262
|
+
# a visitor on a single device. This unique identifier should not change if the
|
20263
|
+
# visitor logs in or out of the website. This field should NOT have a fixed
|
20264
|
+
# value such as `unknown_visitor`. This should be the same identifier as
|
20265
|
+
# UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a
|
20266
|
+
# UTF-8 encoded string with a length limit of 128.
|
20267
|
+
# Corresponds to the JSON property `userPseudoId`
|
20268
|
+
# @return [String]
|
20269
|
+
attr_accessor :user_pseudo_id
|
20270
|
+
|
20271
|
+
def initialize(**args)
|
20272
|
+
update!(**args)
|
20273
|
+
end
|
20274
|
+
|
20275
|
+
# Update properties of this object
|
20276
|
+
def update!(**args)
|
20277
|
+
@remove_all_search_history_suggestions = args[:remove_all_search_history_suggestions] if args.key?(:remove_all_search_history_suggestions)
|
20278
|
+
@remove_time = args[:remove_time] if args.key?(:remove_time)
|
20279
|
+
@search_history_suggestion = args[:search_history_suggestion] if args.key?(:search_history_suggestion)
|
20280
|
+
@user_info = args[:user_info] if args.key?(:user_info)
|
20281
|
+
@user_pseudo_id = args[:user_pseudo_id] if args.key?(:user_pseudo_id)
|
20282
|
+
end
|
20283
|
+
end
|
20284
|
+
|
20285
|
+
# Response message for CompletionService.RemoveSuggestion method.
|
20286
|
+
class GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse
|
20287
|
+
include Google::Apis::Core::Hashable
|
20288
|
+
|
20289
|
+
def initialize(**args)
|
20290
|
+
update!(**args)
|
20291
|
+
end
|
20292
|
+
|
20293
|
+
# Update properties of this object
|
20294
|
+
def update!(**args)
|
20295
|
+
end
|
20296
|
+
end
|
20297
|
+
|
18666
20298
|
# Defines a reply message to user.
|
18667
20299
|
class GoogleCloudDiscoveryengineV1betaReply
|
18668
20300
|
include Google::Apis::Core::Hashable
|
@@ -19215,21 +20847,41 @@ module Google
|
|
19215
20847
|
attr_accessor :query_expansion_spec
|
19216
20848
|
|
19217
20849
|
# The ranking expression controls the customized ranking on retrieval documents.
|
19218
|
-
# This overrides ServingConfig.ranking_expression. The
|
19219
|
-
#
|
19220
|
-
#
|
19221
|
-
#
|
19222
|
-
#
|
19223
|
-
#
|
19224
|
-
#
|
19225
|
-
#
|
19226
|
-
#
|
19227
|
-
#
|
19228
|
-
#
|
20850
|
+
# This overrides ServingConfig.ranking_expression. The syntax and supported
|
20851
|
+
# features depend on the ranking_expression_backend value. If
|
20852
|
+
# ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
|
20853
|
+
# If ranking expression is not provided or set to BYOE, it should be a single
|
20854
|
+
# function or multiple functions that are joined by "+". * ranking_expression =
|
20855
|
+
# function, ` " + ", function `; Supported functions: * double * relevance_score
|
20856
|
+
# * double * dotProduct(embedding_field_path) Function variables: * `
|
20857
|
+
# relevance_score`: pre-defined keywords, used for measure relevance between
|
20858
|
+
# query and document. * `embedding_field_path`: the document embedding field
|
20859
|
+
# used with query embedding vector. * `dotProduct`: embedding function between
|
20860
|
+
# embedding_field_path and query embedding vector. Example ranking expression:
|
20861
|
+
# If document has an embedding field doc_embedding, the ranking expression could
|
20862
|
+
# be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX ===
|
20863
|
+
# If ranking expression is set to CLEARBOX, the following expression types (and
|
20864
|
+
# combinations of those chained using + or * operators) are supported: * double *
|
20865
|
+
# signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal
|
20866
|
+
# rank transformation with second argument being a denominator constant. *
|
20867
|
+
# is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1,
|
20868
|
+
# signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns
|
20869
|
+
# signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(
|
20870
|
+
# fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score,
|
20871
|
+
# 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: *
|
20872
|
+
# gecko_score -- semantic similarity adjustment * bm25_score -- keyword match
|
20873
|
+
# adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank --
|
20874
|
+
# predicted conversion rate adjustment as a rank * freshness_rank -- freshness
|
20875
|
+
# adjustment as a rank * base_rank -- the default rank of the result
|
19229
20876
|
# Corresponds to the JSON property `rankingExpression`
|
19230
20877
|
# @return [String]
|
19231
20878
|
attr_accessor :ranking_expression
|
19232
20879
|
|
20880
|
+
# Optional. The backend to use for the ranking expression evaluation.
|
20881
|
+
# Corresponds to the JSON property `rankingExpressionBackend`
|
20882
|
+
# @return [String]
|
20883
|
+
attr_accessor :ranking_expression_backend
|
20884
|
+
|
19233
20885
|
# The Unicode country/region code (CLDR) of a location, such as "US" and "419".
|
19234
20886
|
# For more information, see [Standard fields](https://cloud.google.com/apis/
|
19235
20887
|
# design/standard_fields). If set, then results will be boosted based on the
|
@@ -19238,9 +20890,15 @@ module Google
|
|
19238
20890
|
# @return [String]
|
19239
20891
|
attr_accessor :region_code
|
19240
20892
|
|
20893
|
+
# The specification for returning the document relevance score.
|
20894
|
+
# Corresponds to the JSON property `relevanceScoreSpec`
|
20895
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec]
|
20896
|
+
attr_accessor :relevance_score_spec
|
20897
|
+
|
19241
20898
|
# The relevance threshold of the search results. Default to Google defined
|
19242
20899
|
# threshold, leveraging a balance of precision and recall to deliver both highly
|
19243
|
-
# accurate results and comprehensive coverage of relevant information.
|
20900
|
+
# accurate results and comprehensive coverage of relevant information. This
|
20901
|
+
# feature is not supported for healthcare search.
|
19244
20902
|
# Corresponds to the JSON property `relevanceThreshold`
|
19245
20903
|
# @return [String]
|
19246
20904
|
attr_accessor :relevance_threshold
|
@@ -19358,7 +21016,9 @@ module Google
|
|
19358
21016
|
@query = args[:query] if args.key?(:query)
|
19359
21017
|
@query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
|
19360
21018
|
@ranking_expression = args[:ranking_expression] if args.key?(:ranking_expression)
|
21019
|
+
@ranking_expression_backend = args[:ranking_expression_backend] if args.key?(:ranking_expression_backend)
|
19361
21020
|
@region_code = args[:region_code] if args.key?(:region_code)
|
21021
|
+
@relevance_score_spec = args[:relevance_score_spec] if args.key?(:relevance_score_spec)
|
19362
21022
|
@relevance_threshold = args[:relevance_threshold] if args.key?(:relevance_threshold)
|
19363
21023
|
@safe_search = args[:safe_search] if args.key?(:safe_search)
|
19364
21024
|
@search_as_you_type_spec = args[:search_as_you_type_spec] if args.key?(:search_as_you_type_spec)
|
@@ -20189,6 +21849,27 @@ module Google
|
|
20189
21849
|
end
|
20190
21850
|
end
|
20191
21851
|
|
21852
|
+
# The specification for returning the document relevance score.
|
21853
|
+
class GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec
|
21854
|
+
include Google::Apis::Core::Hashable
|
21855
|
+
|
21856
|
+
# Optional. Whether to return the relevance score for search results. The higher
|
21857
|
+
# the score, the more relevant the document is to the query.
|
21858
|
+
# Corresponds to the JSON property `returnRelevanceScore`
|
21859
|
+
# @return [Boolean]
|
21860
|
+
attr_accessor :return_relevance_score
|
21861
|
+
alias_method :return_relevance_score?, :return_relevance_score
|
21862
|
+
|
21863
|
+
def initialize(**args)
|
21864
|
+
update!(**args)
|
21865
|
+
end
|
21866
|
+
|
21867
|
+
# Update properties of this object
|
21868
|
+
def update!(**args)
|
21869
|
+
@return_relevance_score = args[:return_relevance_score] if args.key?(:return_relevance_score)
|
21870
|
+
end
|
21871
|
+
end
|
21872
|
+
|
20192
21873
|
# Specification for search as you type in search requests.
|
20193
21874
|
class GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec
|
20194
21875
|
include Google::Apis::Core::Hashable
|
@@ -20230,7 +21911,7 @@ module Google
|
|
20230
21911
|
attr_accessor :query_id
|
20231
21912
|
|
20232
21913
|
# The number of top search results to persist. The persisted search results can
|
20233
|
-
# be used for the subsequent /answer api call. This field is
|
21914
|
+
# be used for the subsequent /answer api call. This field is similar to the `
|
20234
21915
|
# summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.
|
20235
21916
|
# summary_result_count. At most 10 results for documents mode, or 50 for chunks
|
20236
21917
|
# mode.
|
@@ -20355,6 +22036,15 @@ module Google
|
|
20355
22036
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo]
|
20356
22037
|
attr_accessor :session_info
|
20357
22038
|
|
22039
|
+
# Corrected query with low confidence, AKA did you mean query. Compared with
|
22040
|
+
# corrected_query, this field is set when SpellCorrector returned a response,
|
22041
|
+
# but FPR(full page replacement) is not triggered because the corrction is of
|
22042
|
+
# low confidence(eg, reversed because there are matches of the original query in
|
22043
|
+
# document corpus).
|
22044
|
+
# Corresponds to the JSON property `suggestedQuery`
|
22045
|
+
# @return [String]
|
22046
|
+
attr_accessor :suggested_query
|
22047
|
+
|
20358
22048
|
# Summary of the top N search results specified by the summary spec.
|
20359
22049
|
# Corresponds to the JSON property `summary`
|
20360
22050
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummary]
|
@@ -20387,6 +22077,7 @@ module Google
|
|
20387
22077
|
@results = args[:results] if args.key?(:results)
|
20388
22078
|
@search_link_promotions = args[:search_link_promotions] if args.key?(:search_link_promotions)
|
20389
22079
|
@session_info = args[:session_info] if args.key?(:session_info)
|
22080
|
+
@suggested_query = args[:suggested_query] if args.key?(:suggested_query)
|
20390
22081
|
@summary = args[:summary] if args.key?(:summary)
|
20391
22082
|
@total_size = args[:total_size] if args.key?(:total_size)
|
20392
22083
|
end
|
@@ -20548,6 +22239,12 @@ module Google
|
|
20548
22239
|
# @return [String]
|
20549
22240
|
attr_accessor :rewritten_query
|
20550
22241
|
|
22242
|
+
# The SQL request that was generated from the natural language query
|
22243
|
+
# understanding phase.
|
22244
|
+
# Corresponds to the JSON property `sqlRequest`
|
22245
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest]
|
22246
|
+
attr_accessor :sql_request
|
22247
|
+
|
20551
22248
|
# The filters that were extracted from the input query represented in a
|
20552
22249
|
# structured form.
|
20553
22250
|
# Corresponds to the JSON property `structuredExtractedFilter`
|
@@ -20562,10 +22259,31 @@ module Google
|
|
20562
22259
|
def update!(**args)
|
20563
22260
|
@extracted_filters = args[:extracted_filters] if args.key?(:extracted_filters)
|
20564
22261
|
@rewritten_query = args[:rewritten_query] if args.key?(:rewritten_query)
|
22262
|
+
@sql_request = args[:sql_request] if args.key?(:sql_request)
|
20565
22263
|
@structured_extracted_filter = args[:structured_extracted_filter] if args.key?(:structured_extracted_filter)
|
20566
22264
|
end
|
20567
22265
|
end
|
20568
22266
|
|
22267
|
+
# The SQL request that was generated from the natural language query
|
22268
|
+
# understanding phase.
|
22269
|
+
class GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest
|
22270
|
+
include Google::Apis::Core::Hashable
|
22271
|
+
|
22272
|
+
# Optional. The SQL query in text format.
|
22273
|
+
# Corresponds to the JSON property `sqlQuery`
|
22274
|
+
# @return [String]
|
22275
|
+
attr_accessor :sql_query
|
22276
|
+
|
22277
|
+
def initialize(**args)
|
22278
|
+
update!(**args)
|
22279
|
+
end
|
22280
|
+
|
22281
|
+
# Update properties of this object
|
22282
|
+
def update!(**args)
|
22283
|
+
@sql_query = args[:sql_query] if args.key?(:sql_query)
|
22284
|
+
end
|
22285
|
+
end
|
22286
|
+
|
20569
22287
|
# The filters that were extracted from the input query represented in a
|
20570
22288
|
# structured form.
|
20571
22289
|
class GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter
|
@@ -20860,7 +22578,7 @@ module Google
|
|
20860
22578
|
# @return [String]
|
20861
22579
|
attr_accessor :id
|
20862
22580
|
|
20863
|
-
# Google provided available scores.
|
22581
|
+
# Output only. Google provided available scores.
|
20864
22582
|
# Corresponds to the JSON property `modelScores`
|
20865
22583
|
# @return [Hash<String,Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDoubleList>]
|
20866
22584
|
attr_accessor :model_scores
|
@@ -21511,6 +23229,113 @@ module Google
|
|
21511
23229
|
end
|
21512
23230
|
end
|
21513
23231
|
|
23232
|
+
# Metadata related to the progress of the CrawlRateManagementService.
|
23233
|
+
# SetDedicatedCrawlRate operation. This will be returned by the google.
|
23234
|
+
# longrunning.Operation.metadata field.
|
23235
|
+
class GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata
|
23236
|
+
include Google::Apis::Core::Hashable
|
23237
|
+
|
23238
|
+
# Operation create time.
|
23239
|
+
# Corresponds to the JSON property `createTime`
|
23240
|
+
# @return [String]
|
23241
|
+
attr_accessor :create_time
|
23242
|
+
|
23243
|
+
# Operation last update time. If the operation is done, this is also the finish
|
23244
|
+
# time.
|
23245
|
+
# Corresponds to the JSON property `updateTime`
|
23246
|
+
# @return [String]
|
23247
|
+
attr_accessor :update_time
|
23248
|
+
|
23249
|
+
def initialize(**args)
|
23250
|
+
update!(**args)
|
23251
|
+
end
|
23252
|
+
|
23253
|
+
# Update properties of this object
|
23254
|
+
def update!(**args)
|
23255
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
23256
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
23257
|
+
end
|
23258
|
+
end
|
23259
|
+
|
23260
|
+
# Request message for CrawlRateManagementService.SetDedicatedCrawlRate method.
|
23261
|
+
# The user can set the crawl rate for a crawl_rate_scope they own. They can set
|
23262
|
+
# up an overall crawl rate, or set up a user-triggered crawl rate and a auto-
|
23263
|
+
# refresh crawl rate separately. If an overall crawl rate is set, Vertex AI will
|
23264
|
+
# automatically splits crawl_rate into user-triggered and auto-refresh.
|
23265
|
+
class GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest
|
23266
|
+
include Google::Apis::Core::Hashable
|
23267
|
+
|
23268
|
+
# Optional. The crawl QPS set by the user. It is not guaranteed that Vertex
|
23269
|
+
# crawl bot will crawl at this QPS. If the crawl rate is too high, the real QPS
|
23270
|
+
# may be lower than the value set by the user to avoid overloading the user's
|
23271
|
+
# website.
|
23272
|
+
# Corresponds to the JSON property `crawlRate`
|
23273
|
+
# @return [Fixnum]
|
23274
|
+
attr_accessor :crawl_rate
|
23275
|
+
|
23276
|
+
# Required. The scope of the crawl rate that the user wants to config. Currently,
|
23277
|
+
# only domain and host name are supported. A domain name example: `example.com`.
|
23278
|
+
# A host name example: `www.example.com`. Please do not include `/` in the
|
23279
|
+
# domain or host name.
|
23280
|
+
# Corresponds to the JSON property `crawlRateScope`
|
23281
|
+
# @return [String]
|
23282
|
+
attr_accessor :crawl_rate_scope
|
23283
|
+
|
23284
|
+
# Optional. Whether it's the crawl rate of user-triggered or auto-refresh.
|
23285
|
+
# Corresponds to the JSON property `crawlType`
|
23286
|
+
# @return [String]
|
23287
|
+
attr_accessor :crawl_type
|
23288
|
+
|
23289
|
+
# Optional. Whether the rate is explicitly set by users, or set by vertex AI.
|
23290
|
+
# Corresponds to the JSON property `mode`
|
23291
|
+
# @return [String]
|
23292
|
+
attr_accessor :mode
|
23293
|
+
|
23294
|
+
def initialize(**args)
|
23295
|
+
update!(**args)
|
23296
|
+
end
|
23297
|
+
|
23298
|
+
# Update properties of this object
|
23299
|
+
def update!(**args)
|
23300
|
+
@crawl_rate = args[:crawl_rate] if args.key?(:crawl_rate)
|
23301
|
+
@crawl_rate_scope = args[:crawl_rate_scope] if args.key?(:crawl_rate_scope)
|
23302
|
+
@crawl_type = args[:crawl_type] if args.key?(:crawl_type)
|
23303
|
+
@mode = args[:mode] if args.key?(:mode)
|
23304
|
+
end
|
23305
|
+
end
|
23306
|
+
|
23307
|
+
# Response message for CrawlRateManagementService.SetDedicatedCrawlRate method.
|
23308
|
+
# It simply returns the state of the response, and an error message if the state
|
23309
|
+
# is FAILED.
|
23310
|
+
class GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse
|
23311
|
+
include Google::Apis::Core::Hashable
|
23312
|
+
|
23313
|
+
# The `Status` type defines a logical error model that is suitable for different
|
23314
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
23315
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
23316
|
+
# data: error code, error message, and error details. You can find out more
|
23317
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
23318
|
+
# //cloud.google.com/apis/design/errors).
|
23319
|
+
# Corresponds to the JSON property `error`
|
23320
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus]
|
23321
|
+
attr_accessor :error
|
23322
|
+
|
23323
|
+
# Output only. The state of the response.
|
23324
|
+
# Corresponds to the JSON property `state`
|
23325
|
+
# @return [String]
|
23326
|
+
attr_accessor :state
|
23327
|
+
|
23328
|
+
def initialize(**args)
|
23329
|
+
update!(**args)
|
23330
|
+
end
|
23331
|
+
|
23332
|
+
# Update properties of this object
|
23333
|
+
def update!(**args)
|
23334
|
+
@error = args[:error] if args.key?(:error)
|
23335
|
+
@state = args[:state] if args.key?(:state)
|
23336
|
+
end
|
23337
|
+
end
|
23338
|
+
|
21514
23339
|
# Metadata for single-regional CMEKs.
|
21515
23340
|
class GoogleCloudDiscoveryengineV1betaSingleRegionKey
|
21516
23341
|
include Google::Apis::Core::Hashable
|