google-apis-discoveryengine_v1alpha 0.44.0 → 0.45.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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
@@ -3482,71 +3494,6 @@ module Google
3482
3494
  end
3483
3495
  end
3484
3496
 
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
3497
  # Response message for CompletionService.CompleteQuery method.
3551
3498
  class GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse
3552
3499
  include Google::Apis::Core::Hashable
@@ -3769,16 +3716,6 @@ module Google
3769
3716
  # @return [String]
3770
3717
  attr_accessor :filter
3771
3718
 
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
3719
  # Defines text input.
3783
3720
  # Corresponds to the JSON property `query`
3784
3721
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTextInput]
@@ -3827,7 +3764,6 @@ module Google
3827
3764
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
3828
3765
  @conversation = args[:conversation] if args.key?(:conversation)
3829
3766
  @filter = args[:filter] if args.key?(:filter)
3830
- @name = args[:name] if args.key?(:name)
3831
3767
  @query = args[:query] if args.key?(:query)
3832
3768
  @safe_search = args[:safe_search] if args.key?(:safe_search)
3833
3769
  @serving_config = args[:serving_config] if args.key?(:serving_config)
@@ -4062,6 +3998,58 @@ module Google
4062
3998
  end
4063
3999
  end
4064
4000
 
4001
+ # Metadata that describes a custom tuned model.
4002
+ class GoogleCloudDiscoveryengineV1alphaCustomTuningModel
4003
+ include Google::Apis::Core::Hashable
4004
+
4005
+ # Timestamp the Model was created at.
4006
+ # Corresponds to the JSON property `createTime`
4007
+ # @return [String]
4008
+ attr_accessor :create_time
4009
+
4010
+ # The display name of the model.
4011
+ # Corresponds to the JSON property `displayName`
4012
+ # @return [String]
4013
+ attr_accessor :display_name
4014
+
4015
+ # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
4016
+ # Corresponds to the JSON property `modelState`
4017
+ # @return [String]
4018
+ attr_accessor :model_state
4019
+
4020
+ #
4021
+ # Corresponds to the JSON property `modelVersion`
4022
+ # @return [Fixnum]
4023
+ attr_accessor :model_version
4024
+
4025
+ # Required. The fully qualified resource name of the model. Format: `projects/`
4026
+ # project_number`/locations/`location`/collections/`collection`/dataStores/`
4027
+ # data_store`/customTuningModels/`custom_tuning_model`` model must be an alpha-
4028
+ # numerical string with limit of 40 characters.
4029
+ # Corresponds to the JSON property `name`
4030
+ # @return [String]
4031
+ attr_accessor :name
4032
+
4033
+ # Timestamp the model training was initiated.
4034
+ # Corresponds to the JSON property `trainingStartTime`
4035
+ # @return [String]
4036
+ attr_accessor :training_start_time
4037
+
4038
+ def initialize(**args)
4039
+ update!(**args)
4040
+ end
4041
+
4042
+ # Update properties of this object
4043
+ def update!(**args)
4044
+ @create_time = args[:create_time] if args.key?(:create_time)
4045
+ @display_name = args[:display_name] if args.key?(:display_name)
4046
+ @model_state = args[:model_state] if args.key?(:model_state)
4047
+ @model_version = args[:model_version] if args.key?(:model_version)
4048
+ @name = args[:name] if args.key?(:name)
4049
+ @training_start_time = args[:training_start_time] if args.key?(:training_start_time)
4050
+ end
4051
+ end
4052
+
4065
4053
  # DataStore captures global settings and configs at the DataStore level.
4066
4054
  class GoogleCloudDiscoveryengineV1alphaDataStore
4067
4055
  include Google::Apis::Core::Hashable
@@ -5373,6 +5361,11 @@ module Google
5373
5361
  # @return [String]
5374
5362
  attr_accessor :chunk_text
5375
5363
 
5364
+ # The index of this chunk. Currently, only used for the streaming mode.
5365
+ # Corresponds to the JSON property `index`
5366
+ # @return [Fixnum]
5367
+ attr_accessor :index
5368
+
5376
5369
  # Source from which this fact chunk was retrieved. If it was retrieved from the
5377
5370
  # GroundingFacts provided in the request then this field will contain the index
5378
5371
  # of the specific fact from which this chunk was retrieved.
@@ -5392,6 +5385,7 @@ module Google
5392
5385
  # Update properties of this object
5393
5386
  def update!(**args)
5394
5387
  @chunk_text = args[:chunk_text] if args.key?(:chunk_text)
5388
+ @index = args[:index] if args.key?(:index)
5395
5389
  @source = args[:source] if args.key?(:source)
5396
5390
  @source_metadata = args[:source_metadata] if args.key?(:source_metadata)
5397
5391
  end
@@ -6332,6 +6326,25 @@ module Google
6332
6326
  end
6333
6327
  end
6334
6328
 
6329
+ # Response message for SearchTuningService.ListCustomModels method.
6330
+ class GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse
6331
+ include Google::Apis::Core::Hashable
6332
+
6333
+ # List of custom tuning models.
6334
+ # Corresponds to the JSON property `models`
6335
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomTuningModel>]
6336
+ attr_accessor :models
6337
+
6338
+ def initialize(**args)
6339
+ update!(**args)
6340
+ end
6341
+
6342
+ # Update properties of this object
6343
+ def update!(**args)
6344
+ @models = args[:models] if args.key?(:models)
6345
+ end
6346
+ end
6347
+
6335
6348
  # Response message for DataStoreService.ListDataStores method.
6336
6349
  class GoogleCloudDiscoveryengineV1alphaListDataStoresResponse
6337
6350
  include Google::Apis::Core::Hashable
@@ -6518,44 +6531,6 @@ module Google
6518
6531
  end
6519
6532
  end
6520
6533
 
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
6534
  # Media-specific user event information.
6560
6535
  class GoogleCloudDiscoveryengineV1alphaMediaInfo
6561
6536
  include Google::Apis::Core::Hashable
@@ -7931,9 +7906,9 @@ module Google
7931
7906
 
7932
7907
  # The order in which documents are returned. Documents can be ordered by a field
7933
7908
  # 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.
7909
+ # expression is case-sensitive. For more information on ordering for retail
7910
+ # search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#
7911
+ # order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
7937
7912
  # Corresponds to the JSON property `orderBy`
7938
7913
  # @return [String]
7939
7914
  attr_accessor :order_by
@@ -7998,16 +7973,6 @@ module Google
7998
7973
  attr_accessor :safe_search
7999
7974
  alias_method :safe_search?, :safe_search
8000
7975
 
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
7976
  # The specification for query spell correction.
8012
7977
  # Corresponds to the JSON property `spellCorrectionSpec`
8013
7978
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec]
@@ -8070,7 +8035,6 @@ module Google
8070
8035
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
8071
8036
  @ranking_expression = args[:ranking_expression] if args.key?(:ranking_expression)
8072
8037
  @safe_search = args[:safe_search] if args.key?(:safe_search)
8073
- @serving_config = args[:serving_config] if args.key?(:serving_config)
8074
8038
  @spell_correction_spec = args[:spell_correction_spec] if args.key?(:spell_correction_spec)
8075
8039
  @user_info = args[:user_info] if args.key?(:user_info)
8076
8040
  @user_labels = args[:user_labels] if args.key?(:user_labels)
@@ -9866,6 +9830,11 @@ module Google
9866
9830
  # @return [String]
9867
9831
  attr_accessor :provided_uri_pattern
9868
9832
 
9833
+ # Output only. Root domain of the provided_uri_pattern.
9834
+ # Corresponds to the JSON property `rootDomainUri`
9835
+ # @return [String]
9836
+ attr_accessor :root_domain_uri
9837
+
9869
9838
  # Verification information for target sites in advanced site search.
9870
9839
  # Corresponds to the JSON property `siteVerificationInfo`
9871
9840
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo]
@@ -9894,6 +9863,7 @@ module Google
9894
9863
  @indexing_status = args[:indexing_status] if args.key?(:indexing_status)
9895
9864
  @name = args[:name] if args.key?(:name)
9896
9865
  @provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
9866
+ @root_domain_uri = args[:root_domain_uri] if args.key?(:root_domain_uri)
9897
9867
  @site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
9898
9868
  @type = args[:type] if args.key?(:type)
9899
9869
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -10005,6 +9975,11 @@ module Google
10005
9975
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput]
10006
9976
  attr_accessor :gcs_training_input
10007
9977
 
9978
+ # If not provided, a UUID will be generated.
9979
+ # Corresponds to the JSON property `modelId`
9980
+ # @return [String]
9981
+ attr_accessor :model_id
9982
+
10008
9983
  # Model to be trained. Supported values are: * **search-tuning**: Fine tuning
10009
9984
  # the search system based on data provided.
10010
9985
  # Corresponds to the JSON property `modelType`
@@ -10019,6 +9994,7 @@ module Google
10019
9994
  def update!(**args)
10020
9995
  @error_config = args[:error_config] if args.key?(:error_config)
10021
9996
  @gcs_training_input = args[:gcs_training_input] if args.key?(:gcs_training_input)
9997
+ @model_id = args[:model_id] if args.key?(:model_id)
10022
9998
  @model_type = args[:model_type] if args.key?(:model_type)
10023
9999
  end
10024
10000
  end
@@ -10092,6 +10068,11 @@ module Google
10092
10068
  # @return [Hash<String,Float>]
10093
10069
  attr_accessor :metrics
10094
10070
 
10071
+ # Fully qualified name of the CustomTuningModel.
10072
+ # Corresponds to the JSON property `modelName`
10073
+ # @return [String]
10074
+ attr_accessor :model_name
10075
+
10095
10076
  # The trained model status. Possible values are: * **bad-data**: The training
10096
10077
  # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
10097
10078
  # Won't deploy. * **in-progress**: Model training job creation is in progress. *
@@ -10111,6 +10092,7 @@ module Google
10111
10092
  @error_config = args[:error_config] if args.key?(:error_config)
10112
10093
  @error_samples = args[:error_samples] if args.key?(:error_samples)
10113
10094
  @metrics = args[:metrics] if args.key?(:metrics)
10095
+ @model_name = args[:model_name] if args.key?(:model_name)
10114
10096
  @model_status = args[:model_status] if args.key?(:model_status)
10115
10097
  end
10116
10098
  end
@@ -10506,26 +10488,22 @@ module Google
10506
10488
  end
10507
10489
  end
10508
10490
 
10509
- # Request message for WidgetService.WidgetCompleteQuery method.
10510
- class GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest
10491
+ # Metadata related to the progress of the SiteSearchEngineService.
10492
+ # BatchCreateTargetSites operation. This will be returned by the google.
10493
+ # longrunning.Operation.metadata field.
10494
+ class GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata
10511
10495
  include Google::Apis::Core::Hashable
10512
10496
 
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
10497
+ # Operation create time.
10498
+ # Corresponds to the JSON property `createTime`
10499
+ # @return [String]
10500
+ attr_accessor :create_time
10523
10501
 
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`
10502
+ # Operation last update time. If the operation is done, this is also the finish
10503
+ # time.
10504
+ # Corresponds to the JSON property `updateTime`
10527
10505
  # @return [String]
10528
- attr_accessor :config_id
10506
+ attr_accessor :update_time
10529
10507
 
10530
10508
  def initialize(**args)
10531
10509
  update!(**args)
@@ -10533,26 +10511,19 @@ module Google
10533
10511
 
10534
10512
  # Update properties of this object
10535
10513
  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)
10514
+ @create_time = args[:create_time] if args.key?(:create_time)
10515
+ @update_time = args[:update_time] if args.key?(:update_time)
10539
10516
  end
10540
10517
  end
10541
10518
 
10542
- # Response message for WidgetService.WidgetCompleteQuery method.
10543
- class GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse
10519
+ # Response message for SiteSearchEngineService.BatchCreateTargetSites method.
10520
+ class GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse
10544
10521
  include Google::Apis::Core::Hashable
10545
10522
 
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
10523
+ # TargetSites created.
10524
+ # Corresponds to the JSON property `targetSites`
10525
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaTargetSite>]
10526
+ attr_accessor :target_sites
10556
10527
 
10557
10528
  def initialize(**args)
10558
10529
  update!(**args)
@@ -10560,19 +10531,26 @@ module Google
10560
10531
 
10561
10532
  # Update properties of this object
10562
10533
  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)
10534
+ @target_sites = args[:target_sites] if args.key?(:target_sites)
10565
10535
  end
10566
10536
  end
10567
10537
 
10568
- # Suggestions as search queries.
10569
- class GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion
10538
+ # Metadata related to the progress of the DataStoreService.CreateDataStore
10539
+ # operation. This will be returned by the google.longrunning.Operation.metadata
10540
+ # field.
10541
+ class GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata
10570
10542
  include Google::Apis::Core::Hashable
10571
10543
 
10572
- # The suggestion for the query.
10573
- # Corresponds to the JSON property `suggestion`
10544
+ # Operation create time.
10545
+ # Corresponds to the JSON property `createTime`
10574
10546
  # @return [String]
10575
- attr_accessor :suggestion
10547
+ attr_accessor :create_time
10548
+
10549
+ # Operation last update time. If the operation is done, this is also the finish
10550
+ # time.
10551
+ # Corresponds to the JSON property `updateTime`
10552
+ # @return [String]
10553
+ attr_accessor :update_time
10576
10554
 
10577
10555
  def initialize(**args)
10578
10556
  update!(**args)
@@ -10580,582 +10558,68 @@ module Google
10580
10558
 
10581
10559
  # Update properties of this object
10582
10560
  def update!(**args)
10583
- @suggestion = args[:suggestion] if args.key?(:suggestion)
10561
+ @create_time = args[:create_time] if args.key?(:create_time)
10562
+ @update_time = args[:update_time] if args.key?(:update_time)
10584
10563
  end
10585
10564
  end
10586
10565
 
10587
- # WidgetConfig captures configs at the Widget level.
10588
- class GoogleCloudDiscoveryengineV1alphaWidgetConfig
10566
+ # Metadata related to the progress of the EngineService.CreateEngine operation.
10567
+ # This will be returned by the google.longrunning.Operation.metadata field.
10568
+ class GoogleCloudDiscoveryengineV1betaCreateEngineMetadata
10589
10569
  include Google::Apis::Core::Hashable
10590
10570
 
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
10571
+ # Operation create time.
10572
+ # Corresponds to the JSON property `createTime`
10573
+ # @return [String]
10574
+ attr_accessor :create_time
10598
10575
 
10599
- # Allowlisted domains that can load this widget.
10600
- # Corresponds to the JSON property `allowlistedDomains`
10601
- # @return [Array<String>]
10602
- attr_accessor :allowlisted_domains
10576
+ # Operation last update time. If the operation is done, this is also the finish
10577
+ # time.
10578
+ # Corresponds to the JSON property `updateTime`
10579
+ # @return [String]
10580
+ attr_accessor :update_time
10603
10581
 
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
10582
+ def initialize(**args)
10583
+ update!(**args)
10584
+ end
10611
10585
 
10612
- # Output only. Unique obfuscated identifier of a WidgetConfig.
10613
- # Corresponds to the JSON property `configId`
10614
- # @return [String]
10615
- attr_accessor :config_id
10586
+ # Update properties of this object
10587
+ def update!(**args)
10588
+ @create_time = args[:create_time] if args.key?(:create_time)
10589
+ @update_time = args[:update_time] if args.key?(:update_time)
10590
+ end
10591
+ end
10616
10592
 
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
10593
+ # Metadata for Create Schema LRO.
10594
+ class GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata
10595
+ include Google::Apis::Core::Hashable
10621
10596
 
10622
- # Output only. Timestamp the WidgetConfig was created.
10597
+ # Operation create time.
10623
10598
  # Corresponds to the JSON property `createTime`
10624
10599
  # @return [String]
10625
10600
  attr_accessor :create_time
10626
10601
 
10627
- # Output only. The type of the parent data store.
10628
- # Corresponds to the JSON property `dataStoreType`
10602
+ # Operation last update time. If the operation is done, this is also the finish
10603
+ # time.
10604
+ # Corresponds to the JSON property `updateTime`
10629
10605
  # @return [String]
10630
- attr_accessor :data_store_type
10606
+ attr_accessor :update_time
10631
10607
 
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
10608
+ def initialize(**args)
10609
+ update!(**args)
10610
+ end
10760
10611
 
10761
10612
  # Update properties of this object
10762
10613
  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
10614
  @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
10615
  @update_time = args[:update_time] if args.key?(:update_time)
10790
10616
  end
10791
10617
  end
10792
10618
 
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
10619
  # 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
11112
- include Google::Apis::Core::Hashable
11113
-
11114
- # Operation create time.
11115
- # Corresponds to the JSON property `createTime`
11116
- # @return [String]
11117
- attr_accessor :create_time
11118
-
11119
- # Operation last update time. If the operation is done, this is also the finish
11120
- # time.
11121
- # Corresponds to the JSON property `updateTime`
11122
- # @return [String]
11123
- attr_accessor :update_time
11124
-
11125
- def initialize(**args)
11126
- update!(**args)
11127
- end
11128
-
11129
- # Update properties of this object
11130
- def update!(**args)
11131
- @create_time = args[:create_time] if args.key?(:create_time)
11132
- @update_time = args[:update_time] if args.key?(:update_time)
11133
- end
11134
- end
11135
-
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
10620
+ # CreateTargetSite operation. This will be returned by the google.longrunning.
10621
+ # Operation.metadata field.
10622
+ class GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata
11159
10623
  include Google::Apis::Core::Hashable
11160
10624
 
11161
10625
  # Operation create time.
@@ -11180,75 +10644,42 @@ module Google
11180
10644
  end
11181
10645
  end
11182
10646
 
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
10647
+ # Metadata that describes a custom tuned model.
10648
+ class GoogleCloudDiscoveryengineV1betaCustomTuningModel
11186
10649
  include Google::Apis::Core::Hashable
11187
10650
 
11188
- # Operation create time.
10651
+ # Timestamp the Model was created at.
11189
10652
  # Corresponds to the JSON property `createTime`
11190
10653
  # @return [String]
11191
10654
  attr_accessor :create_time
11192
10655
 
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`
10656
+ # The display name of the model.
10657
+ # Corresponds to the JSON property `displayName`
11216
10658
  # @return [String]
11217
- attr_accessor :create_time
10659
+ attr_accessor :display_name
11218
10660
 
11219
- # Operation last update time. If the operation is done, this is also the finish
11220
- # time.
11221
- # Corresponds to the JSON property `updateTime`
10661
+ # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
10662
+ # Corresponds to the JSON property `modelState`
11222
10663
  # @return [String]
11223
- attr_accessor :update_time
10664
+ attr_accessor :model_state
11224
10665
 
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
10666
+ #
10667
+ # Corresponds to the JSON property `modelVersion`
10668
+ # @return [Fixnum]
10669
+ attr_accessor :model_version
11241
10670
 
11242
- # Operation create time.
11243
- # Corresponds to the JSON property `createTime`
10671
+ # Required. The fully qualified resource name of the model. Format: `projects/`
10672
+ # project_number`/locations/`location`/collections/`collection`/dataStores/`
10673
+ # data_store`/customTuningModels/`custom_tuning_model`` model must be an alpha-
10674
+ # numerical string with limit of 40 characters.
10675
+ # Corresponds to the JSON property `name`
11244
10676
  # @return [String]
11245
- attr_accessor :create_time
10677
+ attr_accessor :name
11246
10678
 
11247
- # Operation last update time. If the operation is done, this is also the finish
11248
- # time.
11249
- # Corresponds to the JSON property `updateTime`
10679
+ # Timestamp the model training was initiated.
10680
+ # Corresponds to the JSON property `trainingStartTime`
11250
10681
  # @return [String]
11251
- attr_accessor :update_time
10682
+ attr_accessor :training_start_time
11252
10683
 
11253
10684
  def initialize(**args)
11254
10685
  update!(**args)
@@ -11257,7 +10688,11 @@ module Google
11257
10688
  # Update properties of this object
11258
10689
  def update!(**args)
11259
10690
  @create_time = args[:create_time] if args.key?(:create_time)
11260
- @update_time = args[:update_time] if args.key?(:update_time)
10691
+ @display_name = args[:display_name] if args.key?(:display_name)
10692
+ @model_state = args[:model_state] if args.key?(:model_state)
10693
+ @model_version = args[:model_version] if args.key?(:model_version)
10694
+ @name = args[:name] if args.key?(:name)
10695
+ @training_start_time = args[:training_start_time] if args.key?(:training_start_time)
11261
10696
  end
11262
10697
  end
11263
10698
 
@@ -12107,6 +11542,25 @@ module Google
12107
11542
  end
12108
11543
  end
12109
11544
 
11545
+ # Response message for SearchTuningService.ListCustomModels method.
11546
+ class GoogleCloudDiscoveryengineV1betaListCustomModelsResponse
11547
+ include Google::Apis::Core::Hashable
11548
+
11549
+ # List of custom tuning models.
11550
+ # Corresponds to the JSON property `models`
11551
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaCustomTuningModel>]
11552
+ attr_accessor :models
11553
+
11554
+ def initialize(**args)
11555
+ update!(**args)
11556
+ end
11557
+
11558
+ # Update properties of this object
11559
+ def update!(**args)
11560
+ @models = args[:models] if args.key?(:models)
11561
+ end
11562
+ end
11563
+
12110
11564
  # Metadata related to the progress of the PurgeDocuments operation. This will be
12111
11565
  # returned by the google.longrunning.Operation.metadata field.
12112
11566
  class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata
@@ -12336,6 +11790,11 @@ module Google
12336
11790
  # @return [String]
12337
11791
  attr_accessor :provided_uri_pattern
12338
11792
 
11793
+ # Output only. Root domain of the provided_uri_pattern.
11794
+ # Corresponds to the JSON property `rootDomainUri`
11795
+ # @return [String]
11796
+ attr_accessor :root_domain_uri
11797
+
12339
11798
  # Verification information for target sites in advanced site search.
12340
11799
  # Corresponds to the JSON property `siteVerificationInfo`
12341
11800
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSiteVerificationInfo]
@@ -12364,6 +11823,7 @@ module Google
12364
11823
  @indexing_status = args[:indexing_status] if args.key?(:indexing_status)
12365
11824
  @name = args[:name] if args.key?(:name)
12366
11825
  @provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
11826
+ @root_domain_uri = args[:root_domain_uri] if args.key?(:root_domain_uri)
12367
11827
  @site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
12368
11828
  @type = args[:type] if args.key?(:type)
12369
11829
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -12456,6 +11916,11 @@ module Google
12456
11916
  # @return [Hash<String,Float>]
12457
11917
  attr_accessor :metrics
12458
11918
 
11919
+ # Fully qualified name of the CustomTuningModel.
11920
+ # Corresponds to the JSON property `modelName`
11921
+ # @return [String]
11922
+ attr_accessor :model_name
11923
+
12459
11924
  # The trained model status. Possible values are: * **bad-data**: The training
12460
11925
  # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
12461
11926
  # Won't deploy. * **in-progress**: Model training job creation is in progress. *
@@ -12475,6 +11940,7 @@ module Google
12475
11940
  @error_config = args[:error_config] if args.key?(:error_config)
12476
11941
  @error_samples = args[:error_samples] if args.key?(:error_samples)
12477
11942
  @metrics = args[:metrics] if args.key?(:metrics)
11943
+ @model_name = args[:model_name] if args.key?(:model_name)
12478
11944
  @model_status = args[:model_status] if args.key?(:model_status)
12479
11945
  end
12480
11946
  end