google-apis-discoveryengine_v1alpha 0.43.0 → 0.45.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.
@@ -741,8 +741,8 @@ module Google
741
741
  class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig
742
742
  include Google::Apis::Core::Hashable
743
743
 
744
- # Apply additional enhanced OCR processing to a list of document elements.
745
- # Supported values: * `table`: advanced table parsing model.
744
+ # [DEPRECATED] This field is deprecated. To use the additional enhanced document
745
+ # elements processing, please switch to `layout_parsing_config`.
746
746
  # Corresponds to the JSON property `enhancedDocumentElements`
747
747
  # @return [Array<String>]
748
748
  attr_accessor :enhanced_document_elements
@@ -917,8 +917,8 @@ module Google
917
917
  # projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
918
918
  # one-time consumed by and passed to Dialogflow service. It means they cannot be
919
919
  # retrieved using EngineService.GetEngine or EngineService.ListEngines API after
920
- # engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual
921
- # agent association after Engine is created.
920
+ # engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent
921
+ # association after Engine is created.
922
922
  # Corresponds to the JSON property `dialogflowAgentToLink`
923
923
  # @return [String]
924
924
  attr_accessor :dialogflow_agent_to_link
@@ -1031,7 +1031,7 @@ module Google
1031
1031
  attr_accessor :search_add_ons
1032
1032
 
1033
1033
  # The search feature tier of this engine. Different tiers might have different
1034
- # pricing. To learn more, please check the pricing documentation. Defaults to
1034
+ # pricing. To learn more, check the pricing documentation. Defaults to
1035
1035
  # SearchTier.SEARCH_TIER_STANDARD if not specified.
1036
1036
  # Corresponds to the JSON property `searchTier`
1037
1037
  # @return [String]
@@ -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
@@ -1711,8 +1697,8 @@ module Google
1711
1697
  # @return [String]
1712
1698
  attr_accessor :create_time
1713
1699
 
1714
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
1715
- # collection`/engines/`engine`/sessions/*/answers/*`
1700
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
1701
+ # collections/`collection`/engines/`engine`/sessions/*/answers/*`
1716
1702
  # Corresponds to the JSON property `name`
1717
1703
  # @return [String]
1718
1704
  attr_accessor :name
@@ -2051,7 +2037,7 @@ module Google
2051
2037
  attr_accessor :disable
2052
2038
  alias_method :disable?, :disable
2053
2039
 
2054
- # Max rephrase steps. The max number is 10 steps. If not set or set to < 1, it
2040
+ # Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it
2055
2041
  # will be set to 1 by default.
2056
2042
  # Corresponds to the JSON property `maxRephraseSteps`
2057
2043
  # @return [Fixnum]
@@ -2142,6 +2128,11 @@ module Google
2142
2128
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec]
2143
2129
  attr_accessor :boost_spec
2144
2130
 
2131
+ # Defines custom fine tuning spec.
2132
+ # Corresponds to the JSON property `customFineTuningSpec`
2133
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
2134
+ attr_accessor :custom_fine_tuning_spec
2135
+
2145
2136
  # The filter syntax consists of an expression language for constructing a
2146
2137
  # predicate from one or more fields of the documents being filtered. Filter
2147
2138
  # expression is case-sensitive. This will be used to filter search results which
@@ -2188,6 +2179,7 @@ module Google
2188
2179
  # Update properties of this object
2189
2180
  def update!(**args)
2190
2181
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
2182
+ @custom_fine_tuning_spec = args[:custom_fine_tuning_spec] if args.key?(:custom_fine_tuning_spec)
2191
2183
  @filter = args[:filter] if args.key?(:filter)
2192
2184
  @max_return_results = args[:max_return_results] if args.key?(:max_return_results)
2193
2185
  @order_by = args[:order_by] if args.key?(:order_by)
@@ -2399,6 +2391,11 @@ module Google
2399
2391
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer]
2400
2392
  attr_accessor :answer
2401
2393
 
2394
+ # A global unique ID used for logging.
2395
+ # Corresponds to the JSON property `answerQueryToken`
2396
+ # @return [String]
2397
+ attr_accessor :answer_query_token
2398
+
2402
2399
  # External session proto definition.
2403
2400
  # Corresponds to the JSON property `session`
2404
2401
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
@@ -2411,6 +2408,7 @@ module Google
2411
2408
  # Update properties of this object
2412
2409
  def update!(**args)
2413
2410
  @answer = args[:answer] if args.key?(:answer)
2411
+ @answer_query_token = args[:answer_query_token] if args.key?(:answer_query_token)
2414
2412
  @session = args[:session] if args.key?(:session)
2415
2413
  end
2416
2414
  end
@@ -3135,7 +3133,7 @@ module Google
3135
3133
  class GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest
3136
3134
  include Google::Apis::Core::Hashable
3137
3135
 
3138
- # Answer candidate to check.
3136
+ # Answer candidate to check. Can have a maximum length of 1024 characters.
3139
3137
  # Corresponds to the JSON property `answerCandidate`
3140
3138
  # @return [String]
3141
3139
  attr_accessor :answer_candidate
@@ -3150,6 +3148,21 @@ module Google
3150
3148
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec]
3151
3149
  attr_accessor :grounding_spec
3152
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
+
3153
3166
  def initialize(**args)
3154
3167
  update!(**args)
3155
3168
  end
@@ -3159,6 +3172,7 @@ module Google
3159
3172
  @answer_candidate = args[:answer_candidate] if args.key?(:answer_candidate)
3160
3173
  @facts = args[:facts] if args.key?(:facts)
3161
3174
  @grounding_spec = args[:grounding_spec] if args.key?(:grounding_spec)
3175
+ @user_labels = args[:user_labels] if args.key?(:user_labels)
3162
3176
  end
3163
3177
  end
3164
3178
 
@@ -3219,8 +3233,17 @@ module Google
3219
3233
  # @return [Fixnum]
3220
3234
  attr_accessor :end_pos
3221
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
+
3222
3245
  # Position indicating the start of the claim in the answer candidate, measured
3223
- # in bytes/unicode.
3246
+ # in bytes.
3224
3247
  # Corresponds to the JSON property `startPos`
3225
3248
  # @return [Fixnum]
3226
3249
  attr_accessor :start_pos
@@ -3234,6 +3257,7 @@ module Google
3234
3257
  @citation_indices = args[:citation_indices] if args.key?(:citation_indices)
3235
3258
  @claim_text = args[:claim_text] if args.key?(:claim_text)
3236
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)
3237
3261
  @start_pos = args[:start_pos] if args.key?(:start_pos)
3238
3262
  end
3239
3263
  end
@@ -3358,6 +3382,12 @@ module Google
3358
3382
  class GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata
3359
3383
  include Google::Apis::Core::Hashable
3360
3384
 
3385
+ # Data representation. The structured JSON data for the document. It should
3386
+ # conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
3387
+ # Corresponds to the JSON property `structData`
3388
+ # @return [Hash<String,Object>]
3389
+ attr_accessor :struct_data
3390
+
3361
3391
  # Title of the document.
3362
3392
  # Corresponds to the JSON property `title`
3363
3393
  # @return [String]
@@ -3374,6 +3404,7 @@ module Google
3374
3404
 
3375
3405
  # Update properties of this object
3376
3406
  def update!(**args)
3407
+ @struct_data = args[:struct_data] if args.key?(:struct_data)
3377
3408
  @title = args[:title] if args.key?(:title)
3378
3409
  @uri = args[:uri] if args.key?(:uri)
3379
3410
  end
@@ -3416,7 +3447,7 @@ module Google
3416
3447
 
3417
3448
  # Intermediate Cloud Storage directory used for the import with a length limit
3418
3449
  # of 2,000 characters. Can be specified if one wants to have the Cloud SQL
3419
- # export to a specific Cloud Storage directory. Please ensure that the Cloud SQL
3450
+ # export to a specific Cloud Storage directory. Ensure that the Cloud SQL
3420
3451
  # service account has the necessary Cloud Storage Admin permissions to access
3421
3452
  # the specified Cloud Storage directory.
3422
3453
  # Corresponds to the JSON property `gcsStagingDir`
@@ -3463,71 +3494,6 @@ module Google
3463
3494
  end
3464
3495
  end
3465
3496
 
3466
- # Request message for CompletionService.CompleteQuery method.
3467
- class GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest
3468
- include Google::Apis::Core::Hashable
3469
-
3470
- # Required. The parent data store resource name for which the completion is
3471
- # performed, such as `projects/*/locations/global/collections/default_collection/
3472
- # dataStores/default_data_store`.
3473
- # Corresponds to the JSON property `dataStore`
3474
- # @return [String]
3475
- attr_accessor :data_store
3476
-
3477
- # Indicates if tail suggestions should be returned if there are no suggestions
3478
- # that match the full query. Even if set to true, if there are suggestions that
3479
- # match the full query, those are returned and no tail suggestions are returned.
3480
- # Corresponds to the JSON property `includeTailSuggestions`
3481
- # @return [Boolean]
3482
- attr_accessor :include_tail_suggestions
3483
- alias_method :include_tail_suggestions?, :include_tail_suggestions
3484
-
3485
- # Required. The typeahead input used to fetch suggestions. Maximum length is 128
3486
- # characters.
3487
- # Corresponds to the JSON property `query`
3488
- # @return [String]
3489
- attr_accessor :query
3490
-
3491
- # Specifies the autocomplete data model. This overrides any model specified in
3492
- # the Configuration > Autocomplete section of the Cloud console. Currently
3493
- # supported values: * `document` - Using suggestions generated from user-
3494
- # imported documents. * `search-history` - Using suggestions generated from the
3495
- # past history of SearchService.Search API calls. Do not use it when there is no
3496
- # traffic for Search API. * `user-event` - Using suggestions generated from user-
3497
- # imported search events. * `document-completable` - Using suggestions taken
3498
- # directly from user-imported document fields marked as completable. Default
3499
- # values: * `document` is the default model for regular dataStores. * `search-
3500
- # history` is the default model for site search dataStores.
3501
- # Corresponds to the JSON property `queryModel`
3502
- # @return [String]
3503
- attr_accessor :query_model
3504
-
3505
- # A unique identifier for tracking visitors. For example, this could be
3506
- # implemented with an HTTP cookie, which should be able to uniquely identify a
3507
- # visitor on a single device. This unique identifier should not change if the
3508
- # visitor logs in or out of the website. This field should NOT have a fixed
3509
- # value such as `unknown_visitor`. This should be the same identifier as
3510
- # UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a
3511
- # UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `
3512
- # INVALID_ARGUMENT` error is returned.
3513
- # Corresponds to the JSON property `userPseudoId`
3514
- # @return [String]
3515
- attr_accessor :user_pseudo_id
3516
-
3517
- def initialize(**args)
3518
- update!(**args)
3519
- end
3520
-
3521
- # Update properties of this object
3522
- def update!(**args)
3523
- @data_store = args[:data_store] if args.key?(:data_store)
3524
- @include_tail_suggestions = args[:include_tail_suggestions] if args.key?(:include_tail_suggestions)
3525
- @query = args[:query] if args.key?(:query)
3526
- @query_model = args[:query_model] if args.key?(:query_model)
3527
- @user_pseudo_id = args[:user_pseudo_id] if args.key?(:user_pseudo_id)
3528
- end
3529
- end
3530
-
3531
3497
  # Response message for CompletionService.CompleteQuery method.
3532
3498
  class GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse
3533
3499
  include Google::Apis::Core::Hashable
@@ -3625,9 +3591,9 @@ module Google
3625
3591
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversationMessage>]
3626
3592
  attr_accessor :messages
3627
3593
 
3628
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
3629
- # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
3630
- # collections/`collection`/engines/*/conversations/*`.
3594
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
3595
+ # collections/`collection`/dataStore/*/conversations/*` or `projects/`project`/
3596
+ # locations/global/collections/`collection`/engines/*/conversations/*`.
3631
3597
  # Corresponds to the JSON property `name`
3632
3598
  # @return [String]
3633
3599
  attr_accessor :name
@@ -3750,16 +3716,6 @@ module Google
3750
3716
  # @return [String]
3751
3717
  attr_accessor :filter
3752
3718
 
3753
- # Required. The resource name of the Conversation to get. Format: `projects/`
3754
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
3755
- # data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
3756
- # /locations/`location_id`/collections/`collection`/dataStores/`data_store_id`/
3757
- # conversations/-` to activate auto session mode, which automatically creates a
3758
- # new conversation inside a ConverseConversation session.
3759
- # Corresponds to the JSON property `name`
3760
- # @return [String]
3761
- attr_accessor :name
3762
-
3763
3719
  # Defines text input.
3764
3720
  # Corresponds to the JSON property `query`
3765
3721
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTextInput]
@@ -3808,7 +3764,6 @@ module Google
3808
3764
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
3809
3765
  @conversation = args[:conversation] if args.key?(:conversation)
3810
3766
  @filter = args[:filter] if args.key?(:filter)
3811
- @name = args[:name] if args.key?(:name)
3812
3767
  @query = args[:query] if args.key?(:query)
3813
3768
  @safe_search = args[:safe_search] if args.key?(:safe_search)
3814
3769
  @serving_config = args[:serving_config] if args.key?(:serving_config)
@@ -4043,6 +3998,58 @@ module Google
4043
3998
  end
4044
3999
  end
4045
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
+
4046
4053
  # DataStore captures global settings and configs at the DataStore level.
4047
4054
  class GoogleCloudDiscoveryengineV1alphaDataStore
4048
4055
  include Google::Apis::Core::Hashable
@@ -4680,8 +4687,8 @@ module Google
4680
4687
  class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig
4681
4688
  include Google::Apis::Core::Hashable
4682
4689
 
4683
- # Apply additional enhanced OCR processing to a list of document elements.
4684
- # Supported values: * `table`: advanced table parsing model.
4690
+ # [DEPRECATED] This field is deprecated. To use the additional enhanced document
4691
+ # elements processing, please switch to `layout_parsing_config`.
4685
4692
  # Corresponds to the JSON property `enhancedDocumentElements`
4686
4693
  # @return [Array<String>]
4687
4694
  attr_accessor :enhanced_document_elements
@@ -4925,8 +4932,8 @@ module Google
4925
4932
  # projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
4926
4933
  # one-time consumed by and passed to Dialogflow service. It means they cannot be
4927
4934
  # retrieved using EngineService.GetEngine or EngineService.ListEngines API after
4928
- # engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual
4929
- # agent association after Engine is created.
4935
+ # engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent
4936
+ # association after Engine is created.
4930
4937
  # Corresponds to the JSON property `dialogflowAgentToLink`
4931
4938
  # @return [String]
4932
4939
  attr_accessor :dialogflow_agent_to_link
@@ -5161,7 +5168,7 @@ module Google
5161
5168
  attr_accessor :search_add_ons
5162
5169
 
5163
5170
  # The search feature tier of this engine. Different tiers might have different
5164
- # pricing. To learn more, please check the pricing documentation. Defaults to
5171
+ # pricing. To learn more, check the pricing documentation. Defaults to
5165
5172
  # SearchTier.SEARCH_TIER_STANDARD if not specified.
5166
5173
  # Corresponds to the JSON property `searchTier`
5167
5174
  # @return [String]
@@ -5354,6 +5361,11 @@ module Google
5354
5361
  # @return [String]
5355
5362
  attr_accessor :chunk_text
5356
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
+
5357
5369
  # Source from which this fact chunk was retrieved. If it was retrieved from the
5358
5370
  # GroundingFacts provided in the request then this field will contain the index
5359
5371
  # of the specific fact from which this chunk was retrieved.
@@ -5373,6 +5385,7 @@ module Google
5373
5385
  # Update properties of this object
5374
5386
  def update!(**args)
5375
5387
  @chunk_text = args[:chunk_text] if args.key?(:chunk_text)
5388
+ @index = args[:index] if args.key?(:index)
5376
5389
  @source = args[:source] if args.key?(:source)
5377
5390
  @source_metadata = args[:source_metadata] if args.key?(:source_metadata)
5378
5391
  end
@@ -5446,6 +5459,15 @@ module Google
5446
5459
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
5447
5460
  include Google::Apis::Core::Hashable
5448
5461
 
5462
+ # If this field is set, only the corresponding source will be indexed for this
5463
+ # field. Otherwise, the values from different sources are merged. Assuming a
5464
+ # page with `` in meta tag, and `` in page map: if this enum is set to METATAGS,
5465
+ # we will only index ``; if this enum is not set, we will merge them and index ``
5466
+ # .
5467
+ # Corresponds to the JSON property `advancedSiteSearchDataSources`
5468
+ # @return [Array<String>]
5469
+ attr_accessor :advanced_site_search_data_sources
5470
+
5449
5471
  # If completable_option is COMPLETABLE_ENABLED, field values are directly used
5450
5472
  # and returned as suggestions for Autocomplete in CompletionService.
5451
5473
  # CompleteQuery. If completable_option is unset, the server behavior defaults to
@@ -5546,6 +5568,7 @@ module Google
5546
5568
 
5547
5569
  # Update properties of this object
5548
5570
  def update!(**args)
5571
+ @advanced_site_search_data_sources = args[:advanced_site_search_data_sources] if args.key?(:advanced_site_search_data_sources)
5549
5572
  @completable_option = args[:completable_option] if args.key?(:completable_option)
5550
5573
  @dynamic_facetable_option = args[:dynamic_facetable_option] if args.key?(:dynamic_facetable_option)
5551
5574
  @field_path = args[:field_path] if args.key?(:field_path)
@@ -5576,7 +5599,7 @@ module Google
5576
5599
 
5577
5600
  # Intermediate Cloud Storage directory used for the import with a length limit
5578
5601
  # of 2,000 characters. Can be specified if one wants to have the Firestore
5579
- # export to a specific Cloud Storage directory. Please ensure that the Firestore
5602
+ # export to a specific Cloud Storage directory. Ensure that the Firestore
5580
5603
  # service account has the necessary Cloud Storage Admin permissions to access
5581
5604
  # the specified Cloud Storage directory.
5582
5605
  # Corresponds to the JSON property `gcsStagingDir`
@@ -5748,66 +5771,6 @@ module Google
5748
5771
  end
5749
5772
  end
5750
5773
 
5751
- # Metadata related to the progress of the ImportCompletionSuggestions operation.
5752
- # This will be returned by the google.longrunning.Operation.metadata field.
5753
- class GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata
5754
- include Google::Apis::Core::Hashable
5755
-
5756
- # Operation create time.
5757
- # Corresponds to the JSON property `createTime`
5758
- # @return [String]
5759
- attr_accessor :create_time
5760
-
5761
- # Operation last update time. If the operation is done, this is also the finish
5762
- # time.
5763
- # Corresponds to the JSON property `updateTime`
5764
- # @return [String]
5765
- attr_accessor :update_time
5766
-
5767
- def initialize(**args)
5768
- update!(**args)
5769
- end
5770
-
5771
- # Update properties of this object
5772
- def update!(**args)
5773
- @create_time = args[:create_time] if args.key?(:create_time)
5774
- @update_time = args[:update_time] if args.key?(:update_time)
5775
- end
5776
- end
5777
-
5778
- # Response of the CompletionService.ImportCompletionSuggestions method. If the
5779
- # long running operation is done, this message is returned by the google.
5780
- # longrunning.Operations.response field if the operation is successful.
5781
- class GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse
5782
- include Google::Apis::Core::Hashable
5783
-
5784
- # A sample of errors encountered while processing the request.
5785
- # Corresponds to the JSON property `errorSamples`
5786
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus>]
5787
- attr_accessor :error_samples
5788
-
5789
- # Count of CompletionSuggestions that failed to be imported.
5790
- # Corresponds to the JSON property `failureCount`
5791
- # @return [Fixnum]
5792
- attr_accessor :failure_count
5793
-
5794
- # Count of CompletionSuggestions successfully imported.
5795
- # Corresponds to the JSON property `successCount`
5796
- # @return [Fixnum]
5797
- attr_accessor :success_count
5798
-
5799
- def initialize(**args)
5800
- update!(**args)
5801
- end
5802
-
5803
- # Update properties of this object
5804
- def update!(**args)
5805
- @error_samples = args[:error_samples] if args.key?(:error_samples)
5806
- @failure_count = args[:failure_count] if args.key?(:failure_count)
5807
- @success_count = args[:success_count] if args.key?(:success_count)
5808
- end
5809
- end
5810
-
5811
5774
  # Metadata related to the progress of the ImportDocuments operation. This is
5812
5775
  # returned by the google.longrunning.Operation.metadata field.
5813
5776
  class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
@@ -6363,6 +6326,25 @@ module Google
6363
6326
  end
6364
6327
  end
6365
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
+
6366
6348
  # Response message for DataStoreService.ListDataStores method.
6367
6349
  class GoogleCloudDiscoveryengineV1alphaListDataStoresResponse
6368
6350
  include Google::Apis::Core::Hashable
@@ -6549,44 +6531,6 @@ module Google
6549
6531
  end
6550
6532
  end
6551
6533
 
6552
- # Request message for WidgetService.LookupWidgetConfig method.
6553
- class GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest
6554
- include Google::Apis::Core::Hashable
6555
-
6556
- # Required. The UUID of the Widget Config.
6557
- # Corresponds to the JSON property `widgetConfigId`
6558
- # @return [String]
6559
- attr_accessor :widget_config_id
6560
-
6561
- def initialize(**args)
6562
- update!(**args)
6563
- end
6564
-
6565
- # Update properties of this object
6566
- def update!(**args)
6567
- @widget_config_id = args[:widget_config_id] if args.key?(:widget_config_id)
6568
- end
6569
- end
6570
-
6571
- # Response message for WidgetService.LookupWidgetConfig method.
6572
- class GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse
6573
- include Google::Apis::Core::Hashable
6574
-
6575
- # WidgetConfig captures configs at the Widget level.
6576
- # Corresponds to the JSON property `anonymousWidgetConfig`
6577
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig]
6578
- attr_accessor :anonymous_widget_config
6579
-
6580
- def initialize(**args)
6581
- update!(**args)
6582
- end
6583
-
6584
- # Update properties of this object
6585
- def update!(**args)
6586
- @anonymous_widget_config = args[:anonymous_widget_config] if args.key?(:anonymous_widget_config)
6587
- end
6588
- end
6589
-
6590
6534
  # Media-specific user event information.
6591
6535
  class GoogleCloudDiscoveryengineV1alphaMediaInfo
6592
6536
  include Google::Apis::Core::Hashable
@@ -6623,12 +6567,12 @@ module Google
6623
6567
 
6624
6568
  # The most specific category associated with a category page. To represent full
6625
6569
  # path of category, use '>' sign to separate different hierarchies. If '>' is
6626
- # part of the category name, please replace it with other character(s). Category
6627
- # pages include special pages such as sales or promotions. For instance, a
6628
- # special sale page may have the category hierarchy: `"pageCategory" : "Sales >
6629
- # 2017 Black Friday Deals"`. Required for `view-category-page` events. Other
6630
- # event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error
6631
- # is returned.
6570
+ # part of the category name, replace it with other character(s). Category pages
6571
+ # include special pages such as sales or promotions. For instance, a special
6572
+ # sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017
6573
+ # Black Friday Deals"`. Required for `view-category-page` events. Other event
6574
+ # types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is
6575
+ # returned.
6632
6576
  # Corresponds to the JSON property `pageCategory`
6633
6577
  # @return [String]
6634
6578
  attr_accessor :page_category
@@ -6782,36 +6726,32 @@ module Google
6782
6726
  end
6783
6727
  end
6784
6728
 
6785
- # Metadata related to the progress of the PurgeDocuments operation. This will be
6786
- # returned by the google.longrunning.Operation.metadata field.
6787
- class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
6729
+ # Metadata and configurations for a Google Cloud project in the service.
6730
+ class GoogleCloudDiscoveryengineV1alphaProject
6788
6731
  include Google::Apis::Core::Hashable
6789
6732
 
6790
- # Operation create time.
6733
+ # Output only. The timestamp when this project is created.
6791
6734
  # Corresponds to the JSON property `createTime`
6792
6735
  # @return [String]
6793
6736
  attr_accessor :create_time
6794
6737
 
6795
- # Count of entries that encountered errors while processing.
6796
- # Corresponds to the JSON property `failureCount`
6797
- # @return [Fixnum]
6798
- attr_accessor :failure_count
6799
-
6800
- # Count of entries that were ignored as entries were not found.
6801
- # Corresponds to the JSON property `ignoredCount`
6802
- # @return [Fixnum]
6803
- attr_accessor :ignored_count
6804
-
6805
- # Count of entries that were deleted successfully.
6806
- # Corresponds to the JSON property `successCount`
6807
- # @return [Fixnum]
6808
- attr_accessor :success_count
6738
+ # Output only. Full resource name of the project, for example `projects/`
6739
+ # project_number``. Note that when making requests, project number and project
6740
+ # id are both acceptable, but the server will always respond in project number.
6741
+ # Corresponds to the JSON property `name`
6742
+ # @return [String]
6743
+ attr_accessor :name
6809
6744
 
6810
- # Operation last update time. If the operation is done, this is also the finish
6811
- # time.
6812
- # Corresponds to the JSON property `updateTime`
6745
+ # Output only. The timestamp when this project is successfully provisioned.
6746
+ # Empty value means this project is still provisioning and is not ready for use.
6747
+ # Corresponds to the JSON property `provisionCompletionTime`
6813
6748
  # @return [String]
6814
- attr_accessor :update_time
6749
+ attr_accessor :provision_completion_time
6750
+
6751
+ # Output only. A map of terms of services. The key is the `id` of ServiceTerms.
6752
+ # Corresponds to the JSON property `serviceTermsMap`
6753
+ # @return [Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProjectServiceTerms>]
6754
+ attr_accessor :service_terms_map
6815
6755
 
6816
6756
  def initialize(**args)
6817
6757
  update!(**args)
@@ -6820,19 +6760,155 @@ module Google
6820
6760
  # Update properties of this object
6821
6761
  def update!(**args)
6822
6762
  @create_time = args[:create_time] if args.key?(:create_time)
6823
- @failure_count = args[:failure_count] if args.key?(:failure_count)
6824
- @ignored_count = args[:ignored_count] if args.key?(:ignored_count)
6825
- @success_count = args[:success_count] if args.key?(:success_count)
6826
- @update_time = args[:update_time] if args.key?(:update_time)
6763
+ @name = args[:name] if args.key?(:name)
6764
+ @provision_completion_time = args[:provision_completion_time] if args.key?(:provision_completion_time)
6765
+ @service_terms_map = args[:service_terms_map] if args.key?(:service_terms_map)
6827
6766
  end
6828
6767
  end
6829
6768
 
6830
- # Request message for DocumentService.PurgeDocuments method.
6831
- class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest
6769
+ # Metadata about the terms of service.
6770
+ class GoogleCloudDiscoveryengineV1alphaProjectServiceTerms
6832
6771
  include Google::Apis::Core::Hashable
6833
6772
 
6834
- # Configuration of destination for Purge related errors.
6835
- # Corresponds to the JSON property `errorConfig`
6773
+ # The last time when the project agreed to the terms of service.
6774
+ # Corresponds to the JSON property `acceptTime`
6775
+ # @return [String]
6776
+ attr_accessor :accept_time
6777
+
6778
+ # The last time when the project declined or revoked the agreement to terms of
6779
+ # service.
6780
+ # Corresponds to the JSON property `declineTime`
6781
+ # @return [String]
6782
+ attr_accessor :decline_time
6783
+
6784
+ # The unique identifier of this terms of service. Available terms: * `
6785
+ # GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-
6786
+ # use-terms). When using this as `id`, the acceptable version to provide is `
6787
+ # 2022-11-23`.
6788
+ # Corresponds to the JSON property `id`
6789
+ # @return [String]
6790
+ attr_accessor :id
6791
+
6792
+ # Whether the project has accepted/rejected the service terms or it is still
6793
+ # pending.
6794
+ # Corresponds to the JSON property `state`
6795
+ # @return [String]
6796
+ attr_accessor :state
6797
+
6798
+ # The version string of the terms of service. For acceptable values, see the
6799
+ # comments for id above.
6800
+ # Corresponds to the JSON property `version`
6801
+ # @return [String]
6802
+ attr_accessor :version
6803
+
6804
+ def initialize(**args)
6805
+ update!(**args)
6806
+ end
6807
+
6808
+ # Update properties of this object
6809
+ def update!(**args)
6810
+ @accept_time = args[:accept_time] if args.key?(:accept_time)
6811
+ @decline_time = args[:decline_time] if args.key?(:decline_time)
6812
+ @id = args[:id] if args.key?(:id)
6813
+ @state = args[:state] if args.key?(:state)
6814
+ @version = args[:version] if args.key?(:version)
6815
+ end
6816
+ end
6817
+
6818
+ # Metadata associated with a project provision operation.
6819
+ class GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata
6820
+ include Google::Apis::Core::Hashable
6821
+
6822
+ def initialize(**args)
6823
+ update!(**args)
6824
+ end
6825
+
6826
+ # Update properties of this object
6827
+ def update!(**args)
6828
+ end
6829
+ end
6830
+
6831
+ # Request for ProjectService.ProvisionProject method.
6832
+ class GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest
6833
+ include Google::Apis::Core::Hashable
6834
+
6835
+ # Required. Set to `true` to specify that caller has read and would like to give
6836
+ # consent to the [Terms for data use](https://cloud.google.com/retail/data-use-
6837
+ # terms).
6838
+ # Corresponds to the JSON property `acceptDataUseTerms`
6839
+ # @return [Boolean]
6840
+ attr_accessor :accept_data_use_terms
6841
+ alias_method :accept_data_use_terms?, :accept_data_use_terms
6842
+
6843
+ # Required. The version of the [Terms for data use](https://cloud.google.com/
6844
+ # retail/data-use-terms) that caller has read and would like to give consent to.
6845
+ # Acceptable version is `2022-11-23`, and this may change over time.
6846
+ # Corresponds to the JSON property `dataUseTermsVersion`
6847
+ # @return [String]
6848
+ attr_accessor :data_use_terms_version
6849
+
6850
+ def initialize(**args)
6851
+ update!(**args)
6852
+ end
6853
+
6854
+ # Update properties of this object
6855
+ def update!(**args)
6856
+ @accept_data_use_terms = args[:accept_data_use_terms] if args.key?(:accept_data_use_terms)
6857
+ @data_use_terms_version = args[:data_use_terms_version] if args.key?(:data_use_terms_version)
6858
+ end
6859
+ end
6860
+
6861
+ # Metadata related to the progress of the PurgeDocuments operation. This will be
6862
+ # returned by the google.longrunning.Operation.metadata field.
6863
+ class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
6864
+ include Google::Apis::Core::Hashable
6865
+
6866
+ # Operation create time.
6867
+ # Corresponds to the JSON property `createTime`
6868
+ # @return [String]
6869
+ attr_accessor :create_time
6870
+
6871
+ # Count of entries that encountered errors while processing.
6872
+ # Corresponds to the JSON property `failureCount`
6873
+ # @return [Fixnum]
6874
+ attr_accessor :failure_count
6875
+
6876
+ # Count of entries that were ignored as entries were not found.
6877
+ # Corresponds to the JSON property `ignoredCount`
6878
+ # @return [Fixnum]
6879
+ attr_accessor :ignored_count
6880
+
6881
+ # Count of entries that were deleted successfully.
6882
+ # Corresponds to the JSON property `successCount`
6883
+ # @return [Fixnum]
6884
+ attr_accessor :success_count
6885
+
6886
+ # Operation last update time. If the operation is done, this is also the finish
6887
+ # time.
6888
+ # Corresponds to the JSON property `updateTime`
6889
+ # @return [String]
6890
+ attr_accessor :update_time
6891
+
6892
+ def initialize(**args)
6893
+ update!(**args)
6894
+ end
6895
+
6896
+ # Update properties of this object
6897
+ def update!(**args)
6898
+ @create_time = args[:create_time] if args.key?(:create_time)
6899
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
6900
+ @ignored_count = args[:ignored_count] if args.key?(:ignored_count)
6901
+ @success_count = args[:success_count] if args.key?(:success_count)
6902
+ @update_time = args[:update_time] if args.key?(:update_time)
6903
+ end
6904
+ end
6905
+
6906
+ # Request message for DocumentService.PurgeDocuments method.
6907
+ class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest
6908
+ include Google::Apis::Core::Hashable
6909
+
6910
+ # Configuration of destination for Purge related errors.
6911
+ # Corresponds to the JSON property `errorConfig`
6836
6912
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig]
6837
6913
  attr_accessor :error_config
6838
6914
 
@@ -7130,7 +7206,7 @@ module Google
7130
7206
  # @return [String]
7131
7207
  attr_accessor :query
7132
7208
 
7133
- # Required. A list of records to rank. At most 100 records to rank.
7209
+ # Required. A list of records to rank. At most 200 records to rank.
7134
7210
  # Corresponds to the JSON property `records`
7135
7211
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRankingRecord>]
7136
7212
  attr_accessor :records
@@ -7610,6 +7686,41 @@ module Google
7610
7686
  end
7611
7687
  end
7612
7688
 
7689
+ # Request for ReportConsentChange method.
7690
+ class GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest
7691
+ include Google::Apis::Core::Hashable
7692
+
7693
+ # Required. Whether customer decides to accept or decline service term. At this
7694
+ # moment, only accept action is supported.
7695
+ # Corresponds to the JSON property `consentChangeAction`
7696
+ # @return [String]
7697
+ attr_accessor :consent_change_action
7698
+
7699
+ # Required. The unique identifier of the terms of service to update. Available
7700
+ # term ids: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/
7701
+ # retail/data-use-terms). When using this service term id, the acceptable
7702
+ # service_term_version to provide is `2022-11-23`.
7703
+ # Corresponds to the JSON property `serviceTermId`
7704
+ # @return [String]
7705
+ attr_accessor :service_term_id
7706
+
7707
+ # Required. The version string of the terms of service to update.
7708
+ # Corresponds to the JSON property `serviceTermVersion`
7709
+ # @return [String]
7710
+ attr_accessor :service_term_version
7711
+
7712
+ def initialize(**args)
7713
+ update!(**args)
7714
+ end
7715
+
7716
+ # Update properties of this object
7717
+ def update!(**args)
7718
+ @consent_change_action = args[:consent_change_action] if args.key?(:consent_change_action)
7719
+ @service_term_id = args[:service_term_id] if args.key?(:service_term_id)
7720
+ @service_term_version = args[:service_term_version] if args.key?(:service_term_version)
7721
+ end
7722
+ end
7723
+
7613
7724
  # Request for resuming training of an engine.
7614
7725
  class GoogleCloudDiscoveryengineV1alphaResumeEngineRequest
7615
7726
  include Google::Apis::Core::Hashable
@@ -7795,9 +7906,9 @@ module Google
7795
7906
 
7796
7907
  # The order in which documents are returned. Documents can be ordered by a field
7797
7908
  # in an Document object. Leave it unset if ordered by relevance. `order_by`
7798
- # expression is case-sensitive. For more information on ordering, see [Ordering](
7799
- # https://cloud.google.com/retail/docs/filter-and-order#order) If this field is
7800
- # 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.
7801
7912
  # Corresponds to the JSON property `orderBy`
7802
7913
  # @return [String]
7803
7914
  attr_accessor :order_by
@@ -7862,16 +7973,6 @@ module Google
7862
7973
  attr_accessor :safe_search
7863
7974
  alias_method :safe_search?, :safe_search
7864
7975
 
7865
- # Required. The resource name of the Search serving config, such as `projects/*/
7866
- # locations/global/collections/default_collection/engines/*/servingConfigs/
7867
- # default_serving_config`, or `projects/*/locations/global/collections/
7868
- # default_collection/dataStores/default_data_store/servingConfigs/
7869
- # default_serving_config`. This field is used to identify the serving
7870
- # configuration name, set of models used to make the search.
7871
- # Corresponds to the JSON property `servingConfig`
7872
- # @return [String]
7873
- attr_accessor :serving_config
7874
-
7875
7976
  # The specification for query spell correction.
7876
7977
  # Corresponds to the JSON property `spellCorrectionSpec`
7877
7978
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec]
@@ -7934,7 +8035,6 @@ module Google
7934
8035
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
7935
8036
  @ranking_expression = args[:ranking_expression] if args.key?(:ranking_expression)
7936
8037
  @safe_search = args[:safe_search] if args.key?(:safe_search)
7937
- @serving_config = args[:serving_config] if args.key?(:serving_config)
7938
8038
  @spell_correction_spec = args[:spell_correction_spec] if args.key?(:spell_correction_spec)
7939
8039
  @user_info = args[:user_info] if args.key?(:user_info)
7940
8040
  @user_labels = args[:user_labels] if args.key?(:user_labels)
@@ -8208,8 +8308,8 @@ module Google
8208
8308
 
8209
8309
  # Specifies whether to return the confidence score from the extractive segments
8210
8310
  # in each search result. This feature is available only for new or allowlisted
8211
- # data stores. To allowlist your data store, please contact your Customer
8212
- # Engineer. The default value is `false`.
8311
+ # data stores. To allowlist your data store, contact your Customer Engineer. The
8312
+ # default value is `false`.
8213
8313
  # Corresponds to the JSON property `returnExtractiveSegmentScore`
8214
8314
  # @return [Boolean]
8215
8315
  attr_accessor :return_extractive_segment_score
@@ -8328,13 +8428,15 @@ module Google
8328
8428
 
8329
8429
  # The number of top results to generate the summary from. If the number of
8330
8430
  # results returned is less than `summaryResultCount`, the summary is generated
8331
- # from all of the results. At most 10 results can be used to generate a summary.
8431
+ # from all of the results. At most 10 results for documents mode, or 50 for
8432
+ # chunks mode, can be used to generate a summary. The chunks mode is used when
8433
+ # SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
8332
8434
  # Corresponds to the JSON property `summaryResultCount`
8333
8435
  # @return [Fixnum]
8334
8436
  attr_accessor :summary_result_count
8335
8437
 
8336
8438
  # If true, answer will be generated from most relevant chunks from top search
8337
- # results. This feature will improve summary quality. Please note that with this
8439
+ # results. This feature will improve summary quality. Note that with this
8338
8440
  # feature enabled, not all top search results will be referenced and included in
8339
8441
  # the reference list, so the citation source index only points to the search
8340
8442
  # results listed in the reference list.
@@ -9497,8 +9599,8 @@ module Google
9497
9599
  # @return [String]
9498
9600
  attr_accessor :end_time
9499
9601
 
9500
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
9501
- # collection`/engines/`engine`/sessions/*`
9602
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
9603
+ # collections/`collection`/engines/`engine`/sessions/*`
9502
9604
  # Corresponds to the JSON property `name`
9503
9605
  # @return [String]
9504
9606
  attr_accessor :name
@@ -9728,6 +9830,11 @@ module Google
9728
9830
  # @return [String]
9729
9831
  attr_accessor :provided_uri_pattern
9730
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
+
9731
9838
  # Verification information for target sites in advanced site search.
9732
9839
  # Corresponds to the JSON property `siteVerificationInfo`
9733
9840
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo]
@@ -9756,6 +9863,7 @@ module Google
9756
9863
  @indexing_status = args[:indexing_status] if args.key?(:indexing_status)
9757
9864
  @name = args[:name] if args.key?(:name)
9758
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)
9759
9867
  @site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
9760
9868
  @type = args[:type] if args.key?(:type)
9761
9869
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -9867,6 +9975,11 @@ module Google
9867
9975
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput]
9868
9976
  attr_accessor :gcs_training_input
9869
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
+
9870
9983
  # Model to be trained. Supported values are: * **search-tuning**: Fine tuning
9871
9984
  # the search system based on data provided.
9872
9985
  # Corresponds to the JSON property `modelType`
@@ -9881,6 +9994,7 @@ module Google
9881
9994
  def update!(**args)
9882
9995
  @error_config = args[:error_config] if args.key?(:error_config)
9883
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)
9884
9998
  @model_type = args[:model_type] if args.key?(:model_type)
9885
9999
  end
9886
10000
  end
@@ -9954,6 +10068,11 @@ module Google
9954
10068
  # @return [Hash<String,Float>]
9955
10069
  attr_accessor :metrics
9956
10070
 
10071
+ # Fully qualified name of the CustomTuningModel.
10072
+ # Corresponds to the JSON property `modelName`
10073
+ # @return [String]
10074
+ attr_accessor :model_name
10075
+
9957
10076
  # The trained model status. Possible values are: * **bad-data**: The training
9958
10077
  # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
9959
10078
  # Won't deploy. * **in-progress**: Model training job creation is in progress. *
@@ -9973,6 +10092,7 @@ module Google
9973
10092
  @error_config = args[:error_config] if args.key?(:error_config)
9974
10093
  @error_samples = args[:error_samples] if args.key?(:error_samples)
9975
10094
  @metrics = args[:metrics] if args.key?(:metrics)
10095
+ @model_name = args[:model_name] if args.key?(:model_name)
9976
10096
  @model_status = args[:model_status] if args.key?(:model_status)
9977
10097
  end
9978
10098
  end
@@ -10368,605 +10488,6 @@ module Google
10368
10488
  end
10369
10489
  end
10370
10490
 
10371
- # Request message for WidgetService.WidgetCompleteQuery method.
10372
- class GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest
10373
- include Google::Apis::Core::Hashable
10374
-
10375
- # AdditionalParams message for WidgetService methods for security and privacy
10376
- # enhancement.
10377
- # Corresponds to the JSON property `additionalParams`
10378
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdditionalParams]
10379
- attr_accessor :additional_params
10380
-
10381
- # Request message for CompletionService.CompleteQuery method.
10382
- # Corresponds to the JSON property `completeQueryRequest`
10383
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest]
10384
- attr_accessor :complete_query_request
10385
-
10386
- # Required. The UUID of the WidgetConfig. This field is used to identify the
10387
- # widget configuration, set of models used to make the auto complete query.
10388
- # Corresponds to the JSON property `configId`
10389
- # @return [String]
10390
- attr_accessor :config_id
10391
-
10392
- def initialize(**args)
10393
- update!(**args)
10394
- end
10395
-
10396
- # Update properties of this object
10397
- def update!(**args)
10398
- @additional_params = args[:additional_params] if args.key?(:additional_params)
10399
- @complete_query_request = args[:complete_query_request] if args.key?(:complete_query_request)
10400
- @config_id = args[:config_id] if args.key?(:config_id)
10401
- end
10402
- end
10403
-
10404
- # Response message for WidgetService.WidgetCompleteQuery method.
10405
- class GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse
10406
- include Google::Apis::Core::Hashable
10407
-
10408
- # The token in response.
10409
- # Corresponds to the JSON property `uToken`
10410
- # @return [String]
10411
- attr_accessor :u_token
10412
-
10413
- # Results of the matched query suggestions in widget. The result list is ordered
10414
- # and the first result is a top suggestion.
10415
- # Corresponds to the JSON property `widgetQuerySuggestions`
10416
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion>]
10417
- attr_accessor :widget_query_suggestions
10418
-
10419
- def initialize(**args)
10420
- update!(**args)
10421
- end
10422
-
10423
- # Update properties of this object
10424
- def update!(**args)
10425
- @u_token = args[:u_token] if args.key?(:u_token)
10426
- @widget_query_suggestions = args[:widget_query_suggestions] if args.key?(:widget_query_suggestions)
10427
- end
10428
- end
10429
-
10430
- # Suggestions as search queries.
10431
- class GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion
10432
- include Google::Apis::Core::Hashable
10433
-
10434
- # The suggestion for the query.
10435
- # Corresponds to the JSON property `suggestion`
10436
- # @return [String]
10437
- attr_accessor :suggestion
10438
-
10439
- def initialize(**args)
10440
- update!(**args)
10441
- end
10442
-
10443
- # Update properties of this object
10444
- def update!(**args)
10445
- @suggestion = args[:suggestion] if args.key?(:suggestion)
10446
- end
10447
- end
10448
-
10449
- # WidgetConfig captures configs at the Widget level.
10450
- class GoogleCloudDiscoveryengineV1alphaWidgetConfig
10451
- include Google::Apis::Core::Hashable
10452
-
10453
- # Whether allow no-auth integration with widget. If set true, public access to
10454
- # search or other solutions from widget is allowed without authenication token
10455
- # provided by customer hosted backend server.
10456
- # Corresponds to the JSON property `allowPublicAccess`
10457
- # @return [Boolean]
10458
- attr_accessor :allow_public_access
10459
- alias_method :allow_public_access?, :allow_public_access
10460
-
10461
- # Allowlisted domains that can load this widget.
10462
- # Corresponds to the JSON property `allowlistedDomains`
10463
- # @return [Array<String>]
10464
- attr_accessor :allowlisted_domains
10465
-
10466
- # Output only. Collection components that lists all collections and child data
10467
- # stores associated with the widget config, those data sources can be used for
10468
- # filtering in widget service APIs, users can return results that from selected
10469
- # data sources.
10470
- # Corresponds to the JSON property `collectionComponents`
10471
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent>]
10472
- attr_accessor :collection_components
10473
-
10474
- # Output only. Unique obfuscated identifier of a WidgetConfig.
10475
- # Corresponds to the JSON property `configId`
10476
- # @return [String]
10477
- attr_accessor :config_id
10478
-
10479
- # A specification for configuring the behavior of content search.
10480
- # Corresponds to the JSON property `contentSearchSpec`
10481
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec]
10482
- attr_accessor :content_search_spec
10483
-
10484
- # Output only. Timestamp the WidgetConfig was created.
10485
- # Corresponds to the JSON property `createTime`
10486
- # @return [String]
10487
- attr_accessor :create_time
10488
-
10489
- # Output only. The type of the parent data store.
10490
- # Corresponds to the JSON property `dataStoreType`
10491
- # @return [String]
10492
- attr_accessor :data_store_type
10493
-
10494
- # Configurable UI configurations per data store.
10495
- # Corresponds to the JSON property `dataStoreUiConfigs`
10496
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig>]
10497
- attr_accessor :data_store_ui_configs
10498
-
10499
- # Required. The human readable widget config display name. Used in Discovery UI.
10500
- # This field must be a UTF-8 encoded string with a length limit of 128
10501
- # characters. Otherwise, an INVALID_ARGUMENT error is returned.
10502
- # Corresponds to the JSON property `displayName`
10503
- # @return [String]
10504
- attr_accessor :display_name
10505
-
10506
- # Whether or not to enable autocomplete.
10507
- # Corresponds to the JSON property `enableAutocomplete`
10508
- # @return [Boolean]
10509
- attr_accessor :enable_autocomplete
10510
- alias_method :enable_autocomplete?, :enable_autocomplete
10511
-
10512
- # Whether to allow conversational search (LLM, multi-turn) or not (non-LLM,
10513
- # single-turn).
10514
- # Corresponds to the JSON property `enableConversationalSearch`
10515
- # @return [Boolean]
10516
- attr_accessor :enable_conversational_search
10517
- alias_method :enable_conversational_search?, :enable_conversational_search
10518
-
10519
- # Turn on or off collecting the search result quality feedback from end users.
10520
- # Corresponds to the JSON property `enableQualityFeedback`
10521
- # @return [Boolean]
10522
- attr_accessor :enable_quality_feedback
10523
- alias_method :enable_quality_feedback?, :enable_quality_feedback
10524
-
10525
- # Whether to show the result score.
10526
- # Corresponds to the JSON property `enableResultScore`
10527
- # @return [Boolean]
10528
- attr_accessor :enable_result_score
10529
- alias_method :enable_result_score?, :enable_result_score
10530
-
10531
- # Whether to enable safe search.
10532
- # Corresponds to the JSON property `enableSafeSearch`
10533
- # @return [Boolean]
10534
- attr_accessor :enable_safe_search
10535
- alias_method :enable_safe_search?, :enable_safe_search
10536
-
10537
- # Whether to enable search-as-you-type behavior for the search widget
10538
- # Corresponds to the JSON property `enableSearchAsYouType`
10539
- # @return [Boolean]
10540
- attr_accessor :enable_search_as_you_type
10541
- alias_method :enable_search_as_you_type?, :enable_search_as_you_type
10542
-
10543
- # Turn on or off summary for each snippets result.
10544
- # Corresponds to the JSON property `enableSnippetResultSummary`
10545
- # @return [Boolean]
10546
- attr_accessor :enable_snippet_result_summary
10547
- alias_method :enable_snippet_result_summary?, :enable_snippet_result_summary
10548
-
10549
- # Turn on or off summarization for the search response.
10550
- # Corresponds to the JSON property `enableSummarization`
10551
- # @return [Boolean]
10552
- attr_accessor :enable_summarization
10553
- alias_method :enable_summarization?, :enable_summarization
10554
-
10555
- # Whether to enable standalone web app.
10556
- # Corresponds to the JSON property `enableWebApp`
10557
- # @return [Boolean]
10558
- attr_accessor :enable_web_app
10559
- alias_method :enable_web_app?, :enable_web_app
10560
-
10561
- # The configuration and appearance of facets in the end user view.
10562
- # Corresponds to the JSON property `facetField`
10563
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField>]
10564
- attr_accessor :facet_field
10565
-
10566
- # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `
10567
- # url`, `custom1`, `custom2`, `custom3`. The value is the name of the field
10568
- # along with its device visibility. The 3 custom fields are optional and can be
10569
- # added or removed. `title`, `thumbnail`, `url` are required UI components that
10570
- # cannot be removed.
10571
- # Corresponds to the JSON property `fieldsUiComponentsMap`
10572
- # @return [Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField>]
10573
- attr_accessor :fields_ui_components_map
10574
-
10575
- # Output only. The industry vertical that the WidgetConfig registers. The
10576
- # WidgetConfig industry vertical is based on the associated Engine.
10577
- # Corresponds to the JSON property `industryVertical`
10578
- # @return [String]
10579
- attr_accessor :industry_vertical
10580
-
10581
- # Output only. Whether LLM is enabled in the corresponding data store.
10582
- # Corresponds to the JSON property `llmEnabled`
10583
- # @return [Boolean]
10584
- attr_accessor :llm_enabled
10585
- alias_method :llm_enabled?, :llm_enabled
10586
-
10587
- # Output only. Whether the customer accepted data use terms.
10588
- # Corresponds to the JSON property `minimumDataTermAccepted`
10589
- # @return [Boolean]
10590
- attr_accessor :minimum_data_term_accepted
10591
- alias_method :minimum_data_term_accepted?, :minimum_data_term_accepted
10592
-
10593
- # Immutable. The full resource name of the widget config. Format: `projects/`
10594
- # project`/locations/`location`/collections/`collection_id`/dataStores/`
10595
- # data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
10596
- # encoded string with a length limit of 1024 characters.
10597
- # Corresponds to the JSON property `name`
10598
- # @return [String]
10599
- attr_accessor :name
10600
-
10601
- # The type of snippet to display in UCS widget. -
10602
- # RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-
10603
- # enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.
10604
- # Corresponds to the JSON property `resultDisplayType`
10605
- # @return [String]
10606
- attr_accessor :result_display_type
10607
-
10608
- # Required. Immutable. Specifies the solution type that this WidgetConfig can be
10609
- # used for.
10610
- # Corresponds to the JSON property `solutionType`
10611
- # @return [String]
10612
- attr_accessor :solution_type
10613
-
10614
- # Output only. Timestamp the WidgetConfig was updated.
10615
- # Corresponds to the JSON property `updateTime`
10616
- # @return [String]
10617
- attr_accessor :update_time
10618
-
10619
- def initialize(**args)
10620
- update!(**args)
10621
- end
10622
-
10623
- # Update properties of this object
10624
- def update!(**args)
10625
- @allow_public_access = args[:allow_public_access] if args.key?(:allow_public_access)
10626
- @allowlisted_domains = args[:allowlisted_domains] if args.key?(:allowlisted_domains)
10627
- @collection_components = args[:collection_components] if args.key?(:collection_components)
10628
- @config_id = args[:config_id] if args.key?(:config_id)
10629
- @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
10630
- @create_time = args[:create_time] if args.key?(:create_time)
10631
- @data_store_type = args[:data_store_type] if args.key?(:data_store_type)
10632
- @data_store_ui_configs = args[:data_store_ui_configs] if args.key?(:data_store_ui_configs)
10633
- @display_name = args[:display_name] if args.key?(:display_name)
10634
- @enable_autocomplete = args[:enable_autocomplete] if args.key?(:enable_autocomplete)
10635
- @enable_conversational_search = args[:enable_conversational_search] if args.key?(:enable_conversational_search)
10636
- @enable_quality_feedback = args[:enable_quality_feedback] if args.key?(:enable_quality_feedback)
10637
- @enable_result_score = args[:enable_result_score] if args.key?(:enable_result_score)
10638
- @enable_safe_search = args[:enable_safe_search] if args.key?(:enable_safe_search)
10639
- @enable_search_as_you_type = args[:enable_search_as_you_type] if args.key?(:enable_search_as_you_type)
10640
- @enable_snippet_result_summary = args[:enable_snippet_result_summary] if args.key?(:enable_snippet_result_summary)
10641
- @enable_summarization = args[:enable_summarization] if args.key?(:enable_summarization)
10642
- @enable_web_app = args[:enable_web_app] if args.key?(:enable_web_app)
10643
- @facet_field = args[:facet_field] if args.key?(:facet_field)
10644
- @fields_ui_components_map = args[:fields_ui_components_map] if args.key?(:fields_ui_components_map)
10645
- @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
10646
- @llm_enabled = args[:llm_enabled] if args.key?(:llm_enabled)
10647
- @minimum_data_term_accepted = args[:minimum_data_term_accepted] if args.key?(:minimum_data_term_accepted)
10648
- @name = args[:name] if args.key?(:name)
10649
- @result_display_type = args[:result_display_type] if args.key?(:result_display_type)
10650
- @solution_type = args[:solution_type] if args.key?(:solution_type)
10651
- @update_time = args[:update_time] if args.key?(:update_time)
10652
- end
10653
- end
10654
-
10655
- # Read-only collection component that contains data store collections fields
10656
- # that may be used for filtering
10657
- class GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent
10658
- include Google::Apis::Core::Hashable
10659
-
10660
- # For the data store collection, list of the children data stores.
10661
- # Corresponds to the JSON property `dataStoreComponents`
10662
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent>]
10663
- attr_accessor :data_store_components
10664
-
10665
- # The display name of the collection.
10666
- # Corresponds to the JSON property `displayName`
10667
- # @return [String]
10668
- attr_accessor :display_name
10669
-
10670
- # Output only. the identifier of the collection, used for widget service. For
10671
- # now it refers to collection_id, in the future we will migrate the field to
10672
- # encrypted collection name UUID.
10673
- # Corresponds to the JSON property `id`
10674
- # @return [String]
10675
- attr_accessor :id
10676
-
10677
- # The name of the collection. It should be collection resource name. Format: `
10678
- # projects/`project_number`/locations/`location`/collections/`collection_id``.
10679
- # For APIs under WidgetService, such as LookUpWidgetConfig, the project number
10680
- # and location part is erased in this field.
10681
- # Corresponds to the JSON property `name`
10682
- # @return [String]
10683
- attr_accessor :name
10684
-
10685
- def initialize(**args)
10686
- update!(**args)
10687
- end
10688
-
10689
- # Update properties of this object
10690
- def update!(**args)
10691
- @data_store_components = args[:data_store_components] if args.key?(:data_store_components)
10692
- @display_name = args[:display_name] if args.key?(:display_name)
10693
- @id = args[:id] if args.key?(:id)
10694
- @name = args[:name] if args.key?(:name)
10695
- end
10696
- end
10697
-
10698
- # Read-only data store component that contains data stores fields that may be
10699
- # used for filtering, it's the child of `CollectionComponent`.
10700
- class GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent
10701
- include Google::Apis::Core::Hashable
10702
-
10703
- # The display name of the data store.
10704
- # Corresponds to the JSON property `displayName`
10705
- # @return [String]
10706
- attr_accessor :display_name
10707
-
10708
- # Output only. the identifier of the data store, used for widget service. For
10709
- # now it refers to data_store_id, in the future we will migrate the field to
10710
- # encrypted data store name UUID.
10711
- # Corresponds to the JSON property `id`
10712
- # @return [String]
10713
- attr_accessor :id
10714
-
10715
- # The name of the data store. It should be data store resource name Format: `
10716
- # projects/`project_number`/locations/`location`/collections/`collection_id`/
10717
- # dataStores/`data_store_id``. For APIs under WidgetService, such as
10718
- # LookUpWidgetConfig, the project number and location part is erased in this
10719
- # field.
10720
- # Corresponds to the JSON property `name`
10721
- # @return [String]
10722
- attr_accessor :name
10723
-
10724
- def initialize(**args)
10725
- update!(**args)
10726
- end
10727
-
10728
- # Update properties of this object
10729
- def update!(**args)
10730
- @display_name = args[:display_name] if args.key?(:display_name)
10731
- @id = args[:id] if args.key?(:id)
10732
- @name = args[:name] if args.key?(:name)
10733
- end
10734
- end
10735
-
10736
- # UI component configuration for data store.
10737
- class GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig
10738
- include Google::Apis::Core::Hashable
10739
-
10740
- # Facet fields that store the mapping of fields to end user widget appearance.
10741
- # Corresponds to the JSON property `facetField`
10742
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField>]
10743
- attr_accessor :facet_field
10744
-
10745
- # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `
10746
- # url`, `custom1`, `custom2`, `custom3`. The value is the name of the field
10747
- # along with its device visibility. The 3 custom fields are optional and can be
10748
- # added or removed. `title`, `thumbnail`, `url` are required UI components that
10749
- # cannot be removed.
10750
- # Corresponds to the JSON property `fieldsUiComponentsMap`
10751
- # @return [Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField>]
10752
- attr_accessor :fields_ui_components_map
10753
-
10754
- # Output only. the identifier of the data store, used for widget service. For
10755
- # now it refers to data_store_id, in the future we will migrate the field to
10756
- # encrypted data store name UUID.
10757
- # Corresponds to the JSON property `id`
10758
- # @return [String]
10759
- attr_accessor :id
10760
-
10761
- # The name of the data store. It should be data store resource name Format: `
10762
- # projects/`project_number`/locations/`location`/collections/`collection_id`/
10763
- # dataStores/`data_store_id``. For APIs under WidgetService, such as
10764
- # LookUpWidgetConfig, the project number and location part is erased in this
10765
- # field.
10766
- # Corresponds to the JSON property `name`
10767
- # @return [String]
10768
- attr_accessor :name
10769
-
10770
- def initialize(**args)
10771
- update!(**args)
10772
- end
10773
-
10774
- # Update properties of this object
10775
- def update!(**args)
10776
- @facet_field = args[:facet_field] if args.key?(:facet_field)
10777
- @fields_ui_components_map = args[:fields_ui_components_map] if args.key?(:fields_ui_components_map)
10778
- @id = args[:id] if args.key?(:id)
10779
- @name = args[:name] if args.key?(:name)
10780
- end
10781
- end
10782
-
10783
- # Facet fields that store the mapping of fields to end user widget appearance.
10784
- class GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField
10785
- include Google::Apis::Core::Hashable
10786
-
10787
- # Optional. The field name that end users will see.
10788
- # Corresponds to the JSON property `displayName`
10789
- # @return [String]
10790
- attr_accessor :display_name
10791
-
10792
- # Required. Registered field name. The format is `field.abc`.
10793
- # Corresponds to the JSON property `field`
10794
- # @return [String]
10795
- attr_accessor :field
10796
-
10797
- def initialize(**args)
10798
- update!(**args)
10799
- end
10800
-
10801
- # Update properties of this object
10802
- def update!(**args)
10803
- @display_name = args[:display_name] if args.key?(:display_name)
10804
- @field = args[:field] if args.key?(:field)
10805
- end
10806
- end
10807
-
10808
- # Facet field that maps to a UI Component.
10809
- class GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField
10810
- include Google::Apis::Core::Hashable
10811
-
10812
- # The field visibility on different types of devices.
10813
- # Corresponds to the JSON property `deviceVisibility`
10814
- # @return [Array<String>]
10815
- attr_accessor :device_visibility
10816
-
10817
- # The template to customize how the field is displayed. An example value would
10818
- # be a string that looks like: "Price: `value`".
10819
- # Corresponds to the JSON property `displayTemplate`
10820
- # @return [String]
10821
- attr_accessor :display_template
10822
-
10823
- # Required. Registered field name. The format is `field.abc`.
10824
- # Corresponds to the JSON property `field`
10825
- # @return [String]
10826
- attr_accessor :field
10827
-
10828
- def initialize(**args)
10829
- update!(**args)
10830
- end
10831
-
10832
- # Update properties of this object
10833
- def update!(**args)
10834
- @device_visibility = args[:device_visibility] if args.key?(:device_visibility)
10835
- @display_template = args[:display_template] if args.key?(:display_template)
10836
- @field = args[:field] if args.key?(:field)
10837
- end
10838
- end
10839
-
10840
- # Request message for WidgetService.WidgetConverseConversation method.
10841
- class GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest
10842
- include Google::Apis::Core::Hashable
10843
-
10844
- # AdditionalParams message for WidgetService methods for security and privacy
10845
- # enhancement.
10846
- # Corresponds to the JSON property `additionalParams`
10847
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdditionalParams]
10848
- attr_accessor :additional_params
10849
-
10850
- # Required. The UUID of the WidgetConfig. This field is used to identify the
10851
- # widget configuration, set of models used to make the user event collection.
10852
- # Corresponds to the JSON property `configId`
10853
- # @return [String]
10854
- attr_accessor :config_id
10855
-
10856
- # The id of the Conversation to get. Use "-" to activate auto session mode,
10857
- # which automatically creates a new conversation inside a ConverseConversation
10858
- # session.
10859
- # Corresponds to the JSON property `conversationId`
10860
- # @return [String]
10861
- attr_accessor :conversation_id
10862
-
10863
- # Request message for ConversationalSearchService.ConverseConversation method.
10864
- # Corresponds to the JSON property `converseConversationRequest`
10865
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationRequest]
10866
- attr_accessor :converse_conversation_request
10867
-
10868
- def initialize(**args)
10869
- update!(**args)
10870
- end
10871
-
10872
- # Update properties of this object
10873
- def update!(**args)
10874
- @additional_params = args[:additional_params] if args.key?(:additional_params)
10875
- @config_id = args[:config_id] if args.key?(:config_id)
10876
- @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
10877
- @converse_conversation_request = args[:converse_conversation_request] if args.key?(:converse_conversation_request)
10878
- end
10879
- end
10880
-
10881
- # Response message for WidgetService.WidgetConverseConversation method.
10882
- class GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse
10883
- include Google::Apis::Core::Hashable
10884
-
10885
- # The id of the Conversation returned.
10886
- # Corresponds to the JSON property `conversationId`
10887
- # @return [String]
10888
- attr_accessor :conversation_id
10889
-
10890
- # Response message for ConversationalSearchService.ConverseConversation method.
10891
- # Corresponds to the JSON property `converseConversationResponse`
10892
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationResponse]
10893
- attr_accessor :converse_conversation_response
10894
-
10895
- # The token in response.
10896
- # Corresponds to the JSON property `uToken`
10897
- # @return [String]
10898
- attr_accessor :u_token
10899
-
10900
- def initialize(**args)
10901
- update!(**args)
10902
- end
10903
-
10904
- # Update properties of this object
10905
- def update!(**args)
10906
- @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
10907
- @converse_conversation_response = args[:converse_conversation_response] if args.key?(:converse_conversation_response)
10908
- @u_token = args[:u_token] if args.key?(:u_token)
10909
- end
10910
- end
10911
-
10912
- # Request message for WidgetService.WidgetSearch method.
10913
- class GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest
10914
- include Google::Apis::Core::Hashable
10915
-
10916
- # AdditionalParams message for WidgetService methods for security and privacy
10917
- # enhancement.
10918
- # Corresponds to the JSON property `additionalParams`
10919
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdditionalParams]
10920
- attr_accessor :additional_params
10921
-
10922
- # Required. The UUID of the Search WidgetConfig. This field is used to identify
10923
- # the search widget configuration, set of models used to make the search.
10924
- # Corresponds to the JSON property `configId`
10925
- # @return [String]
10926
- attr_accessor :config_id
10927
-
10928
- # Request message for SearchService.Search method.
10929
- # Corresponds to the JSON property `searchRequest`
10930
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest]
10931
- attr_accessor :search_request
10932
-
10933
- def initialize(**args)
10934
- update!(**args)
10935
- end
10936
-
10937
- # Update properties of this object
10938
- def update!(**args)
10939
- @additional_params = args[:additional_params] if args.key?(:additional_params)
10940
- @config_id = args[:config_id] if args.key?(:config_id)
10941
- @search_request = args[:search_request] if args.key?(:search_request)
10942
- end
10943
- end
10944
-
10945
- # Response message for WidgetService.WidgetSearch method.
10946
- class GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse
10947
- include Google::Apis::Core::Hashable
10948
-
10949
- # Response message for SearchService.Search method.
10950
- # Corresponds to the JSON property `searchResponse`
10951
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse]
10952
- attr_accessor :search_response
10953
-
10954
- # The token in response.
10955
- # Corresponds to the JSON property `uToken`
10956
- # @return [String]
10957
- attr_accessor :u_token
10958
-
10959
- def initialize(**args)
10960
- update!(**args)
10961
- end
10962
-
10963
- # Update properties of this object
10964
- def update!(**args)
10965
- @search_response = args[:search_response] if args.key?(:search_response)
10966
- @u_token = args[:u_token] if args.key?(:u_token)
10967
- end
10968
- end
10969
-
10970
10491
  # Metadata related to the progress of the SiteSearchEngineService.
10971
10492
  # BatchCreateTargetSites operation. This will be returned by the google.
10972
10493
  # longrunning.Operation.metadata field.
@@ -11123,6 +10644,58 @@ module Google
11123
10644
  end
11124
10645
  end
11125
10646
 
10647
+ # Metadata that describes a custom tuned model.
10648
+ class GoogleCloudDiscoveryengineV1betaCustomTuningModel
10649
+ include Google::Apis::Core::Hashable
10650
+
10651
+ # Timestamp the Model was created at.
10652
+ # Corresponds to the JSON property `createTime`
10653
+ # @return [String]
10654
+ attr_accessor :create_time
10655
+
10656
+ # The display name of the model.
10657
+ # Corresponds to the JSON property `displayName`
10658
+ # @return [String]
10659
+ attr_accessor :display_name
10660
+
10661
+ # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
10662
+ # Corresponds to the JSON property `modelState`
10663
+ # @return [String]
10664
+ attr_accessor :model_state
10665
+
10666
+ #
10667
+ # Corresponds to the JSON property `modelVersion`
10668
+ # @return [Fixnum]
10669
+ attr_accessor :model_version
10670
+
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`
10676
+ # @return [String]
10677
+ attr_accessor :name
10678
+
10679
+ # Timestamp the model training was initiated.
10680
+ # Corresponds to the JSON property `trainingStartTime`
10681
+ # @return [String]
10682
+ attr_accessor :training_start_time
10683
+
10684
+ def initialize(**args)
10685
+ update!(**args)
10686
+ end
10687
+
10688
+ # Update properties of this object
10689
+ def update!(**args)
10690
+ @create_time = args[:create_time] if args.key?(:create_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)
10696
+ end
10697
+ end
10698
+
11126
10699
  # DataStore captures global settings and configs at the DataStore level.
11127
10700
  class GoogleCloudDiscoveryengineV1betaDataStore
11128
10701
  include Google::Apis::Core::Hashable
@@ -11432,8 +11005,8 @@ module Google
11432
11005
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig
11433
11006
  include Google::Apis::Core::Hashable
11434
11007
 
11435
- # Apply additional enhanced OCR processing to a list of document elements.
11436
- # Supported values: * `table`: advanced table parsing model.
11008
+ # [DEPRECATED] This field is deprecated. To use the additional enhanced document
11009
+ # elements processing, please switch to `layout_parsing_config`.
11437
11010
  # Corresponds to the JSON property `enhancedDocumentElements`
11438
11011
  # @return [Array<String>]
11439
11012
  attr_accessor :enhanced_document_elements
@@ -11608,8 +11181,8 @@ module Google
11608
11181
  # projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
11609
11182
  # one-time consumed by and passed to Dialogflow service. It means they cannot be
11610
11183
  # retrieved using EngineService.GetEngine or EngineService.ListEngines API after
11611
- # engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual
11612
- # agent association after Engine is created.
11184
+ # engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent
11185
+ # association after Engine is created.
11613
11186
  # Corresponds to the JSON property `dialogflowAgentToLink`
11614
11187
  # @return [String]
11615
11188
  attr_accessor :dialogflow_agent_to_link
@@ -11722,7 +11295,7 @@ module Google
11722
11295
  attr_accessor :search_add_ons
11723
11296
 
11724
11297
  # The search feature tier of this engine. Different tiers might have different
11725
- # pricing. To learn more, please check the pricing documentation. Defaults to
11298
+ # pricing. To learn more, check the pricing documentation. Defaults to
11726
11299
  # SearchTier.SEARCH_TIER_STANDARD if not specified.
11727
11300
  # Corresponds to the JSON property `searchTier`
11728
11301
  # @return [String]
@@ -11969,6 +11542,25 @@ module Google
11969
11542
  end
11970
11543
  end
11971
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
+
11972
11564
  # Metadata related to the progress of the PurgeDocuments operation. This will be
11973
11565
  # returned by the google.longrunning.Operation.metadata field.
11974
11566
  class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata
@@ -12198,6 +11790,11 @@ module Google
12198
11790
  # @return [String]
12199
11791
  attr_accessor :provided_uri_pattern
12200
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
+
12201
11798
  # Verification information for target sites in advanced site search.
12202
11799
  # Corresponds to the JSON property `siteVerificationInfo`
12203
11800
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSiteVerificationInfo]
@@ -12226,6 +11823,7 @@ module Google
12226
11823
  @indexing_status = args[:indexing_status] if args.key?(:indexing_status)
12227
11824
  @name = args[:name] if args.key?(:name)
12228
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)
12229
11827
  @site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
12230
11828
  @type = args[:type] if args.key?(:type)
12231
11829
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -12318,6 +11916,11 @@ module Google
12318
11916
  # @return [Hash<String,Float>]
12319
11917
  attr_accessor :metrics
12320
11918
 
11919
+ # Fully qualified name of the CustomTuningModel.
11920
+ # Corresponds to the JSON property `modelName`
11921
+ # @return [String]
11922
+ attr_accessor :model_name
11923
+
12321
11924
  # The trained model status. Possible values are: * **bad-data**: The training
12322
11925
  # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
12323
11926
  # Won't deploy. * **in-progress**: Model training job creation is in progress. *
@@ -12337,6 +11940,7 @@ module Google
12337
11940
  @error_config = args[:error_config] if args.key?(:error_config)
12338
11941
  @error_samples = args[:error_samples] if args.key?(:error_samples)
12339
11942
  @metrics = args[:metrics] if args.key?(:metrics)
11943
+ @model_name = args[:model_name] if args.key?(:model_name)
12340
11944
  @model_status = args[:model_status] if args.key?(:model_status)
12341
11945
  end
12342
11946
  end
@@ -12362,6 +11966,19 @@ module Google
12362
11966
  end
12363
11967
  end
12364
11968
 
11969
+ # Response associated with a tune operation.
11970
+ class GoogleCloudDiscoveryengineV1betaTuneEngineResponse
11971
+ include Google::Apis::Core::Hashable
11972
+
11973
+ def initialize(**args)
11974
+ update!(**args)
11975
+ end
11976
+
11977
+ # Update properties of this object
11978
+ def update!(**args)
11979
+ end
11980
+ end
11981
+
12365
11982
  # Metadata for UpdateSchema LRO.
12366
11983
  class GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata
12367
11984
  include Google::Apis::Core::Hashable