google-apis-discoveryengine_v1alpha 0.44.0 → 0.46.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.
@@ -1507,6 +1507,11 @@ module Google
1507
1507
  # @return [String]
1508
1508
  attr_accessor :provided_uri_pattern
1509
1509
 
1510
+ # Output only. Root domain of the provided_uri_pattern.
1511
+ # Corresponds to the JSON property `rootDomainUri`
1512
+ # @return [String]
1513
+ attr_accessor :root_domain_uri
1514
+
1510
1515
  # Verification information for target sites in advanced site search.
1511
1516
  # Corresponds to the JSON property `siteVerificationInfo`
1512
1517
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1SiteVerificationInfo]
@@ -1535,6 +1540,7 @@ module Google
1535
1540
  @indexing_status = args[:indexing_status] if args.key?(:indexing_status)
1536
1541
  @name = args[:name] if args.key?(:name)
1537
1542
  @provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
1543
+ @root_domain_uri = args[:root_domain_uri] if args.key?(:root_domain_uri)
1538
1544
  @site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
1539
1545
  @type = args[:type] if args.key?(:type)
1540
1546
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -1661,26 +1667,6 @@ module Google
1661
1667
  end
1662
1668
  end
1663
1669
 
1664
- # AdditionalParams message for WidgetService methods for security and privacy
1665
- # enhancement.
1666
- class GoogleCloudDiscoveryengineV1alphaAdditionalParams
1667
- include Google::Apis::Core::Hashable
1668
-
1669
- # Token that used for non-human user check.
1670
- # Corresponds to the JSON property `token`
1671
- # @return [String]
1672
- attr_accessor :token
1673
-
1674
- def initialize(**args)
1675
- update!(**args)
1676
- end
1677
-
1678
- # Update properties of this object
1679
- def update!(**args)
1680
- @token = args[:token] if args.key?(:token)
1681
- end
1682
- end
1683
-
1684
1670
  # Defines an answer.
1685
1671
  class GoogleCloudDiscoveryengineV1alphaAnswer
1686
1672
  include Google::Apis::Core::Hashable
@@ -3147,7 +3133,7 @@ module Google
3147
3133
  class GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest
3148
3134
  include Google::Apis::Core::Hashable
3149
3135
 
3150
- # Answer candidate to check.
3136
+ # Answer candidate to check. Can have a maximum length of 1024 characters.
3151
3137
  # Corresponds to the JSON property `answerCandidate`
3152
3138
  # @return [String]
3153
3139
  attr_accessor :answer_candidate
@@ -3162,6 +3148,21 @@ module Google
3162
3148
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec]
3163
3149
  attr_accessor :grounding_spec
3164
3150
 
3151
+ # The user labels applied to a resource must meet the following requirements: *
3152
+ # Each resource can have multiple labels, up to a maximum of 64. * Each label
3153
+ # must be a key-value pair. * Keys have a minimum length of 1 character and a
3154
+ # maximum length of 63 characters and cannot be empty. Values can be empty and
3155
+ # have a maximum length of 63 characters. * Keys and values can contain only
3156
+ # lowercase letters, numeric characters, underscores, and dashes. All characters
3157
+ # must use UTF-8 encoding, and international characters are allowed. * The key
3158
+ # portion of a label must be unique. However, you can use the same key with
3159
+ # multiple resources. * Keys must start with a lowercase letter or international
3160
+ # character. See [Google Cloud Document](https://cloud.google.com/resource-
3161
+ # manager/docs/creating-managing-labels#requirements) for more details.
3162
+ # Corresponds to the JSON property `userLabels`
3163
+ # @return [Hash<String,String>]
3164
+ attr_accessor :user_labels
3165
+
3165
3166
  def initialize(**args)
3166
3167
  update!(**args)
3167
3168
  end
@@ -3171,6 +3172,7 @@ module Google
3171
3172
  @answer_candidate = args[:answer_candidate] if args.key?(:answer_candidate)
3172
3173
  @facts = args[:facts] if args.key?(:facts)
3173
3174
  @grounding_spec = args[:grounding_spec] if args.key?(:grounding_spec)
3175
+ @user_labels = args[:user_labels] if args.key?(:user_labels)
3174
3176
  end
3175
3177
  end
3176
3178
 
@@ -3231,6 +3233,15 @@ module Google
3231
3233
  # @return [Fixnum]
3232
3234
  attr_accessor :end_pos
3233
3235
 
3236
+ # Indicates that this claim required grounding check. When the system decided
3237
+ # this claim doesn't require attribution/grounding check, this field will be set
3238
+ # to false. In that case, no grounding check was done for the claim and
3239
+ # therefore citation_indices, and anti_citation_indices should not be returned.
3240
+ # Corresponds to the JSON property `groundingCheckRequired`
3241
+ # @return [Boolean]
3242
+ attr_accessor :grounding_check_required
3243
+ alias_method :grounding_check_required?, :grounding_check_required
3244
+
3234
3245
  # Position indicating the start of the claim in the answer candidate, measured
3235
3246
  # in bytes.
3236
3247
  # Corresponds to the JSON property `startPos`
@@ -3246,6 +3257,7 @@ module Google
3246
3257
  @citation_indices = args[:citation_indices] if args.key?(:citation_indices)
3247
3258
  @claim_text = args[:claim_text] if args.key?(:claim_text)
3248
3259
  @end_pos = args[:end_pos] if args.key?(:end_pos)
3260
+ @grounding_check_required = args[:grounding_check_required] if args.key?(:grounding_check_required)
3249
3261
  @start_pos = args[:start_pos] if args.key?(:start_pos)
3250
3262
  end
3251
3263
  end
@@ -3319,6 +3331,13 @@ module Google
3319
3331
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkPageSpan]
3320
3332
  attr_accessor :page_span
3321
3333
 
3334
+ # Represents the relevance score based on similarity. Higher score represents
3335
+ # the chunk relevance. The score is in range [0.0, 1.0]. Only populated on
3336
+ # SearchService.SearchResponse
3337
+ # Corresponds to the JSON property `relevanceScore`
3338
+ # @return [Float]
3339
+ attr_accessor :relevance_score
3340
+
3322
3341
  def initialize(**args)
3323
3342
  update!(**args)
3324
3343
  end
@@ -3332,6 +3351,7 @@ module Google
3332
3351
  @id = args[:id] if args.key?(:id)
3333
3352
  @name = args[:name] if args.key?(:name)
3334
3353
  @page_span = args[:page_span] if args.key?(:page_span)
3354
+ @relevance_score = args[:relevance_score] if args.key?(:relevance_score)
3335
3355
  end
3336
3356
  end
3337
3357
 
@@ -3482,71 +3502,6 @@ module Google
3482
3502
  end
3483
3503
  end
3484
3504
 
3485
- # Request message for CompletionService.CompleteQuery method.
3486
- class GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest
3487
- include Google::Apis::Core::Hashable
3488
-
3489
- # Required. The parent data store resource name for which the completion is
3490
- # performed, such as `projects/*/locations/global/collections/default_collection/
3491
- # dataStores/default_data_store`.
3492
- # Corresponds to the JSON property `dataStore`
3493
- # @return [String]
3494
- attr_accessor :data_store
3495
-
3496
- # Indicates if tail suggestions should be returned if there are no suggestions
3497
- # that match the full query. Even if set to true, if there are suggestions that
3498
- # match the full query, those are returned and no tail suggestions are returned.
3499
- # Corresponds to the JSON property `includeTailSuggestions`
3500
- # @return [Boolean]
3501
- attr_accessor :include_tail_suggestions
3502
- alias_method :include_tail_suggestions?, :include_tail_suggestions
3503
-
3504
- # Required. The typeahead input used to fetch suggestions. Maximum length is 128
3505
- # characters.
3506
- # Corresponds to the JSON property `query`
3507
- # @return [String]
3508
- attr_accessor :query
3509
-
3510
- # Specifies the autocomplete data model. This overrides any model specified in
3511
- # the Configuration > Autocomplete section of the Cloud console. Currently
3512
- # supported values: * `document` - Using suggestions generated from user-
3513
- # imported documents. * `search-history` - Using suggestions generated from the
3514
- # past history of SearchService.Search API calls. Do not use it when there is no
3515
- # traffic for Search API. * `user-event` - Using suggestions generated from user-
3516
- # imported search events. * `document-completable` - Using suggestions taken
3517
- # directly from user-imported document fields marked as completable. Default
3518
- # values: * `document` is the default model for regular dataStores. * `search-
3519
- # history` is the default model for site search dataStores.
3520
- # Corresponds to the JSON property `queryModel`
3521
- # @return [String]
3522
- attr_accessor :query_model
3523
-
3524
- # A unique identifier for tracking visitors. For example, this could be
3525
- # implemented with an HTTP cookie, which should be able to uniquely identify a
3526
- # visitor on a single device. This unique identifier should not change if the
3527
- # visitor logs in or out of the website. This field should NOT have a fixed
3528
- # value such as `unknown_visitor`. This should be the same identifier as
3529
- # UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a
3530
- # UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `
3531
- # INVALID_ARGUMENT` error is returned.
3532
- # Corresponds to the JSON property `userPseudoId`
3533
- # @return [String]
3534
- attr_accessor :user_pseudo_id
3535
-
3536
- def initialize(**args)
3537
- update!(**args)
3538
- end
3539
-
3540
- # Update properties of this object
3541
- def update!(**args)
3542
- @data_store = args[:data_store] if args.key?(:data_store)
3543
- @include_tail_suggestions = args[:include_tail_suggestions] if args.key?(:include_tail_suggestions)
3544
- @query = args[:query] if args.key?(:query)
3545
- @query_model = args[:query_model] if args.key?(:query_model)
3546
- @user_pseudo_id = args[:user_pseudo_id] if args.key?(:user_pseudo_id)
3547
- end
3548
- end
3549
-
3550
3505
  # Response message for CompletionService.CompleteQuery method.
3551
3506
  class GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse
3552
3507
  include Google::Apis::Core::Hashable
@@ -3769,16 +3724,6 @@ module Google
3769
3724
  # @return [String]
3770
3725
  attr_accessor :filter
3771
3726
 
3772
- # Required. The resource name of the Conversation to get. Format: `projects/`
3773
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
3774
- # data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
3775
- # /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
3776
- # conversations/-` to activate auto session mode, which automatically creates a
3777
- # new conversation inside a ConverseConversation session.
3778
- # Corresponds to the JSON property `name`
3779
- # @return [String]
3780
- attr_accessor :name
3781
-
3782
3727
  # Defines text input.
3783
3728
  # Corresponds to the JSON property `query`
3784
3729
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTextInput]
@@ -3827,7 +3772,6 @@ module Google
3827
3772
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
3828
3773
  @conversation = args[:conversation] if args.key?(:conversation)
3829
3774
  @filter = args[:filter] if args.key?(:filter)
3830
- @name = args[:name] if args.key?(:name)
3831
3775
  @query = args[:query] if args.key?(:query)
3832
3776
  @safe_search = args[:safe_search] if args.key?(:safe_search)
3833
3777
  @serving_config = args[:serving_config] if args.key?(:serving_config)
@@ -4062,6 +4006,58 @@ module Google
4062
4006
  end
4063
4007
  end
4064
4008
 
4009
+ # Metadata that describes a custom tuned model.
4010
+ class GoogleCloudDiscoveryengineV1alphaCustomTuningModel
4011
+ include Google::Apis::Core::Hashable
4012
+
4013
+ # Timestamp the Model was created at.
4014
+ # Corresponds to the JSON property `createTime`
4015
+ # @return [String]
4016
+ attr_accessor :create_time
4017
+
4018
+ # The display name of the model.
4019
+ # Corresponds to the JSON property `displayName`
4020
+ # @return [String]
4021
+ attr_accessor :display_name
4022
+
4023
+ # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
4024
+ # Corresponds to the JSON property `modelState`
4025
+ # @return [String]
4026
+ attr_accessor :model_state
4027
+
4028
+ #
4029
+ # Corresponds to the JSON property `modelVersion`
4030
+ # @return [Fixnum]
4031
+ attr_accessor :model_version
4032
+
4033
+ # Required. The fully qualified resource name of the model. Format: `projects/`
4034
+ # project_number`/locations/`location`/collections/`collection`/dataStores/`
4035
+ # data_store`/customTuningModels/`custom_tuning_model`` model must be an alpha-
4036
+ # numerical string with limit of 40 characters.
4037
+ # Corresponds to the JSON property `name`
4038
+ # @return [String]
4039
+ attr_accessor :name
4040
+
4041
+ # Timestamp the model training was initiated.
4042
+ # Corresponds to the JSON property `trainingStartTime`
4043
+ # @return [String]
4044
+ attr_accessor :training_start_time
4045
+
4046
+ def initialize(**args)
4047
+ update!(**args)
4048
+ end
4049
+
4050
+ # Update properties of this object
4051
+ def update!(**args)
4052
+ @create_time = args[:create_time] if args.key?(:create_time)
4053
+ @display_name = args[:display_name] if args.key?(:display_name)
4054
+ @model_state = args[:model_state] if args.key?(:model_state)
4055
+ @model_version = args[:model_version] if args.key?(:model_version)
4056
+ @name = args[:name] if args.key?(:name)
4057
+ @training_start_time = args[:training_start_time] if args.key?(:training_start_time)
4058
+ end
4059
+ end
4060
+
4065
4061
  # DataStore captures global settings and configs at the DataStore level.
4066
4062
  class GoogleCloudDiscoveryengineV1alphaDataStore
4067
4063
  include Google::Apis::Core::Hashable
@@ -5373,6 +5369,11 @@ module Google
5373
5369
  # @return [String]
5374
5370
  attr_accessor :chunk_text
5375
5371
 
5372
+ # The index of this chunk. Currently, only used for the streaming mode.
5373
+ # Corresponds to the JSON property `index`
5374
+ # @return [Fixnum]
5375
+ attr_accessor :index
5376
+
5376
5377
  # Source from which this fact chunk was retrieved. If it was retrieved from the
5377
5378
  # GroundingFacts provided in the request then this field will contain the index
5378
5379
  # of the specific fact from which this chunk was retrieved.
@@ -5392,6 +5393,7 @@ module Google
5392
5393
  # Update properties of this object
5393
5394
  def update!(**args)
5394
5395
  @chunk_text = args[:chunk_text] if args.key?(:chunk_text)
5396
+ @index = args[:index] if args.key?(:index)
5395
5397
  @source = args[:source] if args.key?(:source)
5396
5398
  @source_metadata = args[:source_metadata] if args.key?(:source_metadata)
5397
5399
  end
@@ -6332,6 +6334,25 @@ module Google
6332
6334
  end
6333
6335
  end
6334
6336
 
6337
+ # Response message for SearchTuningService.ListCustomModels method.
6338
+ class GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse
6339
+ include Google::Apis::Core::Hashable
6340
+
6341
+ # List of custom tuning models.
6342
+ # Corresponds to the JSON property `models`
6343
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomTuningModel>]
6344
+ attr_accessor :models
6345
+
6346
+ def initialize(**args)
6347
+ update!(**args)
6348
+ end
6349
+
6350
+ # Update properties of this object
6351
+ def update!(**args)
6352
+ @models = args[:models] if args.key?(:models)
6353
+ end
6354
+ end
6355
+
6335
6356
  # Response message for DataStoreService.ListDataStores method.
6336
6357
  class GoogleCloudDiscoveryengineV1alphaListDataStoresResponse
6337
6358
  include Google::Apis::Core::Hashable
@@ -6518,44 +6539,6 @@ module Google
6518
6539
  end
6519
6540
  end
6520
6541
 
6521
- # Request message for WidgetService.LookupWidgetConfig method.
6522
- class GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest
6523
- include Google::Apis::Core::Hashable
6524
-
6525
- # Required. The UUID of the Widget Config.
6526
- # Corresponds to the JSON property `widgetConfigId`
6527
- # @return [String]
6528
- attr_accessor :widget_config_id
6529
-
6530
- def initialize(**args)
6531
- update!(**args)
6532
- end
6533
-
6534
- # Update properties of this object
6535
- def update!(**args)
6536
- @widget_config_id = args[:widget_config_id] if args.key?(:widget_config_id)
6537
- end
6538
- end
6539
-
6540
- # Response message for WidgetService.LookupWidgetConfig method.
6541
- class GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse
6542
- include Google::Apis::Core::Hashable
6543
-
6544
- # WidgetConfig captures configs at the Widget level.
6545
- # Corresponds to the JSON property `anonymousWidgetConfig`
6546
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig]
6547
- attr_accessor :anonymous_widget_config
6548
-
6549
- def initialize(**args)
6550
- update!(**args)
6551
- end
6552
-
6553
- # Update properties of this object
6554
- def update!(**args)
6555
- @anonymous_widget_config = args[:anonymous_widget_config] if args.key?(:anonymous_widget_config)
6556
- end
6557
- end
6558
-
6559
6542
  # Media-specific user event information.
6560
6543
  class GoogleCloudDiscoveryengineV1alphaMediaInfo
6561
6544
  include Google::Apis::Core::Hashable
@@ -7931,9 +7914,9 @@ module Google
7931
7914
 
7932
7915
  # The order in which documents are returned. Documents can be ordered by a field
7933
7916
  # in an Document object. Leave it unset if ordered by relevance. `order_by`
7934
- # expression is case-sensitive. For more information on ordering, see [Ordering](
7935
- # https://cloud.google.com/retail/docs/filter-and-order#order) If this field is
7936
- # unrecognizable, an `INVALID_ARGUMENT` is returned.
7917
+ # expression is case-sensitive. For more information on ordering for retail
7918
+ # search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#
7919
+ # order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
7937
7920
  # Corresponds to the JSON property `orderBy`
7938
7921
  # @return [String]
7939
7922
  attr_accessor :order_by
@@ -7998,16 +7981,6 @@ module Google
7998
7981
  attr_accessor :safe_search
7999
7982
  alias_method :safe_search?, :safe_search
8000
7983
 
8001
- # Required. The resource name of the Search serving config, such as `projects/*/
8002
- # locations/global/collections/default_collection/engines/*/servingConfigs/
8003
- # default_serving_config`, or `projects/*/locations/global/collections/
8004
- # default_collection/dataStores/default_data_store/servingConfigs/
8005
- # default_serving_config`. This field is used to identify the serving
8006
- # configuration name, set of models used to make the search.
8007
- # Corresponds to the JSON property `servingConfig`
8008
- # @return [String]
8009
- attr_accessor :serving_config
8010
-
8011
7984
  # The specification for query spell correction.
8012
7985
  # Corresponds to the JSON property `spellCorrectionSpec`
8013
7986
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec]
@@ -8070,7 +8043,6 @@ module Google
8070
8043
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
8071
8044
  @ranking_expression = args[:ranking_expression] if args.key?(:ranking_expression)
8072
8045
  @safe_search = args[:safe_search] if args.key?(:safe_search)
8073
- @serving_config = args[:serving_config] if args.key?(:serving_config)
8074
8046
  @spell_correction_spec = args[:spell_correction_spec] if args.key?(:spell_correction_spec)
8075
8047
  @user_info = args[:user_info] if args.key?(:user_info)
8076
8048
  @user_labels = args[:user_labels] if args.key?(:user_labels)
@@ -9866,6 +9838,11 @@ module Google
9866
9838
  # @return [String]
9867
9839
  attr_accessor :provided_uri_pattern
9868
9840
 
9841
+ # Output only. Root domain of the provided_uri_pattern.
9842
+ # Corresponds to the JSON property `rootDomainUri`
9843
+ # @return [String]
9844
+ attr_accessor :root_domain_uri
9845
+
9869
9846
  # Verification information for target sites in advanced site search.
9870
9847
  # Corresponds to the JSON property `siteVerificationInfo`
9871
9848
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo]
@@ -9894,6 +9871,7 @@ module Google
9894
9871
  @indexing_status = args[:indexing_status] if args.key?(:indexing_status)
9895
9872
  @name = args[:name] if args.key?(:name)
9896
9873
  @provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
9874
+ @root_domain_uri = args[:root_domain_uri] if args.key?(:root_domain_uri)
9897
9875
  @site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
9898
9876
  @type = args[:type] if args.key?(:type)
9899
9877
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -10005,6 +9983,11 @@ module Google
10005
9983
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput]
10006
9984
  attr_accessor :gcs_training_input
10007
9985
 
9986
+ # If not provided, a UUID will be generated.
9987
+ # Corresponds to the JSON property `modelId`
9988
+ # @return [String]
9989
+ attr_accessor :model_id
9990
+
10008
9991
  # Model to be trained. Supported values are: * **search-tuning**: Fine tuning
10009
9992
  # the search system based on data provided.
10010
9993
  # Corresponds to the JSON property `modelType`
@@ -10019,6 +10002,7 @@ module Google
10019
10002
  def update!(**args)
10020
10003
  @error_config = args[:error_config] if args.key?(:error_config)
10021
10004
  @gcs_training_input = args[:gcs_training_input] if args.key?(:gcs_training_input)
10005
+ @model_id = args[:model_id] if args.key?(:model_id)
10022
10006
  @model_type = args[:model_type] if args.key?(:model_type)
10023
10007
  end
10024
10008
  end
@@ -10092,6 +10076,11 @@ module Google
10092
10076
  # @return [Hash<String,Float>]
10093
10077
  attr_accessor :metrics
10094
10078
 
10079
+ # Fully qualified name of the CustomTuningModel.
10080
+ # Corresponds to the JSON property `modelName`
10081
+ # @return [String]
10082
+ attr_accessor :model_name
10083
+
10095
10084
  # The trained model status. Possible values are: * **bad-data**: The training
10096
10085
  # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
10097
10086
  # Won't deploy. * **in-progress**: Model training job creation is in progress. *
@@ -10111,6 +10100,7 @@ module Google
10111
10100
  @error_config = args[:error_config] if args.key?(:error_config)
10112
10101
  @error_samples = args[:error_samples] if args.key?(:error_samples)
10113
10102
  @metrics = args[:metrics] if args.key?(:metrics)
10103
+ @model_name = args[:model_name] if args.key?(:model_name)
10114
10104
  @model_status = args[:model_status] if args.key?(:model_status)
10115
10105
  end
10116
10106
  end
@@ -10506,26 +10496,22 @@ module Google
10506
10496
  end
10507
10497
  end
10508
10498
 
10509
- # Request message for WidgetService.WidgetCompleteQuery method.
10510
- class GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest
10499
+ # Metadata related to the progress of the SiteSearchEngineService.
10500
+ # BatchCreateTargetSites operation. This will be returned by the google.
10501
+ # longrunning.Operation.metadata field.
10502
+ class GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata
10511
10503
  include Google::Apis::Core::Hashable
10512
10504
 
10513
- # AdditionalParams message for WidgetService methods for security and privacy
10514
- # enhancement.
10515
- # Corresponds to the JSON property `additionalParams`
10516
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdditionalParams]
10517
- attr_accessor :additional_params
10518
-
10519
- # Request message for CompletionService.CompleteQuery method.
10520
- # Corresponds to the JSON property `completeQueryRequest`
10521
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest]
10522
- attr_accessor :complete_query_request
10505
+ # Operation create time.
10506
+ # Corresponds to the JSON property `createTime`
10507
+ # @return [String]
10508
+ attr_accessor :create_time
10523
10509
 
10524
- # Required. The UUID of the WidgetConfig. This field is used to identify the
10525
- # widget configuration, set of models used to make the auto complete query.
10526
- # Corresponds to the JSON property `configId`
10510
+ # Operation last update time. If the operation is done, this is also the finish
10511
+ # time.
10512
+ # Corresponds to the JSON property `updateTime`
10527
10513
  # @return [String]
10528
- attr_accessor :config_id
10514
+ attr_accessor :update_time
10529
10515
 
10530
10516
  def initialize(**args)
10531
10517
  update!(**args)
@@ -10533,26 +10519,19 @@ module Google
10533
10519
 
10534
10520
  # Update properties of this object
10535
10521
  def update!(**args)
10536
- @additional_params = args[:additional_params] if args.key?(:additional_params)
10537
- @complete_query_request = args[:complete_query_request] if args.key?(:complete_query_request)
10538
- @config_id = args[:config_id] if args.key?(:config_id)
10522
+ @create_time = args[:create_time] if args.key?(:create_time)
10523
+ @update_time = args[:update_time] if args.key?(:update_time)
10539
10524
  end
10540
10525
  end
10541
10526
 
10542
- # Response message for WidgetService.WidgetCompleteQuery method.
10543
- class GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse
10527
+ # Response message for SiteSearchEngineService.BatchCreateTargetSites method.
10528
+ class GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse
10544
10529
  include Google::Apis::Core::Hashable
10545
10530
 
10546
- # The token in response.
10547
- # Corresponds to the JSON property `uToken`
10548
- # @return [String]
10549
- attr_accessor :u_token
10550
-
10551
- # Results of the matched query suggestions in widget. The result list is ordered
10552
- # and the first result is a top suggestion.
10553
- # Corresponds to the JSON property `widgetQuerySuggestions`
10554
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion>]
10555
- attr_accessor :widget_query_suggestions
10531
+ # TargetSites created.
10532
+ # Corresponds to the JSON property `targetSites`
10533
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaTargetSite>]
10534
+ attr_accessor :target_sites
10556
10535
 
10557
10536
  def initialize(**args)
10558
10537
  update!(**args)
@@ -10560,19 +10539,26 @@ module Google
10560
10539
 
10561
10540
  # Update properties of this object
10562
10541
  def update!(**args)
10563
- @u_token = args[:u_token] if args.key?(:u_token)
10564
- @widget_query_suggestions = args[:widget_query_suggestions] if args.key?(:widget_query_suggestions)
10542
+ @target_sites = args[:target_sites] if args.key?(:target_sites)
10565
10543
  end
10566
10544
  end
10567
10545
 
10568
- # Suggestions as search queries.
10569
- class GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion
10546
+ # Metadata related to the progress of the DataStoreService.CreateDataStore
10547
+ # operation. This will be returned by the google.longrunning.Operation.metadata
10548
+ # field.
10549
+ class GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata
10570
10550
  include Google::Apis::Core::Hashable
10571
10551
 
10572
- # The suggestion for the query.
10573
- # Corresponds to the JSON property `suggestion`
10552
+ # Operation create time.
10553
+ # Corresponds to the JSON property `createTime`
10574
10554
  # @return [String]
10575
- attr_accessor :suggestion
10555
+ attr_accessor :create_time
10556
+
10557
+ # Operation last update time. If the operation is done, this is also the finish
10558
+ # time.
10559
+ # Corresponds to the JSON property `updateTime`
10560
+ # @return [String]
10561
+ attr_accessor :update_time
10576
10562
 
10577
10563
  def initialize(**args)
10578
10564
  update!(**args)
@@ -10580,535 +10566,68 @@ module Google
10580
10566
 
10581
10567
  # Update properties of this object
10582
10568
  def update!(**args)
10583
- @suggestion = args[:suggestion] if args.key?(:suggestion)
10569
+ @create_time = args[:create_time] if args.key?(:create_time)
10570
+ @update_time = args[:update_time] if args.key?(:update_time)
10584
10571
  end
10585
10572
  end
10586
10573
 
10587
- # WidgetConfig captures configs at the Widget level.
10588
- class GoogleCloudDiscoveryengineV1alphaWidgetConfig
10574
+ # Metadata related to the progress of the EngineService.CreateEngine operation.
10575
+ # This will be returned by the google.longrunning.Operation.metadata field.
10576
+ class GoogleCloudDiscoveryengineV1betaCreateEngineMetadata
10589
10577
  include Google::Apis::Core::Hashable
10590
10578
 
10591
- # Whether allow no-auth integration with widget. If set true, public access to
10592
- # search or other solutions from widget is allowed without authenication token
10593
- # provided by customer hosted backend server.
10594
- # Corresponds to the JSON property `allowPublicAccess`
10595
- # @return [Boolean]
10596
- attr_accessor :allow_public_access
10597
- alias_method :allow_public_access?, :allow_public_access
10579
+ # Operation create time.
10580
+ # Corresponds to the JSON property `createTime`
10581
+ # @return [String]
10582
+ attr_accessor :create_time
10598
10583
 
10599
- # Allowlisted domains that can load this widget.
10600
- # Corresponds to the JSON property `allowlistedDomains`
10601
- # @return [Array<String>]
10602
- attr_accessor :allowlisted_domains
10584
+ # Operation last update time. If the operation is done, this is also the finish
10585
+ # time.
10586
+ # Corresponds to the JSON property `updateTime`
10587
+ # @return [String]
10588
+ attr_accessor :update_time
10603
10589
 
10604
- # Output only. Collection components that lists all collections and child data
10605
- # stores associated with the widget config, those data sources can be used for
10606
- # filtering in widget service APIs, users can return results that from selected
10607
- # data sources.
10608
- # Corresponds to the JSON property `collectionComponents`
10609
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent>]
10610
- attr_accessor :collection_components
10590
+ def initialize(**args)
10591
+ update!(**args)
10592
+ end
10611
10593
 
10612
- # Output only. Unique obfuscated identifier of a WidgetConfig.
10613
- # Corresponds to the JSON property `configId`
10614
- # @return [String]
10615
- attr_accessor :config_id
10594
+ # Update properties of this object
10595
+ def update!(**args)
10596
+ @create_time = args[:create_time] if args.key?(:create_time)
10597
+ @update_time = args[:update_time] if args.key?(:update_time)
10598
+ end
10599
+ end
10616
10600
 
10617
- # A specification for configuring the behavior of content search.
10618
- # Corresponds to the JSON property `contentSearchSpec`
10619
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec]
10620
- attr_accessor :content_search_spec
10601
+ # Metadata for Create Schema LRO.
10602
+ class GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata
10603
+ include Google::Apis::Core::Hashable
10621
10604
 
10622
- # Output only. Timestamp the WidgetConfig was created.
10605
+ # Operation create time.
10623
10606
  # Corresponds to the JSON property `createTime`
10624
10607
  # @return [String]
10625
10608
  attr_accessor :create_time
10626
10609
 
10627
- # Output only. The type of the parent data store.
10628
- # Corresponds to the JSON property `dataStoreType`
10610
+ # Operation last update time. If the operation is done, this is also the finish
10611
+ # time.
10612
+ # Corresponds to the JSON property `updateTime`
10629
10613
  # @return [String]
10630
- attr_accessor :data_store_type
10614
+ attr_accessor :update_time
10631
10615
 
10632
- # Configurable UI configurations per data store.
10633
- # Corresponds to the JSON property `dataStoreUiConfigs`
10634
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig>]
10635
- attr_accessor :data_store_ui_configs
10636
-
10637
- # Required. The human readable widget config display name. Used in Discovery UI.
10638
- # This field must be a UTF-8 encoded string with a length limit of 128
10639
- # characters. Otherwise, an INVALID_ARGUMENT error is returned.
10640
- # Corresponds to the JSON property `displayName`
10641
- # @return [String]
10642
- attr_accessor :display_name
10643
-
10644
- # Whether or not to enable autocomplete.
10645
- # Corresponds to the JSON property `enableAutocomplete`
10646
- # @return [Boolean]
10647
- attr_accessor :enable_autocomplete
10648
- alias_method :enable_autocomplete?, :enable_autocomplete
10649
-
10650
- # Whether to allow conversational search (LLM, multi-turn) or not (non-LLM,
10651
- # single-turn).
10652
- # Corresponds to the JSON property `enableConversationalSearch`
10653
- # @return [Boolean]
10654
- attr_accessor :enable_conversational_search
10655
- alias_method :enable_conversational_search?, :enable_conversational_search
10656
-
10657
- # Turn on or off collecting the search result quality feedback from end users.
10658
- # Corresponds to the JSON property `enableQualityFeedback`
10659
- # @return [Boolean]
10660
- attr_accessor :enable_quality_feedback
10661
- alias_method :enable_quality_feedback?, :enable_quality_feedback
10662
-
10663
- # Whether to show the result score.
10664
- # Corresponds to the JSON property `enableResultScore`
10665
- # @return [Boolean]
10666
- attr_accessor :enable_result_score
10667
- alias_method :enable_result_score?, :enable_result_score
10668
-
10669
- # Whether to enable safe search.
10670
- # Corresponds to the JSON property `enableSafeSearch`
10671
- # @return [Boolean]
10672
- attr_accessor :enable_safe_search
10673
- alias_method :enable_safe_search?, :enable_safe_search
10674
-
10675
- # Whether to enable search-as-you-type behavior for the search widget
10676
- # Corresponds to the JSON property `enableSearchAsYouType`
10677
- # @return [Boolean]
10678
- attr_accessor :enable_search_as_you_type
10679
- alias_method :enable_search_as_you_type?, :enable_search_as_you_type
10680
-
10681
- # Turn on or off summary for each snippets result.
10682
- # Corresponds to the JSON property `enableSnippetResultSummary`
10683
- # @return [Boolean]
10684
- attr_accessor :enable_snippet_result_summary
10685
- alias_method :enable_snippet_result_summary?, :enable_snippet_result_summary
10686
-
10687
- # Turn on or off summarization for the search response.
10688
- # Corresponds to the JSON property `enableSummarization`
10689
- # @return [Boolean]
10690
- attr_accessor :enable_summarization
10691
- alias_method :enable_summarization?, :enable_summarization
10692
-
10693
- # Whether to enable standalone web app.
10694
- # Corresponds to the JSON property `enableWebApp`
10695
- # @return [Boolean]
10696
- attr_accessor :enable_web_app
10697
- alias_method :enable_web_app?, :enable_web_app
10698
-
10699
- # The configuration and appearance of facets in the end user view.
10700
- # Corresponds to the JSON property `facetField`
10701
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField>]
10702
- attr_accessor :facet_field
10703
-
10704
- # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `
10705
- # url`, `custom1`, `custom2`, `custom3`. The value is the name of the field
10706
- # along with its device visibility. The 3 custom fields are optional and can be
10707
- # added or removed. `title`, `thumbnail`, `url` are required UI components that
10708
- # cannot be removed.
10709
- # Corresponds to the JSON property `fieldsUiComponentsMap`
10710
- # @return [Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField>]
10711
- attr_accessor :fields_ui_components_map
10712
-
10713
- # Output only. The industry vertical that the WidgetConfig registers. The
10714
- # WidgetConfig industry vertical is based on the associated Engine.
10715
- # Corresponds to the JSON property `industryVertical`
10716
- # @return [String]
10717
- attr_accessor :industry_vertical
10718
-
10719
- # Output only. Whether LLM is enabled in the corresponding data store.
10720
- # Corresponds to the JSON property `llmEnabled`
10721
- # @return [Boolean]
10722
- attr_accessor :llm_enabled
10723
- alias_method :llm_enabled?, :llm_enabled
10724
-
10725
- # Output only. Whether the customer accepted data use terms.
10726
- # Corresponds to the JSON property `minimumDataTermAccepted`
10727
- # @return [Boolean]
10728
- attr_accessor :minimum_data_term_accepted
10729
- alias_method :minimum_data_term_accepted?, :minimum_data_term_accepted
10730
-
10731
- # Immutable. The full resource name of the widget config. Format: `projects/`
10732
- # project`/locations/`location`/collections/`collection_id`/dataStores/`
10733
- # data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
10734
- # encoded string with a length limit of 1024 characters.
10735
- # Corresponds to the JSON property `name`
10736
- # @return [String]
10737
- attr_accessor :name
10738
-
10739
- # The type of snippet to display in UCS widget. -
10740
- # RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-
10741
- # enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.
10742
- # Corresponds to the JSON property `resultDisplayType`
10743
- # @return [String]
10744
- attr_accessor :result_display_type
10745
-
10746
- # Required. Immutable. Specifies the solution type that this WidgetConfig can be
10747
- # used for.
10748
- # Corresponds to the JSON property `solutionType`
10749
- # @return [String]
10750
- attr_accessor :solution_type
10751
-
10752
- # Output only. Timestamp the WidgetConfig was updated.
10753
- # Corresponds to the JSON property `updateTime`
10754
- # @return [String]
10755
- attr_accessor :update_time
10756
-
10757
- def initialize(**args)
10758
- update!(**args)
10759
- end
10616
+ def initialize(**args)
10617
+ update!(**args)
10618
+ end
10760
10619
 
10761
10620
  # Update properties of this object
10762
10621
  def update!(**args)
10763
- @allow_public_access = args[:allow_public_access] if args.key?(:allow_public_access)
10764
- @allowlisted_domains = args[:allowlisted_domains] if args.key?(:allowlisted_domains)
10765
- @collection_components = args[:collection_components] if args.key?(:collection_components)
10766
- @config_id = args[:config_id] if args.key?(:config_id)
10767
- @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
10768
10622
  @create_time = args[:create_time] if args.key?(:create_time)
10769
- @data_store_type = args[:data_store_type] if args.key?(:data_store_type)
10770
- @data_store_ui_configs = args[:data_store_ui_configs] if args.key?(:data_store_ui_configs)
10771
- @display_name = args[:display_name] if args.key?(:display_name)
10772
- @enable_autocomplete = args[:enable_autocomplete] if args.key?(:enable_autocomplete)
10773
- @enable_conversational_search = args[:enable_conversational_search] if args.key?(:enable_conversational_search)
10774
- @enable_quality_feedback = args[:enable_quality_feedback] if args.key?(:enable_quality_feedback)
10775
- @enable_result_score = args[:enable_result_score] if args.key?(:enable_result_score)
10776
- @enable_safe_search = args[:enable_safe_search] if args.key?(:enable_safe_search)
10777
- @enable_search_as_you_type = args[:enable_search_as_you_type] if args.key?(:enable_search_as_you_type)
10778
- @enable_snippet_result_summary = args[:enable_snippet_result_summary] if args.key?(:enable_snippet_result_summary)
10779
- @enable_summarization = args[:enable_summarization] if args.key?(:enable_summarization)
10780
- @enable_web_app = args[:enable_web_app] if args.key?(:enable_web_app)
10781
- @facet_field = args[:facet_field] if args.key?(:facet_field)
10782
- @fields_ui_components_map = args[:fields_ui_components_map] if args.key?(:fields_ui_components_map)
10783
- @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
10784
- @llm_enabled = args[:llm_enabled] if args.key?(:llm_enabled)
10785
- @minimum_data_term_accepted = args[:minimum_data_term_accepted] if args.key?(:minimum_data_term_accepted)
10786
- @name = args[:name] if args.key?(:name)
10787
- @result_display_type = args[:result_display_type] if args.key?(:result_display_type)
10788
- @solution_type = args[:solution_type] if args.key?(:solution_type)
10789
10623
  @update_time = args[:update_time] if args.key?(:update_time)
10790
10624
  end
10791
10625
  end
10792
10626
 
10793
- # Read-only collection component that contains data store collections fields
10794
- # that may be used for filtering
10795
- class GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent
10796
- include Google::Apis::Core::Hashable
10797
-
10798
- # For the data store collection, list of the children data stores.
10799
- # Corresponds to the JSON property `dataStoreComponents`
10800
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent>]
10801
- attr_accessor :data_store_components
10802
-
10803
- # The display name of the collection.
10804
- # Corresponds to the JSON property `displayName`
10805
- # @return [String]
10806
- attr_accessor :display_name
10807
-
10808
- # Output only. the identifier of the collection, used for widget service. For
10809
- # now it refers to collection_id, in the future we will migrate the field to
10810
- # encrypted collection name UUID.
10811
- # Corresponds to the JSON property `id`
10812
- # @return [String]
10813
- attr_accessor :id
10814
-
10815
- # The name of the collection. It should be collection resource name. Format: `
10816
- # projects/`project_number`/locations/`location`/collections/`collection_id``.
10817
- # For APIs under WidgetService, such as LookUpWidgetConfig, the project number
10818
- # and location part is erased in this field.
10819
- # Corresponds to the JSON property `name`
10820
- # @return [String]
10821
- attr_accessor :name
10822
-
10823
- def initialize(**args)
10824
- update!(**args)
10825
- end
10826
-
10827
- # Update properties of this object
10828
- def update!(**args)
10829
- @data_store_components = args[:data_store_components] if args.key?(:data_store_components)
10830
- @display_name = args[:display_name] if args.key?(:display_name)
10831
- @id = args[:id] if args.key?(:id)
10832
- @name = args[:name] if args.key?(:name)
10833
- end
10834
- end
10835
-
10836
- # Read-only data store component that contains data stores fields that may be
10837
- # used for filtering, it's the child of `CollectionComponent`.
10838
- class GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent
10839
- include Google::Apis::Core::Hashable
10840
-
10841
- # The display name of the data store.
10842
- # Corresponds to the JSON property `displayName`
10843
- # @return [String]
10844
- attr_accessor :display_name
10845
-
10846
- # Output only. the identifier of the data store, used for widget service. For
10847
- # now it refers to data_store_id, in the future we will migrate the field to
10848
- # encrypted data store name UUID.
10849
- # Corresponds to the JSON property `id`
10850
- # @return [String]
10851
- attr_accessor :id
10852
-
10853
- # The name of the data store. It should be data store resource name Format: `
10854
- # projects/`project_number`/locations/`location`/collections/`collection_id`/
10855
- # dataStores/`data_store_id``. For APIs under WidgetService, such as
10856
- # LookUpWidgetConfig, the project number and location part is erased in this
10857
- # field.
10858
- # Corresponds to the JSON property `name`
10859
- # @return [String]
10860
- attr_accessor :name
10861
-
10862
- def initialize(**args)
10863
- update!(**args)
10864
- end
10865
-
10866
- # Update properties of this object
10867
- def update!(**args)
10868
- @display_name = args[:display_name] if args.key?(:display_name)
10869
- @id = args[:id] if args.key?(:id)
10870
- @name = args[:name] if args.key?(:name)
10871
- end
10872
- end
10873
-
10874
- # UI component configuration for data store.
10875
- class GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig
10876
- include Google::Apis::Core::Hashable
10877
-
10878
- # Facet fields that store the mapping of fields to end user widget appearance.
10879
- # Corresponds to the JSON property `facetField`
10880
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField>]
10881
- attr_accessor :facet_field
10882
-
10883
- # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `
10884
- # url`, `custom1`, `custom2`, `custom3`. The value is the name of the field
10885
- # along with its device visibility. The 3 custom fields are optional and can be
10886
- # added or removed. `title`, `thumbnail`, `url` are required UI components that
10887
- # cannot be removed.
10888
- # Corresponds to the JSON property `fieldsUiComponentsMap`
10889
- # @return [Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField>]
10890
- attr_accessor :fields_ui_components_map
10891
-
10892
- # Output only. the identifier of the data store, used for widget service. For
10893
- # now it refers to data_store_id, in the future we will migrate the field to
10894
- # encrypted data store name UUID.
10895
- # Corresponds to the JSON property `id`
10896
- # @return [String]
10897
- attr_accessor :id
10898
-
10899
- # The name of the data store. It should be data store resource name Format: `
10900
- # projects/`project_number`/locations/`location`/collections/`collection_id`/
10901
- # dataStores/`data_store_id``. For APIs under WidgetService, such as
10902
- # LookUpWidgetConfig, the project number and location part is erased in this
10903
- # field.
10904
- # Corresponds to the JSON property `name`
10905
- # @return [String]
10906
- attr_accessor :name
10907
-
10908
- def initialize(**args)
10909
- update!(**args)
10910
- end
10911
-
10912
- # Update properties of this object
10913
- def update!(**args)
10914
- @facet_field = args[:facet_field] if args.key?(:facet_field)
10915
- @fields_ui_components_map = args[:fields_ui_components_map] if args.key?(:fields_ui_components_map)
10916
- @id = args[:id] if args.key?(:id)
10917
- @name = args[:name] if args.key?(:name)
10918
- end
10919
- end
10920
-
10921
- # Facet fields that store the mapping of fields to end user widget appearance.
10922
- class GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField
10923
- include Google::Apis::Core::Hashable
10924
-
10925
- # Optional. The field name that end users will see.
10926
- # Corresponds to the JSON property `displayName`
10927
- # @return [String]
10928
- attr_accessor :display_name
10929
-
10930
- # Required. Registered field name. The format is `field.abc`.
10931
- # Corresponds to the JSON property `field`
10932
- # @return [String]
10933
- attr_accessor :field
10934
-
10935
- def initialize(**args)
10936
- update!(**args)
10937
- end
10938
-
10939
- # Update properties of this object
10940
- def update!(**args)
10941
- @display_name = args[:display_name] if args.key?(:display_name)
10942
- @field = args[:field] if args.key?(:field)
10943
- end
10944
- end
10945
-
10946
- # Facet field that maps to a UI Component.
10947
- class GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField
10948
- include Google::Apis::Core::Hashable
10949
-
10950
- # The field visibility on different types of devices.
10951
- # Corresponds to the JSON property `deviceVisibility`
10952
- # @return [Array<String>]
10953
- attr_accessor :device_visibility
10954
-
10955
- # The template to customize how the field is displayed. An example value would
10956
- # be a string that looks like: "Price: `value`".
10957
- # Corresponds to the JSON property `displayTemplate`
10958
- # @return [String]
10959
- attr_accessor :display_template
10960
-
10961
- # Required. Registered field name. The format is `field.abc`.
10962
- # Corresponds to the JSON property `field`
10963
- # @return [String]
10964
- attr_accessor :field
10965
-
10966
- def initialize(**args)
10967
- update!(**args)
10968
- end
10969
-
10970
- # Update properties of this object
10971
- def update!(**args)
10972
- @device_visibility = args[:device_visibility] if args.key?(:device_visibility)
10973
- @display_template = args[:display_template] if args.key?(:display_template)
10974
- @field = args[:field] if args.key?(:field)
10975
- end
10976
- end
10977
-
10978
- # Request message for WidgetService.WidgetConverseConversation method.
10979
- class GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest
10980
- include Google::Apis::Core::Hashable
10981
-
10982
- # AdditionalParams message for WidgetService methods for security and privacy
10983
- # enhancement.
10984
- # Corresponds to the JSON property `additionalParams`
10985
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdditionalParams]
10986
- attr_accessor :additional_params
10987
-
10988
- # Required. The UUID of the WidgetConfig. This field is used to identify the
10989
- # widget configuration, set of models used to make the user event collection.
10990
- # Corresponds to the JSON property `configId`
10991
- # @return [String]
10992
- attr_accessor :config_id
10993
-
10994
- # The id of the Conversation to get. Use "-" to activate auto session mode,
10995
- # which automatically creates a new conversation inside a ConverseConversation
10996
- # session.
10997
- # Corresponds to the JSON property `conversationId`
10998
- # @return [String]
10999
- attr_accessor :conversation_id
11000
-
11001
- # Request message for ConversationalSearchService.ConverseConversation method.
11002
- # Corresponds to the JSON property `converseConversationRequest`
11003
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationRequest]
11004
- attr_accessor :converse_conversation_request
11005
-
11006
- def initialize(**args)
11007
- update!(**args)
11008
- end
11009
-
11010
- # Update properties of this object
11011
- def update!(**args)
11012
- @additional_params = args[:additional_params] if args.key?(:additional_params)
11013
- @config_id = args[:config_id] if args.key?(:config_id)
11014
- @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
11015
- @converse_conversation_request = args[:converse_conversation_request] if args.key?(:converse_conversation_request)
11016
- end
11017
- end
11018
-
11019
- # Response message for WidgetService.WidgetConverseConversation method.
11020
- class GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse
11021
- include Google::Apis::Core::Hashable
11022
-
11023
- # The id of the Conversation returned.
11024
- # Corresponds to the JSON property `conversationId`
11025
- # @return [String]
11026
- attr_accessor :conversation_id
11027
-
11028
- # Response message for ConversationalSearchService.ConverseConversation method.
11029
- # Corresponds to the JSON property `converseConversationResponse`
11030
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse]
11031
- attr_accessor :converse_conversation_response
11032
-
11033
- # The token in response.
11034
- # Corresponds to the JSON property `uToken`
11035
- # @return [String]
11036
- attr_accessor :u_token
11037
-
11038
- def initialize(**args)
11039
- update!(**args)
11040
- end
11041
-
11042
- # Update properties of this object
11043
- def update!(**args)
11044
- @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
11045
- @converse_conversation_response = args[:converse_conversation_response] if args.key?(:converse_conversation_response)
11046
- @u_token = args[:u_token] if args.key?(:u_token)
11047
- end
11048
- end
11049
-
11050
- # Request message for WidgetService.WidgetSearch method.
11051
- class GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest
11052
- include Google::Apis::Core::Hashable
11053
-
11054
- # AdditionalParams message for WidgetService methods for security and privacy
11055
- # enhancement.
11056
- # Corresponds to the JSON property `additionalParams`
11057
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdditionalParams]
11058
- attr_accessor :additional_params
11059
-
11060
- # Required. The UUID of the Search WidgetConfig. This field is used to identify
11061
- # the search widget configuration, set of models used to make the search.
11062
- # Corresponds to the JSON property `configId`
11063
- # @return [String]
11064
- attr_accessor :config_id
11065
-
11066
- # Request message for SearchService.Search method.
11067
- # Corresponds to the JSON property `searchRequest`
11068
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest]
11069
- attr_accessor :search_request
11070
-
11071
- def initialize(**args)
11072
- update!(**args)
11073
- end
11074
-
11075
- # Update properties of this object
11076
- def update!(**args)
11077
- @additional_params = args[:additional_params] if args.key?(:additional_params)
11078
- @config_id = args[:config_id] if args.key?(:config_id)
11079
- @search_request = args[:search_request] if args.key?(:search_request)
11080
- end
11081
- end
11082
-
11083
- # Response message for WidgetService.WidgetSearch method.
11084
- class GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse
11085
- include Google::Apis::Core::Hashable
11086
-
11087
- # Response message for SearchService.Search method.
11088
- # Corresponds to the JSON property `searchResponse`
11089
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse]
11090
- attr_accessor :search_response
11091
-
11092
- # The token in response.
11093
- # Corresponds to the JSON property `uToken`
11094
- # @return [String]
11095
- attr_accessor :u_token
11096
-
11097
- def initialize(**args)
11098
- update!(**args)
11099
- end
11100
-
11101
- # Update properties of this object
11102
- def update!(**args)
11103
- @search_response = args[:search_response] if args.key?(:search_response)
11104
- @u_token = args[:u_token] if args.key?(:u_token)
11105
- end
11106
- end
11107
-
11108
10627
  # Metadata related to the progress of the SiteSearchEngineService.
11109
- # BatchCreateTargetSites operation. This will be returned by the google.
11110
- # longrunning.Operation.metadata field.
11111
- class GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata
10628
+ # CreateTargetSite operation. This will be returned by the google.longrunning.
10629
+ # Operation.metadata field.
10630
+ class GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata
11112
10631
  include Google::Apis::Core::Hashable
11113
10632
 
11114
10633
  # Operation create time.
@@ -11133,122 +10652,42 @@ module Google
11133
10652
  end
11134
10653
  end
11135
10654
 
11136
- # Response message for SiteSearchEngineService.BatchCreateTargetSites method.
11137
- class GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse
11138
- include Google::Apis::Core::Hashable
11139
-
11140
- # TargetSites created.
11141
- # Corresponds to the JSON property `targetSites`
11142
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaTargetSite>]
11143
- attr_accessor :target_sites
11144
-
11145
- def initialize(**args)
11146
- update!(**args)
11147
- end
11148
-
11149
- # Update properties of this object
11150
- def update!(**args)
11151
- @target_sites = args[:target_sites] if args.key?(:target_sites)
11152
- end
11153
- end
11154
-
11155
- # Metadata related to the progress of the DataStoreService.CreateDataStore
11156
- # operation. This will be returned by the google.longrunning.Operation.metadata
11157
- # field.
11158
- class GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata
10655
+ # Metadata that describes a custom tuned model.
10656
+ class GoogleCloudDiscoveryengineV1betaCustomTuningModel
11159
10657
  include Google::Apis::Core::Hashable
11160
10658
 
11161
- # Operation create time.
10659
+ # Timestamp the Model was created at.
11162
10660
  # Corresponds to the JSON property `createTime`
11163
10661
  # @return [String]
11164
10662
  attr_accessor :create_time
11165
10663
 
11166
- # Operation last update time. If the operation is done, this is also the finish
11167
- # time.
11168
- # Corresponds to the JSON property `updateTime`
11169
- # @return [String]
11170
- attr_accessor :update_time
11171
-
11172
- def initialize(**args)
11173
- update!(**args)
11174
- end
11175
-
11176
- # Update properties of this object
11177
- def update!(**args)
11178
- @create_time = args[:create_time] if args.key?(:create_time)
11179
- @update_time = args[:update_time] if args.key?(:update_time)
11180
- end
11181
- end
11182
-
11183
- # Metadata related to the progress of the EngineService.CreateEngine operation.
11184
- # This will be returned by the google.longrunning.Operation.metadata field.
11185
- class GoogleCloudDiscoveryengineV1betaCreateEngineMetadata
11186
- include Google::Apis::Core::Hashable
11187
-
11188
- # Operation create time.
11189
- # Corresponds to the JSON property `createTime`
11190
- # @return [String]
11191
- attr_accessor :create_time
11192
-
11193
- # Operation last update time. If the operation is done, this is also the finish
11194
- # time.
11195
- # Corresponds to the JSON property `updateTime`
11196
- # @return [String]
11197
- attr_accessor :update_time
11198
-
11199
- def initialize(**args)
11200
- update!(**args)
11201
- end
11202
-
11203
- # Update properties of this object
11204
- def update!(**args)
11205
- @create_time = args[:create_time] if args.key?(:create_time)
11206
- @update_time = args[:update_time] if args.key?(:update_time)
11207
- end
11208
- end
11209
-
11210
- # Metadata for Create Schema LRO.
11211
- class GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata
11212
- include Google::Apis::Core::Hashable
11213
-
11214
- # Operation create time.
11215
- # Corresponds to the JSON property `createTime`
10664
+ # The display name of the model.
10665
+ # Corresponds to the JSON property `displayName`
11216
10666
  # @return [String]
11217
- attr_accessor :create_time
10667
+ attr_accessor :display_name
11218
10668
 
11219
- # Operation last update time. If the operation is done, this is also the finish
11220
- # time.
11221
- # Corresponds to the JSON property `updateTime`
10669
+ # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
10670
+ # Corresponds to the JSON property `modelState`
11222
10671
  # @return [String]
11223
- attr_accessor :update_time
10672
+ attr_accessor :model_state
11224
10673
 
11225
- def initialize(**args)
11226
- update!(**args)
11227
- end
11228
-
11229
- # Update properties of this object
11230
- def update!(**args)
11231
- @create_time = args[:create_time] if args.key?(:create_time)
11232
- @update_time = args[:update_time] if args.key?(:update_time)
11233
- end
11234
- end
11235
-
11236
- # Metadata related to the progress of the SiteSearchEngineService.
11237
- # CreateTargetSite operation. This will be returned by the google.longrunning.
11238
- # Operation.metadata field.
11239
- class GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata
11240
- include Google::Apis::Core::Hashable
10674
+ #
10675
+ # Corresponds to the JSON property `modelVersion`
10676
+ # @return [Fixnum]
10677
+ attr_accessor :model_version
11241
10678
 
11242
- # Operation create time.
11243
- # Corresponds to the JSON property `createTime`
10679
+ # Required. The fully qualified resource name of the model. Format: `projects/`
10680
+ # project_number`/locations/`location`/collections/`collection`/dataStores/`
10681
+ # data_store`/customTuningModels/`custom_tuning_model`` model must be an alpha-
10682
+ # numerical string with limit of 40 characters.
10683
+ # Corresponds to the JSON property `name`
11244
10684
  # @return [String]
11245
- attr_accessor :create_time
10685
+ attr_accessor :name
11246
10686
 
11247
- # Operation last update time. If the operation is done, this is also the finish
11248
- # time.
11249
- # Corresponds to the JSON property `updateTime`
10687
+ # Timestamp the model training was initiated.
10688
+ # Corresponds to the JSON property `trainingStartTime`
11250
10689
  # @return [String]
11251
- attr_accessor :update_time
10690
+ attr_accessor :training_start_time
11252
10691
 
11253
10692
  def initialize(**args)
11254
10693
  update!(**args)
@@ -11257,7 +10696,11 @@ module Google
11257
10696
  # Update properties of this object
11258
10697
  def update!(**args)
11259
10698
  @create_time = args[:create_time] if args.key?(:create_time)
11260
- @update_time = args[:update_time] if args.key?(:update_time)
10699
+ @display_name = args[:display_name] if args.key?(:display_name)
10700
+ @model_state = args[:model_state] if args.key?(:model_state)
10701
+ @model_version = args[:model_version] if args.key?(:model_version)
10702
+ @name = args[:name] if args.key?(:name)
10703
+ @training_start_time = args[:training_start_time] if args.key?(:training_start_time)
11261
10704
  end
11262
10705
  end
11263
10706
 
@@ -12107,6 +11550,25 @@ module Google
12107
11550
  end
12108
11551
  end
12109
11552
 
11553
+ # Response message for SearchTuningService.ListCustomModels method.
11554
+ class GoogleCloudDiscoveryengineV1betaListCustomModelsResponse
11555
+ include Google::Apis::Core::Hashable
11556
+
11557
+ # List of custom tuning models.
11558
+ # Corresponds to the JSON property `models`
11559
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaCustomTuningModel>]
11560
+ attr_accessor :models
11561
+
11562
+ def initialize(**args)
11563
+ update!(**args)
11564
+ end
11565
+
11566
+ # Update properties of this object
11567
+ def update!(**args)
11568
+ @models = args[:models] if args.key?(:models)
11569
+ end
11570
+ end
11571
+
12110
11572
  # Metadata related to the progress of the PurgeDocuments operation. This will be
12111
11573
  # returned by the google.longrunning.Operation.metadata field.
12112
11574
  class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata
@@ -12336,6 +11798,11 @@ module Google
12336
11798
  # @return [String]
12337
11799
  attr_accessor :provided_uri_pattern
12338
11800
 
11801
+ # Output only. Root domain of the provided_uri_pattern.
11802
+ # Corresponds to the JSON property `rootDomainUri`
11803
+ # @return [String]
11804
+ attr_accessor :root_domain_uri
11805
+
12339
11806
  # Verification information for target sites in advanced site search.
12340
11807
  # Corresponds to the JSON property `siteVerificationInfo`
12341
11808
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSiteVerificationInfo]
@@ -12364,6 +11831,7 @@ module Google
12364
11831
  @indexing_status = args[:indexing_status] if args.key?(:indexing_status)
12365
11832
  @name = args[:name] if args.key?(:name)
12366
11833
  @provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
11834
+ @root_domain_uri = args[:root_domain_uri] if args.key?(:root_domain_uri)
12367
11835
  @site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
12368
11836
  @type = args[:type] if args.key?(:type)
12369
11837
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -12456,6 +11924,11 @@ module Google
12456
11924
  # @return [Hash<String,Float>]
12457
11925
  attr_accessor :metrics
12458
11926
 
11927
+ # Fully qualified name of the CustomTuningModel.
11928
+ # Corresponds to the JSON property `modelName`
11929
+ # @return [String]
11930
+ attr_accessor :model_name
11931
+
12459
11932
  # The trained model status. Possible values are: * **bad-data**: The training
12460
11933
  # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
12461
11934
  # Won't deploy. * **in-progress**: Model training job creation is in progress. *
@@ -12475,6 +11948,7 @@ module Google
12475
11948
  @error_config = args[:error_config] if args.key?(:error_config)
12476
11949
  @error_samples = args[:error_samples] if args.key?(:error_samples)
12477
11950
  @metrics = args[:metrics] if args.key?(:metrics)
11951
+ @model_name = args[:model_name] if args.key?(:model_name)
12478
11952
  @model_status = args[:model_status] if args.key?(:model_status)
12479
11953
  end
12480
11954
  end
@@ -12567,6 +12041,19 @@ module Google
12567
12041
  end
12568
12042
  end
12569
12043
 
12044
+ # The request message for Operations.CancelOperation.
12045
+ class GoogleLongrunningCancelOperationRequest
12046
+ include Google::Apis::Core::Hashable
12047
+
12048
+ def initialize(**args)
12049
+ update!(**args)
12050
+ end
12051
+
12052
+ # Update properties of this object
12053
+ def update!(**args)
12054
+ end
12055
+ end
12056
+
12570
12057
  # The response message for Operations.ListOperations.
12571
12058
  class GoogleLongrunningListOperationsResponse
12572
12059
  include Google::Apis::Core::Hashable