google-apis-discoveryengine_v1 0.27.0 → 0.28.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.
@@ -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::DiscoveryengineV1::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::DiscoveryengineV1::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)
@@ -880,7 +948,9 @@ module Google
880
948
  class GoogleCloudDiscoveryengineV1AnswerCitation
881
949
  include Google::Apis::Core::Hashable
882
950
 
883
- # End of the attributed segment, exclusive.
951
+ # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode).
952
+ # If there are multi-byte characters,such as non-ASCII characters, the index
953
+ # measurement is longer than the string length.
884
954
  # Corresponds to the JSON property `endIndex`
885
955
  # @return [Fixnum]
886
956
  attr_accessor :end_index
@@ -891,6 +961,8 @@ module Google
891
961
  attr_accessor :sources
892
962
 
893
963
  # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
964
+ # If there are multi-byte characters,such as non-ASCII characters, the index
965
+ # measurement is longer than the string length.
894
966
  # Corresponds to the JSON property `startIndex`
895
967
  # @return [Fixnum]
896
968
  attr_accessor :start_index
@@ -996,6 +1068,11 @@ module Google
996
1068
  attr_accessor :asynchronous_mode
997
1069
  alias_method :asynchronous_mode?, :asynchronous_mode
998
1070
 
1071
+ # End user specification.
1072
+ # Corresponds to the JSON property `endUserSpec`
1073
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec]
1074
+ attr_accessor :end_user_spec
1075
+
999
1076
  # Grounding specification.
1000
1077
  # Corresponds to the JSON property `groundingSpec`
1001
1078
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec]
@@ -1071,6 +1148,7 @@ module Google
1071
1148
  def update!(**args)
1072
1149
  @answer_generation_spec = args[:answer_generation_spec] if args.key?(:answer_generation_spec)
1073
1150
  @asynchronous_mode = args[:asynchronous_mode] if args.key?(:asynchronous_mode)
1151
+ @end_user_spec = args[:end_user_spec] if args.key?(:end_user_spec)
1074
1152
  @grounding_spec = args[:grounding_spec] if args.key?(:grounding_spec)
1075
1153
  @query = args[:query] if args.key?(:query)
1076
1154
  @query_understanding_spec = args[:query_understanding_spec] if args.key?(:query_understanding_spec)
@@ -1211,6 +1289,90 @@ module Google
1211
1289
  end
1212
1290
  end
1213
1291
 
1292
+ # End user specification.
1293
+ class GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec
1294
+ include Google::Apis::Core::Hashable
1295
+
1296
+ # Optional. End user metadata.
1297
+ # Corresponds to the JSON property `endUserMetadata`
1298
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData>]
1299
+ attr_accessor :end_user_metadata
1300
+
1301
+ def initialize(**args)
1302
+ update!(**args)
1303
+ end
1304
+
1305
+ # Update properties of this object
1306
+ def update!(**args)
1307
+ @end_user_metadata = args[:end_user_metadata] if args.key?(:end_user_metadata)
1308
+ end
1309
+ end
1310
+
1311
+ # End user metadata.
1312
+ class GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData
1313
+ include Google::Apis::Core::Hashable
1314
+
1315
+ # Chunk information.
1316
+ # Corresponds to the JSON property `chunkInfo`
1317
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo]
1318
+ attr_accessor :chunk_info
1319
+
1320
+ def initialize(**args)
1321
+ update!(**args)
1322
+ end
1323
+
1324
+ # Update properties of this object
1325
+ def update!(**args)
1326
+ @chunk_info = args[:chunk_info] if args.key?(:chunk_info)
1327
+ end
1328
+ end
1329
+
1330
+ # Chunk information.
1331
+ class GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo
1332
+ include Google::Apis::Core::Hashable
1333
+
1334
+ # Chunk textual content. It is limited to 8000 characters.
1335
+ # Corresponds to the JSON property `content`
1336
+ # @return [String]
1337
+ attr_accessor :content
1338
+
1339
+ # Document metadata contains the information of the document of the current
1340
+ # chunk.
1341
+ # Corresponds to the JSON property `documentMetadata`
1342
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata]
1343
+ attr_accessor :document_metadata
1344
+
1345
+ def initialize(**args)
1346
+ update!(**args)
1347
+ end
1348
+
1349
+ # Update properties of this object
1350
+ def update!(**args)
1351
+ @content = args[:content] if args.key?(:content)
1352
+ @document_metadata = args[:document_metadata] if args.key?(:document_metadata)
1353
+ end
1354
+ end
1355
+
1356
+ # Document metadata contains the information of the document of the current
1357
+ # chunk.
1358
+ class GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata
1359
+ include Google::Apis::Core::Hashable
1360
+
1361
+ # Title of the document.
1362
+ # Corresponds to the JSON property `title`
1363
+ # @return [String]
1364
+ attr_accessor :title
1365
+
1366
+ def initialize(**args)
1367
+ update!(**args)
1368
+ end
1369
+
1370
+ # Update properties of this object
1371
+ def update!(**args)
1372
+ @title = args[:title] if args.key?(:title)
1373
+ end
1374
+ end
1375
+
1214
1376
  # Grounding specification.
1215
1377
  class GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec
1216
1378
  include Google::Apis::Core::Hashable
@@ -1944,6 +2106,16 @@ module Google
1944
2106
  # @return [Hash<String,Object>]
1945
2107
  attr_accessor :struct_data
1946
2108
 
2109
+ # Output only. The title of the document.
2110
+ # Corresponds to the JSON property `title`
2111
+ # @return [String]
2112
+ attr_accessor :title
2113
+
2114
+ # Output only. The URI of the document.
2115
+ # Corresponds to the JSON property `uri`
2116
+ # @return [String]
2117
+ attr_accessor :uri
2118
+
1947
2119
  def initialize(**args)
1948
2120
  update!(**args)
1949
2121
  end
@@ -1952,6 +2124,8 @@ module Google
1952
2124
  def update!(**args)
1953
2125
  @document = args[:document] if args.key?(:document)
1954
2126
  @struct_data = args[:struct_data] if args.key?(:struct_data)
2127
+ @title = args[:title] if args.key?(:title)
2128
+ @uri = args[:uri] if args.key?(:uri)
1955
2129
  end
1956
2130
  end
1957
2131
 
@@ -2762,7 +2936,12 @@ module Google
2762
2936
  # @return [String]
2763
2937
  attr_accessor :claim_text
2764
2938
 
2765
- # Position indicating the end of the claim in the answer candidate, exclusive.
2939
+ # Position indicating the end of the claim in the answer candidate, exclusive,
2940
+ # in bytes. Note that this is not measured in characters and, therefore, must be
2941
+ # rendered as such. For example, if the claim text contains non-ASCII characters,
2942
+ # the start and end positions vary when measured in characters (programming-
2943
+ # language-dependent) and when measured in bytes (programming-language-
2944
+ # independent).
2766
2945
  # Corresponds to the JSON property `endPos`
2767
2946
  # @return [Fixnum]
2768
2947
  attr_accessor :end_pos
@@ -2777,7 +2956,12 @@ module Google
2777
2956
  alias_method :grounding_check_required?, :grounding_check_required
2778
2957
 
2779
2958
  # Position indicating the start of the claim in the answer candidate, measured
2780
- # in bytes.
2959
+ # in bytes. Note that this is not measured in characters and, therefore, must be
2960
+ # rendered in the user interface keeping in mind that some characters may take
2961
+ # more than one byte. For example, if the claim text contains non-ASCII
2962
+ # characters, the start and end positions vary when measured in characters (
2963
+ # programming-language-dependent) and when measured in bytes (programming-
2964
+ # language-independent).
2781
2965
  # Corresponds to the JSON property `startPos`
2782
2966
  # @return [Fixnum]
2783
2967
  attr_accessor :start_pos
@@ -3046,13 +3230,13 @@ module Google
3046
3230
  attr_accessor :is_default
3047
3231
  alias_method :is_default?, :is_default
3048
3232
 
3049
- # Kms key resource name which will be used to encrypt resources `projects/`
3233
+ # KMS key resource name which will be used to encrypt resources `projects/`
3050
3234
  # project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
3051
3235
  # Corresponds to the JSON property `kmsKey`
3052
3236
  # @return [String]
3053
3237
  attr_accessor :kms_key
3054
3238
 
3055
- # Kms key version resource name which will be used to encrypt resources `/
3239
+ # KMS key version resource name which will be used to encrypt resources `/
3056
3240
  # cryptoKeyVersions/`keyVersion``.
3057
3241
  # Corresponds to the JSON property `kmsKeyVersion`
3058
3242
  # @return [String]
@@ -3063,9 +3247,9 @@ module Google
3063
3247
  # @return [Fixnum]
3064
3248
  attr_accessor :last_rotation_timestamp_micros
3065
3249
 
3066
- # Required. Name of the CmekConfig, of the form `projects/`project`/locations/`
3067
- # location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/`
3068
- # cmekConfig``.
3250
+ # Required. The name of the CmekConfig of the form `projects/`project`/locations/
3251
+ # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
3252
+ # `cmekConfig``.
3069
3253
  # Corresponds to the JSON property `name`
3070
3254
  # @return [String]
3071
3255
  attr_accessor :name
@@ -3075,7 +3259,7 @@ module Google
3075
3259
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SingleRegionKey>]
3076
3260
  attr_accessor :single_region_keys
3077
3261
 
3078
- # Output only. State of the CmekConfig.
3262
+ # Output only. The states of the CmekConfig.
3079
3263
  # Corresponds to the JSON property `state`
3080
3264
  # @return [String]
3081
3265
  attr_accessor :state
@@ -3451,6 +3635,13 @@ module Google
3451
3635
  # @return [Float]
3452
3636
  attr_accessor :fixed_boost
3453
3637
 
3638
+ # Specification for custom ranking based on customer specified attribute value.
3639
+ # It provides more controls for customized ranking than the simple (condition,
3640
+ # boost) combination above.
3641
+ # Corresponds to the JSON property `interpolationBoostSpec`
3642
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec]
3643
+ attr_accessor :interpolation_boost_spec
3644
+
3454
3645
  def initialize(**args)
3455
3646
  update!(**args)
3456
3647
  end
@@ -3461,6 +3652,85 @@ module Google
3461
3652
  @data_store = args[:data_store] if args.key?(:data_store)
3462
3653
  @filter = args[:filter] if args.key?(:filter)
3463
3654
  @fixed_boost = args[:fixed_boost] if args.key?(:fixed_boost)
3655
+ @interpolation_boost_spec = args[:interpolation_boost_spec] if args.key?(:interpolation_boost_spec)
3656
+ end
3657
+ end
3658
+
3659
+ # Specification for custom ranking based on customer specified attribute value.
3660
+ # It provides more controls for customized ranking than the simple (condition,
3661
+ # boost) combination above.
3662
+ class GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec
3663
+ include Google::Apis::Core::Hashable
3664
+
3665
+ # Optional. The attribute type to be used to determine the boost amount. The
3666
+ # attribute value can be derived from the field value of the specified
3667
+ # field_name. In the case of numerical it is straightforward i.e.
3668
+ # attribute_value = numerical_field_value. In the case of freshness however,
3669
+ # attribute_value = (time.now() - datetime_field_value).
3670
+ # Corresponds to the JSON property `attributeType`
3671
+ # @return [String]
3672
+ attr_accessor :attribute_type
3673
+
3674
+ # Optional. The control points used to define the curve. The monotonic function (
3675
+ # defined through the interpolation_type above) passes through the control
3676
+ # points listed here.
3677
+ # Corresponds to the JSON property `controlPoints`
3678
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint>]
3679
+ attr_accessor :control_points
3680
+
3681
+ # Optional. The name of the field whose value will be used to determine the
3682
+ # boost amount.
3683
+ # Corresponds to the JSON property `fieldName`
3684
+ # @return [String]
3685
+ attr_accessor :field_name
3686
+
3687
+ # Optional. The interpolation type to be applied to connect the control points
3688
+ # listed below.
3689
+ # Corresponds to the JSON property `interpolationType`
3690
+ # @return [String]
3691
+ attr_accessor :interpolation_type
3692
+
3693
+ def initialize(**args)
3694
+ update!(**args)
3695
+ end
3696
+
3697
+ # Update properties of this object
3698
+ def update!(**args)
3699
+ @attribute_type = args[:attribute_type] if args.key?(:attribute_type)
3700
+ @control_points = args[:control_points] if args.key?(:control_points)
3701
+ @field_name = args[:field_name] if args.key?(:field_name)
3702
+ @interpolation_type = args[:interpolation_type] if args.key?(:interpolation_type)
3703
+ end
3704
+ end
3705
+
3706
+ # The control points used to define the curve. The curve defined through these
3707
+ # control points can only be monotonically increasing or decreasing(constant
3708
+ # values are acceptable).
3709
+ class GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint
3710
+ include Google::Apis::Core::Hashable
3711
+
3712
+ # Optional. Can be one of: 1. The numerical field value. 2. The duration spec
3713
+ # for freshness: The value must be formatted as an XSD `dayTimeDuration` value (
3714
+ # a restricted subset of an ISO 8601 duration value). The pattern for this is: `
3715
+ # nDnM]`.
3716
+ # Corresponds to the JSON property `attributeValue`
3717
+ # @return [String]
3718
+ attr_accessor :attribute_value
3719
+
3720
+ # Optional. The value between -1 to 1 by which to boost the score if the
3721
+ # attribute_value evaluates to the value specified above.
3722
+ # Corresponds to the JSON property `boostAmount`
3723
+ # @return [Float]
3724
+ attr_accessor :boost_amount
3725
+
3726
+ def initialize(**args)
3727
+ update!(**args)
3728
+ end
3729
+
3730
+ # Update properties of this object
3731
+ def update!(**args)
3732
+ @attribute_value = args[:attribute_value] if args.key?(:attribute_value)
3733
+ @boost_amount = args[:boost_amount] if args.key?(:boost_amount)
3464
3734
  end
3465
3735
  end
3466
3736
 
@@ -3871,6 +4141,34 @@ module Google
3871
4141
  end
3872
4142
  end
3873
4143
 
4144
+ # Metadata related to the progress of the SiteSearchEngineService.CreateSitemap
4145
+ # operation. This will be returned by the google.longrunning.Operation.metadata
4146
+ # field.
4147
+ class GoogleCloudDiscoveryengineV1CreateSitemapMetadata
4148
+ include Google::Apis::Core::Hashable
4149
+
4150
+ # Operation create time.
4151
+ # Corresponds to the JSON property `createTime`
4152
+ # @return [String]
4153
+ attr_accessor :create_time
4154
+
4155
+ # Operation last update time. If the operation is done, this is also the finish
4156
+ # time.
4157
+ # Corresponds to the JSON property `updateTime`
4158
+ # @return [String]
4159
+ attr_accessor :update_time
4160
+
4161
+ def initialize(**args)
4162
+ update!(**args)
4163
+ end
4164
+
4165
+ # Update properties of this object
4166
+ def update!(**args)
4167
+ @create_time = args[:create_time] if args.key?(:create_time)
4168
+ @update_time = args[:update_time] if args.key?(:update_time)
4169
+ end
4170
+ end
4171
+
3874
4172
  # Metadata related to the progress of the SiteSearchEngineService.
3875
4173
  # CreateTargetSite operation. This will be returned by the google.longrunning.
3876
4174
  # Operation.metadata field.
@@ -4054,7 +4352,7 @@ module Google
4054
4352
  # @return [String]
4055
4353
  attr_accessor :create_time
4056
4354
 
4057
- # Output only. The id of the default Schema asscociated to this data store.
4355
+ # Output only. The id of the default Schema associated to this data store.
4058
4356
  # Corresponds to the JSON property `defaultSchemaId`
4059
4357
  # @return [String]
4060
4358
  attr_accessor :default_schema_id
@@ -4073,6 +4371,19 @@ module Google
4073
4371
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentProcessingConfig]
4074
4372
  attr_accessor :document_processing_config
4075
4373
 
4374
+ # Config to data store for `HEALTHCARE_FHIR` vertical.
4375
+ # Corresponds to the JSON property `healthcareFhirConfig`
4376
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1HealthcareFhirConfig]
4377
+ attr_accessor :healthcare_fhir_config
4378
+
4379
+ # Immutable. The fully qualified resource name of the associated
4380
+ # IdentityMappingStore. This field can only be set for acl_enabled DataStores
4381
+ # with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/`project`/locations/`
4382
+ # location`/identityMappingStores/`identity_mapping_store``.
4383
+ # Corresponds to the JSON property `identityMappingStore`
4384
+ # @return [String]
4385
+ attr_accessor :identity_mapping_store
4386
+
4076
4387
  # Immutable. The industry vertical that the data store registers.
4077
4388
  # Corresponds to the JSON property `industryVertical`
4078
4389
  # @return [String]
@@ -4137,6 +4448,8 @@ module Google
4137
4448
  @default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
4138
4449
  @display_name = args[:display_name] if args.key?(:display_name)
4139
4450
  @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
4451
+ @healthcare_fhir_config = args[:healthcare_fhir_config] if args.key?(:healthcare_fhir_config)
4452
+ @identity_mapping_store = args[:identity_mapping_store] if args.key?(:identity_mapping_store)
4140
4453
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
4141
4454
  @is_infobot_faq_data_store = args[:is_infobot_faq_data_store] if args.key?(:is_infobot_faq_data_store)
4142
4455
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
@@ -4217,6 +4530,34 @@ module Google
4217
4530
  end
4218
4531
  end
4219
4532
 
4533
+ # Metadata related to the progress of the CmekConfigService.DeleteCmekConfig
4534
+ # operation. This will be returned by the google.longrunning.Operation.metadata
4535
+ # field.
4536
+ class GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata
4537
+ include Google::Apis::Core::Hashable
4538
+
4539
+ # Operation create time.
4540
+ # Corresponds to the JSON property `createTime`
4541
+ # @return [String]
4542
+ attr_accessor :create_time
4543
+
4544
+ # Operation last update time. If the operation is done, this is also the finish
4545
+ # time.
4546
+ # Corresponds to the JSON property `updateTime`
4547
+ # @return [String]
4548
+ attr_accessor :update_time
4549
+
4550
+ def initialize(**args)
4551
+ update!(**args)
4552
+ end
4553
+
4554
+ # Update properties of this object
4555
+ def update!(**args)
4556
+ @create_time = args[:create_time] if args.key?(:create_time)
4557
+ @update_time = args[:update_time] if args.key?(:update_time)
4558
+ end
4559
+ end
4560
+
4220
4561
  # Metadata related to the progress of the DataStoreService.DeleteDataStore
4221
4562
  # operation. This will be returned by the google.longrunning.Operation.metadata
4222
4563
  # field.
@@ -4326,10 +4667,10 @@ module Google
4326
4667
  end
4327
4668
  end
4328
4669
 
4329
- # Metadata related to the progress of the SiteSearchEngineService.
4330
- # DeleteTargetSite operation. This will be returned by the google.longrunning.
4331
- # Operation.metadata field.
4332
- class GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata
4670
+ # Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap
4671
+ # operation. This will be returned by the google.longrunning.Operation.metadata
4672
+ # field.
4673
+ class GoogleCloudDiscoveryengineV1DeleteSitemapMetadata
4333
4674
  include Google::Apis::Core::Hashable
4334
4675
 
4335
4676
  # Operation create time.
@@ -4355,9 +4696,9 @@ module Google
4355
4696
  end
4356
4697
 
4357
4698
  # Metadata related to the progress of the SiteSearchEngineService.
4358
- # DisableAdvancedSiteSearch operation. This will be returned by the google.
4359
- # longrunning.Operation.metadata field.
4360
- class GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata
4699
+ # DeleteTargetSite operation. This will be returned by the google.longrunning.
4700
+ # Operation.metadata field.
4701
+ class GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata
4361
4702
  include Google::Apis::Core::Hashable
4362
4703
 
4363
4704
  # Operation create time.
@@ -4382,7 +4723,35 @@ module Google
4382
4723
  end
4383
4724
  end
4384
4725
 
4385
- # Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
4726
+ # Metadata related to the progress of the SiteSearchEngineService.
4727
+ # DisableAdvancedSiteSearch operation. This will be returned by the google.
4728
+ # longrunning.Operation.metadata field.
4729
+ class GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata
4730
+ include Google::Apis::Core::Hashable
4731
+
4732
+ # Operation create time.
4733
+ # Corresponds to the JSON property `createTime`
4734
+ # @return [String]
4735
+ attr_accessor :create_time
4736
+
4737
+ # Operation last update time. If the operation is done, this is also the finish
4738
+ # time.
4739
+ # Corresponds to the JSON property `updateTime`
4740
+ # @return [String]
4741
+ attr_accessor :update_time
4742
+
4743
+ def initialize(**args)
4744
+ update!(**args)
4745
+ end
4746
+
4747
+ # Update properties of this object
4748
+ def update!(**args)
4749
+ @create_time = args[:create_time] if args.key?(:create_time)
4750
+ @update_time = args[:update_time] if args.key?(:update_time)
4751
+ end
4752
+ end
4753
+
4754
+ # Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
4386
4755
  class GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest
4387
4756
  include Google::Apis::Core::Hashable
4388
4757
 
@@ -4818,6 +5187,25 @@ module Google
4818
5187
  end
4819
5188
  end
4820
5189
 
5190
+ # Double list.
5191
+ class GoogleCloudDiscoveryengineV1DoubleList
5192
+ include Google::Apis::Core::Hashable
5193
+
5194
+ # Double values.
5195
+ # Corresponds to the JSON property `values`
5196
+ # @return [Array<Float>]
5197
+ attr_accessor :values
5198
+
5199
+ def initialize(**args)
5200
+ update!(**args)
5201
+ end
5202
+
5203
+ # Update properties of this object
5204
+ def update!(**args)
5205
+ @values = args[:values] if args.key?(:values)
5206
+ end
5207
+ end
5208
+
4821
5209
  # Metadata related to the progress of the SiteSearchEngineService.
4822
5210
  # EnableAdvancedSiteSearch operation. This will be returned by the google.
4823
5211
  # longrunning.Operation.metadata field.
@@ -4983,6 +5371,17 @@ module Google
4983
5371
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig]
4984
5372
  attr_accessor :agent_creation_config
4985
5373
 
5374
+ # Optional. If the flag set to true, we allow the agent and engine are in
5375
+ # different locations, otherwise the agent and engine are required to be in the
5376
+ # same location. The flag is set to false by default. Note that the `
5377
+ # allow_cross_region` are one-time consumed by and passed to EngineService.
5378
+ # CreateEngine. It means they cannot be retrieved using EngineService.GetEngine
5379
+ # or EngineService.ListEngines API after engine creation.
5380
+ # Corresponds to the JSON property `allowCrossRegion`
5381
+ # @return [Boolean]
5382
+ attr_accessor :allow_cross_region
5383
+ alias_method :allow_cross_region?, :allow_cross_region
5384
+
4986
5385
  # The resource name of an exist Dialogflow agent to link to this Chat Engine.
4987
5386
  # Customers can either provide `agent_creation_config` to create agent or
4988
5387
  # provide an agent name that links the agent with the Chat engine. Format: `
@@ -5002,6 +5401,7 @@ module Google
5002
5401
  # Update properties of this object
5003
5402
  def update!(**args)
5004
5403
  @agent_creation_config = args[:agent_creation_config] if args.key?(:agent_creation_config)
5404
+ @allow_cross_region = args[:allow_cross_region] if args.key?(:allow_cross_region)
5005
5405
  @dialogflow_agent_to_link = args[:dialogflow_agent_to_link] if args.key?(:dialogflow_agent_to_link)
5006
5406
  end
5007
5407
  end
@@ -5193,6 +5593,44 @@ module Google
5193
5593
  end
5194
5594
  end
5195
5595
 
5596
+ # Response message for SiteSearchEngineService.FetchSitemaps method.
5597
+ class GoogleCloudDiscoveryengineV1FetchSitemapsResponse
5598
+ include Google::Apis::Core::Hashable
5599
+
5600
+ # List of Sitemaps fetched.
5601
+ # Corresponds to the JSON property `sitemapsMetadata`
5602
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata>]
5603
+ attr_accessor :sitemaps_metadata
5604
+
5605
+ def initialize(**args)
5606
+ update!(**args)
5607
+ end
5608
+
5609
+ # Update properties of this object
5610
+ def update!(**args)
5611
+ @sitemaps_metadata = args[:sitemaps_metadata] if args.key?(:sitemaps_metadata)
5612
+ end
5613
+ end
5614
+
5615
+ # Contains a Sitemap and its metadata.
5616
+ class GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata
5617
+ include Google::Apis::Core::Hashable
5618
+
5619
+ # A sitemap for the SiteSearchEngine.
5620
+ # Corresponds to the JSON property `sitemap`
5621
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Sitemap]
5622
+ attr_accessor :sitemap
5623
+
5624
+ def initialize(**args)
5625
+ update!(**args)
5626
+ end
5627
+
5628
+ # Update properties of this object
5629
+ def update!(**args)
5630
+ @sitemap = args[:sitemap] if args.key?(:sitemap)
5631
+ end
5632
+ end
5633
+
5196
5634
  # Cloud FhirStore source import data from.
5197
5635
  class GoogleCloudDiscoveryengineV1FhirStoreSource
5198
5636
  include Google::Apis::Core::Hashable
@@ -5942,6 +6380,144 @@ module Google
5942
6380
  end
5943
6381
  end
5944
6382
 
6383
+ # Config to data store for `HEALTHCARE_FHIR` vertical.
6384
+ class GoogleCloudDiscoveryengineV1HealthcareFhirConfig
6385
+ include Google::Apis::Core::Hashable
6386
+
6387
+ # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set
6388
+ # to `true`, the predefined healthcare fhir schema can be extended for more
6389
+ # customized searching and filtering.
6390
+ # Corresponds to the JSON property `enableConfigurableSchema`
6391
+ # @return [Boolean]
6392
+ attr_accessor :enable_configurable_schema
6393
+ alias_method :enable_configurable_schema?, :enable_configurable_schema
6394
+
6395
+ # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If
6396
+ # set to `true`, the batch ingestion will be processed in a static indexing mode
6397
+ # which is slower but more capable of handling larger volume.
6398
+ # Corresponds to the JSON property `enableStaticIndexingForBatchIngestion`
6399
+ # @return [Boolean]
6400
+ attr_accessor :enable_static_indexing_for_batch_ingestion
6401
+ alias_method :enable_static_indexing_for_batch_ingestion?, :enable_static_indexing_for_batch_ingestion
6402
+
6403
+ def initialize(**args)
6404
+ update!(**args)
6405
+ end
6406
+
6407
+ # Update properties of this object
6408
+ def update!(**args)
6409
+ @enable_configurable_schema = args[:enable_configurable_schema] if args.key?(:enable_configurable_schema)
6410
+ @enable_static_indexing_for_batch_ingestion = args[:enable_static_indexing_for_batch_ingestion] if args.key?(:enable_static_indexing_for_batch_ingestion)
6411
+ end
6412
+ end
6413
+
6414
+ # Identity Mapping Entry that maps an external identity to an internal identity.
6415
+ class GoogleCloudDiscoveryengineV1IdentityMappingEntry
6416
+ include Google::Apis::Core::Hashable
6417
+
6418
+ # Required. Identity outside the customer identity provider. The length limit of
6419
+ # external identity will be of 100 characters.
6420
+ # Corresponds to the JSON property `externalIdentity`
6421
+ # @return [String]
6422
+ attr_accessor :external_identity
6423
+
6424
+ # Group identifier. For Google Workspace user account, group_id should be the
6425
+ # google workspace group email. For non-google identity provider, group_id is
6426
+ # the mapped group identifier configured during the workforcepool config.
6427
+ # Corresponds to the JSON property `groupId`
6428
+ # @return [String]
6429
+ attr_accessor :group_id
6430
+
6431
+ # User identifier. For Google Workspace user account, user_id should be the
6432
+ # google workspace user email. For non-google identity provider, user_id is the
6433
+ # mapped user identifier configured during the workforcepool config.
6434
+ # Corresponds to the JSON property `userId`
6435
+ # @return [String]
6436
+ attr_accessor :user_id
6437
+
6438
+ def initialize(**args)
6439
+ update!(**args)
6440
+ end
6441
+
6442
+ # Update properties of this object
6443
+ def update!(**args)
6444
+ @external_identity = args[:external_identity] if args.key?(:external_identity)
6445
+ @group_id = args[:group_id] if args.key?(:group_id)
6446
+ @user_id = args[:user_id] if args.key?(:user_id)
6447
+ end
6448
+ end
6449
+
6450
+ # IdentityMappingEntry LongRunningOperation metadata for
6451
+ # IdentityMappingStoreService.ImportIdentityMappings and
6452
+ # IdentityMappingStoreService.PurgeIdentityMappings
6453
+ class GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata
6454
+ include Google::Apis::Core::Hashable
6455
+
6456
+ # The number of IdentityMappingEntries that failed to be processed.
6457
+ # Corresponds to the JSON property `failureCount`
6458
+ # @return [Fixnum]
6459
+ attr_accessor :failure_count
6460
+
6461
+ # The number of IdentityMappingEntries that were successfully processed.
6462
+ # Corresponds to the JSON property `successCount`
6463
+ # @return [Fixnum]
6464
+ attr_accessor :success_count
6465
+
6466
+ # The total number of IdentityMappingEntries that were processed.
6467
+ # Corresponds to the JSON property `totalCount`
6468
+ # @return [Fixnum]
6469
+ attr_accessor :total_count
6470
+
6471
+ def initialize(**args)
6472
+ update!(**args)
6473
+ end
6474
+
6475
+ # Update properties of this object
6476
+ def update!(**args)
6477
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
6478
+ @success_count = args[:success_count] if args.key?(:success_count)
6479
+ @total_count = args[:total_count] if args.key?(:total_count)
6480
+ end
6481
+ end
6482
+
6483
+ # Identity Mapping Store which contains Identity Mapping Entries.
6484
+ class GoogleCloudDiscoveryengineV1IdentityMappingStore
6485
+ include Google::Apis::Core::Hashable
6486
+
6487
+ # Configurations used to enable CMEK data encryption with Cloud KMS keys.
6488
+ # Corresponds to the JSON property `cmekConfig`
6489
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CmekConfig]
6490
+ attr_accessor :cmek_config
6491
+
6492
+ # Input only. The KMS key to be used to protect this Identity Mapping Store at
6493
+ # creation time. Must be set for requests that need to comply with CMEK Org
6494
+ # Policy protections. If this field is set and processed successfully, the
6495
+ # Identity Mapping Store will be protected by the KMS key, as indicated in the
6496
+ # cmek_config field.
6497
+ # Corresponds to the JSON property `kmsKeyName`
6498
+ # @return [String]
6499
+ attr_accessor :kms_key_name
6500
+
6501
+ # Immutable. The full resource name of the identity mapping store. Format: `
6502
+ # projects/`project`/locations/`location`/identityMappingStores/`
6503
+ # identity_mapping_store``. This field must be a UTF-8 encoded string with a
6504
+ # length limit of 1024 characters.
6505
+ # Corresponds to the JSON property `name`
6506
+ # @return [String]
6507
+ attr_accessor :name
6508
+
6509
+ def initialize(**args)
6510
+ update!(**args)
6511
+ end
6512
+
6513
+ # Update properties of this object
6514
+ def update!(**args)
6515
+ @cmek_config = args[:cmek_config] if args.key?(:cmek_config)
6516
+ @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
6517
+ @name = args[:name] if args.key?(:name)
6518
+ end
6519
+ end
6520
+
5945
6521
  # Metadata related to the progress of the ImportCompletionSuggestions operation.
5946
6522
  # This will be returned by the google.longrunning.Operation.metadata field.
5947
6523
  class GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata
@@ -6163,6 +6739,14 @@ module Google
6163
6739
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FirestoreSource]
6164
6740
  attr_accessor :firestore_source
6165
6741
 
6742
+ # Optional. Whether to force refresh the unstructured content of the documents.
6743
+ # If set to `true`, the content part of the documents will be refreshed
6744
+ # regardless of the update status of the referencing content.
6745
+ # Corresponds to the JSON property `forceRefreshContent`
6746
+ # @return [Boolean]
6747
+ attr_accessor :force_refresh_content
6748
+ alias_method :force_refresh_content?, :force_refresh_content
6749
+
6166
6750
  # Cloud Storage location for input content.
6167
6751
  # Corresponds to the JSON property `gcsSource`
6168
6752
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GcsSource]
@@ -6223,6 +6807,7 @@ module Google
6223
6807
  @error_config = args[:error_config] if args.key?(:error_config)
6224
6808
  @fhir_store_source = args[:fhir_store_source] if args.key?(:fhir_store_source)
6225
6809
  @firestore_source = args[:firestore_source] if args.key?(:firestore_source)
6810
+ @force_refresh_content = args[:force_refresh_content] if args.key?(:force_refresh_content)
6226
6811
  @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
6227
6812
  @id_field = args[:id_field] if args.key?(:id_field)
6228
6813
  @inline_source = args[:inline_source] if args.key?(:inline_source)
@@ -6300,6 +6885,63 @@ module Google
6300
6885
  end
6301
6886
  end
6302
6887
 
6888
+ # Request message for IdentityMappingStoreService.ImportIdentityMappings
6889
+ class GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest
6890
+ include Google::Apis::Core::Hashable
6891
+
6892
+ # The inline source to import identity mapping entries from.
6893
+ # Corresponds to the JSON property `inlineSource`
6894
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource]
6895
+ attr_accessor :inline_source
6896
+
6897
+ def initialize(**args)
6898
+ update!(**args)
6899
+ end
6900
+
6901
+ # Update properties of this object
6902
+ def update!(**args)
6903
+ @inline_source = args[:inline_source] if args.key?(:inline_source)
6904
+ end
6905
+ end
6906
+
6907
+ # The inline source to import identity mapping entries from.
6908
+ class GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource
6909
+ include Google::Apis::Core::Hashable
6910
+
6911
+ # A maximum of 10000 entries can be imported at one time
6912
+ # Corresponds to the JSON property `identityMappingEntries`
6913
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1IdentityMappingEntry>]
6914
+ attr_accessor :identity_mapping_entries
6915
+
6916
+ def initialize(**args)
6917
+ update!(**args)
6918
+ end
6919
+
6920
+ # Update properties of this object
6921
+ def update!(**args)
6922
+ @identity_mapping_entries = args[:identity_mapping_entries] if args.key?(:identity_mapping_entries)
6923
+ end
6924
+ end
6925
+
6926
+ # Response message for IdentityMappingStoreService.ImportIdentityMappings
6927
+ class GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse
6928
+ include Google::Apis::Core::Hashable
6929
+
6930
+ # A sample of errors encountered while processing the request.
6931
+ # Corresponds to the JSON property `errorSamples`
6932
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleRpcStatus>]
6933
+ attr_accessor :error_samples
6934
+
6935
+ def initialize(**args)
6936
+ update!(**args)
6937
+ end
6938
+
6939
+ # Update properties of this object
6940
+ def update!(**args)
6941
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
6942
+ end
6943
+ end
6944
+
6303
6945
  # Metadata related to the progress of the ImportSuggestionDenyListEntries
6304
6946
  # operation. This is returned by the google.longrunning.Operation.metadata field.
6305
6947
  class GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata
@@ -6720,6 +7362,58 @@ module Google
6720
7362
  end
6721
7363
  end
6722
7364
 
7365
+ # Response message for IdentityMappingStoreService.ListIdentityMappingStores
7366
+ class GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse
7367
+ include Google::Apis::Core::Hashable
7368
+
7369
+ # The Identity Mapping Stores.
7370
+ # Corresponds to the JSON property `identityMappingStores`
7371
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1IdentityMappingStore>]
7372
+ attr_accessor :identity_mapping_stores
7373
+
7374
+ # A token that can be sent as `page_token` to retrieve the next page. If this
7375
+ # field is omitted, there are no subsequent pages.
7376
+ # Corresponds to the JSON property `nextPageToken`
7377
+ # @return [String]
7378
+ attr_accessor :next_page_token
7379
+
7380
+ def initialize(**args)
7381
+ update!(**args)
7382
+ end
7383
+
7384
+ # Update properties of this object
7385
+ def update!(**args)
7386
+ @identity_mapping_stores = args[:identity_mapping_stores] if args.key?(:identity_mapping_stores)
7387
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
7388
+ end
7389
+ end
7390
+
7391
+ # Response message for IdentityMappingStoreService.ListIdentityMappings
7392
+ class GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse
7393
+ include Google::Apis::Core::Hashable
7394
+
7395
+ # The Identity Mapping Entries.
7396
+ # Corresponds to the JSON property `identityMappingEntries`
7397
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1IdentityMappingEntry>]
7398
+ attr_accessor :identity_mapping_entries
7399
+
7400
+ # A token that can be sent as `page_token` to retrieve the next page. If this
7401
+ # field is omitted, there are no subsequent pages.
7402
+ # Corresponds to the JSON property `nextPageToken`
7403
+ # @return [String]
7404
+ attr_accessor :next_page_token
7405
+
7406
+ def initialize(**args)
7407
+ update!(**args)
7408
+ end
7409
+
7410
+ # Update properties of this object
7411
+ def update!(**args)
7412
+ @identity_mapping_entries = args[:identity_mapping_entries] if args.key?(:identity_mapping_entries)
7413
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
7414
+ end
7415
+ end
7416
+
6723
7417
  # Response message for SchemaService.ListSchemas method.
6724
7418
  class GoogleCloudDiscoveryengineV1ListSchemasResponse
6725
7419
  include Google::Apis::Core::Hashable
@@ -7296,6 +7990,67 @@ module Google
7296
7990
  end
7297
7991
  end
7298
7992
 
7993
+ # Request message for IdentityMappingStoreService.PurgeIdentityMappings
7994
+ class GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest
7995
+ include Google::Apis::Core::Hashable
7996
+
7997
+ # Filter matching identity mappings to purge. The eligible field for filtering
7998
+ # is: * `update_time`: in ISO 8601 "zulu" format. * `external_id` Examples: *
7999
+ # Deleting all identity mappings updated in a time range: `update_time > "2012-
8000
+ # 04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"` * Deleting
8001
+ # all identity mappings for a given external_id: `external_id = "id1"` *
8002
+ # Deleting all identity mappings inside an identity mapping store: `*` The
8003
+ # filtering fields are assumed to have an implicit AND. Should not be used with
8004
+ # source. An error will be thrown, if both are provided.
8005
+ # Corresponds to the JSON property `filter`
8006
+ # @return [String]
8007
+ attr_accessor :filter
8008
+
8009
+ # Actually performs the purge. If `force` is set to false, return the expected
8010
+ # purge count without deleting any identity mappings. This field is only
8011
+ # supported for purge with filter. For input source this field is ignored and
8012
+ # data will be purged regardless of the value of this field.
8013
+ # Corresponds to the JSON property `force`
8014
+ # @return [Boolean]
8015
+ attr_accessor :force
8016
+ alias_method :force?, :force
8017
+
8018
+ # The inline source to purge identity mapping entries from.
8019
+ # Corresponds to the JSON property `inlineSource`
8020
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource]
8021
+ attr_accessor :inline_source
8022
+
8023
+ def initialize(**args)
8024
+ update!(**args)
8025
+ end
8026
+
8027
+ # Update properties of this object
8028
+ def update!(**args)
8029
+ @filter = args[:filter] if args.key?(:filter)
8030
+ @force = args[:force] if args.key?(:force)
8031
+ @inline_source = args[:inline_source] if args.key?(:inline_source)
8032
+ end
8033
+ end
8034
+
8035
+ # The inline source to purge identity mapping entries from.
8036
+ class GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource
8037
+ include Google::Apis::Core::Hashable
8038
+
8039
+ # A maximum of 10000 entries can be purged at one time
8040
+ # Corresponds to the JSON property `identityMappingEntries`
8041
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1IdentityMappingEntry>]
8042
+ attr_accessor :identity_mapping_entries
8043
+
8044
+ def initialize(**args)
8045
+ update!(**args)
8046
+ end
8047
+
8048
+ # Update properties of this object
8049
+ def update!(**args)
8050
+ @identity_mapping_entries = args[:identity_mapping_entries] if args.key?(:identity_mapping_entries)
8051
+ end
8052
+ end
8053
+
7299
8054
  # Metadata related to the progress of the PurgeSuggestionDenyListEntries
7300
8055
  # operation. This is returned by the google.longrunning.Operation.metadata field.
7301
8056
  class GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata
@@ -7726,9 +8481,7 @@ module Google
7726
8481
  class GoogleCloudDiscoveryengineV1RecrawlUrisRequest
7727
8482
  include Google::Apis::Core::Hashable
7728
8483
 
7729
- # Optional. Full resource name of the `SiteCredential`, such as `projects/*/
7730
- # locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`.
7731
- # Only set to crawl private URIs.
8484
+ # Optional. Credential id to use for crawling.
7732
8485
  # Corresponds to the JSON property `siteCredential`
7733
8486
  # @return [String]
7734
8487
  attr_accessor :site_credential
@@ -8089,6 +8842,19 @@ module Google
8089
8842
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec]
8090
8843
  attr_accessor :query_expansion_spec
8091
8844
 
8845
+ # The specification for returning the document relevance score.
8846
+ # Corresponds to the JSON property `relevanceScoreSpec`
8847
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec]
8848
+ attr_accessor :relevance_score_spec
8849
+
8850
+ # The relevance threshold of the search results. Default to Google defined
8851
+ # threshold, leveraging a balance of precision and recall to deliver both highly
8852
+ # accurate results and comprehensive coverage of relevant information. This
8853
+ # feature is not supported for healthcare search.
8854
+ # Corresponds to the JSON property `relevanceThreshold`
8855
+ # @return [String]
8856
+ attr_accessor :relevance_threshold
8857
+
8092
8858
  # Whether to turn on safe search. This is only supported for website search.
8093
8859
  # Corresponds to the JSON property `safeSearch`
8094
8860
  # @return [Boolean]
@@ -8188,6 +8954,8 @@ module Google
8188
8954
  @params = args[:params] if args.key?(:params)
8189
8955
  @query = args[:query] if args.key?(:query)
8190
8956
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
8957
+ @relevance_score_spec = args[:relevance_score_spec] if args.key?(:relevance_score_spec)
8958
+ @relevance_threshold = args[:relevance_threshold] if args.key?(:relevance_threshold)
8191
8959
  @safe_search = args[:safe_search] if args.key?(:safe_search)
8192
8960
  @search_as_you_type_spec = args[:search_as_you_type_spec] if args.key?(:search_as_you_type_spec)
8193
8961
  @session = args[:session] if args.key?(:session)
@@ -8921,6 +9689,27 @@ module Google
8921
9689
  end
8922
9690
  end
8923
9691
 
9692
+ # The specification for returning the document relevance score.
9693
+ class GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec
9694
+ include Google::Apis::Core::Hashable
9695
+
9696
+ # Optional. Whether to return the relevance score for search results. The higher
9697
+ # the score, the more relevant the document is to the query.
9698
+ # Corresponds to the JSON property `returnRelevanceScore`
9699
+ # @return [Boolean]
9700
+ attr_accessor :return_relevance_score
9701
+ alias_method :return_relevance_score?, :return_relevance_score
9702
+
9703
+ def initialize(**args)
9704
+ update!(**args)
9705
+ end
9706
+
9707
+ # Update properties of this object
9708
+ def update!(**args)
9709
+ @return_relevance_score = args[:return_relevance_score] if args.key?(:return_relevance_score)
9710
+ end
9711
+ end
9712
+
8924
9713
  # Specification for search as you type in search requests.
8925
9714
  class GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec
8926
9715
  include Google::Apis::Core::Hashable
@@ -8962,7 +9751,7 @@ module Google
8962
9751
  attr_accessor :query_id
8963
9752
 
8964
9753
  # The number of top search results to persist. The persisted search results can
8965
- # be used for the subsequent /answer api call. This field is simliar to the `
9754
+ # be used for the subsequent /answer api call. This field is similar to the `
8966
9755
  # summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.
8967
9756
  # summary_result_count. At most 10 results for documents mode, or 50 for chunks
8968
9757
  # mode.
@@ -9204,6 +9993,11 @@ module Google
9204
9993
  # @return [String]
9205
9994
  attr_accessor :id
9206
9995
 
9996
+ # Output only. Google provided available scores.
9997
+ # Corresponds to the JSON property `modelScores`
9998
+ # @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DoubleList>]
9999
+ attr_accessor :model_scores
10000
+
9207
10001
  def initialize(**args)
9208
10002
  update!(**args)
9209
10003
  end
@@ -9213,6 +10007,7 @@ module Google
9213
10007
  @chunk = args[:chunk] if args.key?(:chunk)
9214
10008
  @document = args[:document] if args.key?(:document)
9215
10009
  @id = args[:id] if args.key?(:id)
10010
+ @model_scores = args[:model_scores] if args.key?(:model_scores)
9216
10011
  end
9217
10012
  end
9218
10013
 
@@ -9904,6 +10699,39 @@ module Google
9904
10699
  end
9905
10700
  end
9906
10701
 
10702
+ # A sitemap for the SiteSearchEngine.
10703
+ class GoogleCloudDiscoveryengineV1Sitemap
10704
+ include Google::Apis::Core::Hashable
10705
+
10706
+ # Output only. The sitemap's creation time.
10707
+ # Corresponds to the JSON property `createTime`
10708
+ # @return [String]
10709
+ attr_accessor :create_time
10710
+
10711
+ # Output only. The fully qualified resource name of the sitemap. `projects/*/
10712
+ # locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `
10713
+ # sitemap_id` suffix is system-generated.
10714
+ # Corresponds to the JSON property `name`
10715
+ # @return [String]
10716
+ attr_accessor :name
10717
+
10718
+ # Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.
10719
+ # Corresponds to the JSON property `uri`
10720
+ # @return [String]
10721
+ attr_accessor :uri
10722
+
10723
+ def initialize(**args)
10724
+ update!(**args)
10725
+ end
10726
+
10727
+ # Update properties of this object
10728
+ def update!(**args)
10729
+ @create_time = args[:create_time] if args.key?(:create_time)
10730
+ @name = args[:name] if args.key?(:name)
10731
+ @uri = args[:uri] if args.key?(:uri)
10732
+ end
10733
+ end
10734
+
9907
10735
  # The Spanner source for importing data
9908
10736
  class GoogleCloudDiscoveryengineV1SpannerSource
9909
10737
  include Google::Apis::Core::Hashable
@@ -10774,7 +11602,7 @@ module Google
10774
11602
  # Required. Params needed to support actions in the format of (Key, Value) pairs.
10775
11603
  # Required parameters for sources that support OAUTH, i.e. `gmail`, `
10776
11604
  # google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `
10777
- # client_id` * Value: type STRING. The client id for the service provider to
11605
+ # client_id` * Value: type STRING. The client ID for the service provider to
10778
11606
  # identify your application. * Key: `client_secret` * Value:type STRING. The
10779
11607
  # client secret generated by the application's authorization server.
10780
11608
  # Corresponds to the JSON property `actionParams`
@@ -10930,7 +11758,9 @@ module Google
10930
11758
  class GoogleCloudDiscoveryengineV1alphaAnswerCitation
10931
11759
  include Google::Apis::Core::Hashable
10932
11760
 
10933
- # End of the attributed segment, exclusive.
11761
+ # End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode).
11762
+ # If there are multi-byte characters,such as non-ASCII characters, the index
11763
+ # measurement is longer than the string length.
10934
11764
  # Corresponds to the JSON property `endIndex`
10935
11765
  # @return [Fixnum]
10936
11766
  attr_accessor :end_index
@@ -10941,6 +11771,8 @@ module Google
10941
11771
  attr_accessor :sources
10942
11772
 
10943
11773
  # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
11774
+ # If there are multi-byte characters,such as non-ASCII characters, the index
11775
+ # measurement is longer than the string length.
10944
11776
  # Corresponds to the JSON property `startIndex`
10945
11777
  # @return [Fixnum]
10946
11778
  attr_accessor :start_index
@@ -11200,6 +12032,16 @@ module Google
11200
12032
  # @return [Hash<String,Object>]
11201
12033
  attr_accessor :struct_data
11202
12034
 
12035
+ # Output only. The title of the document.
12036
+ # Corresponds to the JSON property `title`
12037
+ # @return [String]
12038
+ attr_accessor :title
12039
+
12040
+ # Output only. The URI of the document.
12041
+ # Corresponds to the JSON property `uri`
12042
+ # @return [String]
12043
+ attr_accessor :uri
12044
+
11203
12045
  def initialize(**args)
11204
12046
  update!(**args)
11205
12047
  end
@@ -11208,6 +12050,8 @@ module Google
11208
12050
  def update!(**args)
11209
12051
  @document = args[:document] if args.key?(:document)
11210
12052
  @struct_data = args[:struct_data] if args.key?(:struct_data)
12053
+ @title = args[:title] if args.key?(:title)
12054
+ @uri = args[:uri] if args.key?(:uri)
11211
12055
  end
11212
12056
  end
11213
12057
 
@@ -11500,6 +12344,25 @@ module Google
11500
12344
  end
11501
12345
  end
11502
12346
 
12347
+ # The configuration for the BAP connector.
12348
+ class GoogleCloudDiscoveryengineV1alphaBapConfig
12349
+ include Google::Apis::Core::Hashable
12350
+
12351
+ # Required. The supported connector modes for the associated BAP connection.
12352
+ # Corresponds to the JSON property `supportedConnectorModes`
12353
+ # @return [Array<String>]
12354
+ attr_accessor :supported_connector_modes
12355
+
12356
+ def initialize(**args)
12357
+ update!(**args)
12358
+ end
12359
+
12360
+ # Update properties of this object
12361
+ def update!(**args)
12362
+ @supported_connector_modes = args[:supported_connector_modes] if args.key?(:supported_connector_modes)
12363
+ end
12364
+ end
12365
+
11503
12366
  # Metadata related to the progress of the SiteSearchEngineService.
11504
12367
  # BatchCreateTargetSites operation. This will be returned by the google.
11505
12368
  # longrunning.Operation.metadata field.
@@ -11557,13 +12420,13 @@ module Google
11557
12420
  attr_accessor :is_default
11558
12421
  alias_method :is_default?, :is_default
11559
12422
 
11560
- # Kms key resource name which will be used to encrypt resources `projects/`
12423
+ # KMS key resource name which will be used to encrypt resources `projects/`
11561
12424
  # project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
11562
12425
  # Corresponds to the JSON property `kmsKey`
11563
12426
  # @return [String]
11564
12427
  attr_accessor :kms_key
11565
12428
 
11566
- # Kms key version resource name which will be used to encrypt resources `/
12429
+ # KMS key version resource name which will be used to encrypt resources `/
11567
12430
  # cryptoKeyVersions/`keyVersion``.
11568
12431
  # Corresponds to the JSON property `kmsKeyVersion`
11569
12432
  # @return [String]
@@ -11574,9 +12437,9 @@ module Google
11574
12437
  # @return [Fixnum]
11575
12438
  attr_accessor :last_rotation_timestamp_micros
11576
12439
 
11577
- # Required. Name of the CmekConfig, of the form `projects/`project`/locations/`
11578
- # location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/`
11579
- # cmekConfig``.
12440
+ # Required. The name of the CmekConfig of the form `projects/`project`/locations/
12441
+ # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
12442
+ # `cmekConfig``.
11580
12443
  # Corresponds to the JSON property `name`
11581
12444
  # @return [String]
11582
12445
  attr_accessor :name
@@ -11586,7 +12449,7 @@ module Google
11586
12449
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSingleRegionKey>]
11587
12450
  attr_accessor :single_region_keys
11588
12451
 
11589
- # Output only. State of the CmekConfig.
12452
+ # Output only. The states of the CmekConfig.
11590
12453
  # Corresponds to the JSON property `state`
11591
12454
  # @return [String]
11592
12455
  attr_accessor :state
@@ -11819,6 +12682,11 @@ module Google
11819
12682
  class GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun
11820
12683
  include Google::Apis::Core::Hashable
11821
12684
 
12685
+ # The number of documents deleted.
12686
+ # Corresponds to the JSON property `deletedRecordCount`
12687
+ # @return [Fixnum]
12688
+ attr_accessor :deleted_record_count
12689
+
11822
12690
  # The name of the source entity.
11823
12691
  # Corresponds to the JSON property `entityName`
11824
12692
  # @return [String]
@@ -11879,6 +12747,7 @@ module Google
11879
12747
 
11880
12748
  # Update properties of this object
11881
12749
  def update!(**args)
12750
+ @deleted_record_count = args[:deleted_record_count] if args.key?(:deleted_record_count)
11882
12751
  @entity_name = args[:entity_name] if args.key?(:entity_name)
11883
12752
  @error_record_count = args[:error_record_count] if args.key?(:error_record_count)
11884
12753
  @errors = args[:errors] if args.key?(:errors)
@@ -12018,6 +12887,13 @@ module Google
12018
12887
  # @return [Float]
12019
12888
  attr_accessor :fixed_boost
12020
12889
 
12890
+ # Specification for custom ranking based on customer specified attribute value.
12891
+ # It provides more controls for customized ranking than the simple (condition,
12892
+ # boost) combination above.
12893
+ # Corresponds to the JSON property `interpolationBoostSpec`
12894
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec]
12895
+ attr_accessor :interpolation_boost_spec
12896
+
12021
12897
  def initialize(**args)
12022
12898
  update!(**args)
12023
12899
  end
@@ -12028,6 +12904,85 @@ module Google
12028
12904
  @data_store = args[:data_store] if args.key?(:data_store)
12029
12905
  @filter = args[:filter] if args.key?(:filter)
12030
12906
  @fixed_boost = args[:fixed_boost] if args.key?(:fixed_boost)
12907
+ @interpolation_boost_spec = args[:interpolation_boost_spec] if args.key?(:interpolation_boost_spec)
12908
+ end
12909
+ end
12910
+
12911
+ # Specification for custom ranking based on customer specified attribute value.
12912
+ # It provides more controls for customized ranking than the simple (condition,
12913
+ # boost) combination above.
12914
+ class GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec
12915
+ include Google::Apis::Core::Hashable
12916
+
12917
+ # Optional. The attribute type to be used to determine the boost amount. The
12918
+ # attribute value can be derived from the field value of the specified
12919
+ # field_name. In the case of numerical it is straightforward i.e.
12920
+ # attribute_value = numerical_field_value. In the case of freshness however,
12921
+ # attribute_value = (time.now() - datetime_field_value).
12922
+ # Corresponds to the JSON property `attributeType`
12923
+ # @return [String]
12924
+ attr_accessor :attribute_type
12925
+
12926
+ # Optional. The control points used to define the curve. The monotonic function (
12927
+ # defined through the interpolation_type above) passes through the control
12928
+ # points listed here.
12929
+ # Corresponds to the JSON property `controlPoints`
12930
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint>]
12931
+ attr_accessor :control_points
12932
+
12933
+ # Optional. The name of the field whose value will be used to determine the
12934
+ # boost amount.
12935
+ # Corresponds to the JSON property `fieldName`
12936
+ # @return [String]
12937
+ attr_accessor :field_name
12938
+
12939
+ # Optional. The interpolation type to be applied to connect the control points
12940
+ # listed below.
12941
+ # Corresponds to the JSON property `interpolationType`
12942
+ # @return [String]
12943
+ attr_accessor :interpolation_type
12944
+
12945
+ def initialize(**args)
12946
+ update!(**args)
12947
+ end
12948
+
12949
+ # Update properties of this object
12950
+ def update!(**args)
12951
+ @attribute_type = args[:attribute_type] if args.key?(:attribute_type)
12952
+ @control_points = args[:control_points] if args.key?(:control_points)
12953
+ @field_name = args[:field_name] if args.key?(:field_name)
12954
+ @interpolation_type = args[:interpolation_type] if args.key?(:interpolation_type)
12955
+ end
12956
+ end
12957
+
12958
+ # The control points used to define the curve. The curve defined through these
12959
+ # control points can only be monotonically increasing or decreasing(constant
12960
+ # values are acceptable).
12961
+ class GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint
12962
+ include Google::Apis::Core::Hashable
12963
+
12964
+ # Optional. Can be one of: 1. The numerical field value. 2. The duration spec
12965
+ # for freshness: The value must be formatted as an XSD `dayTimeDuration` value (
12966
+ # a restricted subset of an ISO 8601 duration value). The pattern for this is: `
12967
+ # nDnM]`.
12968
+ # Corresponds to the JSON property `attributeValue`
12969
+ # @return [String]
12970
+ attr_accessor :attribute_value
12971
+
12972
+ # Optional. The value between -1 to 1 by which to boost the score if the
12973
+ # attribute_value evaluates to the value specified above.
12974
+ # Corresponds to the JSON property `boostAmount`
12975
+ # @return [Float]
12976
+ attr_accessor :boost_amount
12977
+
12978
+ def initialize(**args)
12979
+ update!(**args)
12980
+ end
12981
+
12982
+ # Update properties of this object
12983
+ def update!(**args)
12984
+ @attribute_value = args[:attribute_value] if args.key?(:attribute_value)
12985
+ @boost_amount = args[:boost_amount] if args.key?(:boost_amount)
12031
12986
  end
12032
12987
  end
12033
12988
 
@@ -12343,6 +13298,11 @@ module Google
12343
13298
  attr_accessor :auto_run_disabled
12344
13299
  alias_method :auto_run_disabled?, :auto_run_disabled
12345
13300
 
13301
+ # The configuration for the BAP connector.
13302
+ # Corresponds to the JSON property `bapConfig`
13303
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaBapConfig]
13304
+ attr_accessor :bap_config
13305
+
12346
13306
  # Output only. User actions that must be completed before the connector can
12347
13307
  # start syncing data.
12348
13308
  # Corresponds to the JSON property `blockingReasons`
@@ -12440,7 +13400,7 @@ module Google
12440
13400
  # pairs. Required parameters for all data sources: * Key: `instance_uri` * Value:
12441
13401
  # type STRING. The uri to access the data source. Required parameters for
12442
13402
  # sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value:
12443
- # type STRING. The client id for the third party service provider to identify
13403
+ # type STRING. The client ID for the third party service provider to identify
12444
13404
  # your application. * Key: `client_secret` * Value:type STRING. The client
12445
13405
  # secret generated by the third party authorization server. * Key: `access_token`
12446
13406
  # * Value: type STRING. OAuth token for UCS to access to the protected resource.
@@ -12509,6 +13469,7 @@ module Google
12509
13469
  def update!(**args)
12510
13470
  @action_config = args[:action_config] if args.key?(:action_config)
12511
13471
  @auto_run_disabled = args[:auto_run_disabled] if args.key?(:auto_run_disabled)
13472
+ @bap_config = args[:bap_config] if args.key?(:bap_config)
12512
13473
  @blocking_reasons = args[:blocking_reasons] if args.key?(:blocking_reasons)
12513
13474
  @create_time = args[:create_time] if args.key?(:create_time)
12514
13475
  @data_source = args[:data_source] if args.key?(:data_source)
@@ -12554,6 +13515,11 @@ module Google
12554
13515
  # @return [String]
12555
13516
  attr_accessor :entity_name
12556
13517
 
13518
+ # Config to data store for `HEALTHCARE_FHIR` vertical.
13519
+ # Corresponds to the JSON property `healthcareFhirConfig`
13520
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig]
13521
+ attr_accessor :healthcare_fhir_config
13522
+
12557
13523
  # Attributes for indexing. Key: Field name. Value: The key property to map a
12558
13524
  # field to, such as `title`, and `description`. Supported key properties: * `
12559
13525
  # title`: The title for data record. This would be displayed on search results. *
@@ -12563,13 +13529,18 @@ module Google
12563
13529
  # @return [Hash<String,String>]
12564
13530
  attr_accessor :key_property_mappings
12565
13531
 
12566
- # The parameters for the entity to facilitate data ingestion. E.g. for BQ
13532
+ # The parameters for the entity to facilitate data ingestion. E.g. for BigQuery
12567
13533
  # connectors: * Key: `document_id_column` * Value: type STRING. The value of the
12568
- # column id.
13534
+ # column ID.
12569
13535
  # Corresponds to the JSON property `params`
12570
13536
  # @return [Hash<String,Object>]
12571
13537
  attr_accessor :params
12572
13538
 
13539
+ # Defines the structure and layout of a type of document data.
13540
+ # Corresponds to the JSON property `startingSchema`
13541
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSchema]
13542
+ attr_accessor :starting_schema
13543
+
12573
13544
  def initialize(**args)
12574
13545
  update!(**args)
12575
13546
  end
@@ -12578,8 +13549,10 @@ module Google
12578
13549
  def update!(**args)
12579
13550
  @data_store = args[:data_store] if args.key?(:data_store)
12580
13551
  @entity_name = args[:entity_name] if args.key?(:entity_name)
13552
+ @healthcare_fhir_config = args[:healthcare_fhir_config] if args.key?(:healthcare_fhir_config)
12581
13553
  @key_property_mappings = args[:key_property_mappings] if args.key?(:key_property_mappings)
12582
13554
  @params = args[:params] if args.key?(:params)
13555
+ @starting_schema = args[:starting_schema] if args.key?(:starting_schema)
12583
13556
  end
12584
13557
  end
12585
13558
 
@@ -12624,7 +13597,7 @@ module Google
12624
13597
  # @return [String]
12625
13598
  attr_accessor :create_time
12626
13599
 
12627
- # Output only. The id of the default Schema asscociated to this data store.
13600
+ # Output only. The id of the default Schema associated to this data store.
12628
13601
  # Corresponds to the JSON property `defaultSchemaId`
12629
13602
  # @return [String]
12630
13603
  attr_accessor :default_schema_id
@@ -12643,6 +13616,19 @@ module Google
12643
13616
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig]
12644
13617
  attr_accessor :document_processing_config
12645
13618
 
13619
+ # Config to data store for `HEALTHCARE_FHIR` vertical.
13620
+ # Corresponds to the JSON property `healthcareFhirConfig`
13621
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig]
13622
+ attr_accessor :healthcare_fhir_config
13623
+
13624
+ # Immutable. The fully qualified resource name of the associated
13625
+ # IdentityMappingStore. This field can only be set for acl_enabled DataStores
13626
+ # with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/`project`/locations/`
13627
+ # location`/identityMappingStores/`identity_mapping_store``.
13628
+ # Corresponds to the JSON property `identityMappingStore`
13629
+ # @return [String]
13630
+ attr_accessor :identity_mapping_store
13631
+
12646
13632
  # Identity Provider Config.
12647
13633
  # Corresponds to the JSON property `idpConfig`
12648
13634
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaIdpConfig]
@@ -12723,6 +13709,8 @@ module Google
12723
13709
  @default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
12724
13710
  @display_name = args[:display_name] if args.key?(:display_name)
12725
13711
  @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
13712
+ @healthcare_fhir_config = args[:healthcare_fhir_config] if args.key?(:healthcare_fhir_config)
13713
+ @identity_mapping_store = args[:identity_mapping_store] if args.key?(:identity_mapping_store)
12726
13714
  @idp_config = args[:idp_config] if args.key?(:idp_config)
12727
13715
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
12728
13716
  @is_infobot_faq_data_store = args[:is_infobot_faq_data_store] if args.key?(:is_infobot_faq_data_store)
@@ -12833,6 +13821,34 @@ module Google
12833
13821
  end
12834
13822
  end
12835
13823
 
13824
+ # Metadata related to the progress of the CmekConfigService.DeleteCmekConfig
13825
+ # operation. This will be returned by the google.longrunning.Operation.metadata
13826
+ # field.
13827
+ class GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata
13828
+ include Google::Apis::Core::Hashable
13829
+
13830
+ # Operation create time.
13831
+ # Corresponds to the JSON property `createTime`
13832
+ # @return [String]
13833
+ attr_accessor :create_time
13834
+
13835
+ # Operation last update time. If the operation is done, this is also the finish
13836
+ # time.
13837
+ # Corresponds to the JSON property `updateTime`
13838
+ # @return [String]
13839
+ attr_accessor :update_time
13840
+
13841
+ def initialize(**args)
13842
+ update!(**args)
13843
+ end
13844
+
13845
+ # Update properties of this object
13846
+ def update!(**args)
13847
+ @create_time = args[:create_time] if args.key?(:create_time)
13848
+ @update_time = args[:update_time] if args.key?(:update_time)
13849
+ end
13850
+ end
13851
+
12836
13852
  # Metadata related to the progress of the CollectionService.UpdateCollection
12837
13853
  # operation. This will be returned by the google.longrunning.Operation.metadata
12838
13854
  # field.
@@ -13495,6 +14511,17 @@ module Google
13495
14511
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig]
13496
14512
  attr_accessor :agent_creation_config
13497
14513
 
14514
+ # Optional. If the flag set to true, we allow the agent and engine are in
14515
+ # different locations, otherwise the agent and engine are required to be in the
14516
+ # same location. The flag is set to false by default. Note that the `
14517
+ # allow_cross_region` are one-time consumed by and passed to EngineService.
14518
+ # CreateEngine. It means they cannot be retrieved using EngineService.GetEngine
14519
+ # or EngineService.ListEngines API after engine creation.
14520
+ # Corresponds to the JSON property `allowCrossRegion`
14521
+ # @return [Boolean]
14522
+ attr_accessor :allow_cross_region
14523
+ alias_method :allow_cross_region?, :allow_cross_region
14524
+
13498
14525
  # The resource name of an exist Dialogflow agent to link to this Chat Engine.
13499
14526
  # Customers can either provide `agent_creation_config` to create agent or
13500
14527
  # provide an agent name that links the agent with the Chat engine. Format: `
@@ -13514,6 +14541,7 @@ module Google
13514
14541
  # Update properties of this object
13515
14542
  def update!(**args)
13516
14543
  @agent_creation_config = args[:agent_creation_config] if args.key?(:agent_creation_config)
14544
+ @allow_cross_region = args[:allow_cross_region] if args.key?(:allow_cross_region)
13517
14545
  @dialogflow_agent_to_link = args[:dialogflow_agent_to_link] if args.key?(:dialogflow_agent_to_link)
13518
14546
  end
13519
14547
  end
@@ -13929,44 +14957,6 @@ module Google
13929
14957
  end
13930
14958
  end
13931
14959
 
13932
- # Response message for SiteSearchEngineService.FetchSitemaps method.
13933
- class GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse
13934
- include Google::Apis::Core::Hashable
13935
-
13936
- # List of Sitemaps fetched.
13937
- # Corresponds to the JSON property `sitemapsMetadata`
13938
- # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata>]
13939
- attr_accessor :sitemaps_metadata
13940
-
13941
- def initialize(**args)
13942
- update!(**args)
13943
- end
13944
-
13945
- # Update properties of this object
13946
- def update!(**args)
13947
- @sitemaps_metadata = args[:sitemaps_metadata] if args.key?(:sitemaps_metadata)
13948
- end
13949
- end
13950
-
13951
- # Contains a Sitemap and its metadata.
13952
- class GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata
13953
- include Google::Apis::Core::Hashable
13954
-
13955
- # A sitemap for the SiteSearchEngine.
13956
- # Corresponds to the JSON property `sitemap`
13957
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSitemap]
13958
- attr_accessor :sitemap
13959
-
13960
- def initialize(**args)
13961
- update!(**args)
13962
- end
13963
-
13964
- # Update properties of this object
13965
- def update!(**args)
13966
- @sitemap = args[:sitemap] if args.key?(:sitemap)
13967
- end
13968
- end
13969
-
13970
14960
  # Configurations for fields of a schema. For example, configuring a field is
13971
14961
  # indexable, or searchable.
13972
14962
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
@@ -14165,8 +15155,72 @@ module Google
14165
15155
  end
14166
15156
  end
14167
15157
 
14168
- # The configuration for the identity data synchronization runs.
14169
- class GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig
15158
+ # Config to data store for `HEALTHCARE_FHIR` vertical.
15159
+ class GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig
15160
+ include Google::Apis::Core::Hashable
15161
+
15162
+ # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set
15163
+ # to `true`, the predefined healthcare fhir schema can be extended for more
15164
+ # customized searching and filtering.
15165
+ # Corresponds to the JSON property `enableConfigurableSchema`
15166
+ # @return [Boolean]
15167
+ attr_accessor :enable_configurable_schema
15168
+ alias_method :enable_configurable_schema?, :enable_configurable_schema
15169
+
15170
+ # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If
15171
+ # set to `true`, the batch ingestion will be processed in a static indexing mode
15172
+ # which is slower but more capable of handling larger volume.
15173
+ # Corresponds to the JSON property `enableStaticIndexingForBatchIngestion`
15174
+ # @return [Boolean]
15175
+ attr_accessor :enable_static_indexing_for_batch_ingestion
15176
+ alias_method :enable_static_indexing_for_batch_ingestion?, :enable_static_indexing_for_batch_ingestion
15177
+
15178
+ def initialize(**args)
15179
+ update!(**args)
15180
+ end
15181
+
15182
+ # Update properties of this object
15183
+ def update!(**args)
15184
+ @enable_configurable_schema = args[:enable_configurable_schema] if args.key?(:enable_configurable_schema)
15185
+ @enable_static_indexing_for_batch_ingestion = args[:enable_static_indexing_for_batch_ingestion] if args.key?(:enable_static_indexing_for_batch_ingestion)
15186
+ end
15187
+ end
15188
+
15189
+ # IdentityMappingEntry LongRunningOperation metadata for
15190
+ # IdentityMappingStoreService.ImportIdentityMappings and
15191
+ # IdentityMappingStoreService.PurgeIdentityMappings
15192
+ class GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata
15193
+ include Google::Apis::Core::Hashable
15194
+
15195
+ # The number of IdentityMappingEntries that failed to be processed.
15196
+ # Corresponds to the JSON property `failureCount`
15197
+ # @return [Fixnum]
15198
+ attr_accessor :failure_count
15199
+
15200
+ # The number of IdentityMappingEntries that were successfully processed.
15201
+ # Corresponds to the JSON property `successCount`
15202
+ # @return [Fixnum]
15203
+ attr_accessor :success_count
15204
+
15205
+ # The total number of IdentityMappingEntries that were processed.
15206
+ # Corresponds to the JSON property `totalCount`
15207
+ # @return [Fixnum]
15208
+ attr_accessor :total_count
15209
+
15210
+ def initialize(**args)
15211
+ update!(**args)
15212
+ end
15213
+
15214
+ # Update properties of this object
15215
+ def update!(**args)
15216
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
15217
+ @success_count = args[:success_count] if args.key?(:success_count)
15218
+ @total_count = args[:total_count] if args.key?(:total_count)
15219
+ end
15220
+ end
15221
+
15222
+ # The configuration for the identity data synchronization runs.
15223
+ class GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig
14170
15224
  include Google::Apis::Core::Hashable
14171
15225
 
14172
15226
  # Represents civil time (or occasionally physical time). This type can represent
@@ -14409,6 +15463,25 @@ module Google
14409
15463
  end
14410
15464
  end
14411
15465
 
15466
+ # Response message for IdentityMappingStoreService.ImportIdentityMappings
15467
+ class GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse
15468
+ include Google::Apis::Core::Hashable
15469
+
15470
+ # A sample of errors encountered while processing the request.
15471
+ # Corresponds to the JSON property `errorSamples`
15472
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleRpcStatus>]
15473
+ attr_accessor :error_samples
15474
+
15475
+ def initialize(**args)
15476
+ update!(**args)
15477
+ end
15478
+
15479
+ # Update properties of this object
15480
+ def update!(**args)
15481
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
15482
+ end
15483
+ end
15484
+
14412
15485
  # Metadata related to the progress of the ImportSampleQueries operation. This
14413
15486
  # will be returned by the google.longrunning.Operation.metadata field.
14414
15487
  class GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata
@@ -15336,6 +16409,16 @@ module Google
15336
16409
  # @return [Fixnum]
15337
16410
  attr_accessor :invalid_uris_count
15338
16411
 
16412
+ # URIs that have no index meta tag. Sample limited to 1000.
16413
+ # Corresponds to the JSON property `noindexUris`
16414
+ # @return [Array<String>]
16415
+ attr_accessor :noindex_uris
16416
+
16417
+ # Total number of URIs that have no index meta tag.
16418
+ # Corresponds to the JSON property `noindexUrisCount`
16419
+ # @return [Fixnum]
16420
+ attr_accessor :noindex_uris_count
16421
+
15339
16422
  # Total number of URIs that have yet to be crawled.
15340
16423
  # Corresponds to the JSON property `pendingCount`
15341
16424
  # @return [Fixnum]
@@ -15383,6 +16466,8 @@ module Google
15383
16466
  @create_time = args[:create_time] if args.key?(:create_time)
15384
16467
  @invalid_uris = args[:invalid_uris] if args.key?(:invalid_uris)
15385
16468
  @invalid_uris_count = args[:invalid_uris_count] if args.key?(:invalid_uris_count)
16469
+ @noindex_uris = args[:noindex_uris] if args.key?(:noindex_uris)
16470
+ @noindex_uris_count = args[:noindex_uris_count] if args.key?(:noindex_uris_count)
15386
16471
  @pending_count = args[:pending_count] if args.key?(:pending_count)
15387
16472
  @quota_exceeded_count = args[:quota_exceeded_count] if args.key?(:quota_exceeded_count)
15388
16473
  @success_count = args[:success_count] if args.key?(:success_count)
@@ -15715,6 +16800,11 @@ module Google
15715
16800
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec>]
15716
16801
  attr_accessor :data_store_specs
15717
16802
 
16803
+ # Specifies features for display, like match highlighting.
16804
+ # Corresponds to the JSON property `displaySpec`
16805
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec]
16806
+ attr_accessor :display_spec
16807
+
15718
16808
  # The specification that uses customized query embedding vector to do semantic
15719
16809
  # document retrieval.
15720
16810
  # Corresponds to the JSON property `embeddingSpec`
@@ -15833,21 +16923,41 @@ module Google
15833
16923
  attr_accessor :query_expansion_spec
15834
16924
 
15835
16925
  # The ranking expression controls the customized ranking on retrieval documents.
15836
- # This overrides ServingConfig.ranking_expression. The ranking expression is a
15837
- # single function or multiple functions that are joined by "+". *
15838
- # ranking_expression = function, ` " + ", function `; Supported functions: *
15839
- # double * relevance_score * double * dotProduct(embedding_field_path) Function
15840
- # variables: * `relevance_score`: pre-defined keywords, used for measure
15841
- # relevance between query and document. * `embedding_field_path`: the document
15842
- # embedding field used with query embedding vector. * `dotProduct`: embedding
15843
- # function between embedding_field_path and query embedding vector. Example
15844
- # ranking expression: If document has an embedding field doc_embedding, the
15845
- # ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(
15846
- # doc_embedding)`.
16926
+ # This overrides ServingConfig.ranking_expression. The syntax and supported
16927
+ # features depend on the ranking_expression_backend value. If
16928
+ # ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
16929
+ # If ranking expression is not provided or set to BYOE, it should be a single
16930
+ # function or multiple functions that are joined by "+". * ranking_expression =
16931
+ # function, ` " + ", function `; Supported functions: * double * relevance_score
16932
+ # * double * dotProduct(embedding_field_path) Function variables: * `
16933
+ # relevance_score`: pre-defined keywords, used for measure relevance between
16934
+ # query and document. * `embedding_field_path`: the document embedding field
16935
+ # used with query embedding vector. * `dotProduct`: embedding function between
16936
+ # embedding_field_path and query embedding vector. Example ranking expression:
16937
+ # If document has an embedding field doc_embedding, the ranking expression could
16938
+ # be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX ===
16939
+ # If ranking expression is set to CLEARBOX, the following expression types (and
16940
+ # combinations of those chained using + or * operators) are supported: * double *
16941
+ # signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal
16942
+ # rank transformation with second argument being a denominator constant. *
16943
+ # is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1,
16944
+ # signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns
16945
+ # signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(
16946
+ # fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score,
16947
+ # 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: *
16948
+ # gecko_score -- semantic similarity adjustment * bm25_score -- keyword match
16949
+ # adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank --
16950
+ # predicted conversion rate adjustment as a rank * freshness_rank -- freshness
16951
+ # adjustment as a rank * base_rank -- the default rank of the result
15847
16952
  # Corresponds to the JSON property `rankingExpression`
15848
16953
  # @return [String]
15849
16954
  attr_accessor :ranking_expression
15850
16955
 
16956
+ # Optional. The backend to use for the ranking expression evaluation.
16957
+ # Corresponds to the JSON property `rankingExpressionBackend`
16958
+ # @return [String]
16959
+ attr_accessor :ranking_expression_backend
16960
+
15851
16961
  # The Unicode country/region code (CLDR) of a location, such as "US" and "419".
15852
16962
  # For more information, see [Standard fields](https://cloud.google.com/apis/
15853
16963
  # design/standard_fields). If set, then results will be boosted based on the
@@ -15856,9 +16966,15 @@ module Google
15856
16966
  # @return [String]
15857
16967
  attr_accessor :region_code
15858
16968
 
16969
+ # The specification for returning the document relevance score.
16970
+ # Corresponds to the JSON property `relevanceScoreSpec`
16971
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec]
16972
+ attr_accessor :relevance_score_spec
16973
+
15859
16974
  # The relevance threshold of the search results. Default to Google defined
15860
16975
  # threshold, leveraging a balance of precision and recall to deliver both highly
15861
- # accurate results and comprehensive coverage of relevant information.
16976
+ # accurate results and comprehensive coverage of relevant information. This
16977
+ # feature is not supported for healthcare search.
15862
16978
  # Corresponds to the JSON property `relevanceThreshold`
15863
16979
  # @return [String]
15864
16980
  attr_accessor :relevance_threshold
@@ -15961,6 +17077,7 @@ module Google
15961
17077
  @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
15962
17078
  @custom_fine_tuning_spec = args[:custom_fine_tuning_spec] if args.key?(:custom_fine_tuning_spec)
15963
17079
  @data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
17080
+ @display_spec = args[:display_spec] if args.key?(:display_spec)
15964
17081
  @embedding_spec = args[:embedding_spec] if args.key?(:embedding_spec)
15965
17082
  @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
15966
17083
  @filter = args[:filter] if args.key?(:filter)
@@ -15977,7 +17094,9 @@ module Google
15977
17094
  @query = args[:query] if args.key?(:query)
15978
17095
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
15979
17096
  @ranking_expression = args[:ranking_expression] if args.key?(:ranking_expression)
17097
+ @ranking_expression_backend = args[:ranking_expression_backend] if args.key?(:ranking_expression_backend)
15980
17098
  @region_code = args[:region_code] if args.key?(:region_code)
17099
+ @relevance_score_spec = args[:relevance_score_spec] if args.key?(:relevance_score_spec)
15981
17100
  @relevance_threshold = args[:relevance_threshold] if args.key?(:relevance_threshold)
15982
17101
  @safe_search = args[:safe_search] if args.key?(:safe_search)
15983
17102
  @search_as_you_type_spec = args[:search_as_you_type_spec] if args.key?(:search_as_you_type_spec)
@@ -16515,6 +17634,25 @@ module Google
16515
17634
  end
16516
17635
  end
16517
17636
 
17637
+ # Specifies features for display, like match highlighting.
17638
+ class GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec
17639
+ include Google::Apis::Core::Hashable
17640
+
17641
+ # The condition under which match highlighting should occur.
17642
+ # Corresponds to the JSON property `matchHighlightingCondition`
17643
+ # @return [String]
17644
+ attr_accessor :match_highlighting_condition
17645
+
17646
+ def initialize(**args)
17647
+ update!(**args)
17648
+ end
17649
+
17650
+ # Update properties of this object
17651
+ def update!(**args)
17652
+ @match_highlighting_condition = args[:match_highlighting_condition] if args.key?(:match_highlighting_condition)
17653
+ end
17654
+ end
17655
+
16518
17656
  # The specification that uses customized query embedding vector to do semantic
16519
17657
  # document retrieval.
16520
17658
  class GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec
@@ -16808,6 +17946,27 @@ module Google
16808
17946
  end
16809
17947
  end
16810
17948
 
17949
+ # The specification for returning the document relevance score.
17950
+ class GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec
17951
+ include Google::Apis::Core::Hashable
17952
+
17953
+ # Optional. Whether to return the relevance score for search results. The higher
17954
+ # the score, the more relevant the document is to the query.
17955
+ # Corresponds to the JSON property `returnRelevanceScore`
17956
+ # @return [Boolean]
17957
+ attr_accessor :return_relevance_score
17958
+ alias_method :return_relevance_score?, :return_relevance_score
17959
+
17960
+ def initialize(**args)
17961
+ update!(**args)
17962
+ end
17963
+
17964
+ # Update properties of this object
17965
+ def update!(**args)
17966
+ @return_relevance_score = args[:return_relevance_score] if args.key?(:return_relevance_score)
17967
+ end
17968
+ end
17969
+
16811
17970
  # Specification for search as you type in search requests.
16812
17971
  class GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec
16813
17972
  include Google::Apis::Core::Hashable
@@ -16849,7 +18008,7 @@ module Google
16849
18008
  attr_accessor :query_id
16850
18009
 
16851
18010
  # The number of top search results to persist. The persisted search results can
16852
- # be used for the subsequent /answer api call. This field is simliar to the `
18011
+ # be used for the subsequent /answer api call. This field is similar to the `
16853
18012
  # summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.
16854
18013
  # summary_result_count. At most 10 results for documents mode, or 50 for chunks
16855
18014
  # mode.
@@ -17708,13 +18867,13 @@ module Google
17708
18867
  attr_accessor :is_default
17709
18868
  alias_method :is_default?, :is_default
17710
18869
 
17711
- # Kms key resource name which will be used to encrypt resources `projects/`
18870
+ # KMS key resource name which will be used to encrypt resources `projects/`
17712
18871
  # project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
17713
18872
  # Corresponds to the JSON property `kmsKey`
17714
18873
  # @return [String]
17715
18874
  attr_accessor :kms_key
17716
18875
 
17717
- # Kms key version resource name which will be used to encrypt resources `/
18876
+ # KMS key version resource name which will be used to encrypt resources `/
17718
18877
  # cryptoKeyVersions/`keyVersion``.
17719
18878
  # Corresponds to the JSON property `kmsKeyVersion`
17720
18879
  # @return [String]
@@ -17725,9 +18884,9 @@ module Google
17725
18884
  # @return [Fixnum]
17726
18885
  attr_accessor :last_rotation_timestamp_micros
17727
18886
 
17728
- # Required. Name of the CmekConfig, of the form `projects/`project`/locations/`
17729
- # location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/`
17730
- # cmekConfig``.
18887
+ # Required. The name of the CmekConfig of the form `projects/`project`/locations/
18888
+ # `location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/
18889
+ # `cmekConfig``.
17731
18890
  # Corresponds to the JSON property `name`
17732
18891
  # @return [String]
17733
18892
  attr_accessor :name
@@ -17737,7 +18896,7 @@ module Google
17737
18896
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSingleRegionKey>]
17738
18897
  attr_accessor :single_region_keys
17739
18898
 
17740
- # Output only. State of the CmekConfig.
18899
+ # Output only. The states of the CmekConfig.
17741
18900
  # Corresponds to the JSON property `state`
17742
18901
  # @return [String]
17743
18902
  attr_accessor :state
@@ -17971,6 +19130,13 @@ module Google
17971
19130
  # @return [Float]
17972
19131
  attr_accessor :fixed_boost
17973
19132
 
19133
+ # Specification for custom ranking based on customer specified attribute value.
19134
+ # It provides more controls for customized ranking than the simple (condition,
19135
+ # boost) combination above.
19136
+ # Corresponds to the JSON property `interpolationBoostSpec`
19137
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec]
19138
+ attr_accessor :interpolation_boost_spec
19139
+
17974
19140
  def initialize(**args)
17975
19141
  update!(**args)
17976
19142
  end
@@ -17981,6 +19147,85 @@ module Google
17981
19147
  @data_store = args[:data_store] if args.key?(:data_store)
17982
19148
  @filter = args[:filter] if args.key?(:filter)
17983
19149
  @fixed_boost = args[:fixed_boost] if args.key?(:fixed_boost)
19150
+ @interpolation_boost_spec = args[:interpolation_boost_spec] if args.key?(:interpolation_boost_spec)
19151
+ end
19152
+ end
19153
+
19154
+ # Specification for custom ranking based on customer specified attribute value.
19155
+ # It provides more controls for customized ranking than the simple (condition,
19156
+ # boost) combination above.
19157
+ class GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec
19158
+ include Google::Apis::Core::Hashable
19159
+
19160
+ # Optional. The attribute type to be used to determine the boost amount. The
19161
+ # attribute value can be derived from the field value of the specified
19162
+ # field_name. In the case of numerical it is straightforward i.e.
19163
+ # attribute_value = numerical_field_value. In the case of freshness however,
19164
+ # attribute_value = (time.now() - datetime_field_value).
19165
+ # Corresponds to the JSON property `attributeType`
19166
+ # @return [String]
19167
+ attr_accessor :attribute_type
19168
+
19169
+ # Optional. The control points used to define the curve. The monotonic function (
19170
+ # defined through the interpolation_type above) passes through the control
19171
+ # points listed here.
19172
+ # Corresponds to the JSON property `controlPoints`
19173
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint>]
19174
+ attr_accessor :control_points
19175
+
19176
+ # Optional. The name of the field whose value will be used to determine the
19177
+ # boost amount.
19178
+ # Corresponds to the JSON property `fieldName`
19179
+ # @return [String]
19180
+ attr_accessor :field_name
19181
+
19182
+ # Optional. The interpolation type to be applied to connect the control points
19183
+ # listed below.
19184
+ # Corresponds to the JSON property `interpolationType`
19185
+ # @return [String]
19186
+ attr_accessor :interpolation_type
19187
+
19188
+ def initialize(**args)
19189
+ update!(**args)
19190
+ end
19191
+
19192
+ # Update properties of this object
19193
+ def update!(**args)
19194
+ @attribute_type = args[:attribute_type] if args.key?(:attribute_type)
19195
+ @control_points = args[:control_points] if args.key?(:control_points)
19196
+ @field_name = args[:field_name] if args.key?(:field_name)
19197
+ @interpolation_type = args[:interpolation_type] if args.key?(:interpolation_type)
19198
+ end
19199
+ end
19200
+
19201
+ # The control points used to define the curve. The curve defined through these
19202
+ # control points can only be monotonically increasing or decreasing(constant
19203
+ # values are acceptable).
19204
+ class GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint
19205
+ include Google::Apis::Core::Hashable
19206
+
19207
+ # Optional. Can be one of: 1. The numerical field value. 2. The duration spec
19208
+ # for freshness: The value must be formatted as an XSD `dayTimeDuration` value (
19209
+ # a restricted subset of an ISO 8601 duration value). The pattern for this is: `
19210
+ # nDnM]`.
19211
+ # Corresponds to the JSON property `attributeValue`
19212
+ # @return [String]
19213
+ attr_accessor :attribute_value
19214
+
19215
+ # Optional. The value between -1 to 1 by which to boost the score if the
19216
+ # attribute_value evaluates to the value specified above.
19217
+ # Corresponds to the JSON property `boostAmount`
19218
+ # @return [Float]
19219
+ attr_accessor :boost_amount
19220
+
19221
+ def initialize(**args)
19222
+ update!(**args)
19223
+ end
19224
+
19225
+ # Update properties of this object
19226
+ def update!(**args)
19227
+ @attribute_value = args[:attribute_value] if args.key?(:attribute_value)
19228
+ @boost_amount = args[:boost_amount] if args.key?(:boost_amount)
17984
19229
  end
17985
19230
  end
17986
19231
 
@@ -18084,6 +19329,28 @@ module Google
18084
19329
  end
18085
19330
  end
18086
19331
 
19332
+ # The historical crawl rate timeseries data, used for monitoring.
19333
+ class GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries
19334
+ include Google::Apis::Core::Hashable
19335
+
19336
+ # A collection of data points that describes the time-varying values of a metric.
19337
+ # A time series is identified by a combination of a fully-specified monitored
19338
+ # resource and a fully-specified metric. This type is used for both listing and
19339
+ # creating time series.
19340
+ # Corresponds to the JSON property `qpsTimeSeries`
19341
+ # @return [Google::Apis::DiscoveryengineV1::GoogleMonitoringV3TimeSeries]
19342
+ attr_accessor :qps_time_series
19343
+
19344
+ def initialize(**args)
19345
+ update!(**args)
19346
+ end
19347
+
19348
+ # Update properties of this object
19349
+ def update!(**args)
19350
+ @qps_time_series = args[:qps_time_series] if args.key?(:qps_time_series)
19351
+ end
19352
+ end
19353
+
18087
19354
  # Metadata related to the progress of the DataStoreService.CreateDataStore
18088
19355
  # operation. This will be returned by the google.longrunning.Operation.metadata
18089
19356
  # field.
@@ -18264,7 +19531,7 @@ module Google
18264
19531
  # @return [String]
18265
19532
  attr_accessor :create_time
18266
19533
 
18267
- # Output only. The id of the default Schema asscociated to this data store.
19534
+ # Output only. The id of the default Schema associated to this data store.
18268
19535
  # Corresponds to the JSON property `defaultSchemaId`
18269
19536
  # @return [String]
18270
19537
  attr_accessor :default_schema_id
@@ -18283,6 +19550,19 @@ module Google
18283
19550
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig]
18284
19551
  attr_accessor :document_processing_config
18285
19552
 
19553
+ # Config to data store for `HEALTHCARE_FHIR` vertical.
19554
+ # Corresponds to the JSON property `healthcareFhirConfig`
19555
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig]
19556
+ attr_accessor :healthcare_fhir_config
19557
+
19558
+ # Immutable. The fully qualified resource name of the associated
19559
+ # IdentityMappingStore. This field can only be set for acl_enabled DataStores
19560
+ # with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/`project`/locations/`
19561
+ # location`/identityMappingStores/`identity_mapping_store``.
19562
+ # Corresponds to the JSON property `identityMappingStore`
19563
+ # @return [String]
19564
+ attr_accessor :identity_mapping_store
19565
+
18286
19566
  # Immutable. The industry vertical that the data store registers.
18287
19567
  # Corresponds to the JSON property `industryVertical`
18288
19568
  # @return [String]
@@ -18357,6 +19637,8 @@ module Google
18357
19637
  @default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
18358
19638
  @display_name = args[:display_name] if args.key?(:display_name)
18359
19639
  @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
19640
+ @healthcare_fhir_config = args[:healthcare_fhir_config] if args.key?(:healthcare_fhir_config)
19641
+ @identity_mapping_store = args[:identity_mapping_store] if args.key?(:identity_mapping_store)
18360
19642
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
18361
19643
  @is_infobot_faq_data_store = args[:is_infobot_faq_data_store] if args.key?(:is_infobot_faq_data_store)
18362
19644
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
@@ -18439,6 +19721,33 @@ module Google
18439
19721
  end
18440
19722
  end
18441
19723
 
19724
+ # The historical dedicated crawl rate timeseries data, used for monitoring.
19725
+ # Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate
19726
+ # crawl is set.
19727
+ class GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries
19728
+ include Google::Apis::Core::Hashable
19729
+
19730
+ # The historical crawl rate timeseries data, used for monitoring.
19731
+ # Corresponds to the JSON property `autoRefreshCrawlRate`
19732
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries]
19733
+ attr_accessor :auto_refresh_crawl_rate
19734
+
19735
+ # The historical crawl rate timeseries data, used for monitoring.
19736
+ # Corresponds to the JSON property `userTriggeredCrawlRate`
19737
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries]
19738
+ attr_accessor :user_triggered_crawl_rate
19739
+
19740
+ def initialize(**args)
19741
+ update!(**args)
19742
+ end
19743
+
19744
+ # Update properties of this object
19745
+ def update!(**args)
19746
+ @auto_refresh_crawl_rate = args[:auto_refresh_crawl_rate] if args.key?(:auto_refresh_crawl_rate)
19747
+ @user_triggered_crawl_rate = args[:user_triggered_crawl_rate] if args.key?(:user_triggered_crawl_rate)
19748
+ end
19749
+ end
19750
+
18442
19751
  # Metadata related to the progress of the DataStoreService.DeleteDataStore
18443
19752
  # operation. This will be returned by the google.longrunning.Operation.metadata
18444
19753
  # field.
@@ -18978,6 +20287,17 @@ module Google
18978
20287
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig]
18979
20288
  attr_accessor :agent_creation_config
18980
20289
 
20290
+ # Optional. If the flag set to true, we allow the agent and engine are in
20291
+ # different locations, otherwise the agent and engine are required to be in the
20292
+ # same location. The flag is set to false by default. Note that the `
20293
+ # allow_cross_region` are one-time consumed by and passed to EngineService.
20294
+ # CreateEngine. It means they cannot be retrieved using EngineService.GetEngine
20295
+ # or EngineService.ListEngines API after engine creation.
20296
+ # Corresponds to the JSON property `allowCrossRegion`
20297
+ # @return [Boolean]
20298
+ attr_accessor :allow_cross_region
20299
+ alias_method :allow_cross_region?, :allow_cross_region
20300
+
18981
20301
  # The resource name of an exist Dialogflow agent to link to this Chat Engine.
18982
20302
  # Customers can either provide `agent_creation_config` to create agent or
18983
20303
  # provide an agent name that links the agent with the Chat engine. Format: `
@@ -18997,6 +20317,7 @@ module Google
18997
20317
  # Update properties of this object
18998
20318
  def update!(**args)
18999
20319
  @agent_creation_config = args[:agent_creation_config] if args.key?(:agent_creation_config)
20320
+ @allow_cross_region = args[:allow_cross_region] if args.key?(:allow_cross_region)
19000
20321
  @dialogflow_agent_to_link = args[:dialogflow_agent_to_link] if args.key?(:dialogflow_agent_to_link)
19001
20322
  end
19002
20323
  end
@@ -19230,14 +20551,25 @@ module Google
19230
20551
  end
19231
20552
  end
19232
20553
 
19233
- # Response message for SiteSearchEngineService.FetchSitemaps method.
19234
- class GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse
20554
+ # Config to data store for `HEALTHCARE_FHIR` vertical.
20555
+ class GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig
19235
20556
  include Google::Apis::Core::Hashable
19236
20557
 
19237
- # List of Sitemaps fetched.
19238
- # Corresponds to the JSON property `sitemapsMetadata`
19239
- # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata>]
19240
- attr_accessor :sitemaps_metadata
20558
+ # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set
20559
+ # to `true`, the predefined healthcare fhir schema can be extended for more
20560
+ # customized searching and filtering.
20561
+ # Corresponds to the JSON property `enableConfigurableSchema`
20562
+ # @return [Boolean]
20563
+ attr_accessor :enable_configurable_schema
20564
+ alias_method :enable_configurable_schema?, :enable_configurable_schema
20565
+
20566
+ # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If
20567
+ # set to `true`, the batch ingestion will be processed in a static indexing mode
20568
+ # which is slower but more capable of handling larger volume.
20569
+ # Corresponds to the JSON property `enableStaticIndexingForBatchIngestion`
20570
+ # @return [Boolean]
20571
+ attr_accessor :enable_static_indexing_for_batch_ingestion
20572
+ alias_method :enable_static_indexing_for_batch_ingestion?, :enable_static_indexing_for_batch_ingestion
19241
20573
 
19242
20574
  def initialize(**args)
19243
20575
  update!(**args)
@@ -19245,18 +20577,31 @@ module Google
19245
20577
 
19246
20578
  # Update properties of this object
19247
20579
  def update!(**args)
19248
- @sitemaps_metadata = args[:sitemaps_metadata] if args.key?(:sitemaps_metadata)
20580
+ @enable_configurable_schema = args[:enable_configurable_schema] if args.key?(:enable_configurable_schema)
20581
+ @enable_static_indexing_for_batch_ingestion = args[:enable_static_indexing_for_batch_ingestion] if args.key?(:enable_static_indexing_for_batch_ingestion)
19249
20582
  end
19250
20583
  end
19251
20584
 
19252
- # Contains a Sitemap and its metadata.
19253
- class GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata
20585
+ # IdentityMappingEntry LongRunningOperation metadata for
20586
+ # IdentityMappingStoreService.ImportIdentityMappings and
20587
+ # IdentityMappingStoreService.PurgeIdentityMappings
20588
+ class GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata
19254
20589
  include Google::Apis::Core::Hashable
19255
20590
 
19256
- # A sitemap for the SiteSearchEngine.
19257
- # Corresponds to the JSON property `sitemap`
19258
- # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSitemap]
19259
- attr_accessor :sitemap
20591
+ # The number of IdentityMappingEntries that failed to be processed.
20592
+ # Corresponds to the JSON property `failureCount`
20593
+ # @return [Fixnum]
20594
+ attr_accessor :failure_count
20595
+
20596
+ # The number of IdentityMappingEntries that were successfully processed.
20597
+ # Corresponds to the JSON property `successCount`
20598
+ # @return [Fixnum]
20599
+ attr_accessor :success_count
20600
+
20601
+ # The total number of IdentityMappingEntries that were processed.
20602
+ # Corresponds to the JSON property `totalCount`
20603
+ # @return [Fixnum]
20604
+ attr_accessor :total_count
19260
20605
 
19261
20606
  def initialize(**args)
19262
20607
  update!(**args)
@@ -19264,7 +20609,9 @@ module Google
19264
20609
 
19265
20610
  # Update properties of this object
19266
20611
  def update!(**args)
19267
- @sitemap = args[:sitemap] if args.key?(:sitemap)
20612
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
20613
+ @success_count = args[:success_count] if args.key?(:success_count)
20614
+ @total_count = args[:total_count] if args.key?(:total_count)
19268
20615
  end
19269
20616
  end
19270
20617
 
@@ -19427,6 +20774,25 @@ module Google
19427
20774
  end
19428
20775
  end
19429
20776
 
20777
+ # Response message for IdentityMappingStoreService.ImportIdentityMappings
20778
+ class GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse
20779
+ include Google::Apis::Core::Hashable
20780
+
20781
+ # A sample of errors encountered while processing the request.
20782
+ # Corresponds to the JSON property `errorSamples`
20783
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleRpcStatus>]
20784
+ attr_accessor :error_samples
20785
+
20786
+ def initialize(**args)
20787
+ update!(**args)
20788
+ end
20789
+
20790
+ # Update properties of this object
20791
+ def update!(**args)
20792
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
20793
+ end
20794
+ end
20795
+
19430
20796
  # Metadata related to the progress of the ImportSampleQueries operation. This
19431
20797
  # will be returned by the google.longrunning.Operation.metadata field.
19432
20798
  class GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata
@@ -19734,6 +21100,83 @@ module Google
19734
21100
  end
19735
21101
  end
19736
21102
 
21103
+ # Response message for CrawlRateManagementService.ObtainCrawlRate method. The
21104
+ # response contains organcic or dedicated crawl rate time series data for
21105
+ # monitoring, depending on whether dedicated crawl rate is set.
21106
+ class GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse
21107
+ include Google::Apis::Core::Hashable
21108
+
21109
+ # The historical dedicated crawl rate timeseries data, used for monitoring.
21110
+ # Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate
21111
+ # crawl is set.
21112
+ # Corresponds to the JSON property `dedicatedCrawlRateTimeSeries`
21113
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries]
21114
+ attr_accessor :dedicated_crawl_rate_time_series
21115
+
21116
+ # The `Status` type defines a logical error model that is suitable for different
21117
+ # programming environments, including REST APIs and RPC APIs. It is used by [
21118
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
21119
+ # data: error code, error message, and error details. You can find out more
21120
+ # about this error model and how to work with it in the [API Design Guide](https:
21121
+ # //cloud.google.com/apis/design/errors).
21122
+ # Corresponds to the JSON property `error`
21123
+ # @return [Google::Apis::DiscoveryengineV1::GoogleRpcStatus]
21124
+ attr_accessor :error
21125
+
21126
+ # The historical organic crawl rate timeseries data, used for monitoring.
21127
+ # Organic crawl is auto-determined by Google to crawl the user's website when
21128
+ # dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends
21129
+ # to the user's website.
21130
+ # Corresponds to the JSON property `organicCrawlRateTimeSeries`
21131
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries]
21132
+ attr_accessor :organic_crawl_rate_time_series
21133
+
21134
+ # Output only. The state of the response.
21135
+ # Corresponds to the JSON property `state`
21136
+ # @return [String]
21137
+ attr_accessor :state
21138
+
21139
+ def initialize(**args)
21140
+ update!(**args)
21141
+ end
21142
+
21143
+ # Update properties of this object
21144
+ def update!(**args)
21145
+ @dedicated_crawl_rate_time_series = args[:dedicated_crawl_rate_time_series] if args.key?(:dedicated_crawl_rate_time_series)
21146
+ @error = args[:error] if args.key?(:error)
21147
+ @organic_crawl_rate_time_series = args[:organic_crawl_rate_time_series] if args.key?(:organic_crawl_rate_time_series)
21148
+ @state = args[:state] if args.key?(:state)
21149
+ end
21150
+ end
21151
+
21152
+ # The historical organic crawl rate timeseries data, used for monitoring.
21153
+ # Organic crawl is auto-determined by Google to crawl the user's website when
21154
+ # dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends
21155
+ # to the user's website.
21156
+ class GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries
21157
+ include Google::Apis::Core::Hashable
21158
+
21159
+ # The historical crawl rate timeseries data, used for monitoring.
21160
+ # Corresponds to the JSON property `googleOrganicCrawlRate`
21161
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries]
21162
+ attr_accessor :google_organic_crawl_rate
21163
+
21164
+ # The historical crawl rate timeseries data, used for monitoring.
21165
+ # Corresponds to the JSON property `vertexAiOrganicCrawlRate`
21166
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries]
21167
+ attr_accessor :vertex_ai_organic_crawl_rate
21168
+
21169
+ def initialize(**args)
21170
+ update!(**args)
21171
+ end
21172
+
21173
+ # Update properties of this object
21174
+ def update!(**args)
21175
+ @google_organic_crawl_rate = args[:google_organic_crawl_rate] if args.key?(:google_organic_crawl_rate)
21176
+ @vertex_ai_organic_crawl_rate = args[:vertex_ai_organic_crawl_rate] if args.key?(:vertex_ai_organic_crawl_rate)
21177
+ end
21178
+ end
21179
+
19737
21180
  # Metadata and configurations for a Google Cloud project in the service.
19738
21181
  class GoogleCloudDiscoveryengineV1betaProject
19739
21182
  include Google::Apis::Core::Hashable
@@ -20042,6 +21485,66 @@ module Google
20042
21485
  end
20043
21486
  end
20044
21487
 
21488
+ # Metadata related to the progress of the CrawlRateManagementService.
21489
+ # RemoveDedicatedCrawlRate operation. This will be returned by the google.
21490
+ # longrunning.Operation.metadata field.
21491
+ class GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata
21492
+ include Google::Apis::Core::Hashable
21493
+
21494
+ # Operation create time.
21495
+ # Corresponds to the JSON property `createTime`
21496
+ # @return [String]
21497
+ attr_accessor :create_time
21498
+
21499
+ # Operation last update time. If the operation is done, this is also the finish
21500
+ # time.
21501
+ # Corresponds to the JSON property `updateTime`
21502
+ # @return [String]
21503
+ attr_accessor :update_time
21504
+
21505
+ def initialize(**args)
21506
+ update!(**args)
21507
+ end
21508
+
21509
+ # Update properties of this object
21510
+ def update!(**args)
21511
+ @create_time = args[:create_time] if args.key?(:create_time)
21512
+ @update_time = args[:update_time] if args.key?(:update_time)
21513
+ end
21514
+ end
21515
+
21516
+ # Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate
21517
+ # method. It simply returns the state of the response, and an error message if
21518
+ # the state is FAILED.
21519
+ class GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse
21520
+ include Google::Apis::Core::Hashable
21521
+
21522
+ # The `Status` type defines a logical error model that is suitable for different
21523
+ # programming environments, including REST APIs and RPC APIs. It is used by [
21524
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
21525
+ # data: error code, error message, and error details. You can find out more
21526
+ # about this error model and how to work with it in the [API Design Guide](https:
21527
+ # //cloud.google.com/apis/design/errors).
21528
+ # Corresponds to the JSON property `error`
21529
+ # @return [Google::Apis::DiscoveryengineV1::GoogleRpcStatus]
21530
+ attr_accessor :error
21531
+
21532
+ # Output only. The state of the response.
21533
+ # Corresponds to the JSON property `state`
21534
+ # @return [String]
21535
+ attr_accessor :state
21536
+
21537
+ def initialize(**args)
21538
+ update!(**args)
21539
+ end
21540
+
21541
+ # Update properties of this object
21542
+ def update!(**args)
21543
+ @error = args[:error] if args.key?(:error)
21544
+ @state = args[:state] if args.key?(:state)
21545
+ end
21546
+ end
21547
+
20045
21548
  # Defines the structure and layout of a type of document data.
20046
21549
  class GoogleCloudDiscoveryengineV1betaSchema
20047
21550
  include Google::Apis::Core::Hashable
@@ -20283,21 +21786,41 @@ module Google
20283
21786
  attr_accessor :query_expansion_spec
20284
21787
 
20285
21788
  # The ranking expression controls the customized ranking on retrieval documents.
20286
- # This overrides ServingConfig.ranking_expression. The ranking expression is a
20287
- # single function or multiple functions that are joined by "+". *
20288
- # ranking_expression = function, ` " + ", function `; Supported functions: *
20289
- # double * relevance_score * double * dotProduct(embedding_field_path) Function
20290
- # variables: * `relevance_score`: pre-defined keywords, used for measure
20291
- # relevance between query and document. * `embedding_field_path`: the document
20292
- # embedding field used with query embedding vector. * `dotProduct`: embedding
20293
- # function between embedding_field_path and query embedding vector. Example
20294
- # ranking expression: If document has an embedding field doc_embedding, the
20295
- # ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(
20296
- # doc_embedding)`.
21789
+ # This overrides ServingConfig.ranking_expression. The syntax and supported
21790
+ # features depend on the ranking_expression_backend value. If
21791
+ # ranking_expression_backend is not provided, it defaults to BYOE. === BYOE ===
21792
+ # If ranking expression is not provided or set to BYOE, it should be a single
21793
+ # function or multiple functions that are joined by "+". * ranking_expression =
21794
+ # function, ` " + ", function `; Supported functions: * double * relevance_score
21795
+ # * double * dotProduct(embedding_field_path) Function variables: * `
21796
+ # relevance_score`: pre-defined keywords, used for measure relevance between
21797
+ # query and document. * `embedding_field_path`: the document embedding field
21798
+ # used with query embedding vector. * `dotProduct`: embedding function between
21799
+ # embedding_field_path and query embedding vector. Example ranking expression:
21800
+ # If document has an embedding field doc_embedding, the ranking expression could
21801
+ # be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX ===
21802
+ # If ranking expression is set to CLEARBOX, the following expression types (and
21803
+ # combinations of those chained using + or * operators) are supported: * double *
21804
+ # signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal
21805
+ # rank transformation with second argument being a denominator constant. *
21806
+ # is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1,
21807
+ # signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns
21808
+ # signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(
21809
+ # fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score,
21810
+ # 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: *
21811
+ # gecko_score -- semantic similarity adjustment * bm25_score -- keyword match
21812
+ # adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank --
21813
+ # predicted conversion rate adjustment as a rank * freshness_rank -- freshness
21814
+ # adjustment as a rank * base_rank -- the default rank of the result
20297
21815
  # Corresponds to the JSON property `rankingExpression`
20298
21816
  # @return [String]
20299
21817
  attr_accessor :ranking_expression
20300
21818
 
21819
+ # Optional. The backend to use for the ranking expression evaluation.
21820
+ # Corresponds to the JSON property `rankingExpressionBackend`
21821
+ # @return [String]
21822
+ attr_accessor :ranking_expression_backend
21823
+
20301
21824
  # The Unicode country/region code (CLDR) of a location, such as "US" and "419".
20302
21825
  # For more information, see [Standard fields](https://cloud.google.com/apis/
20303
21826
  # design/standard_fields). If set, then results will be boosted based on the
@@ -20306,9 +21829,15 @@ module Google
20306
21829
  # @return [String]
20307
21830
  attr_accessor :region_code
20308
21831
 
21832
+ # The specification for returning the document relevance score.
21833
+ # Corresponds to the JSON property `relevanceScoreSpec`
21834
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec]
21835
+ attr_accessor :relevance_score_spec
21836
+
20309
21837
  # The relevance threshold of the search results. Default to Google defined
20310
21838
  # threshold, leveraging a balance of precision and recall to deliver both highly
20311
- # accurate results and comprehensive coverage of relevant information.
21839
+ # accurate results and comprehensive coverage of relevant information. This
21840
+ # feature is not supported for healthcare search.
20312
21841
  # Corresponds to the JSON property `relevanceThreshold`
20313
21842
  # @return [String]
20314
21843
  attr_accessor :relevance_threshold
@@ -20426,7 +21955,9 @@ module Google
20426
21955
  @query = args[:query] if args.key?(:query)
20427
21956
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
20428
21957
  @ranking_expression = args[:ranking_expression] if args.key?(:ranking_expression)
21958
+ @ranking_expression_backend = args[:ranking_expression_backend] if args.key?(:ranking_expression_backend)
20429
21959
  @region_code = args[:region_code] if args.key?(:region_code)
21960
+ @relevance_score_spec = args[:relevance_score_spec] if args.key?(:relevance_score_spec)
20430
21961
  @relevance_threshold = args[:relevance_threshold] if args.key?(:relevance_threshold)
20431
21962
  @safe_search = args[:safe_search] if args.key?(:safe_search)
20432
21963
  @search_as_you_type_spec = args[:search_as_you_type_spec] if args.key?(:search_as_you_type_spec)
@@ -21257,6 +22788,27 @@ module Google
21257
22788
  end
21258
22789
  end
21259
22790
 
22791
+ # The specification for returning the document relevance score.
22792
+ class GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec
22793
+ include Google::Apis::Core::Hashable
22794
+
22795
+ # Optional. Whether to return the relevance score for search results. The higher
22796
+ # the score, the more relevant the document is to the query.
22797
+ # Corresponds to the JSON property `returnRelevanceScore`
22798
+ # @return [Boolean]
22799
+ attr_accessor :return_relevance_score
22800
+ alias_method :return_relevance_score?, :return_relevance_score
22801
+
22802
+ def initialize(**args)
22803
+ update!(**args)
22804
+ end
22805
+
22806
+ # Update properties of this object
22807
+ def update!(**args)
22808
+ @return_relevance_score = args[:return_relevance_score] if args.key?(:return_relevance_score)
22809
+ end
22810
+ end
22811
+
21260
22812
  # Specification for search as you type in search requests.
21261
22813
  class GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec
21262
22814
  include Google::Apis::Core::Hashable
@@ -21298,7 +22850,7 @@ module Google
21298
22850
  attr_accessor :query_id
21299
22851
 
21300
22852
  # The number of top search results to persist. The persisted search results can
21301
- # be used for the subsequent /answer api call. This field is simliar to the `
22853
+ # be used for the subsequent /answer api call. This field is similar to the `
21302
22854
  # summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.
21303
22855
  # summary_result_count. At most 10 results for documents mode, or 50 for chunks
21304
22856
  # mode.
@@ -21337,6 +22889,66 @@ module Google
21337
22889
  end
21338
22890
  end
21339
22891
 
22892
+ # Metadata related to the progress of the CrawlRateManagementService.
22893
+ # SetDedicatedCrawlRate operation. This will be returned by the google.
22894
+ # longrunning.Operation.metadata field.
22895
+ class GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata
22896
+ include Google::Apis::Core::Hashable
22897
+
22898
+ # Operation create time.
22899
+ # Corresponds to the JSON property `createTime`
22900
+ # @return [String]
22901
+ attr_accessor :create_time
22902
+
22903
+ # Operation last update time. If the operation is done, this is also the finish
22904
+ # time.
22905
+ # Corresponds to the JSON property `updateTime`
22906
+ # @return [String]
22907
+ attr_accessor :update_time
22908
+
22909
+ def initialize(**args)
22910
+ update!(**args)
22911
+ end
22912
+
22913
+ # Update properties of this object
22914
+ def update!(**args)
22915
+ @create_time = args[:create_time] if args.key?(:create_time)
22916
+ @update_time = args[:update_time] if args.key?(:update_time)
22917
+ end
22918
+ end
22919
+
22920
+ # Response message for CrawlRateManagementService.SetDedicatedCrawlRate method.
22921
+ # It simply returns the state of the response, and an error message if the state
22922
+ # is FAILED.
22923
+ class GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse
22924
+ include Google::Apis::Core::Hashable
22925
+
22926
+ # The `Status` type defines a logical error model that is suitable for different
22927
+ # programming environments, including REST APIs and RPC APIs. It is used by [
22928
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
22929
+ # data: error code, error message, and error details. You can find out more
22930
+ # about this error model and how to work with it in the [API Design Guide](https:
22931
+ # //cloud.google.com/apis/design/errors).
22932
+ # Corresponds to the JSON property `error`
22933
+ # @return [Google::Apis::DiscoveryengineV1::GoogleRpcStatus]
22934
+ attr_accessor :error
22935
+
22936
+ # Output only. The state of the response.
22937
+ # Corresponds to the JSON property `state`
22938
+ # @return [String]
22939
+ attr_accessor :state
22940
+
22941
+ def initialize(**args)
22942
+ update!(**args)
22943
+ end
22944
+
22945
+ # Update properties of this object
22946
+ def update!(**args)
22947
+ @error = args[:error] if args.key?(:error)
22948
+ @state = args[:state] if args.key?(:state)
22949
+ end
22950
+ end
22951
+
21340
22952
  # Metadata for single-regional CMEKs.
21341
22953
  class GoogleCloudDiscoveryengineV1betaSingleRegionKey
21342
22954
  include Google::Apis::Core::Hashable