google-apis-discoveryengine_v1alpha 0.61.0 → 0.63.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.
@@ -2501,10 +2501,10 @@ module Google
2501
2501
  # @return [String]
2502
2502
  attr_accessor :kms_key_name
2503
2503
 
2504
- # Immutable. The full resource name of the data store. Format: `projects/`
2505
- # project`/locations/`location`/collections/`collection_id`/dataStores/`
2506
- # data_store_id``. This field must be a UTF-8 encoded string with a length limit
2507
- # of 1024 characters.
2504
+ # Immutable. Identifier. The full resource name of the data store. Format: `
2505
+ # projects/`project`/locations/`location`/collections/`collection_id`/dataStores/
2506
+ # `data_store_id``. This field must be a UTF-8 encoded string with a length
2507
+ # limit of 1024 characters.
2508
2508
  # Corresponds to the JSON property `name`
2509
2509
  # @return [String]
2510
2510
  attr_accessor :name
@@ -2613,7 +2613,8 @@ module Google
2613
2613
  class GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore
2614
2614
  include Google::Apis::Core::Hashable
2615
2615
 
2616
- # If set true, the DataStore will not be available for serving search requests.
2616
+ # Optional. If set true, the DataStore will not be available for serving search
2617
+ # requests.
2617
2618
  # Corresponds to the JSON property `disabledForServing`
2618
2619
  # @return [Boolean]
2619
2620
  attr_accessor :disabled_for_serving
@@ -3144,12 +3145,12 @@ module Google
3144
3145
  # @return [String]
3145
3146
  attr_accessor :create_time
3146
3147
 
3147
- # The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and
3148
- # SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at
3149
- # most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple
3150
- # DataStores in the same Collection can be associated here. Note that when used
3151
- # in CreateEngineRequest, one DataStore id must be provided as the system will
3152
- # use it for necessary initializations.
3148
+ # Optional. The data stores associated with this engine. For
3149
+ # SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they
3150
+ # can only associate with at most one data store. If solution_type is
3151
+ # SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be
3152
+ # associated here. Note that when used in CreateEngineRequest, one DataStore id
3153
+ # must be provided as the system will use it for necessary initializations.
3153
3154
  # Corresponds to the JSON property `dataStoreIds`
3154
3155
  # @return [Array<String>]
3155
3156
  attr_accessor :data_store_ids
@@ -3166,9 +3167,9 @@ module Google
3166
3167
  # @return [String]
3167
3168
  attr_accessor :display_name
3168
3169
 
3169
- # The industry vertical that the engine registers. The restriction of the Engine
3170
- # industry vertical is based on DataStore: Vertical on Engine has to match
3171
- # vertical of the DataStore linked to the engine.
3170
+ # Optional. The industry vertical that the engine registers. The restriction of
3171
+ # the Engine industry vertical is based on DataStore: Vertical on Engine has to
3172
+ # match vertical of the DataStore linked to the engine.
3172
3173
  # Corresponds to the JSON property `industryVertical`
3173
3174
  # @return [String]
3174
3175
  attr_accessor :industry_vertical
@@ -3178,11 +3179,11 @@ module Google
3178
3179
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig]
3179
3180
  attr_accessor :media_recommendation_engine_config
3180
3181
 
3181
- # Immutable. The fully qualified resource name of the engine. This field must be
3182
- # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
3183
- # projects/`project`/locations/`location`/collections/`collection`/engines/`
3184
- # engine`` engine should be 1-63 characters, and valid characters are /a-z0-9*/.
3185
- # Otherwise, an INVALID_ARGUMENT error is returned.
3182
+ # Immutable. Identifier. The fully qualified resource name of the engine. This
3183
+ # field must be a UTF-8 encoded string with a length limit of 1024 characters.
3184
+ # Format: `projects/`project`/locations/`location`/collections/`collection`/
3185
+ # engines/`engine`` engine should be 1-63 characters, and valid characters are /
3186
+ # a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
3186
3187
  # Corresponds to the JSON property `name`
3187
3188
  # @return [String]
3188
3189
  attr_accessor :name
@@ -7845,6 +7846,131 @@ module Google
7845
7846
  end
7846
7847
  end
7847
7848
 
7849
+ # Metadata related to the progress of the UserLicenseService.
7850
+ # BatchUpdateUserLicenses operation. This will be returned by the google.
7851
+ # longrunning.Operation.metadata field.
7852
+ class GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata
7853
+ include Google::Apis::Core::Hashable
7854
+
7855
+ # Operation create time.
7856
+ # Corresponds to the JSON property `createTime`
7857
+ # @return [String]
7858
+ attr_accessor :create_time
7859
+
7860
+ # Count of user licenses that failed to be updated.
7861
+ # Corresponds to the JSON property `failureCount`
7862
+ # @return [Fixnum]
7863
+ attr_accessor :failure_count
7864
+
7865
+ # Count of user licenses successfully updated.
7866
+ # Corresponds to the JSON property `successCount`
7867
+ # @return [Fixnum]
7868
+ attr_accessor :success_count
7869
+
7870
+ # Operation last update time. If the operation is done, this is also the finish
7871
+ # time.
7872
+ # Corresponds to the JSON property `updateTime`
7873
+ # @return [String]
7874
+ attr_accessor :update_time
7875
+
7876
+ def initialize(**args)
7877
+ update!(**args)
7878
+ end
7879
+
7880
+ # Update properties of this object
7881
+ def update!(**args)
7882
+ @create_time = args[:create_time] if args.key?(:create_time)
7883
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
7884
+ @success_count = args[:success_count] if args.key?(:success_count)
7885
+ @update_time = args[:update_time] if args.key?(:update_time)
7886
+ end
7887
+ end
7888
+
7889
+ # Request message for UserLicenseService.BatchUpdateUserLicenses method.
7890
+ class GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest
7891
+ include Google::Apis::Core::Hashable
7892
+
7893
+ # Optional. If true, if user licenses removed associated license config, the
7894
+ # user license will be deleted. By default which is false, the user license will
7895
+ # be updated to unassigned state.
7896
+ # Corresponds to the JSON property `deleteUnassignedUserLicenses`
7897
+ # @return [Boolean]
7898
+ attr_accessor :delete_unassigned_user_licenses
7899
+ alias_method :delete_unassigned_user_licenses?, :delete_unassigned_user_licenses
7900
+
7901
+ # Cloud Storage location for input content.
7902
+ # Corresponds to the JSON property `gcsSource`
7903
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGcsSource]
7904
+ attr_accessor :gcs_source
7905
+
7906
+ # The inline source for the input config for BatchUpdateUserLicenses method.
7907
+ # Corresponds to the JSON property `inlineSource`
7908
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource]
7909
+ attr_accessor :inline_source
7910
+
7911
+ def initialize(**args)
7912
+ update!(**args)
7913
+ end
7914
+
7915
+ # Update properties of this object
7916
+ def update!(**args)
7917
+ @delete_unassigned_user_licenses = args[:delete_unassigned_user_licenses] if args.key?(:delete_unassigned_user_licenses)
7918
+ @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
7919
+ @inline_source = args[:inline_source] if args.key?(:inline_source)
7920
+ end
7921
+ end
7922
+
7923
+ # The inline source for the input config for BatchUpdateUserLicenses method.
7924
+ class GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource
7925
+ include Google::Apis::Core::Hashable
7926
+
7927
+ # Optional. The list of fields to update.
7928
+ # Corresponds to the JSON property `updateMask`
7929
+ # @return [String]
7930
+ attr_accessor :update_mask
7931
+
7932
+ # Required. A list of user licenses to update. Each user license must have a
7933
+ # valid UserLicense.user_principal.
7934
+ # Corresponds to the JSON property `userLicenses`
7935
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserLicense>]
7936
+ attr_accessor :user_licenses
7937
+
7938
+ def initialize(**args)
7939
+ update!(**args)
7940
+ end
7941
+
7942
+ # Update properties of this object
7943
+ def update!(**args)
7944
+ @update_mask = args[:update_mask] if args.key?(:update_mask)
7945
+ @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
7946
+ end
7947
+ end
7948
+
7949
+ # Response message for UserLicenseService.BatchUpdateUserLicenses method.
7950
+ class GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse
7951
+ include Google::Apis::Core::Hashable
7952
+
7953
+ # A sample of errors encountered while processing the request.
7954
+ # Corresponds to the JSON property `errorSamples`
7955
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus>]
7956
+ attr_accessor :error_samples
7957
+
7958
+ # UserLicenses successfully updated.
7959
+ # Corresponds to the JSON property `userLicenses`
7960
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserLicense>]
7961
+ attr_accessor :user_licenses
7962
+
7963
+ def initialize(**args)
7964
+ update!(**args)
7965
+ end
7966
+
7967
+ # Update properties of this object
7968
+ def update!(**args)
7969
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
7970
+ @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
7971
+ end
7972
+ end
7973
+
7848
7974
  # Request message for SiteSearchEngineService.BatchVerifyTargetSites method.
7849
7975
  class GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest
7850
7976
  include Google::Apis::Core::Hashable
@@ -8232,7 +8358,8 @@ module Google
8232
8358
  alias_method :grounding_check_required?, :grounding_check_required
8233
8359
 
8234
8360
  # Confidence score for the claim in the answer candidate, in the range of [0, 1].
8235
- # This is set only when enable_claim_level_score is true.
8361
+ # This is set only when `CheckGroundingRequest.grounding_spec.
8362
+ # enable_claim_level_score` is true.
8236
8363
  # Corresponds to the JSON property `score`
8237
8364
  # @return [Float]
8238
8365
  attr_accessor :score
@@ -8445,6 +8572,12 @@ module Google
8445
8572
  # @return [Array<String>]
8446
8573
  attr_accessor :annotation_contents
8447
8574
 
8575
+ # Output only. The annotation metadata includes structured content in the
8576
+ # current chunk.
8577
+ # Corresponds to the JSON property `annotationMetadata`
8578
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkAnnotationMetadata>]
8579
+ attr_accessor :annotation_metadata
8580
+
8448
8581
  # Metadata of the current chunk. This field is only populated on SearchService.
8449
8582
  # Search API.
8450
8583
  # Corresponds to the JSON property `chunkMetadata`
@@ -8507,6 +8640,7 @@ module Google
8507
8640
  # Update properties of this object
8508
8641
  def update!(**args)
8509
8642
  @annotation_contents = args[:annotation_contents] if args.key?(:annotation_contents)
8643
+ @annotation_metadata = args[:annotation_metadata] if args.key?(:annotation_metadata)
8510
8644
  @chunk_metadata = args[:chunk_metadata] if args.key?(:chunk_metadata)
8511
8645
  @content = args[:content] if args.key?(:content)
8512
8646
  @data_urls = args[:data_urls] if args.key?(:data_urls)
@@ -8519,6 +8653,32 @@ module Google
8519
8653
  end
8520
8654
  end
8521
8655
 
8656
+ # The annotation metadata includes structured content in the current chunk.
8657
+ class GoogleCloudDiscoveryengineV1alphaChunkAnnotationMetadata
8658
+ include Google::Apis::Core::Hashable
8659
+
8660
+ # Output only. Image id is provided if the structured content is based on an
8661
+ # image.
8662
+ # Corresponds to the JSON property `imageId`
8663
+ # @return [String]
8664
+ attr_accessor :image_id
8665
+
8666
+ # The structured content information.
8667
+ # Corresponds to the JSON property `structuredContent`
8668
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkStructuredContent]
8669
+ attr_accessor :structured_content
8670
+
8671
+ def initialize(**args)
8672
+ update!(**args)
8673
+ end
8674
+
8675
+ # Update properties of this object
8676
+ def update!(**args)
8677
+ @image_id = args[:image_id] if args.key?(:image_id)
8678
+ @structured_content = args[:structured_content] if args.key?(:structured_content)
8679
+ end
8680
+ end
8681
+
8522
8682
  # Metadata of the current chunk. This field is only populated on SearchService.
8523
8683
  # Search API.
8524
8684
  class GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata
@@ -8607,6 +8767,31 @@ module Google
8607
8767
  end
8608
8768
  end
8609
8769
 
8770
+ # The structured content information.
8771
+ class GoogleCloudDiscoveryengineV1alphaChunkStructuredContent
8772
+ include Google::Apis::Core::Hashable
8773
+
8774
+ # Output only. The content of the structured content.
8775
+ # Corresponds to the JSON property `content`
8776
+ # @return [String]
8777
+ attr_accessor :content
8778
+
8779
+ # Output only. The structure type of the structured content.
8780
+ # Corresponds to the JSON property `structureType`
8781
+ # @return [String]
8782
+ attr_accessor :structure_type
8783
+
8784
+ def initialize(**args)
8785
+ update!(**args)
8786
+ end
8787
+
8788
+ # Update properties of this object
8789
+ def update!(**args)
8790
+ @content = args[:content] if args.key?(:content)
8791
+ @structure_type = args[:structure_type] if args.key?(:structure_type)
8792
+ end
8793
+ end
8794
+
8610
8795
  # Cloud SQL source import data from.
8611
8796
  class GoogleCloudDiscoveryengineV1alphaCloudSqlSource
8612
8797
  include Google::Apis::Core::Hashable
@@ -10103,8 +10288,10 @@ module Google
10103
10288
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig>]
10104
10289
  attr_accessor :alert_policy_configs
10105
10290
 
10106
- # Indicates whether the connector is disabled for auto run. It can be used to
10107
- # pause periodical and real time sync.
10291
+ # Optional. Indicates whether the connector is disabled for auto run. It can be
10292
+ # used to pause periodical and real time sync. Update: with the introduction of
10293
+ # incremental_sync_disabled, auto_run_disabled is used to pause/disable only
10294
+ # full syncs
10108
10295
  # Corresponds to the JSON property `autoRunDisabled`
10109
10296
  # @return [Boolean]
10110
10297
  attr_accessor :auto_run_disabled
@@ -10129,11 +10316,17 @@ module Google
10129
10316
 
10130
10317
  # Output only. The type of connector. Each source can only map to one type. For
10131
10318
  # example, salesforce, confluence and jira have THIRD_PARTY connector type. It
10132
- # is notmutable once set by system.
10319
+ # is not mutable once set by system.
10133
10320
  # Corresponds to the JSON property `connectorType`
10134
10321
  # @return [String]
10135
10322
  attr_accessor :connector_type
10136
10323
 
10324
+ # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
10325
+ # Corresponds to the JSON property `createEuaSaas`
10326
+ # @return [Boolean]
10327
+ attr_accessor :create_eua_saas
10328
+ alias_method :create_eua_saas?, :create_eua_saas
10329
+
10137
10330
  # Output only. Timestamp the DataConnector was created at.
10138
10331
  # Corresponds to the JSON property `createTime`
10139
10332
  # @return [String]
@@ -10178,6 +10371,20 @@ module Google
10178
10371
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig]
10179
10372
  attr_accessor :identity_schedule_config
10180
10373
 
10374
+ # Optional. The refresh interval specifically for incremental data syncs. If
10375
+ # unset, incremental syncs will use the default from env, set to 3hrs. The
10376
+ # minimum is 30 minutes and maximum is 7 days.
10377
+ # Corresponds to the JSON property `incrementalRefreshInterval`
10378
+ # @return [String]
10379
+ attr_accessor :incremental_refresh_interval
10380
+
10381
+ # Optional. Indicates whether incremental syncs are paused for this connector.
10382
+ # This is independent of auto_run_disabled.
10383
+ # Corresponds to the JSON property `incrementalSyncDisabled`
10384
+ # @return [Boolean]
10385
+ attr_accessor :incremental_sync_disabled
10386
+ alias_method :incremental_sync_disabled?, :incremental_sync_disabled
10387
+
10181
10388
  # Input only. The KMS key to be used to protect the DataStores managed by this
10182
10389
  # connector. Must be set for requests that need to comply with CMEK Org Policy
10183
10390
  # protections. If this field is set and processed successfully, the DataStores
@@ -10316,6 +10523,7 @@ module Google
10316
10523
  @blocking_reasons = args[:blocking_reasons] if args.key?(:blocking_reasons)
10317
10524
  @connector_modes = args[:connector_modes] if args.key?(:connector_modes)
10318
10525
  @connector_type = args[:connector_type] if args.key?(:connector_type)
10526
+ @create_eua_saas = args[:create_eua_saas] if args.key?(:create_eua_saas)
10319
10527
  @create_time = args[:create_time] if args.key?(:create_time)
10320
10528
  @data_source = args[:data_source] if args.key?(:data_source)
10321
10529
  @destination_configs = args[:destination_configs] if args.key?(:destination_configs)
@@ -10324,6 +10532,8 @@ module Google
10324
10532
  @errors = args[:errors] if args.key?(:errors)
10325
10533
  @identity_refresh_interval = args[:identity_refresh_interval] if args.key?(:identity_refresh_interval)
10326
10534
  @identity_schedule_config = args[:identity_schedule_config] if args.key?(:identity_schedule_config)
10535
+ @incremental_refresh_interval = args[:incremental_refresh_interval] if args.key?(:incremental_refresh_interval)
10536
+ @incremental_sync_disabled = args[:incremental_sync_disabled] if args.key?(:incremental_sync_disabled)
10327
10537
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
10328
10538
  @last_sync_time = args[:last_sync_time] if args.key?(:last_sync_time)
10329
10539
  @latest_pause_time = args[:latest_pause_time] if args.key?(:latest_pause_time)
@@ -10558,10 +10768,10 @@ module Google
10558
10768
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaLanguageInfo]
10559
10769
  attr_accessor :language_info
10560
10770
 
10561
- # Immutable. The full resource name of the data store. Format: `projects/`
10562
- # project`/locations/`location`/collections/`collection_id`/dataStores/`
10563
- # data_store_id``. This field must be a UTF-8 encoded string with a length limit
10564
- # of 1024 characters.
10771
+ # Immutable. Identifier. The full resource name of the data store. Format: `
10772
+ # projects/`project`/locations/`location`/collections/`collection_id`/dataStores/
10773
+ # `data_store_id``. This field must be a UTF-8 encoded string with a length
10774
+ # limit of 1024 characters.
10565
10775
  # Corresponds to the JSON property `name`
10566
10776
  # @return [String]
10567
10777
  attr_accessor :name
@@ -10678,7 +10888,8 @@ module Google
10678
10888
  class GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore
10679
10889
  include Google::Apis::Core::Hashable
10680
10890
 
10681
- # If set true, the DataStore will not be available for serving search requests.
10891
+ # Optional. If set true, the DataStore will not be available for serving search
10892
+ # requests.
10682
10893
  # Corresponds to the JSON property `disabledForServing`
10683
10894
  # @return [Boolean]
10684
10895
  attr_accessor :disabled_for_serving
@@ -11710,12 +11921,12 @@ module Google
11710
11921
  # @return [String]
11711
11922
  attr_accessor :create_time
11712
11923
 
11713
- # The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and
11714
- # SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at
11715
- # most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple
11716
- # DataStores in the same Collection can be associated here. Note that when used
11717
- # in CreateEngineRequest, one DataStore id must be provided as the system will
11718
- # use it for necessary initializations.
11924
+ # Optional. The data stores associated with this engine. For
11925
+ # SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they
11926
+ # can only associate with at most one data store. If solution_type is
11927
+ # SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be
11928
+ # associated here. Note that when used in CreateEngineRequest, one DataStore id
11929
+ # must be provided as the system will use it for necessary initializations.
11719
11930
  # Corresponds to the JSON property `dataStoreIds`
11720
11931
  # @return [Array<String>]
11721
11932
  attr_accessor :data_store_ids
@@ -11732,9 +11943,9 @@ module Google
11732
11943
  # @return [String]
11733
11944
  attr_accessor :display_name
11734
11945
 
11735
- # The industry vertical that the engine registers. The restriction of the Engine
11736
- # industry vertical is based on DataStore: Vertical on Engine has to match
11737
- # vertical of the DataStore linked to the engine.
11946
+ # Optional. The industry vertical that the engine registers. The restriction of
11947
+ # the Engine industry vertical is based on DataStore: Vertical on Engine has to
11948
+ # match vertical of the DataStore linked to the engine.
11738
11949
  # Corresponds to the JSON property `industryVertical`
11739
11950
  # @return [String]
11740
11951
  attr_accessor :industry_vertical
@@ -11744,11 +11955,11 @@ module Google
11744
11955
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig]
11745
11956
  attr_accessor :media_recommendation_engine_config
11746
11957
 
11747
- # Immutable. The fully qualified resource name of the engine. This field must be
11748
- # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
11749
- # projects/`project`/locations/`location`/collections/`collection`/engines/`
11750
- # engine`` engine should be 1-63 characters, and valid characters are /a-z0-9*/.
11751
- # Otherwise, an INVALID_ARGUMENT error is returned.
11958
+ # Immutable. Identifier. The fully qualified resource name of the engine. This
11959
+ # field must be a UTF-8 encoded string with a length limit of 1024 characters.
11960
+ # Format: `projects/`project`/locations/`location`/collections/`collection`/
11961
+ # engines/`engine`` engine should be 1-63 characters, and valid characters are /
11962
+ # a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
11752
11963
  # Corresponds to the JSON property `name`
11753
11964
  # @return [String]
11754
11965
  attr_accessor :name
@@ -14696,6 +14907,32 @@ module Google
14696
14907
  end
14697
14908
  end
14698
14909
 
14910
+ # Response message for UserLicenseService.ListUserLicenses.
14911
+ class GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse
14912
+ include Google::Apis::Core::Hashable
14913
+
14914
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
14915
+ # field is omitted, there are no subsequent pages.
14916
+ # Corresponds to the JSON property `nextPageToken`
14917
+ # @return [String]
14918
+ attr_accessor :next_page_token
14919
+
14920
+ # All the customer's UserLicenses.
14921
+ # Corresponds to the JSON property `userLicenses`
14922
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserLicense>]
14923
+ attr_accessor :user_licenses
14924
+
14925
+ def initialize(**args)
14926
+ update!(**args)
14927
+ end
14928
+
14929
+ # Update properties of this object
14930
+ def update!(**args)
14931
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
14932
+ @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
14933
+ end
14934
+ end
14935
+
14699
14936
  # Media-specific user event information.
14700
14937
  class GoogleCloudDiscoveryengineV1alphaMediaInfo
14701
14938
  include Google::Apis::Core::Hashable
@@ -17894,6 +18131,14 @@ module Google
17894
18131
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec]
17895
18132
  attr_accessor :boost_spec
17896
18133
 
18134
+ # Optional. Custom search operators which if specified will be used to filter
18135
+ # results from workspace data stores. For more information on custom search
18136
+ # operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/
18137
+ # 6172299).
18138
+ # Corresponds to the JSON property `customSearchOperators`
18139
+ # @return [String]
18140
+ attr_accessor :custom_search_operators
18141
+
17897
18142
  # Required. Full resource name of DataStore, such as `projects/`project`/
17898
18143
  # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
17899
18144
  # Corresponds to the JSON property `dataStore`
@@ -17914,6 +18159,7 @@ module Google
17914
18159
  # Update properties of this object
17915
18160
  def update!(**args)
17916
18161
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
18162
+ @custom_search_operators = args[:custom_search_operators] if args.key?(:custom_search_operators)
17917
18163
  @data_store = args[:data_store] if args.key?(:data_store)
17918
18164
  @filter = args[:filter] if args.key?(:filter)
17919
18165
  end
@@ -18626,12 +18872,6 @@ module Google
18626
18872
  # @return [String]
18627
18873
  attr_accessor :rewritten_query
18628
18874
 
18629
- # The SQL request that was generated from the natural language query
18630
- # understanding phase.
18631
- # Corresponds to the JSON property `sqlRequest`
18632
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest]
18633
- attr_accessor :sql_request
18634
-
18635
18875
  # The filters that were extracted from the input query represented in a
18636
18876
  # structured form.
18637
18877
  # Corresponds to the JSON property `structuredExtractedFilter`
@@ -18647,31 +18887,10 @@ module Google
18647
18887
  @classified_intents = args[:classified_intents] if args.key?(:classified_intents)
18648
18888
  @extracted_filters = args[:extracted_filters] if args.key?(:extracted_filters)
18649
18889
  @rewritten_query = args[:rewritten_query] if args.key?(:rewritten_query)
18650
- @sql_request = args[:sql_request] if args.key?(:sql_request)
18651
18890
  @structured_extracted_filter = args[:structured_extracted_filter] if args.key?(:structured_extracted_filter)
18652
18891
  end
18653
18892
  end
18654
18893
 
18655
- # The SQL request that was generated from the natural language query
18656
- # understanding phase.
18657
- class GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest
18658
- include Google::Apis::Core::Hashable
18659
-
18660
- # Optional. The SQL query in text format.
18661
- # Corresponds to the JSON property `sqlQuery`
18662
- # @return [String]
18663
- attr_accessor :sql_query
18664
-
18665
- def initialize(**args)
18666
- update!(**args)
18667
- end
18668
-
18669
- # Update properties of this object
18670
- def update!(**args)
18671
- @sql_query = args[:sql_query] if args.key?(:sql_query)
18672
- end
18673
- end
18674
-
18675
18894
  # The filters that were extracted from the input query represented in a
18676
18895
  # structured form.
18677
18896
  class GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter
@@ -20996,6 +21215,79 @@ module Google
20996
21215
  end
20997
21216
  end
20998
21217
 
21218
+ # User License information assigned by the admin.
21219
+ class GoogleCloudDiscoveryengineV1alphaUserLicense
21220
+ include Google::Apis::Core::Hashable
21221
+
21222
+ # Output only. User created timestamp.
21223
+ # Corresponds to the JSON property `createTime`
21224
+ # @return [String]
21225
+ attr_accessor :create_time
21226
+
21227
+ # Output only. User last logged in time. If the user has not logged in yet, this
21228
+ # field will be empty.
21229
+ # Corresponds to the JSON property `lastLoginTime`
21230
+ # @return [String]
21231
+ attr_accessor :last_login_time
21232
+
21233
+ # Output only. License assignment state of the user. If the user is assigned
21234
+ # with a license config, the user loggin will be assigned with the license; If
21235
+ # the user's license assignment state is unassigned or unspecified, no license
21236
+ # config will be associated to the user;
21237
+ # Corresponds to the JSON property `licenseAssignmentState`
21238
+ # @return [String]
21239
+ attr_accessor :license_assignment_state
21240
+
21241
+ # Optional. The full resource name of the Subscription(LicenseConfig) assigned
21242
+ # to the user.
21243
+ # Corresponds to the JSON property `licenseConfig`
21244
+ # @return [String]
21245
+ attr_accessor :license_config
21246
+
21247
+ # Output only. User update timestamp.
21248
+ # Corresponds to the JSON property `updateTime`
21249
+ # @return [String]
21250
+ attr_accessor :update_time
21251
+
21252
+ # Optional. The full resource name of the User, in the format of `projects/`
21253
+ # project`/locations/`location`/userStores/`user_store`/users/`user_id``. This
21254
+ # field must be a UTF-8 encoded string with a length limit of 2048 characters.
21255
+ # If the user field is empty, it's indicating the user has not logged in yet and
21256
+ # no User entity is created.
21257
+ # Corresponds to the JSON property `user`
21258
+ # @return [String]
21259
+ attr_accessor :user
21260
+
21261
+ # Required. Immutable. The user principal of the User, could be email address or
21262
+ # other prinical identifier. This field is immutable. Admin assign licenses
21263
+ # based on the user principal.
21264
+ # Corresponds to the JSON property `userPrincipal`
21265
+ # @return [String]
21266
+ attr_accessor :user_principal
21267
+
21268
+ # Optional. The user profile. We user user full name(First name + Last name) as
21269
+ # user profile.
21270
+ # Corresponds to the JSON property `userProfile`
21271
+ # @return [String]
21272
+ attr_accessor :user_profile
21273
+
21274
+ def initialize(**args)
21275
+ update!(**args)
21276
+ end
21277
+
21278
+ # Update properties of this object
21279
+ def update!(**args)
21280
+ @create_time = args[:create_time] if args.key?(:create_time)
21281
+ @last_login_time = args[:last_login_time] if args.key?(:last_login_time)
21282
+ @license_assignment_state = args[:license_assignment_state] if args.key?(:license_assignment_state)
21283
+ @license_config = args[:license_config] if args.key?(:license_config)
21284
+ @update_time = args[:update_time] if args.key?(:update_time)
21285
+ @user = args[:user] if args.key?(:user)
21286
+ @user_principal = args[:user_principal] if args.key?(:user_principal)
21287
+ @user_profile = args[:user_profile] if args.key?(:user_profile)
21288
+ end
21289
+ end
21290
+
20999
21291
  # WidgetConfig captures configs at the Widget level.
21000
21292
  class GoogleCloudDiscoveryengineV1alphaWidgetConfig
21001
21293
  include Google::Apis::Core::Hashable
@@ -21089,6 +21381,12 @@ module Google
21089
21381
  attr_accessor :enable_conversational_search
21090
21382
  alias_method :enable_conversational_search?, :enable_conversational_search
21091
21383
 
21384
+ # Optional. Output only. Whether to enable private knowledge graph.
21385
+ # Corresponds to the JSON property `enablePrivateKnowledgeGraph`
21386
+ # @return [Boolean]
21387
+ attr_accessor :enable_private_knowledge_graph
21388
+ alias_method :enable_private_knowledge_graph?, :enable_private_knowledge_graph
21389
+
21092
21390
  # Turn on or off collecting the search result quality feedback from end users.
21093
21391
  # Corresponds to the JSON property `enableQualityFeedback`
21094
21392
  # @return [Boolean]
@@ -21232,6 +21530,7 @@ module Google
21232
21530
  @display_name = args[:display_name] if args.key?(:display_name)
21233
21531
  @enable_autocomplete = args[:enable_autocomplete] if args.key?(:enable_autocomplete)
21234
21532
  @enable_conversational_search = args[:enable_conversational_search] if args.key?(:enable_conversational_search)
21533
+ @enable_private_knowledge_graph = args[:enable_private_knowledge_graph] if args.key?(:enable_private_knowledge_graph)
21235
21534
  @enable_quality_feedback = args[:enable_quality_feedback] if args.key?(:enable_quality_feedback)
21236
21535
  @enable_result_score = args[:enable_result_score] if args.key?(:enable_result_score)
21237
21536
  @enable_safe_search = args[:enable_safe_search] if args.key?(:enable_safe_search)
@@ -22707,10 +23006,10 @@ module Google
22707
23006
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaLanguageInfo]
22708
23007
  attr_accessor :language_info
22709
23008
 
22710
- # Immutable. The full resource name of the data store. Format: `projects/`
22711
- # project`/locations/`location`/collections/`collection_id`/dataStores/`
22712
- # data_store_id``. This field must be a UTF-8 encoded string with a length limit
22713
- # of 1024 characters.
23009
+ # Immutable. Identifier. The full resource name of the data store. Format: `
23010
+ # projects/`project`/locations/`location`/collections/`collection_id`/dataStores/
23011
+ # `data_store_id``. This field must be a UTF-8 encoded string with a length
23012
+ # limit of 1024 characters.
22714
23013
  # Corresponds to the JSON property `name`
22715
23014
  # @return [String]
22716
23015
  attr_accessor :name
@@ -22826,7 +23125,8 @@ module Google
22826
23125
  class GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore
22827
23126
  include Google::Apis::Core::Hashable
22828
23127
 
22829
- # If set true, the DataStore will not be available for serving search requests.
23128
+ # Optional. If set true, the DataStore will not be available for serving search
23129
+ # requests.
22830
23130
  # Corresponds to the JSON property `disabledForServing`
22831
23131
  # @return [Boolean]
22832
23132
  attr_accessor :disabled_for_serving
@@ -23368,12 +23668,12 @@ module Google
23368
23668
  # @return [String]
23369
23669
  attr_accessor :create_time
23370
23670
 
23371
- # The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and
23372
- # SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at
23373
- # most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple
23374
- # DataStores in the same Collection can be associated here. Note that when used
23375
- # in CreateEngineRequest, one DataStore id must be provided as the system will
23376
- # use it for necessary initializations.
23671
+ # Optional. The data stores associated with this engine. For
23672
+ # SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they
23673
+ # can only associate with at most one data store. If solution_type is
23674
+ # SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be
23675
+ # associated here. Note that when used in CreateEngineRequest, one DataStore id
23676
+ # must be provided as the system will use it for necessary initializations.
23377
23677
  # Corresponds to the JSON property `dataStoreIds`
23378
23678
  # @return [Array<String>]
23379
23679
  attr_accessor :data_store_ids
@@ -23390,9 +23690,9 @@ module Google
23390
23690
  # @return [String]
23391
23691
  attr_accessor :display_name
23392
23692
 
23393
- # The industry vertical that the engine registers. The restriction of the Engine
23394
- # industry vertical is based on DataStore: Vertical on Engine has to match
23395
- # vertical of the DataStore linked to the engine.
23693
+ # Optional. The industry vertical that the engine registers. The restriction of
23694
+ # the Engine industry vertical is based on DataStore: Vertical on Engine has to
23695
+ # match vertical of the DataStore linked to the engine.
23396
23696
  # Corresponds to the JSON property `industryVertical`
23397
23697
  # @return [String]
23398
23698
  attr_accessor :industry_vertical
@@ -23402,11 +23702,11 @@ module Google
23402
23702
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig]
23403
23703
  attr_accessor :media_recommendation_engine_config
23404
23704
 
23405
- # Immutable. The fully qualified resource name of the engine. This field must be
23406
- # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
23407
- # projects/`project`/locations/`location`/collections/`collection`/engines/`
23408
- # engine`` engine should be 1-63 characters, and valid characters are /a-z0-9*/.
23409
- # Otherwise, an INVALID_ARGUMENT error is returned.
23705
+ # Immutable. Identifier. The fully qualified resource name of the engine. This
23706
+ # field must be a UTF-8 encoded string with a length limit of 1024 characters.
23707
+ # Format: `projects/`project`/locations/`location`/collections/`collection`/
23708
+ # engines/`engine`` engine should be 1-63 characters, and valid characters are /
23709
+ # a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
23410
23710
  # Corresponds to the JSON property `name`
23411
23711
  # @return [String]
23412
23712
  attr_accessor :name
@@ -25836,6 +26136,14 @@ module Google
25836
26136
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec]
25837
26137
  attr_accessor :boost_spec
25838
26138
 
26139
+ # Optional. Custom search operators which if specified will be used to filter
26140
+ # results from workspace data stores. For more information on custom search
26141
+ # operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/
26142
+ # 6172299).
26143
+ # Corresponds to the JSON property `customSearchOperators`
26144
+ # @return [String]
26145
+ attr_accessor :custom_search_operators
26146
+
25839
26147
  # Required. Full resource name of DataStore, such as `projects/`project`/
25840
26148
  # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
25841
26149
  # Corresponds to the JSON property `dataStore`
@@ -25856,6 +26164,7 @@ module Google
25856
26164
  # Update properties of this object
25857
26165
  def update!(**args)
25858
26166
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
26167
+ @custom_search_operators = args[:custom_search_operators] if args.key?(:custom_search_operators)
25859
26168
  @data_store = args[:data_store] if args.key?(:data_store)
25860
26169
  @filter = args[:filter] if args.key?(:filter)
25861
26170
  end
@@ -26814,6 +27123,12 @@ module Google
26814
27123
  # @return [Google::Apis::DiscoveryengineV1alpha::ApiservingMediaRequestInfo]
26815
27124
  attr_accessor :media_request_info
26816
27125
 
27126
+ # The source id of the associated file. If not set, a source id will be
27127
+ # generated and a new tentative source will be created.
27128
+ # Corresponds to the JSON property `sourceId`
27129
+ # @return [String]
27130
+ attr_accessor :source_id
27131
+
26817
27132
  def initialize(**args)
26818
27133
  update!(**args)
26819
27134
  end
@@ -26822,6 +27137,7 @@ module Google
26822
27137
  def update!(**args)
26823
27138
  @blob = args[:blob] if args.key?(:blob)
26824
27139
  @media_request_info = args[:media_request_info] if args.key?(:media_request_info)
27140
+ @source_id = args[:source_id] if args.key?(:source_id)
26825
27141
  end
26826
27142
  end
26827
27143