google-apis-discoveryengine_v1beta 0.53.0 → 0.55.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.
@@ -695,12 +695,26 @@ module Google
695
695
  class GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig
696
696
  include Google::Apis::Core::Hashable
697
697
 
698
+ # If set true, automatic refresh is disabled for the DataStore.
699
+ # Corresponds to the JSON property `disableAutomaticRefresh`
700
+ # @return [Boolean]
701
+ attr_accessor :disable_automatic_refresh
702
+ alias_method :disable_automatic_refresh?, :disable_automatic_refresh
703
+
704
+ # If set true, initial indexing is disabled for the DataStore.
705
+ # Corresponds to the JSON property `disableInitialIndex`
706
+ # @return [Boolean]
707
+ attr_accessor :disable_initial_index
708
+ alias_method :disable_initial_index?, :disable_initial_index
709
+
698
710
  def initialize(**args)
699
711
  update!(**args)
700
712
  end
701
713
 
702
714
  # Update properties of this object
703
715
  def update!(**args)
716
+ @disable_automatic_refresh = args[:disable_automatic_refresh] if args.key?(:disable_automatic_refresh)
717
+ @disable_initial_index = args[:disable_initial_index] if args.key?(:disable_initial_index)
704
718
  end
705
719
  end
706
720
 
@@ -785,6 +799,11 @@ module Google
785
799
  # @return [String]
786
800
  attr_accessor :name
787
801
 
802
+ # Optional. Single-regional CMEKs that are required for some VAIS features.
803
+ # Corresponds to the JSON property `singleRegionKeys`
804
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1SingleRegionKey>]
805
+ attr_accessor :single_region_keys
806
+
788
807
  # Output only. State of the CmekConfig.
789
808
  # Corresponds to the JSON property `state`
790
809
  # @return [String]
@@ -801,6 +820,7 @@ module Google
801
820
  @kms_key_version = args[:kms_key_version] if args.key?(:kms_key_version)
802
821
  @last_rotation_timestamp_micros = args[:last_rotation_timestamp_micros] if args.key?(:last_rotation_timestamp_micros)
803
822
  @name = args[:name] if args.key?(:name)
823
+ @single_region_keys = args[:single_region_keys] if args.key?(:single_region_keys)
804
824
  @state = args[:state] if args.key?(:state)
805
825
  end
806
826
  end
@@ -991,8 +1011,8 @@ module Google
991
1011
  class GoogleCloudDiscoveryengineV1ControlBoostAction
992
1012
  include Google::Apis::Core::Hashable
993
1013
 
994
- # Required. Strength of the boost, which should be in [-1, 1]. Negative boost
995
- # means demotion. Default is 0.0 (No-op).
1014
+ # Strength of the boost, which should be in [-1, 1]. Negative boost means
1015
+ # demotion. Default is 0.0 (No-op).
996
1016
  # Corresponds to the JSON property `boost`
997
1017
  # @return [Float]
998
1018
  attr_accessor :boost
@@ -1012,6 +1032,12 @@ module Google
1012
1032
  # @return [String]
1013
1033
  attr_accessor :filter
1014
1034
 
1035
+ # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost
1036
+ # means demotion. Default is 0.0 (No-op).
1037
+ # Corresponds to the JSON property `fixedBoost`
1038
+ # @return [Float]
1039
+ attr_accessor :fixed_boost
1040
+
1015
1041
  def initialize(**args)
1016
1042
  update!(**args)
1017
1043
  end
@@ -1021,6 +1047,7 @@ module Google
1021
1047
  @boost = args[:boost] if args.key?(:boost)
1022
1048
  @data_store = args[:data_store] if args.key?(:data_store)
1023
1049
  @filter = args[:filter] if args.key?(:filter)
1050
+ @fixed_boost = args[:fixed_boost] if args.key?(:fixed_boost)
1024
1051
  end
1025
1052
  end
1026
1053
 
@@ -1287,6 +1314,12 @@ module Google
1287
1314
  # @return [String]
1288
1315
  attr_accessor :industry_vertical
1289
1316
 
1317
+ # Optional. If set, this DataStore is an Infobot FAQ DataStore.
1318
+ # Corresponds to the JSON property `isInfobotFaqDataStore`
1319
+ # @return [Boolean]
1320
+ attr_accessor :is_infobot_faq_data_store
1321
+ alias_method :is_infobot_faq_data_store?, :is_infobot_faq_data_store
1322
+
1290
1323
  # Input only. The KMS key to be used to protect this DataStore at creation time.
1291
1324
  # Must be set for requests that need to comply with CMEK Org Policy protections.
1292
1325
  # If this field is set and processed successfully, the DataStore will be
@@ -1341,6 +1374,7 @@ module Google
1341
1374
  @display_name = args[:display_name] if args.key?(:display_name)
1342
1375
  @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
1343
1376
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
1377
+ @is_infobot_faq_data_store = args[:is_infobot_faq_data_store] if args.key?(:is_infobot_faq_data_store)
1344
1378
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
1345
1379
  @name = args[:name] if args.key?(:name)
1346
1380
  @serving_config_data_store = args[:serving_config_data_store] if args.key?(:serving_config_data_store)
@@ -1474,6 +1508,34 @@ module Google
1474
1508
  end
1475
1509
  end
1476
1510
 
1511
+ # Metadata related to the progress of the IdentityMappingStoreService.
1512
+ # DeleteIdentityMappingStore operation. This will be returned by the google.
1513
+ # longrunning.Operation.metadata field.
1514
+ class GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata
1515
+ include Google::Apis::Core::Hashable
1516
+
1517
+ # Operation create time.
1518
+ # Corresponds to the JSON property `createTime`
1519
+ # @return [String]
1520
+ attr_accessor :create_time
1521
+
1522
+ # Operation last update time. If the operation is done, this is also the finish
1523
+ # time.
1524
+ # Corresponds to the JSON property `updateTime`
1525
+ # @return [String]
1526
+ attr_accessor :update_time
1527
+
1528
+ def initialize(**args)
1529
+ update!(**args)
1530
+ end
1531
+
1532
+ # Update properties of this object
1533
+ def update!(**args)
1534
+ @create_time = args[:create_time] if args.key?(:create_time)
1535
+ @update_time = args[:update_time] if args.key?(:update_time)
1536
+ end
1537
+ end
1538
+
1477
1539
  # Metadata for DeleteSchema LRO.
1478
1540
  class GoogleCloudDiscoveryengineV1DeleteSchemaMetadata
1479
1541
  include Google::Apis::Core::Hashable
@@ -3145,7 +3207,7 @@ module Google
3145
3207
  # The ranking expression controls the customized ranking on retrieval documents.
3146
3208
  # To leverage this, document embedding is required. The ranking expression
3147
3209
  # setting in ServingConfig applies to all search requests served by the serving
3148
- # config. However, if SearchRequest.ranking_expression is specified, it
3210
+ # config. However, if `SearchRequest.ranking_expression` is specified, it
3149
3211
  # overrides the ServingConfig ranking expression. The ranking expression is a
3150
3212
  # single function or multiple functions that are joined by "+". *
3151
3213
  # ranking_expression = function, ` " + ", function `; Supported functions: *
@@ -3301,6 +3363,27 @@ module Google
3301
3363
  end
3302
3364
  end
3303
3365
 
3366
+ # Metadata for single-regional CMEKs.
3367
+ class GoogleCloudDiscoveryengineV1SingleRegionKey
3368
+ include Google::Apis::Core::Hashable
3369
+
3370
+ # Required. Single-regional kms key resource name which will be used to encrypt
3371
+ # resources `projects/`project`/locations/`location`/keyRings/`keyRing`/
3372
+ # cryptoKeys/`keyId``.
3373
+ # Corresponds to the JSON property `kmsKey`
3374
+ # @return [String]
3375
+ attr_accessor :kms_key
3376
+
3377
+ def initialize(**args)
3378
+ update!(**args)
3379
+ end
3380
+
3381
+ # Update properties of this object
3382
+ def update!(**args)
3383
+ @kms_key = args[:kms_key] if args.key?(:kms_key)
3384
+ end
3385
+ end
3386
+
3304
3387
  # Verification information for target sites in advanced site search.
3305
3388
  class GoogleCloudDiscoveryengineV1SiteVerificationInfo
3306
3389
  include Google::Apis::Core::Hashable
@@ -3330,7 +3413,7 @@ module Google
3330
3413
  class GoogleCloudDiscoveryengineV1TargetSite
3331
3414
  include Google::Apis::Core::Hashable
3332
3415
 
3333
- # Input only. If set to false, a uri_pattern is generated to include all pages
3416
+ # Immutable. If set to false, a uri_pattern is generated to include all pages
3334
3417
  # whose address contains the provided_uri_pattern. If set to true, an
3335
3418
  # uri_pattern is generated to try to be an exact match of the
3336
3419
  # provided_uri_pattern or just the specific page if the provided_uri_pattern is
@@ -3675,6 +3758,38 @@ module Google
3675
3758
  end
3676
3759
  end
3677
3760
 
3761
+ # Informations to support actions on the connector.
3762
+ class GoogleCloudDiscoveryengineV1alphaActionConfig
3763
+ include Google::Apis::Core::Hashable
3764
+
3765
+ # Required. Params needed to support actions in the format of (Key, Value) pairs.
3766
+ # Required parameters for sources that support OAUTH, i.e. `gmail`, `
3767
+ # google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `
3768
+ # client_id` * Value: type STRING. The client id for the service provider to
3769
+ # identify your application. * Key: `client_secret` * Value:type STRING. The
3770
+ # client secret generated by the application's authorization server.
3771
+ # Corresponds to the JSON property `actionParams`
3772
+ # @return [Hash<String,Object>]
3773
+ attr_accessor :action_params
3774
+
3775
+ # Output only. The connector contains the necessary parameters and is configured
3776
+ # to support actions.
3777
+ # Corresponds to the JSON property `isActionConfigured`
3778
+ # @return [Boolean]
3779
+ attr_accessor :is_action_configured
3780
+ alias_method :is_action_configured?, :is_action_configured
3781
+
3782
+ def initialize(**args)
3783
+ update!(**args)
3784
+ end
3785
+
3786
+ # Update properties of this object
3787
+ def update!(**args)
3788
+ @action_params = args[:action_params] if args.key?(:action_params)
3789
+ @is_action_configured = args[:is_action_configured] if args.key?(:is_action_configured)
3790
+ end
3791
+ end
3792
+
3678
3793
  # Configuration data for advance site search.
3679
3794
  class GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig
3680
3795
  include Google::Apis::Core::Hashable
@@ -3764,6 +3879,11 @@ module Google
3764
3879
  # @return [Array<String>]
3765
3880
  attr_accessor :related_questions
3766
3881
 
3882
+ # Optional. Safety ratings.
3883
+ # Corresponds to the JSON property `safetyRatings`
3884
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSafetyRating>]
3885
+ attr_accessor :safety_ratings
3886
+
3767
3887
  # The state of the answer generation.
3768
3888
  # Corresponds to the JSON property `state`
3769
3889
  # @return [String]
@@ -3791,6 +3911,7 @@ module Google
3791
3911
  @query_understanding_info = args[:query_understanding_info] if args.key?(:query_understanding_info)
3792
3912
  @references = args[:references] if args.key?(:references)
3793
3913
  @related_questions = args[:related_questions] if args.key?(:related_questions)
3914
+ @safety_ratings = args[:safety_ratings] if args.key?(:safety_ratings)
3794
3915
  @state = args[:state] if args.key?(:state)
3795
3916
  @steps = args[:steps] if args.key?(:steps)
3796
3917
  end
@@ -4451,6 +4572,11 @@ module Google
4451
4572
  # @return [String]
4452
4573
  attr_accessor :name
4453
4574
 
4575
+ # Optional. Single-regional CMEKs that are required for some VAIS features.
4576
+ # Corresponds to the JSON property `singleRegionKeys`
4577
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSingleRegionKey>]
4578
+ attr_accessor :single_region_keys
4579
+
4454
4580
  # Output only. State of the CmekConfig.
4455
4581
  # Corresponds to the JSON property `state`
4456
4582
  # @return [String]
@@ -4467,10 +4593,57 @@ module Google
4467
4593
  @kms_key_version = args[:kms_key_version] if args.key?(:kms_key_version)
4468
4594
  @last_rotation_timestamp_micros = args[:last_rotation_timestamp_micros] if args.key?(:last_rotation_timestamp_micros)
4469
4595
  @name = args[:name] if args.key?(:name)
4596
+ @single_region_keys = args[:single_region_keys] if args.key?(:single_region_keys)
4470
4597
  @state = args[:state] if args.key?(:state)
4471
4598
  end
4472
4599
  end
4473
4600
 
4601
+ # Collection is a container for configuring resources and access to a set of
4602
+ # DataStores.
4603
+ class GoogleCloudDiscoveryengineV1alphaCollection
4604
+ include Google::Apis::Core::Hashable
4605
+
4606
+ # Output only. Timestamp the Collection was created at.
4607
+ # Corresponds to the JSON property `createTime`
4608
+ # @return [String]
4609
+ attr_accessor :create_time
4610
+
4611
+ # Manages the connection to external data sources for all data stores grouped
4612
+ # under a Collection. It's a singleton resource of Collection. The
4613
+ # initialization is only supported through DataConnectorService.
4614
+ # SetUpDataConnector method, which will create a new Collection and initialize
4615
+ # its DataConnector.
4616
+ # Corresponds to the JSON property `dataConnector`
4617
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDataConnector]
4618
+ attr_accessor :data_connector
4619
+
4620
+ # Required. The Collection display name. This field must be a UTF-8 encoded
4621
+ # string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
4622
+ # error is returned.
4623
+ # Corresponds to the JSON property `displayName`
4624
+ # @return [String]
4625
+ attr_accessor :display_name
4626
+
4627
+ # Immutable. The full resource name of the Collection. Format: `projects/`
4628
+ # project`/locations/`location`/collections/`collection_id``. This field must be
4629
+ # a UTF-8 encoded string with a length limit of 1024 characters.
4630
+ # Corresponds to the JSON property `name`
4631
+ # @return [String]
4632
+ attr_accessor :name
4633
+
4634
+ def initialize(**args)
4635
+ update!(**args)
4636
+ end
4637
+
4638
+ # Update properties of this object
4639
+ def update!(**args)
4640
+ @create_time = args[:create_time] if args.key?(:create_time)
4641
+ @data_connector = args[:data_connector] if args.key?(:data_connector)
4642
+ @display_name = args[:display_name] if args.key?(:display_name)
4643
+ @name = args[:name] if args.key?(:name)
4644
+ end
4645
+ end
4646
+
4474
4647
  # Defines circumstances to be checked before allowing a behavior
4475
4648
  class GoogleCloudDiscoveryengineV1alphaCondition
4476
4649
  include Google::Apis::Core::Hashable
@@ -4558,6 +4731,158 @@ module Google
4558
4731
  end
4559
4732
  end
4560
4733
 
4734
+ # A data sync run of DataConnector. After DataConnector is successfully
4735
+ # initialized, data syncs are scheduled at DataConnector.refresh_interval. A
4736
+ # ConnectorRun represents a data sync either in the past or onging that the
4737
+ # moment. //
4738
+ class GoogleCloudDiscoveryengineV1alphaConnectorRun
4739
+ include Google::Apis::Core::Hashable
4740
+
4741
+ # Output only. The time when the connector run ended.
4742
+ # Corresponds to the JSON property `endTime`
4743
+ # @return [String]
4744
+ attr_accessor :end_time
4745
+
4746
+ # Output only. The details of the entities synced at the ConnectorRun. Each
4747
+ # ConnectorRun consists of syncing one or more entities.
4748
+ # Corresponds to the JSON property `entityRuns`
4749
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun>]
4750
+ attr_accessor :entity_runs
4751
+
4752
+ # Contains info about errors incurred during the sync. Only exist if running
4753
+ # into an error state. Contains error code and error message. Use with the `
4754
+ # state` field.
4755
+ # Corresponds to the JSON property `errors`
4756
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
4757
+ attr_accessor :errors
4758
+
4759
+ # Output only. The time when the connector run was most recently paused.
4760
+ # Corresponds to the JSON property `latestPauseTime`
4761
+ # @return [String]
4762
+ attr_accessor :latest_pause_time
4763
+
4764
+ # Output only. The full resource name of the Connector Run. Format: `projects/*/
4765
+ # locations/*/collections/*/dataConnector/connectorRuns/*`. The `
4766
+ # connector_run_id` is system-generated.
4767
+ # Corresponds to the JSON property `name`
4768
+ # @return [String]
4769
+ attr_accessor :name
4770
+
4771
+ # Output only. The time when the connector run started.
4772
+ # Corresponds to the JSON property `startTime`
4773
+ # @return [String]
4774
+ attr_accessor :start_time
4775
+
4776
+ # Output only. The state of the sync run.
4777
+ # Corresponds to the JSON property `state`
4778
+ # @return [String]
4779
+ attr_accessor :state
4780
+
4781
+ # Timestamp at which the connector run sync state was last updated.
4782
+ # Corresponds to the JSON property `stateUpdateTime`
4783
+ # @return [String]
4784
+ attr_accessor :state_update_time
4785
+
4786
+ # Output only. The trigger for this ConnectorRun.
4787
+ # Corresponds to the JSON property `trigger`
4788
+ # @return [String]
4789
+ attr_accessor :trigger
4790
+
4791
+ def initialize(**args)
4792
+ update!(**args)
4793
+ end
4794
+
4795
+ # Update properties of this object
4796
+ def update!(**args)
4797
+ @end_time = args[:end_time] if args.key?(:end_time)
4798
+ @entity_runs = args[:entity_runs] if args.key?(:entity_runs)
4799
+ @errors = args[:errors] if args.key?(:errors)
4800
+ @latest_pause_time = args[:latest_pause_time] if args.key?(:latest_pause_time)
4801
+ @name = args[:name] if args.key?(:name)
4802
+ @start_time = args[:start_time] if args.key?(:start_time)
4803
+ @state = args[:state] if args.key?(:state)
4804
+ @state_update_time = args[:state_update_time] if args.key?(:state_update_time)
4805
+ @trigger = args[:trigger] if args.key?(:trigger)
4806
+ end
4807
+ end
4808
+
4809
+ # Represents an entity that was synced in this ConnectorRun.
4810
+ class GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun
4811
+ include Google::Apis::Core::Hashable
4812
+
4813
+ # The name of the source entity.
4814
+ # Corresponds to the JSON property `entityName`
4815
+ # @return [String]
4816
+ attr_accessor :entity_name
4817
+
4818
+ # The total number of documents failed at sync at any stage (extraction,
4819
+ # indexing, etc).
4820
+ # Corresponds to the JSON property `errorRecordCount`
4821
+ # @return [Fixnum]
4822
+ attr_accessor :error_record_count
4823
+
4824
+ # The errors from the entity's sync run. Only exist if running into an error
4825
+ # state. Contains error code and error message.
4826
+ # Corresponds to the JSON property `errors`
4827
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
4828
+ attr_accessor :errors
4829
+
4830
+ # The number of documents extracted from connector source, ready to be ingested
4831
+ # to UCS.
4832
+ # Corresponds to the JSON property `extractedRecordCount`
4833
+ # @return [Fixnum]
4834
+ attr_accessor :extracted_record_count
4835
+
4836
+ # The number of documents indexed.
4837
+ # Corresponds to the JSON property `indexedRecordCount`
4838
+ # @return [Fixnum]
4839
+ attr_accessor :indexed_record_count
4840
+
4841
+ # The number of requests sent to 3p API.
4842
+ # Corresponds to the JSON property `sourceApiRequestCount`
4843
+ # @return [Fixnum]
4844
+ attr_accessor :source_api_request_count
4845
+
4846
+ # The state of the entity's sync run.
4847
+ # Corresponds to the JSON property `state`
4848
+ # @return [String]
4849
+ attr_accessor :state
4850
+
4851
+ # Timestamp at which the entity sync state was last updated.
4852
+ # Corresponds to the JSON property `stateUpdateTime`
4853
+ # @return [String]
4854
+ attr_accessor :state_update_time
4855
+
4856
+ # The timestamp for either extracted_documents_count, indexed_documents_count
4857
+ # and error_documents_count was last updated.
4858
+ # Corresponds to the JSON property `statsUpdateTime`
4859
+ # @return [String]
4860
+ attr_accessor :stats_update_time
4861
+
4862
+ # Sync type of this run.
4863
+ # Corresponds to the JSON property `syncType`
4864
+ # @return [String]
4865
+ attr_accessor :sync_type
4866
+
4867
+ def initialize(**args)
4868
+ update!(**args)
4869
+ end
4870
+
4871
+ # Update properties of this object
4872
+ def update!(**args)
4873
+ @entity_name = args[:entity_name] if args.key?(:entity_name)
4874
+ @error_record_count = args[:error_record_count] if args.key?(:error_record_count)
4875
+ @errors = args[:errors] if args.key?(:errors)
4876
+ @extracted_record_count = args[:extracted_record_count] if args.key?(:extracted_record_count)
4877
+ @indexed_record_count = args[:indexed_record_count] if args.key?(:indexed_record_count)
4878
+ @source_api_request_count = args[:source_api_request_count] if args.key?(:source_api_request_count)
4879
+ @state = args[:state] if args.key?(:state)
4880
+ @state_update_time = args[:state_update_time] if args.key?(:state_update_time)
4881
+ @stats_update_time = args[:stats_update_time] if args.key?(:stats_update_time)
4882
+ @sync_type = args[:sync_type] if args.key?(:sync_type)
4883
+ end
4884
+ end
4885
+
4561
4886
  # Defines a conditioned behavior to employ during serving. Must be attached to a
4562
4887
  # ServingConfig to be considered at serving time. Permitted actions dependent on
4563
4888
  # `SolutionType`.
@@ -4657,8 +4982,8 @@ module Google
4657
4982
  class GoogleCloudDiscoveryengineV1alphaControlBoostAction
4658
4983
  include Google::Apis::Core::Hashable
4659
4984
 
4660
- # Required. Strength of the boost, which should be in [-1, 1]. Negative boost
4661
- # means demotion. Default is 0.0 (No-op).
4985
+ # Strength of the boost, which should be in [-1, 1]. Negative boost means
4986
+ # demotion. Default is 0.0 (No-op).
4662
4987
  # Corresponds to the JSON property `boost`
4663
4988
  # @return [Float]
4664
4989
  attr_accessor :boost
@@ -4678,6 +5003,12 @@ module Google
4678
5003
  # @return [String]
4679
5004
  attr_accessor :filter
4680
5005
 
5006
+ # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost
5007
+ # means demotion. Default is 0.0 (No-op).
5008
+ # Corresponds to the JSON property `fixedBoost`
5009
+ # @return [Float]
5010
+ attr_accessor :fixed_boost
5011
+
4681
5012
  def initialize(**args)
4682
5013
  update!(**args)
4683
5014
  end
@@ -4687,6 +5018,7 @@ module Google
4687
5018
  @boost = args[:boost] if args.key?(:boost)
4688
5019
  @data_store = args[:data_store] if args.key?(:data_store)
4689
5020
  @filter = args[:filter] if args.key?(:filter)
5021
+ @fixed_boost = args[:fixed_boost] if args.key?(:fixed_boost)
4690
5022
  end
4691
5023
  end
4692
5024
 
@@ -4982,90 +5314,356 @@ module Google
4982
5314
  end
4983
5315
  end
4984
5316
 
4985
- # DataStore captures global settings and configs at the DataStore level.
4986
- class GoogleCloudDiscoveryengineV1alphaDataStore
5317
+ # Manages the connection to external data sources for all data stores grouped
5318
+ # under a Collection. It's a singleton resource of Collection. The
5319
+ # initialization is only supported through DataConnectorService.
5320
+ # SetUpDataConnector method, which will create a new Collection and initialize
5321
+ # its DataConnector.
5322
+ class GoogleCloudDiscoveryengineV1alphaDataConnector
4987
5323
  include Google::Apis::Core::Hashable
4988
5324
 
4989
- # Immutable. Whether data in the DataStore has ACL information. If set to `true`,
4990
- # the source data must have ACL. ACL will be ingested when data is ingested by
4991
- # DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore,
4992
- # Document can't be accessed by calling DocumentService.GetDocument or
4993
- # DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC`
4994
- # industry vertical with non-`PUBLIC_WEBSITE` content config.
4995
- # Corresponds to the JSON property `aclEnabled`
4996
- # @return [Boolean]
4997
- attr_accessor :acl_enabled
4998
- alias_method :acl_enabled?, :acl_enabled
4999
-
5000
- # Configuration data for advance site search.
5001
- # Corresponds to the JSON property `advancedSiteSearchConfig`
5002
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig]
5003
- attr_accessor :advanced_site_search_config
5004
-
5005
- # Estimation of data size per data store.
5006
- # Corresponds to the JSON property `billingEstimation`
5007
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation]
5008
- attr_accessor :billing_estimation
5325
+ # Informations to support actions on the connector.
5326
+ # Corresponds to the JSON property `actionConfig`
5327
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaActionConfig]
5328
+ attr_accessor :action_config
5009
5329
 
5010
- # Configurations used to enable CMEK data encryption with Cloud KMS keys.
5011
- # Corresponds to the JSON property `cmekConfig`
5012
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCmekConfig]
5013
- attr_accessor :cmek_config
5330
+ # Indicates whether the connector is disabled for auto run. It can be used to
5331
+ # pause periodical and real time sync.
5332
+ # Corresponds to the JSON property `autoRunDisabled`
5333
+ # @return [Boolean]
5334
+ attr_accessor :auto_run_disabled
5335
+ alias_method :auto_run_disabled?, :auto_run_disabled
5014
5336
 
5015
- # Immutable. The content config of the data store. If this field is unset, the
5016
- # server behavior defaults to ContentConfig.NO_CONTENT.
5017
- # Corresponds to the JSON property `contentConfig`
5018
- # @return [String]
5019
- attr_accessor :content_config
5337
+ # Output only. User actions that must be completed before the connector can
5338
+ # start syncing data.
5339
+ # Corresponds to the JSON property `blockingReasons`
5340
+ # @return [Array<String>]
5341
+ attr_accessor :blocking_reasons
5020
5342
 
5021
- # Output only. Timestamp the DataStore was created at.
5343
+ # Output only. Timestamp the DataConnector was created at.
5022
5344
  # Corresponds to the JSON property `createTime`
5023
5345
  # @return [String]
5024
5346
  attr_accessor :create_time
5025
5347
 
5026
- # Output only. The id of the default Schema asscociated to this data store.
5027
- # Corresponds to the JSON property `defaultSchemaId`
5348
+ # Required. The name of the data source. Supported values: `salesforce`, `jira`,
5349
+ # `confluence`, `bigquery`.
5350
+ # Corresponds to the JSON property `dataSource`
5028
5351
  # @return [String]
5029
- attr_accessor :default_schema_id
5352
+ attr_accessor :data_source
5030
5353
 
5031
- # Required. The data store display name. This field must be a UTF-8 encoded
5032
- # string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
5033
- # error is returned.
5034
- # Corresponds to the JSON property `displayName`
5035
- # @return [String]
5036
- attr_accessor :display_name
5354
+ # Optional. Any target destinations used to connect to third-party services.
5355
+ # Corresponds to the JSON property `destinationConfigs`
5356
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDestinationConfig>]
5357
+ attr_accessor :destination_configs
5037
5358
 
5038
- # A singleton resource of DataStore. If it's empty when DataStore is created and
5039
- # DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default
5040
- # parser will default to digital parser.
5041
- # Corresponds to the JSON property `documentProcessingConfig`
5042
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig]
5043
- attr_accessor :document_processing_config
5359
+ # List of entities from the connected data source to ingest.
5360
+ # Corresponds to the JSON property `entities`
5361
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity>]
5362
+ attr_accessor :entities
5044
5363
 
5045
- # Identity Provider Config.
5046
- # Corresponds to the JSON property `idpConfig`
5047
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaIdpConfig]
5048
- attr_accessor :idp_config
5364
+ # Output only. The errors from initialization or from the latest connector run.
5365
+ # Corresponds to the JSON property `errors`
5366
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
5367
+ attr_accessor :errors
5049
5368
 
5050
- # Immutable. The industry vertical that the data store registers.
5051
- # Corresponds to the JSON property `industryVertical`
5369
+ # The refresh interval to sync the Access Control List information for the
5370
+ # documents ingested by this connector. If not set, the access control list will
5371
+ # be refreshed at the default interval of 30 minutes. The identity refresh
5372
+ # interval can be at least 30 minutes and at most 7 days.
5373
+ # Corresponds to the JSON property `identityRefreshInterval`
5052
5374
  # @return [String]
5053
- attr_accessor :industry_vertical
5375
+ attr_accessor :identity_refresh_interval
5054
5376
 
5055
- # Input only. The KMS key to be used to protect this DataStore at creation time.
5056
- # Must be set for requests that need to comply with CMEK Org Policy protections.
5057
- # If this field is set and processed successfully, the DataStore will be
5058
- # protected by the KMS key, as indicated in the cmek_config field.
5377
+ # The configuration for the identity data synchronization runs.
5378
+ # Corresponds to the JSON property `identityScheduleConfig`
5379
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig]
5380
+ attr_accessor :identity_schedule_config
5381
+
5382
+ # Input only. The KMS key to be used to protect the DataStores managed by this
5383
+ # connector. Must be set for requests that need to comply with CMEK Org Policy
5384
+ # protections. If this field is set and processed successfully, the DataStores
5385
+ # created by this connector will be protected by the KMS key.
5059
5386
  # Corresponds to the JSON property `kmsKeyName`
5060
5387
  # @return [String]
5061
5388
  attr_accessor :kms_key_name
5062
5389
 
5063
- # Language info for DataStore.
5064
- # Corresponds to the JSON property `languageInfo`
5065
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaLanguageInfo]
5066
- attr_accessor :language_info
5390
+ # Output only. For periodic connectors only, the last time a data sync was
5391
+ # completed.
5392
+ # Corresponds to the JSON property `lastSyncTime`
5393
+ # @return [String]
5394
+ attr_accessor :last_sync_time
5067
5395
 
5068
- # Immutable. The full resource name of the data store. Format: `projects/`
5396
+ # Output only. The most recent timestamp when this DataConnector was paused,
5397
+ # affecting all functionalities such as data synchronization. Pausing a
5398
+ # connector has the following effects: - All functionalities, including data
5399
+ # synchronization, are halted. - Any ongoing data synchronization job will be
5400
+ # canceled. - No future data synchronization runs will be scheduled nor can be
5401
+ # triggered.
5402
+ # Corresponds to the JSON property `latestPauseTime`
5403
+ # @return [String]
5404
+ attr_accessor :latest_pause_time
5405
+
5406
+ # Output only. The full resource name of the Data Connector. Format: `projects/*/
5407
+ # locations/*/collections/*/dataConnector`.
5408
+ # Corresponds to the JSON property `name`
5409
+ # @return [String]
5410
+ attr_accessor :name
5411
+
5412
+ # Represents civil time (or occasionally physical time). This type can represent
5413
+ # a civil time in one of a few possible ways: * When utc_offset is set and
5414
+ # time_zone is unset: a civil time on a calendar day with a particular offset
5415
+ # from UTC. * When time_zone is set and utc_offset is unset: a civil time on a
5416
+ # calendar day in a particular time zone. * When neither time_zone nor
5417
+ # utc_offset is set: a civil time on a calendar day in local time. The date is
5418
+ # relative to the Proleptic Gregorian Calendar. If year, month, or day are 0,
5419
+ # the DateTime is considered not to have a specific year, month, or day
5420
+ # respectively. This type may also be used to represent a physical time if all
5421
+ # the date and time fields are set and either case of the `time_offset` oneof is
5422
+ # set. Consider using `Timestamp` message for physical time instead. If your use
5423
+ # case also would like to store the user's timezone, that can be done in another
5424
+ # field. This type is more flexible than some applications may want. Make sure
5425
+ # to document and validate your application's limitations.
5426
+ # Corresponds to the JSON property `nextSyncTime`
5427
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleTypeDateTime]
5428
+ attr_accessor :next_sync_time
5429
+
5430
+ # Required. Params needed to access the source in the format of (Key, Value)
5431
+ # pairs. Required parameters for all data sources: * Key: `instance_uri` * Value:
5432
+ # type STRING. The uri to access the data source. Required parameters for
5433
+ # sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value:
5434
+ # type STRING. The client id for the third party service provider to identify
5435
+ # your application. * Key: `client_secret` * Value:type STRING. The client
5436
+ # secret generated by the third party authorization server. * Key: `access_token`
5437
+ # * Value: type STRING. OAuth token for UCS to access to the protected resource.
5438
+ # * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to
5439
+ # obtain a new access token without user interaction. Required parameters for
5440
+ # sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `
5441
+ # user_account` * Value: type STRING. The username or email with the source. *
5442
+ # Key: `api_token` * Value: type STRING. The API token generated for the source
5443
+ # account, that is used for authenticating anywhere where you would have used a
5444
+ # password. Example: ```json ` "instance_uri": "https://xxx.atlassian.net", "
5445
+ # user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" ` ``` Optional
5446
+ # parameter to specify the authorization type to use for multiple authorization
5447
+ # types support: * Key: `auth_type` * Value: type STRING. The authorization type
5448
+ # for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `
5449
+ # OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `
5450
+ # OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.
5451
+ # Corresponds to the JSON property `params`
5452
+ # @return [Hash<String,Object>]
5453
+ attr_accessor :params
5454
+
5455
+ # Output only. The tenant project ID associated with private connectivity
5456
+ # connectors. This project must be allowlisted by in order for the connector to
5457
+ # function.
5458
+ # Corresponds to the JSON property `privateConnectivityProjectId`
5459
+ # @return [String]
5460
+ attr_accessor :private_connectivity_project_id
5461
+
5462
+ # Required. The refresh interval for data sync. If duration is set to 0, the
5463
+ # data will be synced in real time. The streaming feature is not supported yet.
5464
+ # The minimum is 30 minutes and maximum is 7 days.
5465
+ # Corresponds to the JSON property `refreshInterval`
5466
+ # @return [String]
5467
+ attr_accessor :refresh_interval
5468
+
5469
+ # Output only. State of the connector.
5470
+ # Corresponds to the JSON property `state`
5471
+ # @return [String]
5472
+ attr_accessor :state
5473
+
5474
+ # Output only. The static IP addresses used by this connector.
5475
+ # Corresponds to the JSON property `staticIpAddresses`
5476
+ # @return [Array<String>]
5477
+ attr_accessor :static_ip_addresses
5478
+
5479
+ # Optional. Whether customer has enabled static IP addresses for this connector.
5480
+ # Corresponds to the JSON property `staticIpEnabled`
5481
+ # @return [Boolean]
5482
+ attr_accessor :static_ip_enabled
5483
+ alias_method :static_ip_enabled?, :static_ip_enabled
5484
+
5485
+ # The data synchronization mode supported by the data connector.
5486
+ # Corresponds to the JSON property `syncMode`
5487
+ # @return [String]
5488
+ attr_accessor :sync_mode
5489
+
5490
+ # Output only. Timestamp the DataConnector was last updated.
5491
+ # Corresponds to the JSON property `updateTime`
5492
+ # @return [String]
5493
+ attr_accessor :update_time
5494
+
5495
+ def initialize(**args)
5496
+ update!(**args)
5497
+ end
5498
+
5499
+ # Update properties of this object
5500
+ def update!(**args)
5501
+ @action_config = args[:action_config] if args.key?(:action_config)
5502
+ @auto_run_disabled = args[:auto_run_disabled] if args.key?(:auto_run_disabled)
5503
+ @blocking_reasons = args[:blocking_reasons] if args.key?(:blocking_reasons)
5504
+ @create_time = args[:create_time] if args.key?(:create_time)
5505
+ @data_source = args[:data_source] if args.key?(:data_source)
5506
+ @destination_configs = args[:destination_configs] if args.key?(:destination_configs)
5507
+ @entities = args[:entities] if args.key?(:entities)
5508
+ @errors = args[:errors] if args.key?(:errors)
5509
+ @identity_refresh_interval = args[:identity_refresh_interval] if args.key?(:identity_refresh_interval)
5510
+ @identity_schedule_config = args[:identity_schedule_config] if args.key?(:identity_schedule_config)
5511
+ @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
5512
+ @last_sync_time = args[:last_sync_time] if args.key?(:last_sync_time)
5513
+ @latest_pause_time = args[:latest_pause_time] if args.key?(:latest_pause_time)
5514
+ @name = args[:name] if args.key?(:name)
5515
+ @next_sync_time = args[:next_sync_time] if args.key?(:next_sync_time)
5516
+ @params = args[:params] if args.key?(:params)
5517
+ @private_connectivity_project_id = args[:private_connectivity_project_id] if args.key?(:private_connectivity_project_id)
5518
+ @refresh_interval = args[:refresh_interval] if args.key?(:refresh_interval)
5519
+ @state = args[:state] if args.key?(:state)
5520
+ @static_ip_addresses = args[:static_ip_addresses] if args.key?(:static_ip_addresses)
5521
+ @static_ip_enabled = args[:static_ip_enabled] if args.key?(:static_ip_enabled)
5522
+ @sync_mode = args[:sync_mode] if args.key?(:sync_mode)
5523
+ @update_time = args[:update_time] if args.key?(:update_time)
5524
+ end
5525
+ end
5526
+
5527
+ # Represents an entity in the data source. For example, the `Account` object in
5528
+ # Salesforce.
5529
+ class GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity
5530
+ include Google::Apis::Core::Hashable
5531
+
5532
+ # Output only. The full resource name of the associated data store for the
5533
+ # source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`.
5534
+ # When the connector is initialized by the DataConnectorService.
5535
+ # SetUpDataConnector method, a DataStore is automatically created for each
5536
+ # source entity.
5537
+ # Corresponds to the JSON property `dataStore`
5538
+ # @return [String]
5539
+ attr_accessor :data_store
5540
+
5541
+ # The name of the entity. Supported values by data source: * Salesforce: `Lead`,
5542
+ # `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `
5543
+ # Issue` * Confluence: `Content`, `Space`
5544
+ # Corresponds to the JSON property `entityName`
5545
+ # @return [String]
5546
+ attr_accessor :entity_name
5547
+
5548
+ # Attributes for indexing. Key: Field name. Value: The key property to map a
5549
+ # field to, such as `title`, and `description`. Supported key properties: * `
5550
+ # title`: The title for data record. This would be displayed on search results. *
5551
+ # `description`: The description for data record. This would be displayed on
5552
+ # search results.
5553
+ # Corresponds to the JSON property `keyPropertyMappings`
5554
+ # @return [Hash<String,String>]
5555
+ attr_accessor :key_property_mappings
5556
+
5557
+ # The parameters for the entity to facilitate data ingestion. E.g. for BQ
5558
+ # connectors: * Key: `document_id_column` * Value: type STRING. The value of the
5559
+ # column id.
5560
+ # Corresponds to the JSON property `params`
5561
+ # @return [Hash<String,Object>]
5562
+ attr_accessor :params
5563
+
5564
+ def initialize(**args)
5565
+ update!(**args)
5566
+ end
5567
+
5568
+ # Update properties of this object
5569
+ def update!(**args)
5570
+ @data_store = args[:data_store] if args.key?(:data_store)
5571
+ @entity_name = args[:entity_name] if args.key?(:entity_name)
5572
+ @key_property_mappings = args[:key_property_mappings] if args.key?(:key_property_mappings)
5573
+ @params = args[:params] if args.key?(:params)
5574
+ end
5575
+ end
5576
+
5577
+ # DataStore captures global settings and configs at the DataStore level.
5578
+ class GoogleCloudDiscoveryengineV1alphaDataStore
5579
+ include Google::Apis::Core::Hashable
5580
+
5581
+ # Immutable. Whether data in the DataStore has ACL information. If set to `true`,
5582
+ # the source data must have ACL. ACL will be ingested when data is ingested by
5583
+ # DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore,
5584
+ # Document can't be accessed by calling DocumentService.GetDocument or
5585
+ # DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC`
5586
+ # industry vertical with non-`PUBLIC_WEBSITE` content config.
5587
+ # Corresponds to the JSON property `aclEnabled`
5588
+ # @return [Boolean]
5589
+ attr_accessor :acl_enabled
5590
+ alias_method :acl_enabled?, :acl_enabled
5591
+
5592
+ # Configuration data for advance site search.
5593
+ # Corresponds to the JSON property `advancedSiteSearchConfig`
5594
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig]
5595
+ attr_accessor :advanced_site_search_config
5596
+
5597
+ # Estimation of data size per data store.
5598
+ # Corresponds to the JSON property `billingEstimation`
5599
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation]
5600
+ attr_accessor :billing_estimation
5601
+
5602
+ # Configurations used to enable CMEK data encryption with Cloud KMS keys.
5603
+ # Corresponds to the JSON property `cmekConfig`
5604
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCmekConfig]
5605
+ attr_accessor :cmek_config
5606
+
5607
+ # Immutable. The content config of the data store. If this field is unset, the
5608
+ # server behavior defaults to ContentConfig.NO_CONTENT.
5609
+ # Corresponds to the JSON property `contentConfig`
5610
+ # @return [String]
5611
+ attr_accessor :content_config
5612
+
5613
+ # Output only. Timestamp the DataStore was created at.
5614
+ # Corresponds to the JSON property `createTime`
5615
+ # @return [String]
5616
+ attr_accessor :create_time
5617
+
5618
+ # Output only. The id of the default Schema asscociated to this data store.
5619
+ # Corresponds to the JSON property `defaultSchemaId`
5620
+ # @return [String]
5621
+ attr_accessor :default_schema_id
5622
+
5623
+ # Required. The data store display name. This field must be a UTF-8 encoded
5624
+ # string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
5625
+ # error is returned.
5626
+ # Corresponds to the JSON property `displayName`
5627
+ # @return [String]
5628
+ attr_accessor :display_name
5629
+
5630
+ # A singleton resource of DataStore. If it's empty when DataStore is created and
5631
+ # DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default
5632
+ # parser will default to digital parser.
5633
+ # Corresponds to the JSON property `documentProcessingConfig`
5634
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig]
5635
+ attr_accessor :document_processing_config
5636
+
5637
+ # Identity Provider Config.
5638
+ # Corresponds to the JSON property `idpConfig`
5639
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaIdpConfig]
5640
+ attr_accessor :idp_config
5641
+
5642
+ # Immutable. The industry vertical that the data store registers.
5643
+ # Corresponds to the JSON property `industryVertical`
5644
+ # @return [String]
5645
+ attr_accessor :industry_vertical
5646
+
5647
+ # Optional. If set, this DataStore is an Infobot FAQ DataStore.
5648
+ # Corresponds to the JSON property `isInfobotFaqDataStore`
5649
+ # @return [Boolean]
5650
+ attr_accessor :is_infobot_faq_data_store
5651
+ alias_method :is_infobot_faq_data_store?, :is_infobot_faq_data_store
5652
+
5653
+ # Input only. The KMS key to be used to protect this DataStore at creation time.
5654
+ # Must be set for requests that need to comply with CMEK Org Policy protections.
5655
+ # If this field is set and processed successfully, the DataStore will be
5656
+ # protected by the KMS key, as indicated in the cmek_config field.
5657
+ # Corresponds to the JSON property `kmsKeyName`
5658
+ # @return [String]
5659
+ attr_accessor :kms_key_name
5660
+
5661
+ # Language info for DataStore.
5662
+ # Corresponds to the JSON property `languageInfo`
5663
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaLanguageInfo]
5664
+ attr_accessor :language_info
5665
+
5666
+ # Immutable. The full resource name of the data store. Format: `projects/`
5069
5667
  # project`/locations/`location`/collections/`collection_id`/dataStores/`
5070
5668
  # data_store_id``. This field must be a UTF-8 encoded string with a length limit
5071
5669
  # of 1024 characters.
@@ -5118,6 +5716,7 @@ module Google
5118
5716
  @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
5119
5717
  @idp_config = args[:idp_config] if args.key?(:idp_config)
5120
5718
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
5719
+ @is_infobot_faq_data_store = args[:is_infobot_faq_data_store] if args.key?(:is_infobot_faq_data_store)
5121
5720
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
5122
5721
  @language_info = args[:language_info] if args.key?(:language_info)
5123
5722
  @name = args[:name] if args.key?(:name)
@@ -5225,6 +5824,34 @@ module Google
5225
5824
  end
5226
5825
  end
5227
5826
 
5827
+ # Metadata related to the progress of the CollectionService.UpdateCollection
5828
+ # operation. This will be returned by the google.longrunning.Operation.metadata
5829
+ # field.
5830
+ class GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata
5831
+ include Google::Apis::Core::Hashable
5832
+
5833
+ # Operation create time.
5834
+ # Corresponds to the JSON property `createTime`
5835
+ # @return [String]
5836
+ attr_accessor :create_time
5837
+
5838
+ # Operation last update time. If the operation is done, this is also the finish
5839
+ # time.
5840
+ # Corresponds to the JSON property `updateTime`
5841
+ # @return [String]
5842
+ attr_accessor :update_time
5843
+
5844
+ def initialize(**args)
5845
+ update!(**args)
5846
+ end
5847
+
5848
+ # Update properties of this object
5849
+ def update!(**args)
5850
+ @create_time = args[:create_time] if args.key?(:create_time)
5851
+ @update_time = args[:update_time] if args.key?(:update_time)
5852
+ end
5853
+ end
5854
+
5228
5855
  # Metadata related to the progress of the DataStoreService.DeleteDataStore
5229
5856
  # operation. This will be returned by the google.longrunning.Operation.metadata
5230
5857
  # field.
@@ -5280,6 +5907,34 @@ module Google
5280
5907
  end
5281
5908
  end
5282
5909
 
5910
+ # Metadata related to the progress of the IdentityMappingStoreService.
5911
+ # DeleteIdentityMappingStore operation. This will be returned by the google.
5912
+ # longrunning.Operation.metadata field.
5913
+ class GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata
5914
+ include Google::Apis::Core::Hashable
5915
+
5916
+ # Operation create time.
5917
+ # Corresponds to the JSON property `createTime`
5918
+ # @return [String]
5919
+ attr_accessor :create_time
5920
+
5921
+ # Operation last update time. If the operation is done, this is also the finish
5922
+ # time.
5923
+ # Corresponds to the JSON property `updateTime`
5924
+ # @return [String]
5925
+ attr_accessor :update_time
5926
+
5927
+ def initialize(**args)
5928
+ update!(**args)
5929
+ end
5930
+
5931
+ # Update properties of this object
5932
+ def update!(**args)
5933
+ @create_time = args[:create_time] if args.key?(:create_time)
5934
+ @update_time = args[:update_time] if args.key?(:update_time)
5935
+ end
5936
+ end
5937
+
5283
5938
  # Metadata for DeleteSchema LRO.
5284
5939
  class GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata
5285
5940
  include Google::Apis::Core::Hashable
@@ -5383,6 +6038,62 @@ module Google
5383
6038
  end
5384
6039
  end
5385
6040
 
6041
+ # Defines target endpoints used to connect to third-party sources.
6042
+ class GoogleCloudDiscoveryengineV1alphaDestinationConfig
6043
+ include Google::Apis::Core::Hashable
6044
+
6045
+ # Optional. The destinations for the corresponding key.
6046
+ # Corresponds to the JSON property `destinations`
6047
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination>]
6048
+ attr_accessor :destinations
6049
+
6050
+ # Optional. Unique destination identifier that is supported by the connector.
6051
+ # Corresponds to the JSON property `key`
6052
+ # @return [String]
6053
+ attr_accessor :key
6054
+
6055
+ # Optional. Additional parameters for this destination config.
6056
+ # Corresponds to the JSON property `params`
6057
+ # @return [Hash<String,Object>]
6058
+ attr_accessor :params
6059
+
6060
+ def initialize(**args)
6061
+ update!(**args)
6062
+ end
6063
+
6064
+ # Update properties of this object
6065
+ def update!(**args)
6066
+ @destinations = args[:destinations] if args.key?(:destinations)
6067
+ @key = args[:key] if args.key?(:key)
6068
+ @params = args[:params] if args.key?(:params)
6069
+ end
6070
+ end
6071
+
6072
+ # Defines a target endpoint
6073
+ class GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination
6074
+ include Google::Apis::Core::Hashable
6075
+
6076
+ # Publicly routable host.
6077
+ # Corresponds to the JSON property `host`
6078
+ # @return [String]
6079
+ attr_accessor :host
6080
+
6081
+ # Optional. Target port number accepted by the destination.
6082
+ # Corresponds to the JSON property `port`
6083
+ # @return [Fixnum]
6084
+ attr_accessor :port
6085
+
6086
+ def initialize(**args)
6087
+ update!(**args)
6088
+ end
6089
+
6090
+ # Update properties of this object
6091
+ def update!(**args)
6092
+ @host = args[:host] if args.key?(:host)
6093
+ @port = args[:port] if args.key?(:port)
6094
+ end
6095
+ end
6096
+
5386
6097
  # Metadata related to the progress of the SiteSearchEngineService.
5387
6098
  # DisableAdvancedSiteSearch operation. This will be returned by the google.
5388
6099
  # longrunning.Operation.metadata field.
@@ -6445,19 +7156,35 @@ module Google
6445
7156
  end
6446
7157
  end
6447
7158
 
6448
- # Identity Provider Config.
6449
- class GoogleCloudDiscoveryengineV1alphaIdpConfig
7159
+ # The configuration for the identity data synchronization runs.
7160
+ class GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig
6450
7161
  include Google::Apis::Core::Hashable
6451
7162
 
6452
- # Third party IDP Config.
6453
- # Corresponds to the JSON property `externalIdpConfig`
6454
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig]
6455
- attr_accessor :external_idp_config
7163
+ # Represents civil time (or occasionally physical time). This type can represent
7164
+ # a civil time in one of a few possible ways: * When utc_offset is set and
7165
+ # time_zone is unset: a civil time on a calendar day with a particular offset
7166
+ # from UTC. * When time_zone is set and utc_offset is unset: a civil time on a
7167
+ # calendar day in a particular time zone. * When neither time_zone nor
7168
+ # utc_offset is set: a civil time on a calendar day in local time. The date is
7169
+ # relative to the Proleptic Gregorian Calendar. If year, month, or day are 0,
7170
+ # the DateTime is considered not to have a specific year, month, or day
7171
+ # respectively. This type may also be used to represent a physical time if all
7172
+ # the date and time fields are set and either case of the `time_offset` oneof is
7173
+ # set. Consider using `Timestamp` message for physical time instead. If your use
7174
+ # case also would like to store the user's timezone, that can be done in another
7175
+ # field. This type is more flexible than some applications may want. Make sure
7176
+ # to document and validate your application's limitations.
7177
+ # Corresponds to the JSON property `nextSyncTime`
7178
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleTypeDateTime]
7179
+ attr_accessor :next_sync_time
6456
7180
 
6457
- # Identity provider type configured.
6458
- # Corresponds to the JSON property `idpType`
7181
+ # Optional. The refresh interval to sync the Access Control List information for
7182
+ # the documents ingested by this connector. If not set, the access control list
7183
+ # will be refreshed at the default interval of 30 minutes. The identity refresh
7184
+ # interval can be at least 30 minutes and at most 7 days.
7185
+ # Corresponds to the JSON property `refreshInterval`
6459
7186
  # @return [String]
6460
- attr_accessor :idp_type
7187
+ attr_accessor :refresh_interval
6461
7188
 
6462
7189
  def initialize(**args)
6463
7190
  update!(**args)
@@ -6465,13 +7192,38 @@ module Google
6465
7192
 
6466
7193
  # Update properties of this object
6467
7194
  def update!(**args)
6468
- @external_idp_config = args[:external_idp_config] if args.key?(:external_idp_config)
6469
- @idp_type = args[:idp_type] if args.key?(:idp_type)
7195
+ @next_sync_time = args[:next_sync_time] if args.key?(:next_sync_time)
7196
+ @refresh_interval = args[:refresh_interval] if args.key?(:refresh_interval)
6470
7197
  end
6471
7198
  end
6472
7199
 
6473
- # Third party IDP Config.
6474
- class GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig
7200
+ # Identity Provider Config.
7201
+ class GoogleCloudDiscoveryengineV1alphaIdpConfig
7202
+ include Google::Apis::Core::Hashable
7203
+
7204
+ # Third party IDP Config.
7205
+ # Corresponds to the JSON property `externalIdpConfig`
7206
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig]
7207
+ attr_accessor :external_idp_config
7208
+
7209
+ # Identity provider type configured.
7210
+ # Corresponds to the JSON property `idpType`
7211
+ # @return [String]
7212
+ attr_accessor :idp_type
7213
+
7214
+ def initialize(**args)
7215
+ update!(**args)
7216
+ end
7217
+
7218
+ # Update properties of this object
7219
+ def update!(**args)
7220
+ @external_idp_config = args[:external_idp_config] if args.key?(:external_idp_config)
7221
+ @idp_type = args[:idp_type] if args.key?(:idp_type)
7222
+ end
7223
+ end
7224
+
7225
+ # Third party IDP Config.
7226
+ class GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig
6475
7227
  include Google::Apis::Core::Hashable
6476
7228
 
6477
7229
  # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
@@ -7709,6 +8461,117 @@ module Google
7709
8461
  end
7710
8462
  end
7711
8463
 
8464
+ # Metadata related to the progress of the CrawlRateManagementService.
8465
+ # RemoveDedicatedCrawlRate operation. This will be returned by the google.
8466
+ # longrunning.Operation.metadata field.
8467
+ class GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata
8468
+ include Google::Apis::Core::Hashable
8469
+
8470
+ # Operation create time.
8471
+ # Corresponds to the JSON property `createTime`
8472
+ # @return [String]
8473
+ attr_accessor :create_time
8474
+
8475
+ # Operation last update time. If the operation is done, this is also the finish
8476
+ # time.
8477
+ # Corresponds to the JSON property `updateTime`
8478
+ # @return [String]
8479
+ attr_accessor :update_time
8480
+
8481
+ def initialize(**args)
8482
+ update!(**args)
8483
+ end
8484
+
8485
+ # Update properties of this object
8486
+ def update!(**args)
8487
+ @create_time = args[:create_time] if args.key?(:create_time)
8488
+ @update_time = args[:update_time] if args.key?(:update_time)
8489
+ end
8490
+ end
8491
+
8492
+ # Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate
8493
+ # method. It simply returns the state of the response, and an error message if
8494
+ # the state is FAILED.
8495
+ class GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse
8496
+ include Google::Apis::Core::Hashable
8497
+
8498
+ # The `Status` type defines a logical error model that is suitable for different
8499
+ # programming environments, including REST APIs and RPC APIs. It is used by [
8500
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
8501
+ # data: error code, error message, and error details. You can find out more
8502
+ # about this error model and how to work with it in the [API Design Guide](https:
8503
+ # //cloud.google.com/apis/design/errors).
8504
+ # Corresponds to the JSON property `error`
8505
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus]
8506
+ attr_accessor :error
8507
+
8508
+ # Output only. The state of the response.
8509
+ # Corresponds to the JSON property `state`
8510
+ # @return [String]
8511
+ attr_accessor :state
8512
+
8513
+ def initialize(**args)
8514
+ update!(**args)
8515
+ end
8516
+
8517
+ # Update properties of this object
8518
+ def update!(**args)
8519
+ @error = args[:error] if args.key?(:error)
8520
+ @state = args[:state] if args.key?(:state)
8521
+ end
8522
+ end
8523
+
8524
+ # Safety rating corresponding to the generated content.
8525
+ class GoogleCloudDiscoveryengineV1alphaSafetyRating
8526
+ include Google::Apis::Core::Hashable
8527
+
8528
+ # Output only. Indicates whether the content was filtered out because of this
8529
+ # rating.
8530
+ # Corresponds to the JSON property `blocked`
8531
+ # @return [Boolean]
8532
+ attr_accessor :blocked
8533
+ alias_method :blocked?, :blocked
8534
+
8535
+ # Output only. Harm category.
8536
+ # Corresponds to the JSON property `category`
8537
+ # @return [String]
8538
+ attr_accessor :category
8539
+
8540
+ # Output only. Harm probability levels in the content.
8541
+ # Corresponds to the JSON property `probability`
8542
+ # @return [String]
8543
+ attr_accessor :probability
8544
+
8545
+ # Output only. Harm probability score.
8546
+ # Corresponds to the JSON property `probabilityScore`
8547
+ # @return [Float]
8548
+ attr_accessor :probability_score
8549
+
8550
+ # Output only. Harm severity levels in the content.
8551
+ # Corresponds to the JSON property `severity`
8552
+ # @return [String]
8553
+ attr_accessor :severity
8554
+
8555
+ # Output only. Harm severity score.
8556
+ # Corresponds to the JSON property `severityScore`
8557
+ # @return [Float]
8558
+ attr_accessor :severity_score
8559
+
8560
+ def initialize(**args)
8561
+ update!(**args)
8562
+ end
8563
+
8564
+ # Update properties of this object
8565
+ def update!(**args)
8566
+ @blocked = args[:blocked] if args.key?(:blocked)
8567
+ @category = args[:category] if args.key?(:category)
8568
+ @probability = args[:probability] if args.key?(:probability)
8569
+ @probability_score = args[:probability_score] if args.key?(:probability_score)
8570
+ @severity = args[:severity] if args.key?(:severity)
8571
+ @severity_score = args[:severity_score] if args.key?(:severity_score)
8572
+ end
8573
+ end
8574
+
7712
8575
  # Defines the structure and layout of a type of document data.
7713
8576
  class GoogleCloudDiscoveryengineV1alphaSchema
7714
8577
  include Google::Apis::Core::Hashable
@@ -8862,8 +9725,8 @@ module Google
8862
9725
  class GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec
8863
9726
  include Google::Apis::Core::Hashable
8864
9727
 
8865
- # The condition under which filter extraction should occur. Default to Condition.
8866
- # DISABLED.
9728
+ # The condition under which filter extraction should occur. Server behavior
9729
+ # defaults to `DISABLED`.
8867
9730
  # Corresponds to the JSON property `filterExtractionCondition`
8868
9731
  # @return [String]
8869
9732
  attr_accessor :filter_extraction_condition
@@ -9114,6 +9977,79 @@ module Google
9114
9977
  end
9115
9978
  end
9116
9979
 
9980
+ # Metadata related to the progress of the CrawlRateManagementService.
9981
+ # SetDedicatedCrawlRate operation. This will be returned by the google.
9982
+ # longrunning.Operation.metadata field.
9983
+ class GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata
9984
+ include Google::Apis::Core::Hashable
9985
+
9986
+ # Operation create time.
9987
+ # Corresponds to the JSON property `createTime`
9988
+ # @return [String]
9989
+ attr_accessor :create_time
9990
+
9991
+ # Operation last update time. If the operation is done, this is also the finish
9992
+ # time.
9993
+ # Corresponds to the JSON property `updateTime`
9994
+ # @return [String]
9995
+ attr_accessor :update_time
9996
+
9997
+ def initialize(**args)
9998
+ update!(**args)
9999
+ end
10000
+
10001
+ # Update properties of this object
10002
+ def update!(**args)
10003
+ @create_time = args[:create_time] if args.key?(:create_time)
10004
+ @update_time = args[:update_time] if args.key?(:update_time)
10005
+ end
10006
+ end
10007
+
10008
+ # Response message for CrawlRateManagementService.SetDedicatedCrawlRate method.
10009
+ # It simply returns the state of the response, and an error message if the state
10010
+ # is FAILED.
10011
+ class GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse
10012
+ include Google::Apis::Core::Hashable
10013
+
10014
+ # The `Status` type defines a logical error model that is suitable for different
10015
+ # programming environments, including REST APIs and RPC APIs. It is used by [
10016
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
10017
+ # data: error code, error message, and error details. You can find out more
10018
+ # about this error model and how to work with it in the [API Design Guide](https:
10019
+ # //cloud.google.com/apis/design/errors).
10020
+ # Corresponds to the JSON property `error`
10021
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus]
10022
+ attr_accessor :error
10023
+
10024
+ # Output only. The state of the response.
10025
+ # Corresponds to the JSON property `state`
10026
+ # @return [String]
10027
+ attr_accessor :state
10028
+
10029
+ def initialize(**args)
10030
+ update!(**args)
10031
+ end
10032
+
10033
+ # Update properties of this object
10034
+ def update!(**args)
10035
+ @error = args[:error] if args.key?(:error)
10036
+ @state = args[:state] if args.key?(:state)
10037
+ end
10038
+ end
10039
+
10040
+ # Metadata for DataConnectorService.SetUpDataConnector method.
10041
+ class GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata
10042
+ include Google::Apis::Core::Hashable
10043
+
10044
+ def initialize(**args)
10045
+ update!(**args)
10046
+ end
10047
+
10048
+ # Update properties of this object
10049
+ def update!(**args)
10050
+ end
10051
+ end
10052
+
9117
10053
  # Metadata related to the progress of the SiteSearchEngineService.
9118
10054
  # SetUriPatternDocumentData operation. This will be returned by the google.
9119
10055
  # longrunning.Operation.metadata field.
@@ -9155,6 +10091,27 @@ module Google
9155
10091
  end
9156
10092
  end
9157
10093
 
10094
+ # Metadata for single-regional CMEKs.
10095
+ class GoogleCloudDiscoveryengineV1alphaSingleRegionKey
10096
+ include Google::Apis::Core::Hashable
10097
+
10098
+ # Required. Single-regional kms key resource name which will be used to encrypt
10099
+ # resources `projects/`project`/locations/`location`/keyRings/`keyRing`/
10100
+ # cryptoKeys/`keyId``.
10101
+ # Corresponds to the JSON property `kmsKey`
10102
+ # @return [String]
10103
+ attr_accessor :kms_key
10104
+
10105
+ def initialize(**args)
10106
+ update!(**args)
10107
+ end
10108
+
10109
+ # Update properties of this object
10110
+ def update!(**args)
10111
+ @kms_key = args[:kms_key] if args.key?(:kms_key)
10112
+ end
10113
+ end
10114
+
9158
10115
  # Verification information for target sites in advanced site search.
9159
10116
  class GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo
9160
10117
  include Google::Apis::Core::Hashable
@@ -9217,7 +10174,7 @@ module Google
9217
10174
  class GoogleCloudDiscoveryengineV1alphaTargetSite
9218
10175
  include Google::Apis::Core::Hashable
9219
10176
 
9220
- # Input only. If set to false, a uri_pattern is generated to include all pages
10177
+ # Immutable. If set to false, a uri_pattern is generated to include all pages
9221
10178
  # whose address contains the provided_uri_pattern. If set to true, an
9222
10179
  # uri_pattern is generated to try to be an exact match of the
9223
10180
  # provided_uri_pattern or just the specific page if the provided_uri_pattern is
@@ -9474,6 +10431,34 @@ module Google
9474
10431
  end
9475
10432
  end
9476
10433
 
10434
+ # Metadata related to the progress of the CollectionService.UpdateCollection
10435
+ # operation. This will be returned by the google.longrunning.Operation.metadata
10436
+ # field.
10437
+ class GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata
10438
+ include Google::Apis::Core::Hashable
10439
+
10440
+ # Operation create time.
10441
+ # Corresponds to the JSON property `createTime`
10442
+ # @return [String]
10443
+ attr_accessor :create_time
10444
+
10445
+ # Operation last update time. If the operation is done, this is also the finish
10446
+ # time.
10447
+ # Corresponds to the JSON property `updateTime`
10448
+ # @return [String]
10449
+ attr_accessor :update_time
10450
+
10451
+ def initialize(**args)
10452
+ update!(**args)
10453
+ end
10454
+
10455
+ # Update properties of this object
10456
+ def update!(**args)
10457
+ @create_time = args[:create_time] if args.key?(:create_time)
10458
+ @update_time = args[:update_time] if args.key?(:update_time)
10459
+ end
10460
+ end
10461
+
9477
10462
  # Metadata for UpdateSchema LRO.
9478
10463
  class GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata
9479
10464
  include Google::Apis::Core::Hashable
@@ -9953,12 +10938,26 @@ module Google
9953
10938
  class GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig
9954
10939
  include Google::Apis::Core::Hashable
9955
10940
 
10941
+ # If set true, automatic refresh is disabled for the DataStore.
10942
+ # Corresponds to the JSON property `disableAutomaticRefresh`
10943
+ # @return [Boolean]
10944
+ attr_accessor :disable_automatic_refresh
10945
+ alias_method :disable_automatic_refresh?, :disable_automatic_refresh
10946
+
10947
+ # If set true, initial indexing is disabled for the DataStore.
10948
+ # Corresponds to the JSON property `disableInitialIndex`
10949
+ # @return [Boolean]
10950
+ attr_accessor :disable_initial_index
10951
+ alias_method :disable_initial_index?, :disable_initial_index
10952
+
9956
10953
  def initialize(**args)
9957
10954
  update!(**args)
9958
10955
  end
9959
10956
 
9960
10957
  # Update properties of this object
9961
10958
  def update!(**args)
10959
+ @disable_automatic_refresh = args[:disable_automatic_refresh] if args.key?(:disable_automatic_refresh)
10960
+ @disable_initial_index = args[:disable_initial_index] if args.key?(:disable_initial_index)
9962
10961
  end
9963
10962
  end
9964
10963
 
@@ -10082,6 +11081,11 @@ module Google
10082
11081
  # @return [Array<String>]
10083
11082
  attr_accessor :related_questions
10084
11083
 
11084
+ # Optional. Safety ratings.
11085
+ # Corresponds to the JSON property `safetyRatings`
11086
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSafetyRating>]
11087
+ attr_accessor :safety_ratings
11088
+
10085
11089
  # The state of the answer generation.
10086
11090
  # Corresponds to the JSON property `state`
10087
11091
  # @return [String]
@@ -10109,6 +11113,7 @@ module Google
10109
11113
  @query_understanding_info = args[:query_understanding_info] if args.key?(:query_understanding_info)
10110
11114
  @references = args[:references] if args.key?(:references)
10111
11115
  @related_questions = args[:related_questions] if args.key?(:related_questions)
11116
+ @safety_ratings = args[:safety_ratings] if args.key?(:safety_ratings)
10112
11117
  @state = args[:state] if args.key?(:state)
10113
11118
  @steps = args[:steps] if args.key?(:steps)
10114
11119
  end
@@ -10608,6 +11613,12 @@ module Google
10608
11613
  attr_accessor :enable
10609
11614
  alias_method :enable?, :enable
10610
11615
 
11616
+ # Optional. Safety settings. This settings are effective only when the
11617
+ # safety_spec.enable is true.
11618
+ # Corresponds to the JSON property `safetySettings`
11619
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpecSafetySetting>]
11620
+ attr_accessor :safety_settings
11621
+
10611
11622
  def initialize(**args)
10612
11623
  update!(**args)
10613
11624
  end
@@ -10615,6 +11626,32 @@ module Google
10615
11626
  # Update properties of this object
10616
11627
  def update!(**args)
10617
11628
  @enable = args[:enable] if args.key?(:enable)
11629
+ @safety_settings = args[:safety_settings] if args.key?(:safety_settings)
11630
+ end
11631
+ end
11632
+
11633
+ # Safety settings.
11634
+ class GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpecSafetySetting
11635
+ include Google::Apis::Core::Hashable
11636
+
11637
+ # Required. Harm category.
11638
+ # Corresponds to the JSON property `category`
11639
+ # @return [String]
11640
+ attr_accessor :category
11641
+
11642
+ # Required. The harm block threshold.
11643
+ # Corresponds to the JSON property `threshold`
11644
+ # @return [String]
11645
+ attr_accessor :threshold
11646
+
11647
+ def initialize(**args)
11648
+ update!(**args)
11649
+ end
11650
+
11651
+ # Update properties of this object
11652
+ def update!(**args)
11653
+ @category = args[:category] if args.key?(:category)
11654
+ @threshold = args[:threshold] if args.key?(:threshold)
10618
11655
  end
10619
11656
  end
10620
11657
 
@@ -12283,6 +13320,11 @@ module Google
12283
13320
  # @return [String]
12284
13321
  attr_accessor :name
12285
13322
 
13323
+ # Optional. Single-regional CMEKs that are required for some VAIS features.
13324
+ # Corresponds to the JSON property `singleRegionKeys`
13325
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSingleRegionKey>]
13326
+ attr_accessor :single_region_keys
13327
+
12286
13328
  # Output only. State of the CmekConfig.
12287
13329
  # Corresponds to the JSON property `state`
12288
13330
  # @return [String]
@@ -12299,6 +13341,7 @@ module Google
12299
13341
  @kms_key_version = args[:kms_key_version] if args.key?(:kms_key_version)
12300
13342
  @last_rotation_timestamp_micros = args[:last_rotation_timestamp_micros] if args.key?(:last_rotation_timestamp_micros)
12301
13343
  @name = args[:name] if args.key?(:name)
13344
+ @single_region_keys = args[:single_region_keys] if args.key?(:single_region_keys)
12302
13345
  @state = args[:state] if args.key?(:state)
12303
13346
  end
12304
13347
  end
@@ -12631,8 +13674,8 @@ module Google
12631
13674
  class GoogleCloudDiscoveryengineV1betaControlBoostAction
12632
13675
  include Google::Apis::Core::Hashable
12633
13676
 
12634
- # Required. Strength of the boost, which should be in [-1, 1]. Negative boost
12635
- # means demotion. Default is 0.0 (No-op).
13677
+ # Strength of the boost, which should be in [-1, 1]. Negative boost means
13678
+ # demotion. Default is 0.0 (No-op).
12636
13679
  # Corresponds to the JSON property `boost`
12637
13680
  # @return [Float]
12638
13681
  attr_accessor :boost
@@ -12652,6 +13695,12 @@ module Google
12652
13695
  # @return [String]
12653
13696
  attr_accessor :filter
12654
13697
 
13698
+ # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost
13699
+ # means demotion. Default is 0.0 (No-op).
13700
+ # Corresponds to the JSON property `fixedBoost`
13701
+ # @return [Float]
13702
+ attr_accessor :fixed_boost
13703
+
12655
13704
  def initialize(**args)
12656
13705
  update!(**args)
12657
13706
  end
@@ -12661,6 +13710,7 @@ module Google
12661
13710
  @boost = args[:boost] if args.key?(:boost)
12662
13711
  @data_store = args[:data_store] if args.key?(:data_store)
12663
13712
  @filter = args[:filter] if args.key?(:filter)
13713
+ @fixed_boost = args[:fixed_boost] if args.key?(:fixed_boost)
12664
13714
  end
12665
13715
  end
12666
13716
 
@@ -13325,6 +14375,12 @@ module Google
13325
14375
  # @return [String]
13326
14376
  attr_accessor :industry_vertical
13327
14377
 
14378
+ # Optional. If set, this DataStore is an Infobot FAQ DataStore.
14379
+ # Corresponds to the JSON property `isInfobotFaqDataStore`
14380
+ # @return [Boolean]
14381
+ attr_accessor :is_infobot_faq_data_store
14382
+ alias_method :is_infobot_faq_data_store?, :is_infobot_faq_data_store
14383
+
13328
14384
  # Input only. The KMS key to be used to protect this DataStore at creation time.
13329
14385
  # Must be set for requests that need to comply with CMEK Org Policy protections.
13330
14386
  # If this field is set and processed successfully, the DataStore will be
@@ -13389,6 +14445,7 @@ module Google
13389
14445
  @display_name = args[:display_name] if args.key?(:display_name)
13390
14446
  @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
13391
14447
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
14448
+ @is_infobot_faq_data_store = args[:is_infobot_faq_data_store] if args.key?(:is_infobot_faq_data_store)
13392
14449
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
13393
14450
  @language_info = args[:language_info] if args.key?(:language_info)
13394
14451
  @name = args[:name] if args.key?(:name)
@@ -13524,8 +14581,10 @@ module Google
13524
14581
  end
13525
14582
  end
13526
14583
 
13527
- # Metadata for DeleteSchema LRO.
13528
- class GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata
14584
+ # Metadata related to the progress of the IdentityMappingStoreService.
14585
+ # DeleteIdentityMappingStore operation. This will be returned by the google.
14586
+ # longrunning.Operation.metadata field.
14587
+ class GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata
13529
14588
  include Google::Apis::Core::Hashable
13530
14589
 
13531
14590
  # Operation create time.
@@ -13550,10 +14609,36 @@ module Google
13550
14609
  end
13551
14610
  end
13552
14611
 
13553
- # Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap
13554
- # operation. This will be returned by the google.longrunning.Operation.metadata
13555
- # field.
13556
- class GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata
14612
+ # Metadata for DeleteSchema LRO.
14613
+ class GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata
14614
+ include Google::Apis::Core::Hashable
14615
+
14616
+ # Operation create time.
14617
+ # Corresponds to the JSON property `createTime`
14618
+ # @return [String]
14619
+ attr_accessor :create_time
14620
+
14621
+ # Operation last update time. If the operation is done, this is also the finish
14622
+ # time.
14623
+ # Corresponds to the JSON property `updateTime`
14624
+ # @return [String]
14625
+ attr_accessor :update_time
14626
+
14627
+ def initialize(**args)
14628
+ update!(**args)
14629
+ end
14630
+
14631
+ # Update properties of this object
14632
+ def update!(**args)
14633
+ @create_time = args[:create_time] if args.key?(:create_time)
14634
+ @update_time = args[:update_time] if args.key?(:update_time)
14635
+ end
14636
+ end
14637
+
14638
+ # Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap
14639
+ # operation. This will be returned by the google.longrunning.Operation.metadata
14640
+ # field.
14641
+ class GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata
13557
14642
  include Google::Apis::Core::Hashable
13558
14643
 
13559
14644
  # Operation create time.
@@ -13677,7 +14762,7 @@ module Google
13677
14762
  attr_accessor :derived_struct_data
13678
14763
 
13679
14764
  # Immutable. The identifier of the document. Id should conform to [RFC-1034](
13680
- # https://tools.ietf.org/html/rfc1034) standard with a length limit of 63
14765
+ # https://tools.ietf.org/html/rfc1034) standard with a length limit of 128
13681
14766
  # characters.
13682
14767
  # Corresponds to the JSON property `id`
13683
14768
  # @return [String]
@@ -13806,6 +14891,12 @@ module Google
13806
14891
  # @return [String]
13807
14892
  attr_accessor :index_time
13808
14893
 
14894
+ # Immutable. The message indicates the document index is in progress. If this
14895
+ # field is populated, the document index is pending.
14896
+ # Corresponds to the JSON property `pendingMessage`
14897
+ # @return [String]
14898
+ attr_accessor :pending_message
14899
+
13809
14900
  def initialize(**args)
13810
14901
  update!(**args)
13811
14902
  end
@@ -13814,6 +14905,7 @@ module Google
13814
14905
  def update!(**args)
13815
14906
  @error_samples = args[:error_samples] if args.key?(:error_samples)
13816
14907
  @index_time = args[:index_time] if args.key?(:index_time)
14908
+ @pending_message = args[:pending_message] if args.key?(:pending_message)
13817
14909
  end
13818
14910
  end
13819
14911
 
@@ -14573,11 +15665,591 @@ module Google
14573
15665
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTargetSite>]
14574
15666
  attr_accessor :target_sites
14575
15667
 
14576
- # The total number of items matching the request. This will always be populated
14577
- # in the response.
14578
- # Corresponds to the JSON property `totalSize`
14579
- # @return [Fixnum]
14580
- attr_accessor :total_size
15668
+ # The total number of items matching the request. This will always be populated
15669
+ # in the response.
15670
+ # Corresponds to the JSON property `totalSize`
15671
+ # @return [Fixnum]
15672
+ attr_accessor :total_size
15673
+
15674
+ def initialize(**args)
15675
+ update!(**args)
15676
+ end
15677
+
15678
+ # Update properties of this object
15679
+ def update!(**args)
15680
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
15681
+ @target_sites = args[:target_sites] if args.key?(:target_sites)
15682
+ @total_size = args[:total_size] if args.key?(:total_size)
15683
+ end
15684
+ end
15685
+
15686
+ # Response message for SiteSearchEngineService.FetchSitemaps method.
15687
+ class GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse
15688
+ include Google::Apis::Core::Hashable
15689
+
15690
+ # List of Sitemaps fetched.
15691
+ # Corresponds to the JSON property `sitemapsMetadata`
15692
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata>]
15693
+ attr_accessor :sitemaps_metadata
15694
+
15695
+ def initialize(**args)
15696
+ update!(**args)
15697
+ end
15698
+
15699
+ # Update properties of this object
15700
+ def update!(**args)
15701
+ @sitemaps_metadata = args[:sitemaps_metadata] if args.key?(:sitemaps_metadata)
15702
+ end
15703
+ end
15704
+
15705
+ # Contains a Sitemap and its metadata.
15706
+ class GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata
15707
+ include Google::Apis::Core::Hashable
15708
+
15709
+ # A sitemap for the SiteSearchEngine.
15710
+ # Corresponds to the JSON property `sitemap`
15711
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSitemap]
15712
+ attr_accessor :sitemap
15713
+
15714
+ def initialize(**args)
15715
+ update!(**args)
15716
+ end
15717
+
15718
+ # Update properties of this object
15719
+ def update!(**args)
15720
+ @sitemap = args[:sitemap] if args.key?(:sitemap)
15721
+ end
15722
+ end
15723
+
15724
+ # Cloud FhirStore source import data from.
15725
+ class GoogleCloudDiscoveryengineV1betaFhirStoreSource
15726
+ include Google::Apis::Core::Hashable
15727
+
15728
+ # Required. The full resource name of the FHIR store to import data from, in the
15729
+ # format of `projects/`project`/locations/`location`/datasets/`dataset`/
15730
+ # fhirStores/`fhir_store``.
15731
+ # Corresponds to the JSON property `fhirStore`
15732
+ # @return [String]
15733
+ attr_accessor :fhir_store
15734
+
15735
+ # Intermediate Cloud Storage directory used for the import with a length limit
15736
+ # of 2,000 characters. Can be specified if one wants to have the FhirStore
15737
+ # export to a specific Cloud Storage directory.
15738
+ # Corresponds to the JSON property `gcsStagingDir`
15739
+ # @return [String]
15740
+ attr_accessor :gcs_staging_dir
15741
+
15742
+ # The FHIR resource types to import. The resource types should be a subset of
15743
+ # all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-
15744
+ # builder/docs/fhir-schema-reference#resource-level-specification). Default to
15745
+ # all supported FHIR resource types if empty.
15746
+ # Corresponds to the JSON property `resourceTypes`
15747
+ # @return [Array<String>]
15748
+ attr_accessor :resource_types
15749
+
15750
+ # Optional. Whether to update the DataStore schema to the latest predefined
15751
+ # schema. If true, the DataStore schema will be updated to include any FHIR
15752
+ # fields or resource types that have been added since the last import and
15753
+ # corresponding FHIR resources will be imported from the FHIR store. Note this
15754
+ # field cannot be used in conjunction with `resource_types`. It should be used
15755
+ # after initial import.
15756
+ # Corresponds to the JSON property `updateFromLatestPredefinedSchema`
15757
+ # @return [Boolean]
15758
+ attr_accessor :update_from_latest_predefined_schema
15759
+ alias_method :update_from_latest_predefined_schema?, :update_from_latest_predefined_schema
15760
+
15761
+ def initialize(**args)
15762
+ update!(**args)
15763
+ end
15764
+
15765
+ # Update properties of this object
15766
+ def update!(**args)
15767
+ @fhir_store = args[:fhir_store] if args.key?(:fhir_store)
15768
+ @gcs_staging_dir = args[:gcs_staging_dir] if args.key?(:gcs_staging_dir)
15769
+ @resource_types = args[:resource_types] if args.key?(:resource_types)
15770
+ @update_from_latest_predefined_schema = args[:update_from_latest_predefined_schema] if args.key?(:update_from_latest_predefined_schema)
15771
+ end
15772
+ end
15773
+
15774
+ # Firestore source import data from.
15775
+ class GoogleCloudDiscoveryengineV1betaFirestoreSource
15776
+ include Google::Apis::Core::Hashable
15777
+
15778
+ # Required. The Firestore collection (or entity) to copy the data from with a
15779
+ # length limit of 1,500 characters.
15780
+ # Corresponds to the JSON property `collectionId`
15781
+ # @return [String]
15782
+ attr_accessor :collection_id
15783
+
15784
+ # Required. The Firestore database to copy the data from with a length limit of
15785
+ # 256 characters.
15786
+ # Corresponds to the JSON property `databaseId`
15787
+ # @return [String]
15788
+ attr_accessor :database_id
15789
+
15790
+ # Intermediate Cloud Storage directory used for the import with a length limit
15791
+ # of 2,000 characters. Can be specified if one wants to have the Firestore
15792
+ # export to a specific Cloud Storage directory. Ensure that the Firestore
15793
+ # service account has the necessary Cloud Storage Admin permissions to access
15794
+ # the specified Cloud Storage directory.
15795
+ # Corresponds to the JSON property `gcsStagingDir`
15796
+ # @return [String]
15797
+ attr_accessor :gcs_staging_dir
15798
+
15799
+ # The project ID that the Cloud SQL source is in with a length limit of 128
15800
+ # characters. If not specified, inherits the project ID from the parent request.
15801
+ # Corresponds to the JSON property `projectId`
15802
+ # @return [String]
15803
+ attr_accessor :project_id
15804
+
15805
+ def initialize(**args)
15806
+ update!(**args)
15807
+ end
15808
+
15809
+ # Update properties of this object
15810
+ def update!(**args)
15811
+ @collection_id = args[:collection_id] if args.key?(:collection_id)
15812
+ @database_id = args[:database_id] if args.key?(:database_id)
15813
+ @gcs_staging_dir = args[:gcs_staging_dir] if args.key?(:gcs_staging_dir)
15814
+ @project_id = args[:project_id] if args.key?(:project_id)
15815
+ end
15816
+ end
15817
+
15818
+ # Cloud Storage location for input content.
15819
+ class GoogleCloudDiscoveryengineV1betaGcsSource
15820
+ include Google::Apis::Core::Hashable
15821
+
15822
+ # The schema to use when parsing the data from the source. Supported values for
15823
+ # document imports: * `document` (default): One JSON Document per line. Each
15824
+ # document must have a valid Document.id. * `content`: Unstructured data (e.g.
15825
+ # PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID
15826
+ # set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`:
15827
+ # One custom data JSON per row in arbitrary format that conforms to the defined
15828
+ # Schema of the data store. This can only be used by the GENERIC Data Store
15829
+ # vertical. * `csv`: A CSV file with header conforming to the defined Schema of
15830
+ # the data store. Each entry after the header is imported as a Document. This
15831
+ # can only be used by the GENERIC Data Store vertical. Supported values for user
15832
+ # event imports: * `user_event` (default): One JSON UserEvent per line.
15833
+ # Corresponds to the JSON property `dataSchema`
15834
+ # @return [String]
15835
+ attr_accessor :data_schema
15836
+
15837
+ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000
15838
+ # characters long. URIs can match the full object path (for example, `gs://
15839
+ # bucket/directory/object.json`) or a pattern matching one or more files, such
15840
+ # as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or
15841
+ # 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or
15842
+ # 100 MB if `data_schema` is `content`).
15843
+ # Corresponds to the JSON property `inputUris`
15844
+ # @return [Array<String>]
15845
+ attr_accessor :input_uris
15846
+
15847
+ def initialize(**args)
15848
+ update!(**args)
15849
+ end
15850
+
15851
+ # Update properties of this object
15852
+ def update!(**args)
15853
+ @data_schema = args[:data_schema] if args.key?(:data_schema)
15854
+ @input_uris = args[:input_uris] if args.key?(:input_uris)
15855
+ end
15856
+ end
15857
+
15858
+ # Top-level message sent by the client for the `GenerateGroundedContent` method.
15859
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest
15860
+ include Google::Apis::Core::Hashable
15861
+
15862
+ # Content of the current conversation with the model. For single-turn queries,
15863
+ # this is a single instance. For multi-turn queries, this is a repeated field
15864
+ # that contains conversation history + latest request.
15865
+ # Corresponds to the JSON property `contents`
15866
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGroundedGenerationContent>]
15867
+ attr_accessor :contents
15868
+
15869
+ # Content generation specification.
15870
+ # Corresponds to the JSON property `generationSpec`
15871
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec]
15872
+ attr_accessor :generation_spec
15873
+
15874
+ # Grounding specification.
15875
+ # Corresponds to the JSON property `groundingSpec`
15876
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec]
15877
+ attr_accessor :grounding_spec
15878
+
15879
+ # Base structured datatype containing multi-part content of a message.
15880
+ # Corresponds to the JSON property `systemInstruction`
15881
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGroundedGenerationContent]
15882
+ attr_accessor :system_instruction
15883
+
15884
+ # The user labels applied to a resource must meet the following requirements: *
15885
+ # Each resource can have multiple labels, up to a maximum of 64. * Each label
15886
+ # must be a key-value pair. * Keys have a minimum length of 1 character and a
15887
+ # maximum length of 63 characters and cannot be empty. Values can be empty and
15888
+ # have a maximum length of 63 characters. * Keys and values can contain only
15889
+ # lowercase letters, numeric characters, underscores, and dashes. All characters
15890
+ # must use UTF-8 encoding, and international characters are allowed. * The key
15891
+ # portion of a label must be unique. However, you can use the same key with
15892
+ # multiple resources. * Keys must start with a lowercase letter or international
15893
+ # character. See [Google Cloud Document](https://cloud.google.com/resource-
15894
+ # manager/docs/creating-managing-labels#requirements) for more details.
15895
+ # Corresponds to the JSON property `userLabels`
15896
+ # @return [Hash<String,String>]
15897
+ attr_accessor :user_labels
15898
+
15899
+ def initialize(**args)
15900
+ update!(**args)
15901
+ end
15902
+
15903
+ # Update properties of this object
15904
+ def update!(**args)
15905
+ @contents = args[:contents] if args.key?(:contents)
15906
+ @generation_spec = args[:generation_spec] if args.key?(:generation_spec)
15907
+ @grounding_spec = args[:grounding_spec] if args.key?(:grounding_spec)
15908
+ @system_instruction = args[:system_instruction] if args.key?(:system_instruction)
15909
+ @user_labels = args[:user_labels] if args.key?(:user_labels)
15910
+ end
15911
+ end
15912
+
15913
+ # Describes the options to customize dynamic retrieval.
15914
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration
15915
+ include Google::Apis::Core::Hashable
15916
+
15917
+ # Describes the predictor settings for dynamic retrieval.
15918
+ # Corresponds to the JSON property `predictor`
15919
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor]
15920
+ attr_accessor :predictor
15921
+
15922
+ def initialize(**args)
15923
+ update!(**args)
15924
+ end
15925
+
15926
+ # Update properties of this object
15927
+ def update!(**args)
15928
+ @predictor = args[:predictor] if args.key?(:predictor)
15929
+ end
15930
+ end
15931
+
15932
+ # Describes the predictor settings for dynamic retrieval.
15933
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor
15934
+ include Google::Apis::Core::Hashable
15935
+
15936
+ # The value of the threshold. If the predictor will predict a value smaller than
15937
+ # this, it would suppress grounding in the source.
15938
+ # Corresponds to the JSON property `threshold`
15939
+ # @return [Float]
15940
+ attr_accessor :threshold
15941
+
15942
+ # The version of the predictor to be used in dynamic retrieval.
15943
+ # Corresponds to the JSON property `version`
15944
+ # @return [String]
15945
+ attr_accessor :version
15946
+
15947
+ def initialize(**args)
15948
+ update!(**args)
15949
+ end
15950
+
15951
+ # Update properties of this object
15952
+ def update!(**args)
15953
+ @threshold = args[:threshold] if args.key?(:threshold)
15954
+ @version = args[:version] if args.key?(:version)
15955
+ end
15956
+ end
15957
+
15958
+ # Content generation specification.
15959
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec
15960
+ include Google::Apis::Core::Hashable
15961
+
15962
+ # If specified, custom value for frequency penalty will be used.
15963
+ # Corresponds to the JSON property `frequencyPenalty`
15964
+ # @return [Float]
15965
+ attr_accessor :frequency_penalty
15966
+
15967
+ # Language code for content. Use language tags defined by [BCP47](https://www.
15968
+ # rfc-editor.org/rfc/bcp/bcp47.txt).
15969
+ # Corresponds to the JSON property `languageCode`
15970
+ # @return [String]
15971
+ attr_accessor :language_code
15972
+
15973
+ # If specified, custom value for max output tokens will be used.
15974
+ # Corresponds to the JSON property `maxOutputTokens`
15975
+ # @return [Fixnum]
15976
+ attr_accessor :max_output_tokens
15977
+
15978
+ # Specifies which Vertex model id to use for generation.
15979
+ # Corresponds to the JSON property `modelId`
15980
+ # @return [String]
15981
+ attr_accessor :model_id
15982
+
15983
+ # If specified, custom value for presence penalty will be used.
15984
+ # Corresponds to the JSON property `presencePenalty`
15985
+ # @return [Float]
15986
+ attr_accessor :presence_penalty
15987
+
15988
+ # If specified, custom value for the seed will be used.
15989
+ # Corresponds to the JSON property `seed`
15990
+ # @return [Fixnum]
15991
+ attr_accessor :seed
15992
+
15993
+ # If specified, custom value for the temperature will be used.
15994
+ # Corresponds to the JSON property `temperature`
15995
+ # @return [Float]
15996
+ attr_accessor :temperature
15997
+
15998
+ # If specified, custom value for top-k sampling will be used.
15999
+ # Corresponds to the JSON property `topK`
16000
+ # @return [Fixnum]
16001
+ attr_accessor :top_k
16002
+
16003
+ # If specified, custom value for nucleus sampling will be used.
16004
+ # Corresponds to the JSON property `topP`
16005
+ # @return [Float]
16006
+ attr_accessor :top_p
16007
+
16008
+ def initialize(**args)
16009
+ update!(**args)
16010
+ end
16011
+
16012
+ # Update properties of this object
16013
+ def update!(**args)
16014
+ @frequency_penalty = args[:frequency_penalty] if args.key?(:frequency_penalty)
16015
+ @language_code = args[:language_code] if args.key?(:language_code)
16016
+ @max_output_tokens = args[:max_output_tokens] if args.key?(:max_output_tokens)
16017
+ @model_id = args[:model_id] if args.key?(:model_id)
16018
+ @presence_penalty = args[:presence_penalty] if args.key?(:presence_penalty)
16019
+ @seed = args[:seed] if args.key?(:seed)
16020
+ @temperature = args[:temperature] if args.key?(:temperature)
16021
+ @top_k = args[:top_k] if args.key?(:top_k)
16022
+ @top_p = args[:top_p] if args.key?(:top_p)
16023
+ end
16024
+ end
16025
+
16026
+ # Grounding source.
16027
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource
16028
+ include Google::Apis::Core::Hashable
16029
+
16030
+ # Google Search config parameters.
16031
+ # Corresponds to the JSON property `googleSearchSource`
16032
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource]
16033
+ attr_accessor :google_search_source
16034
+
16035
+ # Message to be used for grounding based on inline content.
16036
+ # Corresponds to the JSON property `inlineSource`
16037
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource]
16038
+ attr_accessor :inline_source
16039
+
16040
+ # Message to be used for grounding with Vertex AI Search.
16041
+ # Corresponds to the JSON property `searchSource`
16042
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource]
16043
+ attr_accessor :search_source
16044
+
16045
+ def initialize(**args)
16046
+ update!(**args)
16047
+ end
16048
+
16049
+ # Update properties of this object
16050
+ def update!(**args)
16051
+ @google_search_source = args[:google_search_source] if args.key?(:google_search_source)
16052
+ @inline_source = args[:inline_source] if args.key?(:inline_source)
16053
+ @search_source = args[:search_source] if args.key?(:search_source)
16054
+ end
16055
+ end
16056
+
16057
+ # Google Search config parameters.
16058
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource
16059
+ include Google::Apis::Core::Hashable
16060
+
16061
+ # Describes the options to customize dynamic retrieval.
16062
+ # Corresponds to the JSON property `dynamicRetrievalConfig`
16063
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration]
16064
+ attr_accessor :dynamic_retrieval_config
16065
+
16066
+ def initialize(**args)
16067
+ update!(**args)
16068
+ end
16069
+
16070
+ # Update properties of this object
16071
+ def update!(**args)
16072
+ @dynamic_retrieval_config = args[:dynamic_retrieval_config] if args.key?(:dynamic_retrieval_config)
16073
+ end
16074
+ end
16075
+
16076
+ # Message to be used for grounding based on inline content.
16077
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource
16078
+ include Google::Apis::Core::Hashable
16079
+
16080
+ # Attributes associated with the content. Common attributes include `source` (
16081
+ # indicating where the content was sourced from) and `author` (indicating the
16082
+ # author of the content).
16083
+ # Corresponds to the JSON property `attributes`
16084
+ # @return [Hash<String,String>]
16085
+ attr_accessor :attributes
16086
+
16087
+ # List of facts to be used for grounding.
16088
+ # Corresponds to the JSON property `groundingFacts`
16089
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGroundingFact>]
16090
+ attr_accessor :grounding_facts
16091
+
16092
+ def initialize(**args)
16093
+ update!(**args)
16094
+ end
16095
+
16096
+ # Update properties of this object
16097
+ def update!(**args)
16098
+ @attributes = args[:attributes] if args.key?(:attributes)
16099
+ @grounding_facts = args[:grounding_facts] if args.key?(:grounding_facts)
16100
+ end
16101
+ end
16102
+
16103
+ # Message to be used for grounding with Vertex AI Search.
16104
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource
16105
+ include Google::Apis::Core::Hashable
16106
+
16107
+ # Filter expression to be applied to the search. The syntax is the same as
16108
+ # SearchRequest.filter.
16109
+ # Corresponds to the JSON property `filter`
16110
+ # @return [String]
16111
+ attr_accessor :filter
16112
+
16113
+ # Number of search results to return. The default value is 10. The maximumm
16114
+ # allowed value is 10.
16115
+ # Corresponds to the JSON property `maxResultCount`
16116
+ # @return [Fixnum]
16117
+ attr_accessor :max_result_count
16118
+
16119
+ # If set, safe search is enabled in Vertex AI Search requests.
16120
+ # Corresponds to the JSON property `safeSearch`
16121
+ # @return [Boolean]
16122
+ attr_accessor :safe_search
16123
+ alias_method :safe_search?, :safe_search
16124
+
16125
+ # The resource name of the Engine to use. Format: `projects/`project`/locations/`
16126
+ # location`/collections/`collection_id`/engines/`engine_id`/servingConfigs/`
16127
+ # serving_config_id``
16128
+ # Corresponds to the JSON property `servingConfig`
16129
+ # @return [String]
16130
+ attr_accessor :serving_config
16131
+
16132
+ def initialize(**args)
16133
+ update!(**args)
16134
+ end
16135
+
16136
+ # Update properties of this object
16137
+ def update!(**args)
16138
+ @filter = args[:filter] if args.key?(:filter)
16139
+ @max_result_count = args[:max_result_count] if args.key?(:max_result_count)
16140
+ @safe_search = args[:safe_search] if args.key?(:safe_search)
16141
+ @serving_config = args[:serving_config] if args.key?(:serving_config)
16142
+ end
16143
+ end
16144
+
16145
+ # Grounding specification.
16146
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec
16147
+ include Google::Apis::Core::Hashable
16148
+
16149
+ # Grounding sources.
16150
+ # Corresponds to the JSON property `groundingSources`
16151
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource>]
16152
+ attr_accessor :grounding_sources
16153
+
16154
+ def initialize(**args)
16155
+ update!(**args)
16156
+ end
16157
+
16158
+ # Update properties of this object
16159
+ def update!(**args)
16160
+ @grounding_sources = args[:grounding_sources] if args.key?(:grounding_sources)
16161
+ end
16162
+ end
16163
+
16164
+ # Response for the `GenerateGroundedContent` method.
16165
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse
16166
+ include Google::Apis::Core::Hashable
16167
+
16168
+ # Generated candidates.
16169
+ # Corresponds to the JSON property `candidates`
16170
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate>]
16171
+ attr_accessor :candidates
16172
+
16173
+ def initialize(**args)
16174
+ update!(**args)
16175
+ end
16176
+
16177
+ # Update properties of this object
16178
+ def update!(**args)
16179
+ @candidates = args[:candidates] if args.key?(:candidates)
16180
+ end
16181
+ end
16182
+
16183
+ # A response candidate generated from the model.
16184
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate
16185
+ include Google::Apis::Core::Hashable
16186
+
16187
+ # Base structured datatype containing multi-part content of a message.
16188
+ # Corresponds to the JSON property `content`
16189
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGroundedGenerationContent]
16190
+ attr_accessor :content
16191
+
16192
+ # Citation for the generated content.
16193
+ # Corresponds to the JSON property `groundingMetadata`
16194
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata]
16195
+ attr_accessor :grounding_metadata
16196
+
16197
+ # The overall grounding score for the candidate, in the range of [0, 1].
16198
+ # Corresponds to the JSON property `groundingScore`
16199
+ # @return [Float]
16200
+ attr_accessor :grounding_score
16201
+
16202
+ # Index of the candidate.
16203
+ # Corresponds to the JSON property `index`
16204
+ # @return [Fixnum]
16205
+ attr_accessor :index
16206
+
16207
+ def initialize(**args)
16208
+ update!(**args)
16209
+ end
16210
+
16211
+ # Update properties of this object
16212
+ def update!(**args)
16213
+ @content = args[:content] if args.key?(:content)
16214
+ @grounding_metadata = args[:grounding_metadata] if args.key?(:grounding_metadata)
16215
+ @grounding_score = args[:grounding_score] if args.key?(:grounding_score)
16216
+ @index = args[:index] if args.key?(:index)
16217
+ end
16218
+ end
16219
+
16220
+ # Citation for the generated content.
16221
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata
16222
+ include Google::Apis::Core::Hashable
16223
+
16224
+ # GroundingSupport across all claims in the answer candidate. An support to a
16225
+ # fact indicates that the claim is supported by the fact.
16226
+ # Corresponds to the JSON property `groundingSupport`
16227
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport>]
16228
+ attr_accessor :grounding_support
16229
+
16230
+ # Retrieval metadata to provide an understanding in the retrieval steps
16231
+ # performed by the model. There can be multiple such messages which can
16232
+ # correspond to different parts of the retrieval. This is a mechanism used to
16233
+ # ensure transparency to our users.
16234
+ # Corresponds to the JSON property `retrievalMetadata`
16235
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata>]
16236
+ attr_accessor :retrieval_metadata
16237
+
16238
+ # Google search entry point.
16239
+ # Corresponds to the JSON property `searchEntryPoint`
16240
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint]
16241
+ attr_accessor :search_entry_point
16242
+
16243
+ # List of chunks to be attributed across all claims in the candidate. These are
16244
+ # derived from the grounding sources supplied in the request.
16245
+ # Corresponds to the JSON property `supportChunks`
16246
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFactChunk>]
16247
+ attr_accessor :support_chunks
16248
+
16249
+ # Web search queries for the following-up web search.
16250
+ # Corresponds to the JSON property `webSearchQueries`
16251
+ # @return [Array<String>]
16252
+ attr_accessor :web_search_queries
14581
16253
 
14582
16254
  def initialize(**args)
14583
16255
  update!(**args)
@@ -14585,20 +16257,22 @@ module Google
14585
16257
 
14586
16258
  # Update properties of this object
14587
16259
  def update!(**args)
14588
- @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
14589
- @target_sites = args[:target_sites] if args.key?(:target_sites)
14590
- @total_size = args[:total_size] if args.key?(:total_size)
16260
+ @grounding_support = args[:grounding_support] if args.key?(:grounding_support)
16261
+ @retrieval_metadata = args[:retrieval_metadata] if args.key?(:retrieval_metadata)
16262
+ @search_entry_point = args[:search_entry_point] if args.key?(:search_entry_point)
16263
+ @support_chunks = args[:support_chunks] if args.key?(:support_chunks)
16264
+ @web_search_queries = args[:web_search_queries] if args.key?(:web_search_queries)
14591
16265
  end
14592
16266
  end
14593
16267
 
14594
- # Response message for SiteSearchEngineService.FetchSitemaps method.
14595
- class GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse
16268
+ # Describes the metadata about dynamic retrieval.
16269
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata
14596
16270
  include Google::Apis::Core::Hashable
14597
16271
 
14598
- # List of Sitemaps fetched.
14599
- # Corresponds to the JSON property `sitemapsMetadata`
14600
- # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata>]
14601
- attr_accessor :sitemaps_metadata
16272
+ # Describes the metadata about the dynamic retrieval predictor.
16273
+ # Corresponds to the JSON property `predictorMetadata`
16274
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata]
16275
+ attr_accessor :predictor_metadata
14602
16276
 
14603
16277
  def initialize(**args)
14604
16278
  update!(**args)
@@ -14606,18 +16280,26 @@ module Google
14606
16280
 
14607
16281
  # Update properties of this object
14608
16282
  def update!(**args)
14609
- @sitemaps_metadata = args[:sitemaps_metadata] if args.key?(:sitemaps_metadata)
16283
+ @predictor_metadata = args[:predictor_metadata] if args.key?(:predictor_metadata)
14610
16284
  end
14611
16285
  end
14612
16286
 
14613
- # Contains a Sitemap and its metadata.
14614
- class GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata
16287
+ # Describes the metadata about the dynamic retrieval predictor.
16288
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata
14615
16289
  include Google::Apis::Core::Hashable
14616
16290
 
14617
- # A sitemap for the SiteSearchEngine.
14618
- # Corresponds to the JSON property `sitemap`
14619
- # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSitemap]
14620
- attr_accessor :sitemap
16291
+ # The value of the predictor. This should be between [0, 1] where a value of 0
16292
+ # means that the query would not benefit from grounding, while a value of 1.0
16293
+ # means that the query would benefit the most. In between values allow to
16294
+ # differentiate between different usefulness scores for grounding.
16295
+ # Corresponds to the JSON property `prediction`
16296
+ # @return [Float]
16297
+ attr_accessor :prediction
16298
+
16299
+ # The version of the predictor which was used in dynamic retrieval.
16300
+ # Corresponds to the JSON property `version`
16301
+ # @return [String]
16302
+ attr_accessor :version
14621
16303
 
14622
16304
  def initialize(**args)
14623
16305
  update!(**args)
@@ -14625,46 +16307,33 @@ module Google
14625
16307
 
14626
16308
  # Update properties of this object
14627
16309
  def update!(**args)
14628
- @sitemap = args[:sitemap] if args.key?(:sitemap)
16310
+ @prediction = args[:prediction] if args.key?(:prediction)
16311
+ @version = args[:version] if args.key?(:version)
14629
16312
  end
14630
16313
  end
14631
16314
 
14632
- # Cloud FhirStore source import data from.
14633
- class GoogleCloudDiscoveryengineV1betaFhirStoreSource
16315
+ # Grounding info for a claim in the candidate and its support.
16316
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport
14634
16317
  include Google::Apis::Core::Hashable
14635
16318
 
14636
- # Required. The full resource name of the FHIR store to import data from, in the
14637
- # format of `projects/`project`/locations/`location`/datasets/`dataset`/
14638
- # fhirStores/`fhir_store``.
14639
- # Corresponds to the JSON property `fhirStore`
14640
- # @return [String]
14641
- attr_accessor :fhir_store
14642
-
14643
- # Intermediate Cloud Storage directory used for the import with a length limit
14644
- # of 2,000 characters. Can be specified if one wants to have the FhirStore
14645
- # export to a specific Cloud Storage directory.
14646
- # Corresponds to the JSON property `gcsStagingDir`
16319
+ # Text for the claim in the candidate. Always provided when a support is found.
16320
+ # Corresponds to the JSON property `claimText`
14647
16321
  # @return [String]
14648
- attr_accessor :gcs_staging_dir
16322
+ attr_accessor :claim_text
14649
16323
 
14650
- # The FHIR resource types to import. The resource types should be a subset of
14651
- # all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-
14652
- # builder/docs/fhir-schema-reference#resource-level-specification). Default to
14653
- # all supported FHIR resource types if empty.
14654
- # Corresponds to the JSON property `resourceTypes`
14655
- # @return [Array<String>]
14656
- attr_accessor :resource_types
16324
+ # A list of indices (into 'support_chunks') specifying the citations associated
16325
+ # with the claim. For instance [1,3,4] means that support_chunks[1],
16326
+ # support_chunks[3], support_chunks[4] are the chunks attributed to the claim.
16327
+ # Corresponds to the JSON property `supportChunkIndices`
16328
+ # @return [Array<Fixnum>]
16329
+ attr_accessor :support_chunk_indices
14657
16330
 
14658
- # Optional. Whether to update the DataStore schema to the latest predefined
14659
- # schema. If true, the DataStore schema will be updated to include any FHIR
14660
- # fields or resource types that have been added since the last import and
14661
- # corresponding FHIR resources will be imported from the FHIR store. Note this
14662
- # field cannot be used in conjunction with `resource_types`. It should be used
14663
- # after initial import.
14664
- # Corresponds to the JSON property `updateFromLatestPredefinedSchema`
14665
- # @return [Boolean]
14666
- attr_accessor :update_from_latest_predefined_schema
14667
- alias_method :update_from_latest_predefined_schema?, :update_from_latest_predefined_schema
16331
+ # A score in the range of [0, 1] describing how grounded is a specific claim in
16332
+ # the support chunks indicated. Higher value means that the claim is better
16333
+ # supported by the chunks.
16334
+ # Corresponds to the JSON property `supportScore`
16335
+ # @return [Float]
16336
+ attr_accessor :support_score
14668
16337
 
14669
16338
  def initialize(**args)
14670
16339
  update!(**args)
@@ -14672,43 +16341,51 @@ module Google
14672
16341
 
14673
16342
  # Update properties of this object
14674
16343
  def update!(**args)
14675
- @fhir_store = args[:fhir_store] if args.key?(:fhir_store)
14676
- @gcs_staging_dir = args[:gcs_staging_dir] if args.key?(:gcs_staging_dir)
14677
- @resource_types = args[:resource_types] if args.key?(:resource_types)
14678
- @update_from_latest_predefined_schema = args[:update_from_latest_predefined_schema] if args.key?(:update_from_latest_predefined_schema)
16344
+ @claim_text = args[:claim_text] if args.key?(:claim_text)
16345
+ @support_chunk_indices = args[:support_chunk_indices] if args.key?(:support_chunk_indices)
16346
+ @support_score = args[:support_score] if args.key?(:support_score)
14679
16347
  end
14680
16348
  end
14681
16349
 
14682
- # Firestore source import data from.
14683
- class GoogleCloudDiscoveryengineV1betaFirestoreSource
16350
+ # Describes the metadata associated with a retrieval step.
16351
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata
14684
16352
  include Google::Apis::Core::Hashable
14685
16353
 
14686
- # Required. The Firestore collection (or entity) to copy the data from with a
14687
- # length limit of 1,500 characters.
14688
- # Corresponds to the JSON property `collectionId`
14689
- # @return [String]
14690
- attr_accessor :collection_id
16354
+ # Describes the metadata about dynamic retrieval.
16355
+ # Corresponds to the JSON property `dynamicRetrievalMetadata`
16356
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata]
16357
+ attr_accessor :dynamic_retrieval_metadata
14691
16358
 
14692
- # Required. The Firestore database to copy the data from with a length limit of
14693
- # 256 characters.
14694
- # Corresponds to the JSON property `databaseId`
16359
+ # Describes the source to which the metadata is referring to.
16360
+ # Corresponds to the JSON property `source`
14695
16361
  # @return [String]
14696
- attr_accessor :database_id
16362
+ attr_accessor :source
14697
16363
 
14698
- # Intermediate Cloud Storage directory used for the import with a length limit
14699
- # of 2,000 characters. Can be specified if one wants to have the Firestore
14700
- # export to a specific Cloud Storage directory. Ensure that the Firestore
14701
- # service account has the necessary Cloud Storage Admin permissions to access
14702
- # the specified Cloud Storage directory.
14703
- # Corresponds to the JSON property `gcsStagingDir`
16364
+ def initialize(**args)
16365
+ update!(**args)
16366
+ end
16367
+
16368
+ # Update properties of this object
16369
+ def update!(**args)
16370
+ @dynamic_retrieval_metadata = args[:dynamic_retrieval_metadata] if args.key?(:dynamic_retrieval_metadata)
16371
+ @source = args[:source] if args.key?(:source)
16372
+ end
16373
+ end
16374
+
16375
+ # Google search entry point.
16376
+ class GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint
16377
+ include Google::Apis::Core::Hashable
16378
+
16379
+ # Web content snippet that can be embedded in a web page or an app webview.
16380
+ # Corresponds to the JSON property `renderedContent`
14704
16381
  # @return [String]
14705
- attr_accessor :gcs_staging_dir
16382
+ attr_accessor :rendered_content
14706
16383
 
14707
- # The project ID that the Cloud SQL source is in with a length limit of 128
14708
- # characters. If not specified, inherits the project ID from the parent request.
14709
- # Corresponds to the JSON property `projectId`
16384
+ # Base64 encoded JSON representing array of tuple.
16385
+ # Corresponds to the JSON property `sdkBlob`
16386
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
14710
16387
  # @return [String]
14711
- attr_accessor :project_id
16388
+ attr_accessor :sdk_blob
14712
16389
 
14713
16390
  def initialize(**args)
14714
16391
  update!(**args)
@@ -14716,41 +16393,45 @@ module Google
14716
16393
 
14717
16394
  # Update properties of this object
14718
16395
  def update!(**args)
14719
- @collection_id = args[:collection_id] if args.key?(:collection_id)
14720
- @database_id = args[:database_id] if args.key?(:database_id)
14721
- @gcs_staging_dir = args[:gcs_staging_dir] if args.key?(:gcs_staging_dir)
14722
- @project_id = args[:project_id] if args.key?(:project_id)
16396
+ @rendered_content = args[:rendered_content] if args.key?(:rendered_content)
16397
+ @sdk_blob = args[:sdk_blob] if args.key?(:sdk_blob)
14723
16398
  end
14724
16399
  end
14725
16400
 
14726
- # Cloud Storage location for input content.
14727
- class GoogleCloudDiscoveryengineV1betaGcsSource
16401
+ # Base structured datatype containing multi-part content of a message.
16402
+ class GoogleCloudDiscoveryengineV1betaGroundedGenerationContent
14728
16403
  include Google::Apis::Core::Hashable
14729
16404
 
14730
- # The schema to use when parsing the data from the source. Supported values for
14731
- # document imports: * `document` (default): One JSON Document per line. Each
14732
- # document must have a valid Document.id. * `content`: Unstructured data (e.g.
14733
- # PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID
14734
- # set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`:
14735
- # One custom data JSON per row in arbitrary format that conforms to the defined
14736
- # Schema of the data store. This can only be used by the GENERIC Data Store
14737
- # vertical. * `csv`: A CSV file with header conforming to the defined Schema of
14738
- # the data store. Each entry after the header is imported as a Document. This
14739
- # can only be used by the GENERIC Data Store vertical. Supported values for user
14740
- # event imports: * `user_event` (default): One JSON UserEvent per line.
14741
- # Corresponds to the JSON property `dataSchema`
16405
+ # Ordered `Parts` that constitute a single message.
16406
+ # Corresponds to the JSON property `parts`
16407
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart>]
16408
+ attr_accessor :parts
16409
+
16410
+ # Producer of the content. Must be either `user` or `model`. Intended to be used
16411
+ # for multi-turn conversations. Otherwise, it can be left unset.
16412
+ # Corresponds to the JSON property `role`
14742
16413
  # @return [String]
14743
- attr_accessor :data_schema
16414
+ attr_accessor :role
14744
16415
 
14745
- # Required. Cloud Storage URIs to input files. Each URI can be up to 2000
14746
- # characters long. URIs can match the full object path (for example, `gs://
14747
- # bucket/directory/object.json`) or a pattern matching one or more files, such
14748
- # as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or
14749
- # 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or
14750
- # 100 MB if `data_schema` is `content`).
14751
- # Corresponds to the JSON property `inputUris`
14752
- # @return [Array<String>]
14753
- attr_accessor :input_uris
16416
+ def initialize(**args)
16417
+ update!(**args)
16418
+ end
16419
+
16420
+ # Update properties of this object
16421
+ def update!(**args)
16422
+ @parts = args[:parts] if args.key?(:parts)
16423
+ @role = args[:role] if args.key?(:role)
16424
+ end
16425
+ end
16426
+
16427
+ # Single part of content.
16428
+ class GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart
16429
+ include Google::Apis::Core::Hashable
16430
+
16431
+ # Inline text.
16432
+ # Corresponds to the JSON property `text`
16433
+ # @return [String]
16434
+ attr_accessor :text
14754
16435
 
14755
16436
  def initialize(**args)
14756
16437
  update!(**args)
@@ -14758,8 +16439,7 @@ module Google
14758
16439
 
14759
16440
  # Update properties of this object
14760
16441
  def update!(**args)
14761
- @data_schema = args[:data_schema] if args.key?(:data_schema)
14762
- @input_uris = args[:input_uris] if args.key?(:input_uris)
16442
+ @text = args[:text] if args.key?(:text)
14763
16443
  end
14764
16444
  end
14765
16445
 
@@ -15741,7 +17421,7 @@ module Google
15741
17421
  class GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse
15742
17422
  include Google::Apis::Core::Hashable
15743
17423
 
15744
- # The EvaluationResults.
17424
+ # The evaluation results for the SampleQuerys.
15745
17425
  # Corresponds to the JSON property `evaluationResults`
15746
17426
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult>]
15747
17427
  attr_accessor :evaluation_results
@@ -16958,7 +18638,7 @@ module Google
16958
18638
  class GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest
16959
18639
  include Google::Apis::Core::Hashable
16960
18640
 
16961
- # Optional. Full resource name of the SiteCredential, such as `projects/*/
18641
+ # Optional. Full resource name of the `SiteCredential`, such as `projects/*/
16962
18642
  # locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`.
16963
18643
  # Only set to crawl private URIs.
16964
18644
  # Corresponds to the JSON property `siteCredential`
@@ -17064,6 +18744,57 @@ module Google
17064
18744
  end
17065
18745
  end
17066
18746
 
18747
+ # Safety rating corresponding to the generated content.
18748
+ class GoogleCloudDiscoveryengineV1betaSafetyRating
18749
+ include Google::Apis::Core::Hashable
18750
+
18751
+ # Output only. Indicates whether the content was filtered out because of this
18752
+ # rating.
18753
+ # Corresponds to the JSON property `blocked`
18754
+ # @return [Boolean]
18755
+ attr_accessor :blocked
18756
+ alias_method :blocked?, :blocked
18757
+
18758
+ # Output only. Harm category.
18759
+ # Corresponds to the JSON property `category`
18760
+ # @return [String]
18761
+ attr_accessor :category
18762
+
18763
+ # Output only. Harm probability levels in the content.
18764
+ # Corresponds to the JSON property `probability`
18765
+ # @return [String]
18766
+ attr_accessor :probability
18767
+
18768
+ # Output only. Harm probability score.
18769
+ # Corresponds to the JSON property `probabilityScore`
18770
+ # @return [Float]
18771
+ attr_accessor :probability_score
18772
+
18773
+ # Output only. Harm severity levels in the content.
18774
+ # Corresponds to the JSON property `severity`
18775
+ # @return [String]
18776
+ attr_accessor :severity
18777
+
18778
+ # Output only. Harm severity score.
18779
+ # Corresponds to the JSON property `severityScore`
18780
+ # @return [Float]
18781
+ attr_accessor :severity_score
18782
+
18783
+ def initialize(**args)
18784
+ update!(**args)
18785
+ end
18786
+
18787
+ # Update properties of this object
18788
+ def update!(**args)
18789
+ @blocked = args[:blocked] if args.key?(:blocked)
18790
+ @category = args[:category] if args.key?(:category)
18791
+ @probability = args[:probability] if args.key?(:probability)
18792
+ @probability_score = args[:probability_score] if args.key?(:probability_score)
18793
+ @severity = args[:severity] if args.key?(:severity)
18794
+ @severity_score = args[:severity_score] if args.key?(:severity_score)
18795
+ end
18796
+ end
18797
+
17067
18798
  # Sample Query captures metadata to be used for evaluation.
17068
18799
  class GoogleCloudDiscoveryengineV1betaSampleQuery
17069
18800
  include Google::Apis::Core::Hashable
@@ -18384,8 +20115,8 @@ module Google
18384
20115
  class GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec
18385
20116
  include Google::Apis::Core::Hashable
18386
20117
 
18387
- # The condition under which filter extraction should occur. Default to Condition.
18388
- # DISABLED.
20118
+ # The condition under which filter extraction should occur. Server behavior
20119
+ # defaults to `DISABLED`.
18389
20120
  # Corresponds to the JSON property `filterExtractionCondition`
18390
20121
  # @return [String]
18391
20122
  attr_accessor :filter_extraction_condition
@@ -19524,7 +21255,7 @@ module Google
19524
21255
  # The ranking expression controls the customized ranking on retrieval documents.
19525
21256
  # To leverage this, document embedding is required. The ranking expression
19526
21257
  # setting in ServingConfig applies to all search requests served by the serving
19527
- # config. However, if SearchRequest.ranking_expression is specified, it
21258
+ # config. However, if `SearchRequest.ranking_expression` is specified, it
19528
21259
  # overrides the ServingConfig ranking expression. The ranking expression is a
19529
21260
  # single function or multiple functions that are joined by "+". *
19530
21261
  # ranking_expression = function, ` " + ", function `; Supported functions: *
@@ -19780,6 +21511,27 @@ module Google
19780
21511
  end
19781
21512
  end
19782
21513
 
21514
+ # Metadata for single-regional CMEKs.
21515
+ class GoogleCloudDiscoveryengineV1betaSingleRegionKey
21516
+ include Google::Apis::Core::Hashable
21517
+
21518
+ # Required. Single-regional kms key resource name which will be used to encrypt
21519
+ # resources `projects/`project`/locations/`location`/keyRings/`keyRing`/
21520
+ # cryptoKeys/`keyId``.
21521
+ # Corresponds to the JSON property `kmsKey`
21522
+ # @return [String]
21523
+ attr_accessor :kms_key
21524
+
21525
+ def initialize(**args)
21526
+ update!(**args)
21527
+ end
21528
+
21529
+ # Update properties of this object
21530
+ def update!(**args)
21531
+ @kms_key = args[:kms_key] if args.key?(:kms_key)
21532
+ end
21533
+ end
21534
+
19783
21535
  # SiteSearchEngine captures DataStore level site search persisting
19784
21536
  # configurations. It is a singleton value per data store.
19785
21537
  class GoogleCloudDiscoveryengineV1betaSiteSearchEngine
@@ -19938,7 +21690,7 @@ module Google
19938
21690
  class GoogleCloudDiscoveryengineV1betaTargetSite
19939
21691
  include Google::Apis::Core::Hashable
19940
21692
 
19941
- # Input only. If set to false, a uri_pattern is generated to include all pages
21693
+ # Immutable. If set to false, a uri_pattern is generated to include all pages
19942
21694
  # whose address contains the provided_uri_pattern. If set to true, an
19943
21695
  # uri_pattern is generated to try to be an exact match of the
19944
21696
  # provided_uri_pattern or just the specific page if the provided_uri_pattern is
@@ -21118,6 +22870,121 @@ module Google
21118
22870
  @year = args[:year] if args.key?(:year)
21119
22871
  end
21120
22872
  end
22873
+
22874
+ # Represents civil time (or occasionally physical time). This type can represent
22875
+ # a civil time in one of a few possible ways: * When utc_offset is set and
22876
+ # time_zone is unset: a civil time on a calendar day with a particular offset
22877
+ # from UTC. * When time_zone is set and utc_offset is unset: a civil time on a
22878
+ # calendar day in a particular time zone. * When neither time_zone nor
22879
+ # utc_offset is set: a civil time on a calendar day in local time. The date is
22880
+ # relative to the Proleptic Gregorian Calendar. If year, month, or day are 0,
22881
+ # the DateTime is considered not to have a specific year, month, or day
22882
+ # respectively. This type may also be used to represent a physical time if all
22883
+ # the date and time fields are set and either case of the `time_offset` oneof is
22884
+ # set. Consider using `Timestamp` message for physical time instead. If your use
22885
+ # case also would like to store the user's timezone, that can be done in another
22886
+ # field. This type is more flexible than some applications may want. Make sure
22887
+ # to document and validate your application's limitations.
22888
+ class GoogleTypeDateTime
22889
+ include Google::Apis::Core::Hashable
22890
+
22891
+ # Optional. Day of month. Must be from 1 to 31 and valid for the year and month,
22892
+ # or 0 if specifying a datetime without a day.
22893
+ # Corresponds to the JSON property `day`
22894
+ # @return [Fixnum]
22895
+ attr_accessor :day
22896
+
22897
+ # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to
22898
+ # 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios
22899
+ # like business closing time.
22900
+ # Corresponds to the JSON property `hours`
22901
+ # @return [Fixnum]
22902
+ attr_accessor :hours
22903
+
22904
+ # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
22905
+ # Corresponds to the JSON property `minutes`
22906
+ # @return [Fixnum]
22907
+ attr_accessor :minutes
22908
+
22909
+ # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime
22910
+ # without a month.
22911
+ # Corresponds to the JSON property `month`
22912
+ # @return [Fixnum]
22913
+ attr_accessor :month
22914
+
22915
+ # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999,
22916
+ # defaults to 0.
22917
+ # Corresponds to the JSON property `nanos`
22918
+ # @return [Fixnum]
22919
+ attr_accessor :nanos
22920
+
22921
+ # Optional. Seconds of minutes of the time. Must normally be from 0 to 59,
22922
+ # defaults to 0. An API may allow the value 60 if it allows leap-seconds.
22923
+ # Corresponds to the JSON property `seconds`
22924
+ # @return [Fixnum]
22925
+ attr_accessor :seconds
22926
+
22927
+ # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/
22928
+ # time-zones).
22929
+ # Corresponds to the JSON property `timeZone`
22930
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleTypeTimeZone]
22931
+ attr_accessor :time_zone
22932
+
22933
+ # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For
22934
+ # example, a UTC offset of -4:00 would be represented as ` seconds: -14400 `.
22935
+ # Corresponds to the JSON property `utcOffset`
22936
+ # @return [String]
22937
+ attr_accessor :utc_offset
22938
+
22939
+ # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime
22940
+ # without a year.
22941
+ # Corresponds to the JSON property `year`
22942
+ # @return [Fixnum]
22943
+ attr_accessor :year
22944
+
22945
+ def initialize(**args)
22946
+ update!(**args)
22947
+ end
22948
+
22949
+ # Update properties of this object
22950
+ def update!(**args)
22951
+ @day = args[:day] if args.key?(:day)
22952
+ @hours = args[:hours] if args.key?(:hours)
22953
+ @minutes = args[:minutes] if args.key?(:minutes)
22954
+ @month = args[:month] if args.key?(:month)
22955
+ @nanos = args[:nanos] if args.key?(:nanos)
22956
+ @seconds = args[:seconds] if args.key?(:seconds)
22957
+ @time_zone = args[:time_zone] if args.key?(:time_zone)
22958
+ @utc_offset = args[:utc_offset] if args.key?(:utc_offset)
22959
+ @year = args[:year] if args.key?(:year)
22960
+ end
22961
+ end
22962
+
22963
+ # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/
22964
+ # time-zones).
22965
+ class GoogleTypeTimeZone
22966
+ include Google::Apis::Core::Hashable
22967
+
22968
+ # IANA Time Zone Database time zone. For example "America/New_York".
22969
+ # Corresponds to the JSON property `id`
22970
+ # @return [String]
22971
+ attr_accessor :id
22972
+
22973
+ # Optional. IANA Time Zone Database version number. For example "2019a".
22974
+ # Corresponds to the JSON property `version`
22975
+ # @return [String]
22976
+ attr_accessor :version
22977
+
22978
+ def initialize(**args)
22979
+ update!(**args)
22980
+ end
22981
+
22982
+ # Update properties of this object
22983
+ def update!(**args)
22984
+ @id = args[:id] if args.key?(:id)
22985
+ @version = args[:version] if args.key?(:version)
22986
+ end
22987
+ end
21121
22988
  end
21122
22989
  end
21123
22990
  end