google-apis-discoveryengine_v1 0.21.0 → 0.23.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b909364916b63087fc7ab0616deca7fadfec0f4ee61bc9adc723cea416123ed4
4
- data.tar.gz: 29ce96241bbe27475629015dd3c708fd4761ac7f2098d149ad3a2e321b812d75
3
+ metadata.gz: 30a1879dbe64d1967abdf3875b45fedb3e902f1f68a2743659d4e96c376baa17
4
+ data.tar.gz: 80afdab1f2072bd1928cd289fded63a03a2e23c5d7645f943ee55ae09b801f79
5
5
  SHA512:
6
- metadata.gz: 5108d71126ff9d82873718bd200c4cdb73fc26c9556d393695b17b51f3b1812693f9b8d1548a09135ebf48118a38d85ef2ab8fca1480acd8143fe8735d27938e
7
- data.tar.gz: d183d2f7dc8f48503be71a38e6773e6cc629129e0b858f2ed37d5ff7bd8b257d6ea9ff9af52fc5539541381fc5b32f81e53f5aacdb7c2d4f351190be308c9f88
6
+ metadata.gz: 71f4093f384d44f24bdf47f3997dace113b5a07adb95db9827da8bc678c48e85b8ca4e9ef83b2f365a10fcbfe5c39112009701c70b92d586a65d573f94595aef
7
+ data.tar.gz: '0978eadffc5abb7b5ca8d832ad4a4aaee3d6578aab3a6e133bfac3a4ebc70d3e7f3ecdb5833370a1920a51e32330f25313b40706228ccb4b43b42d2bbfb687a5'
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-discoveryengine_v1
2
2
 
3
+ ### v0.23.0 (2024-11-24)
4
+
5
+ * Regenerated from discovery document revision 20241123
6
+
7
+ ### v0.22.0 (2024-11-17)
8
+
9
+ * Regenerated from discovery document revision 20241110
10
+
3
11
  ### v0.21.0 (2024-11-03)
4
12
 
5
13
  * Regenerated from discovery document revision 20241030
@@ -1129,6 +1129,12 @@ module Google
1129
1129
  class GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec
1130
1130
  include Google::Apis::Core::Hashable
1131
1131
 
1132
+ # Optional. Specifies whether to enable the filtering based on grounding score
1133
+ # and at what level.
1134
+ # Corresponds to the JSON property `filteringLevel`
1135
+ # @return [String]
1136
+ attr_accessor :filtering_level
1137
+
1132
1138
  # Optional. Specifies whether to include grounding_supports in the answer. The
1133
1139
  # default value is `false`. When this field is set to `true`, returned answer
1134
1140
  # will have `grounding_score` and will contain GroundingSupports for each claim.
@@ -1143,6 +1149,7 @@ module Google
1143
1149
 
1144
1150
  # Update properties of this object
1145
1151
  def update!(**args)
1152
+ @filtering_level = args[:filtering_level] if args.key?(:filtering_level)
1146
1153
  @include_grounding_supports = args[:include_grounding_supports] if args.key?(:include_grounding_supports)
1147
1154
  end
1148
1155
  end
@@ -2537,9 +2544,15 @@ module Google
2537
2544
  # List of facts cited across all claims in the answer candidate. These are
2538
2545
  # derived from the facts supplied in the request.
2539
2546
  # Corresponds to the JSON property `citedChunks`
2540
- # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk>]
2547
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FactChunk>]
2541
2548
  attr_accessor :cited_chunks
2542
2549
 
2550
+ # List of facts cited across all claims in the answer candidate. These are
2551
+ # derived from the facts supplied in the request.
2552
+ # Corresponds to the JSON property `citedFacts`
2553
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk>]
2554
+ attr_accessor :cited_facts
2555
+
2543
2556
  # Claim texts and citation info across all claims in the answer candidate.
2544
2557
  # Corresponds to the JSON property `claims`
2545
2558
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim>]
@@ -2559,11 +2572,31 @@ module Google
2559
2572
  # Update properties of this object
2560
2573
  def update!(**args)
2561
2574
  @cited_chunks = args[:cited_chunks] if args.key?(:cited_chunks)
2575
+ @cited_facts = args[:cited_facts] if args.key?(:cited_facts)
2562
2576
  @claims = args[:claims] if args.key?(:claims)
2563
2577
  @support_score = args[:support_score] if args.key?(:support_score)
2564
2578
  end
2565
2579
  end
2566
2580
 
2581
+ # Fact chunk for grounding check.
2582
+ class GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk
2583
+ include Google::Apis::Core::Hashable
2584
+
2585
+ # Text content of the fact chunk. Can be at most 10K characters long.
2586
+ # Corresponds to the JSON property `chunkText`
2587
+ # @return [String]
2588
+ attr_accessor :chunk_text
2589
+
2590
+ def initialize(**args)
2591
+ update!(**args)
2592
+ end
2593
+
2594
+ # Update properties of this object
2595
+ def update!(**args)
2596
+ @chunk_text = args[:chunk_text] if args.key?(:chunk_text)
2597
+ end
2598
+ end
2599
+
2567
2600
  # Text and citation info for a claim in the answer candidate.
2568
2601
  class GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim
2569
2602
  include Google::Apis::Core::Hashable
@@ -2590,8 +2623,7 @@ module Google
2590
2623
  # Indicates that this claim required grounding check. When the system decided
2591
2624
  # this claim doesn't require attribution/grounding check, this field will be set
2592
2625
  # to false. In that case, no grounding check was done for the claim and
2593
- # therefore citation_indices, anti_citation_indices, and score should not be
2594
- # returned.
2626
+ # therefore citation_indices should not be returned.
2595
2627
  # Corresponds to the JSON property `groundingCheckRequired`
2596
2628
  # @return [Boolean]
2597
2629
  attr_accessor :grounding_check_required
@@ -2617,33 +2649,6 @@ module Google
2617
2649
  end
2618
2650
  end
2619
2651
 
2620
- # Fact chunk for grounding check.
2621
- class GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk
2622
- include Google::Apis::Core::Hashable
2623
-
2624
- # Text content of the fact chunk. Can be at most 10K characters long.
2625
- # Corresponds to the JSON property `chunkText`
2626
- # @return [String]
2627
- attr_accessor :chunk_text
2628
-
2629
- # Source from which this fact chunk was retrieved. For a fact chunk retrieved
2630
- # from inline facts, this field will contain the index of the specific fact from
2631
- # which this chunk was retrieved.
2632
- # Corresponds to the JSON property `source`
2633
- # @return [String]
2634
- attr_accessor :source
2635
-
2636
- def initialize(**args)
2637
- update!(**args)
2638
- end
2639
-
2640
- # Update properties of this object
2641
- def update!(**args)
2642
- @chunk_text = args[:chunk_text] if args.key?(:chunk_text)
2643
- @source = args[:source] if args.key?(:source)
2644
- end
2645
- end
2646
-
2647
2652
  # Specification for the grounding check.
2648
2653
  class GoogleCloudDiscoveryengineV1CheckGroundingSpec
2649
2654
  include Google::Apis::Core::Hashable
@@ -2715,7 +2720,7 @@ module Google
2715
2720
 
2716
2721
  # Output only. Represents the relevance score based on similarity. Higher score
2717
2722
  # indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only
2718
- # populated on SearchService.SearchResponse.
2723
+ # populated on SearchResponse.
2719
2724
  # Corresponds to the JSON property `relevanceScore`
2720
2725
  # @return [Float]
2721
2726
  attr_accessor :relevance_score
@@ -3209,6 +3214,13 @@ module Google
3209
3214
  # @return [String]
3210
3215
  attr_accessor :name
3211
3216
 
3217
+ # Promote certain links based on some trigger queries. Example: Promote shoe
3218
+ # store link when searching for `shoe` keyword. The link can be outside of
3219
+ # associated data store.
3220
+ # Corresponds to the JSON property `promoteAction`
3221
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlPromoteAction]
3222
+ attr_accessor :promote_action
3223
+
3212
3224
  # Redirects a shopper to the provided URI.
3213
3225
  # Corresponds to the JSON property `redirectAction`
3214
3226
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlRedirectAction]
@@ -3247,6 +3259,7 @@ module Google
3247
3259
  @display_name = args[:display_name] if args.key?(:display_name)
3248
3260
  @filter_action = args[:filter_action] if args.key?(:filter_action)
3249
3261
  @name = args[:name] if args.key?(:name)
3262
+ @promote_action = args[:promote_action] if args.key?(:promote_action)
3250
3263
  @redirect_action = args[:redirect_action] if args.key?(:redirect_action)
3251
3264
  @solution_type = args[:solution_type] if args.key?(:solution_type)
3252
3265
  @synonyms_action = args[:synonyms_action] if args.key?(:synonyms_action)
@@ -3320,6 +3333,34 @@ module Google
3320
3333
  end
3321
3334
  end
3322
3335
 
3336
+ # Promote certain links based on some trigger queries. Example: Promote shoe
3337
+ # store link when searching for `shoe` keyword. The link can be outside of
3338
+ # associated data store.
3339
+ class GoogleCloudDiscoveryengineV1ControlPromoteAction
3340
+ include Google::Apis::Core::Hashable
3341
+
3342
+ # Required. Data store with which this promotion is attached to.
3343
+ # Corresponds to the JSON property `dataStore`
3344
+ # @return [String]
3345
+ attr_accessor :data_store
3346
+
3347
+ # Promotion proto includes uri and other helping information to display the
3348
+ # promotion.
3349
+ # Corresponds to the JSON property `searchLinkPromotion`
3350
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchLinkPromotion]
3351
+ attr_accessor :search_link_promotion
3352
+
3353
+ def initialize(**args)
3354
+ update!(**args)
3355
+ end
3356
+
3357
+ # Update properties of this object
3358
+ def update!(**args)
3359
+ @data_store = args[:data_store] if args.key?(:data_store)
3360
+ @search_link_promotion = args[:search_link_promotion] if args.key?(:search_link_promotion)
3361
+ end
3362
+ end
3363
+
3323
3364
  # Redirects a shopper to the provided URI.
3324
3365
  class GoogleCloudDiscoveryengineV1ControlRedirectAction
3325
3366
  include Google::Apis::Core::Hashable
@@ -4333,6 +4374,14 @@ module Google
4333
4374
  class GoogleCloudDiscoveryengineV1DocumentInfo
4334
4375
  include Google::Apis::Core::Hashable
4335
4376
 
4377
+ # Optional. The conversion value associated with this Document. Must be set if
4378
+ # UserEvent.event_type is "conversion". For example, a value of 1000 signifies
4379
+ # that 1000 seconds were spent viewing a Document for the `watch` conversion
4380
+ # type.
4381
+ # Corresponds to the JSON property `conversionValue`
4382
+ # @return [Float]
4383
+ attr_accessor :conversion_value
4384
+
4336
4385
  # The Document resource ID.
4337
4386
  # Corresponds to the JSON property `id`
4338
4387
  # @return [String]
@@ -4376,6 +4425,7 @@ module Google
4376
4425
 
4377
4426
  # Update properties of this object
4378
4427
  def update!(**args)
4428
+ @conversion_value = args[:conversion_value] if args.key?(:conversion_value)
4379
4429
  @id = args[:id] if args.key?(:id)
4380
4430
  @joined = args[:joined] if args.key?(:joined)
4381
4431
  @name = args[:name] if args.key?(:name)
@@ -4868,6 +4918,45 @@ module Google
4868
4918
  end
4869
4919
  end
4870
4920
 
4921
+ # Fact Chunk.
4922
+ class GoogleCloudDiscoveryengineV1FactChunk
4923
+ include Google::Apis::Core::Hashable
4924
+
4925
+ # Text content of the fact chunk. Can be at most 10K characters long.
4926
+ # Corresponds to the JSON property `chunkText`
4927
+ # @return [String]
4928
+ attr_accessor :chunk_text
4929
+
4930
+ # The index of this chunk. Currently, only used for the streaming mode.
4931
+ # Corresponds to the JSON property `index`
4932
+ # @return [Fixnum]
4933
+ attr_accessor :index
4934
+
4935
+ # Source from which this fact chunk was retrieved. If it was retrieved from the
4936
+ # GroundingFacts provided in the request then this field will contain the index
4937
+ # of the specific fact from which this chunk was retrieved.
4938
+ # Corresponds to the JSON property `source`
4939
+ # @return [String]
4940
+ attr_accessor :source
4941
+
4942
+ # More fine-grained information for the source reference.
4943
+ # Corresponds to the JSON property `sourceMetadata`
4944
+ # @return [Hash<String,String>]
4945
+ attr_accessor :source_metadata
4946
+
4947
+ def initialize(**args)
4948
+ update!(**args)
4949
+ end
4950
+
4951
+ # Update properties of this object
4952
+ def update!(**args)
4953
+ @chunk_text = args[:chunk_text] if args.key?(:chunk_text)
4954
+ @index = args[:index] if args.key?(:index)
4955
+ @source = args[:source] if args.key?(:source)
4956
+ @source_metadata = args[:source_metadata] if args.key?(:source_metadata)
4957
+ end
4958
+ end
4959
+
4871
4960
  # Response message for SiteSearchEngineService.FetchDomainVerificationStatus
4872
4961
  # method.
4873
4962
  class GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse
@@ -6007,6 +6096,11 @@ module Google
6007
6096
  # @return [String]
6008
6097
  attr_accessor :display_name
6009
6098
 
6099
+ # Optional. The document IDs associated with this panel.
6100
+ # Corresponds to the JSON property `documents`
6101
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentInfo>]
6102
+ attr_accessor :documents
6103
+
6010
6104
  # Required. The panel ID.
6011
6105
  # Corresponds to the JSON property `panelId`
6012
6106
  # @return [String]
@@ -6031,6 +6125,7 @@ module Google
6031
6125
  # Update properties of this object
6032
6126
  def update!(**args)
6033
6127
  @display_name = args[:display_name] if args.key?(:display_name)
6128
+ @documents = args[:documents] if args.key?(:documents)
6034
6129
  @panel_id = args[:panel_id] if args.key?(:panel_id)
6035
6130
  @panel_position = args[:panel_position] if args.key?(:panel_position)
6036
6131
  @total_panels = args[:total_panels] if args.key?(:total_panels)
@@ -6473,12 +6568,15 @@ module Google
6473
6568
  # : Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 "zulu"
6474
6569
  # format. * `userPseudoId`: Double quoted string. Specifying this will delete
6475
6570
  # all events associated with a visitor. * `userId`: Double quoted string.
6476
- # Specifying this will delete all events associated with a user. Examples: *
6477
- # Deleting all events in a time range: `eventTime > "2012-04-23T18:25:43.511Z"
6478
- # eventTime < "2012-04-23T18:30:43.511Z"` * Deleting specific eventType: `
6479
- # eventType = "search"` * Deleting all events for a specific visitor: `
6480
- # userPseudoId = "visitor1024"` * Deleting all events inside a DataStore: `*`
6481
- # The filtering fields are assumed to have an implicit AND.
6571
+ # Specifying this will delete all events associated with a user. Note: This API
6572
+ # only supports purging a max range of 30 days. Examples: * Deleting all events
6573
+ # in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-
6574
+ # 23T18:30:43.511Z"` * Deleting specific eventType in a time range: `eventTime >
6575
+ # "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "
6576
+ # search"` * Deleting all events for a specific visitor in a time range: `
6577
+ # eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
6578
+ # userPseudoId = "visitor1024"` * Deleting the past 30 days of events inside a
6579
+ # DataStore: `*` The filtering fields are assumed to have an implicit AND.
6482
6580
  # Corresponds to the JSON property `filter`
6483
6581
  # @return [String]
6484
6582
  attr_accessor :filter
@@ -6627,7 +6725,9 @@ module Google
6627
6725
  # @return [String]
6628
6726
  attr_accessor :id
6629
6727
 
6630
- # The score of this record based on the given query and selected model.
6728
+ # The score of this record based on the given query and selected model. The
6729
+ # score will be rounded to 2 decimal places. If the score is close to 0, it will
6730
+ # be rounded to 0.0001 to avoid returning unset.
6631
6731
  # Corresponds to the JSON property `score`
6632
6732
  # @return [Float]
6633
6733
  attr_accessor :score
@@ -6661,8 +6761,8 @@ module Google
6661
6761
  # ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags:
6662
6762
  # ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params`
6663
6763
  # field, then attribute-based expressions are expected instead of the above
6664
- # described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (
6665
- # categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es"))
6764
+ # described tag-based syntax. Examples: * (language: ANY("en", "es")) AND NOT (
6765
+ # categories: ANY("Movie")) * (available: true) AND (language: ANY("en", "es"))
6666
6766
  # OR (categories: ANY("Movie")) If your filter blocks all results, the API
6667
6767
  # returns generic (unfiltered) popular Documents. If you only want results
6668
6768
  # strictly matching the filters, set `strictFiltering` to `true` in
@@ -6947,6 +7047,53 @@ module Google
6947
7047
  end
6948
7048
  end
6949
7049
 
7050
+ # Promotion proto includes uri and other helping information to display the
7051
+ # promotion.
7052
+ class GoogleCloudDiscoveryengineV1SearchLinkPromotion
7053
+ include Google::Apis::Core::Hashable
7054
+
7055
+ # Optional. The Promotion description. Maximum length: 200 characters.
7056
+ # Corresponds to the JSON property `description`
7057
+ # @return [String]
7058
+ attr_accessor :description
7059
+
7060
+ # Optional. The enabled promotion will be returned for any serving configs
7061
+ # associated with the parent of the control this promotion is attached to. This
7062
+ # flag is used for basic site search only.
7063
+ # Corresponds to the JSON property `enabled`
7064
+ # @return [Boolean]
7065
+ attr_accessor :enabled
7066
+ alias_method :enabled?, :enabled
7067
+
7068
+ # Optional. The promotion thumbnail image url.
7069
+ # Corresponds to the JSON property `imageUri`
7070
+ # @return [String]
7071
+ attr_accessor :image_uri
7072
+
7073
+ # Required. The title of the promotion. Maximum length: 160 characters.
7074
+ # Corresponds to the JSON property `title`
7075
+ # @return [String]
7076
+ attr_accessor :title
7077
+
7078
+ # Required. The URL for the page the user wants to promote.
7079
+ # Corresponds to the JSON property `uri`
7080
+ # @return [String]
7081
+ attr_accessor :uri
7082
+
7083
+ def initialize(**args)
7084
+ update!(**args)
7085
+ end
7086
+
7087
+ # Update properties of this object
7088
+ def update!(**args)
7089
+ @description = args[:description] if args.key?(:description)
7090
+ @enabled = args[:enabled] if args.key?(:enabled)
7091
+ @image_uri = args[:image_uri] if args.key?(:image_uri)
7092
+ @title = args[:title] if args.key?(:title)
7093
+ @uri = args[:uri] if args.key?(:uri)
7094
+ end
7095
+ end
7096
+
6950
7097
  # Request message for SearchService.Search method.
6951
7098
  class GoogleCloudDiscoveryengineV1SearchRequest
6952
7099
  include Google::Apis::Core::Hashable
@@ -6981,10 +7128,10 @@ module Google
6981
7128
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec]
6982
7129
  attr_accessor :content_search_spec
6983
7130
 
6984
- # Specs defining dataStores to filter on in a search call and configurations for
6985
- # those dataStores. This is only considered for engines with multiple dataStores
6986
- # use case. For single dataStore within an engine, they should use the specs at
6987
- # the top level.
7131
+ # Specs defining DataStores to filter on in a search call and configurations for
7132
+ # those data stores. This is only considered for Engines with multiple data
7133
+ # stores. For engines with a single data store, the specs directly under
7134
+ # SearchRequest should be used.
6988
7135
  # Corresponds to the JSON property `dataStoreSpecs`
6989
7136
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec>]
6990
7137
  attr_accessor :data_store_specs
@@ -8043,6 +8190,11 @@ module Google
8043
8190
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResult>]
8044
8191
  attr_accessor :results
8045
8192
 
8193
+ # Promotions for site search.
8194
+ # Corresponds to the JSON property `searchLinkPromotions`
8195
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchLinkPromotion>]
8196
+ attr_accessor :search_link_promotions
8197
+
8046
8198
  # Information about the session.
8047
8199
  # Corresponds to the JSON property `sessionInfo`
8048
8200
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSessionInfo]
@@ -8073,6 +8225,7 @@ module Google
8073
8225
  @query_expansion_info = args[:query_expansion_info] if args.key?(:query_expansion_info)
8074
8226
  @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
8075
8227
  @results = args[:results] if args.key?(:results)
8228
+ @search_link_promotions = args[:search_link_promotions] if args.key?(:search_link_promotions)
8076
8229
  @session_info = args[:session_info] if args.key?(:session_info)
8077
8230
  @summary = args[:summary] if args.key?(:summary)
8078
8231
  @total_size = args[:total_size] if args.key?(:total_size)
@@ -8523,6 +8676,11 @@ module Google
8523
8676
  # @return [String]
8524
8677
  attr_accessor :answer
8525
8678
 
8679
+ # Defines an answer.
8680
+ # Corresponds to the JSON property `detailedAnswer`
8681
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer]
8682
+ attr_accessor :detailed_answer
8683
+
8526
8684
  # Defines a user inputed query.
8527
8685
  # Corresponds to the JSON property `query`
8528
8686
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Query]
@@ -8535,6 +8693,7 @@ module Google
8535
8693
  # Update properties of this object
8536
8694
  def update!(**args)
8537
8695
  @answer = args[:answer] if args.key?(:answer)
8696
+ @detailed_answer = args[:detailed_answer] if args.key?(:detailed_answer)
8538
8697
  @query = args[:query] if args.key?(:query)
8539
8698
  end
8540
8699
  end
@@ -9161,6 +9320,15 @@ module Google
9161
9320
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompletionInfo]
9162
9321
  attr_accessor :completion_info
9163
9322
 
9323
+ # Optional. Conversion type. Required if UserEvent.event_type is `conversion`.
9324
+ # This is a customer-defined conversion name in lowercase letters or numbers
9325
+ # separated by "-", such as "watch", "good-visit" etc. Do not set the field if
9326
+ # UserEvent.event_type is not `conversion`. This mixes the custom conversion
9327
+ # event with predefined events like `search`, `view-item` etc.
9328
+ # Corresponds to the JSON property `conversionType`
9329
+ # @return [String]
9330
+ attr_accessor :conversion_type
9331
+
9164
9332
  # The DataStore resource full name, of the form `projects/`project`/locations/`
9165
9333
  # location`/collections/`collection_id`/dataStores/`data_store_id``. Optional.
9166
9334
  # Only required for user events whose data store can't by determined by
@@ -9214,7 +9382,8 @@ module Google
9214
9382
  # values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online
9215
9383
  # shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`
9216
9384
  # : Start/resume watching a video, playing a song, etc. * `media-complete`:
9217
- # Finished or stopped midway through a video, song, etc.
9385
+ # Finished or stopped midway through a video, song, etc. Custom conversion value:
9386
+ # * `conversion`: Customer defined conversion event.
9218
9387
  # Corresponds to the JSON property `eventType`
9219
9388
  # @return [String]
9220
9389
  attr_accessor :event_type
@@ -9247,6 +9416,12 @@ module Google
9247
9416
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PanelInfo]
9248
9417
  attr_accessor :panel
9249
9418
 
9419
+ # Optional. List of panels associated with this event. Used for page-level
9420
+ # impression data.
9421
+ # Corresponds to the JSON property `panels`
9422
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PanelInfo>]
9423
+ attr_accessor :panels
9424
+
9250
9425
  # The promotion IDs if this is an event associated with promotions. Currently,
9251
9426
  # this field is restricted to at most one ID.
9252
9427
  # Corresponds to the JSON property `promotionIds`
@@ -9308,6 +9483,7 @@ module Google
9308
9483
  @attributes = args[:attributes] if args.key?(:attributes)
9309
9484
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
9310
9485
  @completion_info = args[:completion_info] if args.key?(:completion_info)
9486
+ @conversion_type = args[:conversion_type] if args.key?(:conversion_type)
9311
9487
  @data_store = args[:data_store] if args.key?(:data_store)
9312
9488
  @direct_user_request = args[:direct_user_request] if args.key?(:direct_user_request)
9313
9489
  @documents = args[:documents] if args.key?(:documents)
@@ -9318,6 +9494,7 @@ module Google
9318
9494
  @media_info = args[:media_info] if args.key?(:media_info)
9319
9495
  @page_info = args[:page_info] if args.key?(:page_info)
9320
9496
  @panel = args[:panel] if args.key?(:panel)
9497
+ @panels = args[:panels] if args.key?(:panels)
9321
9498
  @promotion_ids = args[:promotion_ids] if args.key?(:promotion_ids)
9322
9499
  @search_info = args[:search_info] if args.key?(:search_info)
9323
9500
  @session_id = args[:session_id] if args.key?(:session_id)
@@ -10292,6 +10469,13 @@ module Google
10292
10469
  # @return [String]
10293
10470
  attr_accessor :name
10294
10471
 
10472
+ # Promote certain links based on some trigger queries. Example: Promote shoe
10473
+ # store link when searching for `shoe` keyword. The link can be outside of
10474
+ # associated data store.
10475
+ # Corresponds to the JSON property `promoteAction`
10476
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlPromoteAction]
10477
+ attr_accessor :promote_action
10478
+
10295
10479
  # Redirects a shopper to the provided URI.
10296
10480
  # Corresponds to the JSON property `redirectAction`
10297
10481
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlRedirectAction]
@@ -10330,6 +10514,7 @@ module Google
10330
10514
  @display_name = args[:display_name] if args.key?(:display_name)
10331
10515
  @filter_action = args[:filter_action] if args.key?(:filter_action)
10332
10516
  @name = args[:name] if args.key?(:name)
10517
+ @promote_action = args[:promote_action] if args.key?(:promote_action)
10333
10518
  @redirect_action = args[:redirect_action] if args.key?(:redirect_action)
10334
10519
  @solution_type = args[:solution_type] if args.key?(:solution_type)
10335
10520
  @synonyms_action = args[:synonyms_action] if args.key?(:synonyms_action)
@@ -10403,6 +10588,34 @@ module Google
10403
10588
  end
10404
10589
  end
10405
10590
 
10591
+ # Promote certain links based on some trigger queries. Example: Promote shoe
10592
+ # store link when searching for `shoe` keyword. The link can be outside of
10593
+ # associated data store.
10594
+ class GoogleCloudDiscoveryengineV1alphaControlPromoteAction
10595
+ include Google::Apis::Core::Hashable
10596
+
10597
+ # Required. Data store with which this promotion is attached to.
10598
+ # Corresponds to the JSON property `dataStore`
10599
+ # @return [String]
10600
+ attr_accessor :data_store
10601
+
10602
+ # Promotion proto includes uri and other helping information to display the
10603
+ # promotion.
10604
+ # Corresponds to the JSON property `searchLinkPromotion`
10605
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion]
10606
+ attr_accessor :search_link_promotion
10607
+
10608
+ def initialize(**args)
10609
+ update!(**args)
10610
+ end
10611
+
10612
+ # Update properties of this object
10613
+ def update!(**args)
10614
+ @data_store = args[:data_store] if args.key?(:data_store)
10615
+ @search_link_promotion = args[:search_link_promotion] if args.key?(:search_link_promotion)
10616
+ end
10617
+ end
10618
+
10406
10619
  # Redirects a shopper to the provided URI.
10407
10620
  class GoogleCloudDiscoveryengineV1alphaControlRedirectAction
10408
10621
  include Google::Apis::Core::Hashable
@@ -13363,6 +13576,53 @@ module Google
13363
13576
  end
13364
13577
  end
13365
13578
 
13579
+ # Promotion proto includes uri and other helping information to display the
13580
+ # promotion.
13581
+ class GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion
13582
+ include Google::Apis::Core::Hashable
13583
+
13584
+ # Optional. The Promotion description. Maximum length: 200 characters.
13585
+ # Corresponds to the JSON property `description`
13586
+ # @return [String]
13587
+ attr_accessor :description
13588
+
13589
+ # Optional. The enabled promotion will be returned for any serving configs
13590
+ # associated with the parent of the control this promotion is attached to. This
13591
+ # flag is used for basic site search only.
13592
+ # Corresponds to the JSON property `enabled`
13593
+ # @return [Boolean]
13594
+ attr_accessor :enabled
13595
+ alias_method :enabled?, :enabled
13596
+
13597
+ # Optional. The promotion thumbnail image url.
13598
+ # Corresponds to the JSON property `imageUri`
13599
+ # @return [String]
13600
+ attr_accessor :image_uri
13601
+
13602
+ # Required. The title of the promotion. Maximum length: 160 characters.
13603
+ # Corresponds to the JSON property `title`
13604
+ # @return [String]
13605
+ attr_accessor :title
13606
+
13607
+ # Required. The URL for the page the user wants to promote.
13608
+ # Corresponds to the JSON property `uri`
13609
+ # @return [String]
13610
+ attr_accessor :uri
13611
+
13612
+ def initialize(**args)
13613
+ update!(**args)
13614
+ end
13615
+
13616
+ # Update properties of this object
13617
+ def update!(**args)
13618
+ @description = args[:description] if args.key?(:description)
13619
+ @enabled = args[:enabled] if args.key?(:enabled)
13620
+ @image_uri = args[:image_uri] if args.key?(:image_uri)
13621
+ @title = args[:title] if args.key?(:title)
13622
+ @uri = args[:uri] if args.key?(:uri)
13623
+ end
13624
+ end
13625
+
13366
13626
  # Request message for SearchService.Search method.
13367
13627
  class GoogleCloudDiscoveryengineV1alphaSearchRequest
13368
13628
  include Google::Apis::Core::Hashable
@@ -13402,10 +13662,10 @@ module Google
13402
13662
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
13403
13663
  attr_accessor :custom_fine_tuning_spec
13404
13664
 
13405
- # Specs defining dataStores to filter on in a search call and configurations for
13406
- # those dataStores. This is only considered for engines with multiple dataStores
13407
- # use case. For single dataStore within an engine, they should use the specs at
13408
- # the top level.
13665
+ # Specs defining DataStores to filter on in a search call and configurations for
13666
+ # those data stores. This is only considered for Engines with multiple data
13667
+ # stores. For engines with a single data store, the specs directly under
13668
+ # SearchRequest should be used.
13409
13669
  # Corresponds to the JSON property `dataStoreSpecs`
13410
13670
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec>]
13411
13671
  attr_accessor :data_store_specs
@@ -14637,6 +14897,11 @@ module Google
14637
14897
  # @return [String]
14638
14898
  attr_accessor :answer
14639
14899
 
14900
+ # Defines an answer.
14901
+ # Corresponds to the JSON property `detailedAnswer`
14902
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswer]
14903
+ attr_accessor :detailed_answer
14904
+
14640
14905
  # Defines a user inputed query.
14641
14906
  # Corresponds to the JSON property `query`
14642
14907
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaQuery]
@@ -14649,6 +14914,7 @@ module Google
14649
14914
  # Update properties of this object
14650
14915
  def update!(**args)
14651
14916
  @answer = args[:answer] if args.key?(:answer)
14917
+ @detailed_answer = args[:detailed_answer] if args.key?(:detailed_answer)
14652
14918
  @query = args[:query] if args.key?(:query)
14653
14919
  end
14654
14920
  end
@@ -15385,6 +15651,13 @@ module Google
15385
15651
  # @return [String]
15386
15652
  attr_accessor :name
15387
15653
 
15654
+ # Promote certain links based on some trigger queries. Example: Promote shoe
15655
+ # store link when searching for `shoe` keyword. The link can be outside of
15656
+ # associated data store.
15657
+ # Corresponds to the JSON property `promoteAction`
15658
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlPromoteAction]
15659
+ attr_accessor :promote_action
15660
+
15388
15661
  # Redirects a shopper to the provided URI.
15389
15662
  # Corresponds to the JSON property `redirectAction`
15390
15663
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlRedirectAction]
@@ -15423,6 +15696,7 @@ module Google
15423
15696
  @display_name = args[:display_name] if args.key?(:display_name)
15424
15697
  @filter_action = args[:filter_action] if args.key?(:filter_action)
15425
15698
  @name = args[:name] if args.key?(:name)
15699
+ @promote_action = args[:promote_action] if args.key?(:promote_action)
15426
15700
  @redirect_action = args[:redirect_action] if args.key?(:redirect_action)
15427
15701
  @solution_type = args[:solution_type] if args.key?(:solution_type)
15428
15702
  @synonyms_action = args[:synonyms_action] if args.key?(:synonyms_action)
@@ -15496,6 +15770,34 @@ module Google
15496
15770
  end
15497
15771
  end
15498
15772
 
15773
+ # Promote certain links based on some trigger queries. Example: Promote shoe
15774
+ # store link when searching for `shoe` keyword. The link can be outside of
15775
+ # associated data store.
15776
+ class GoogleCloudDiscoveryengineV1betaControlPromoteAction
15777
+ include Google::Apis::Core::Hashable
15778
+
15779
+ # Required. Data store with which this promotion is attached to.
15780
+ # Corresponds to the JSON property `dataStore`
15781
+ # @return [String]
15782
+ attr_accessor :data_store
15783
+
15784
+ # Promotion proto includes uri and other helping information to display the
15785
+ # promotion.
15786
+ # Corresponds to the JSON property `searchLinkPromotion`
15787
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchLinkPromotion]
15788
+ attr_accessor :search_link_promotion
15789
+
15790
+ def initialize(**args)
15791
+ update!(**args)
15792
+ end
15793
+
15794
+ # Update properties of this object
15795
+ def update!(**args)
15796
+ @data_store = args[:data_store] if args.key?(:data_store)
15797
+ @search_link_promotion = args[:search_link_promotion] if args.key?(:search_link_promotion)
15798
+ end
15799
+ end
15800
+
15499
15801
  # Redirects a shopper to the provided URI.
15500
15802
  class GoogleCloudDiscoveryengineV1betaControlRedirectAction
15501
15803
  include Google::Apis::Core::Hashable
@@ -17580,6 +17882,53 @@ module Google
17580
17882
  end
17581
17883
  end
17582
17884
 
17885
+ # Promotion proto includes uri and other helping information to display the
17886
+ # promotion.
17887
+ class GoogleCloudDiscoveryengineV1betaSearchLinkPromotion
17888
+ include Google::Apis::Core::Hashable
17889
+
17890
+ # Optional. The Promotion description. Maximum length: 200 characters.
17891
+ # Corresponds to the JSON property `description`
17892
+ # @return [String]
17893
+ attr_accessor :description
17894
+
17895
+ # Optional. The enabled promotion will be returned for any serving configs
17896
+ # associated with the parent of the control this promotion is attached to. This
17897
+ # flag is used for basic site search only.
17898
+ # Corresponds to the JSON property `enabled`
17899
+ # @return [Boolean]
17900
+ attr_accessor :enabled
17901
+ alias_method :enabled?, :enabled
17902
+
17903
+ # Optional. The promotion thumbnail image url.
17904
+ # Corresponds to the JSON property `imageUri`
17905
+ # @return [String]
17906
+ attr_accessor :image_uri
17907
+
17908
+ # Required. The title of the promotion. Maximum length: 160 characters.
17909
+ # Corresponds to the JSON property `title`
17910
+ # @return [String]
17911
+ attr_accessor :title
17912
+
17913
+ # Required. The URL for the page the user wants to promote.
17914
+ # Corresponds to the JSON property `uri`
17915
+ # @return [String]
17916
+ attr_accessor :uri
17917
+
17918
+ def initialize(**args)
17919
+ update!(**args)
17920
+ end
17921
+
17922
+ # Update properties of this object
17923
+ def update!(**args)
17924
+ @description = args[:description] if args.key?(:description)
17925
+ @enabled = args[:enabled] if args.key?(:enabled)
17926
+ @image_uri = args[:image_uri] if args.key?(:image_uri)
17927
+ @title = args[:title] if args.key?(:title)
17928
+ @uri = args[:uri] if args.key?(:uri)
17929
+ end
17930
+ end
17931
+
17583
17932
  # Request message for SearchService.Search method.
17584
17933
  class GoogleCloudDiscoveryengineV1betaSearchRequest
17585
17934
  include Google::Apis::Core::Hashable
@@ -17614,10 +17963,10 @@ module Google
17614
17963
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec]
17615
17964
  attr_accessor :content_search_spec
17616
17965
 
17617
- # Specs defining dataStores to filter on in a search call and configurations for
17618
- # those dataStores. This is only considered for engines with multiple dataStores
17619
- # use case. For single dataStore within an engine, they should use the specs at
17620
- # the top level.
17966
+ # Specs defining DataStores to filter on in a search call and configurations for
17967
+ # those data stores. This is only considered for Engines with multiple data
17968
+ # stores. For engines with a single data store, the specs directly under
17969
+ # SearchRequest should be used.
17621
17970
  # Corresponds to the JSON property `dataStoreSpecs`
17622
17971
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec>]
17623
17972
  attr_accessor :data_store_specs
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DiscoveryengineV1
18
18
  # Version of the google-apis-discoveryengine_v1 gem
19
- GEM_VERSION = "0.21.0"
19
+ GEM_VERSION = "0.23.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.15.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20241030"
25
+ REVISION = "20241123"
26
26
  end
27
27
  end
28
28
  end
@@ -454,13 +454,13 @@ module Google
454
454
  include Google::Apis::Core::JsonObjectSupport
455
455
  end
456
456
 
457
- class GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim
457
+ class GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk
458
458
  class Representation < Google::Apis::Core::JsonRepresentation; end
459
459
 
460
460
  include Google::Apis::Core::JsonObjectSupport
461
461
  end
462
462
 
463
- class GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk
463
+ class GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim
464
464
  class Representation < Google::Apis::Core::JsonRepresentation; end
465
465
 
466
466
  include Google::Apis::Core::JsonObjectSupport
@@ -568,6 +568,12 @@ module Google
568
568
  include Google::Apis::Core::JsonObjectSupport
569
569
  end
570
570
 
571
+ class GoogleCloudDiscoveryengineV1ControlPromoteAction
572
+ class Representation < Google::Apis::Core::JsonRepresentation; end
573
+
574
+ include Google::Apis::Core::JsonObjectSupport
575
+ end
576
+
571
577
  class GoogleCloudDiscoveryengineV1ControlRedirectAction
572
578
  class Representation < Google::Apis::Core::JsonRepresentation; end
573
579
 
@@ -832,6 +838,12 @@ module Google
832
838
  include Google::Apis::Core::JsonObjectSupport
833
839
  end
834
840
 
841
+ class GoogleCloudDiscoveryengineV1FactChunk
842
+ class Representation < Google::Apis::Core::JsonRepresentation; end
843
+
844
+ include Google::Apis::Core::JsonObjectSupport
845
+ end
846
+
835
847
  class GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse
836
848
  class Representation < Google::Apis::Core::JsonRepresentation; end
837
849
 
@@ -1204,6 +1216,12 @@ module Google
1204
1216
  include Google::Apis::Core::JsonObjectSupport
1205
1217
  end
1206
1218
 
1219
+ class GoogleCloudDiscoveryengineV1SearchLinkPromotion
1220
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1221
+
1222
+ include Google::Apis::Core::JsonObjectSupport
1223
+ end
1224
+
1207
1225
  class GoogleCloudDiscoveryengineV1SearchRequest
1208
1226
  class Representation < Google::Apis::Core::JsonRepresentation; end
1209
1227
 
@@ -1708,6 +1726,12 @@ module Google
1708
1726
  include Google::Apis::Core::JsonObjectSupport
1709
1727
  end
1710
1728
 
1729
+ class GoogleCloudDiscoveryengineV1alphaControlPromoteAction
1730
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1731
+
1732
+ include Google::Apis::Core::JsonObjectSupport
1733
+ end
1734
+
1711
1735
  class GoogleCloudDiscoveryengineV1alphaControlRedirectAction
1712
1736
  class Representation < Google::Apis::Core::JsonRepresentation; end
1713
1737
 
@@ -2236,6 +2260,12 @@ module Google
2236
2260
  include Google::Apis::Core::JsonObjectSupport
2237
2261
  end
2238
2262
 
2263
+ class GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion
2264
+ class Representation < Google::Apis::Core::JsonRepresentation; end
2265
+
2266
+ include Google::Apis::Core::JsonObjectSupport
2267
+ end
2268
+
2239
2269
  class GoogleCloudDiscoveryengineV1alphaSearchRequest
2240
2270
  class Representation < Google::Apis::Core::JsonRepresentation; end
2241
2271
 
@@ -2548,6 +2578,12 @@ module Google
2548
2578
  include Google::Apis::Core::JsonObjectSupport
2549
2579
  end
2550
2580
 
2581
+ class GoogleCloudDiscoveryengineV1betaControlPromoteAction
2582
+ class Representation < Google::Apis::Core::JsonRepresentation; end
2583
+
2584
+ include Google::Apis::Core::JsonObjectSupport
2585
+ end
2586
+
2551
2587
  class GoogleCloudDiscoveryengineV1betaControlRedirectAction
2552
2588
  class Representation < Google::Apis::Core::JsonRepresentation; end
2553
2589
 
@@ -2932,6 +2968,12 @@ module Google
2932
2968
  include Google::Apis::Core::JsonObjectSupport
2933
2969
  end
2934
2970
 
2971
+ class GoogleCloudDiscoveryengineV1betaSearchLinkPromotion
2972
+ class Representation < Google::Apis::Core::JsonRepresentation; end
2973
+
2974
+ include Google::Apis::Core::JsonObjectSupport
2975
+ end
2976
+
2935
2977
  class GoogleCloudDiscoveryengineV1betaSearchRequest
2936
2978
  class Representation < Google::Apis::Core::JsonRepresentation; end
2937
2979
 
@@ -3489,6 +3531,7 @@ module Google
3489
3531
  class GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec
3490
3532
  # @private
3491
3533
  class Representation < Google::Apis::Core::JsonRepresentation
3534
+ property :filtering_level, as: 'filteringLevel'
3492
3535
  property :include_grounding_supports, as: 'includeGroundingSupports'
3493
3536
  end
3494
3537
  end
@@ -3914,7 +3957,9 @@ module Google
3914
3957
  class GoogleCloudDiscoveryengineV1CheckGroundingResponse
3915
3958
  # @private
3916
3959
  class Representation < Google::Apis::Core::JsonRepresentation
3917
- collection :cited_chunks, as: 'citedChunks', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk::Representation
3960
+ collection :cited_chunks, as: 'citedChunks', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FactChunk, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FactChunk::Representation
3961
+
3962
+ collection :cited_facts, as: 'citedFacts', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk::Representation
3918
3963
 
3919
3964
  collection :claims, as: 'claims', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim::Representation
3920
3965
 
@@ -3922,6 +3967,13 @@ module Google
3922
3967
  end
3923
3968
  end
3924
3969
 
3970
+ class GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk
3971
+ # @private
3972
+ class Representation < Google::Apis::Core::JsonRepresentation
3973
+ property :chunk_text, as: 'chunkText'
3974
+ end
3975
+ end
3976
+
3925
3977
  class GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim
3926
3978
  # @private
3927
3979
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3933,14 +3985,6 @@ module Google
3933
3985
  end
3934
3986
  end
3935
3987
 
3936
- class GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk
3937
- # @private
3938
- class Representation < Google::Apis::Core::JsonRepresentation
3939
- property :chunk_text, as: 'chunkText'
3940
- property :source, as: 'source'
3941
- end
3942
- end
3943
-
3944
3988
  class GoogleCloudDiscoveryengineV1CheckGroundingSpec
3945
3989
  # @private
3946
3990
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4093,6 +4137,8 @@ module Google
4093
4137
  property :filter_action, as: 'filterAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlFilterAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlFilterAction::Representation
4094
4138
 
4095
4139
  property :name, as: 'name'
4140
+ property :promote_action, as: 'promoteAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlPromoteAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlPromoteAction::Representation
4141
+
4096
4142
  property :redirect_action, as: 'redirectAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlRedirectAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlRedirectAction::Representation
4097
4143
 
4098
4144
  property :solution_type, as: 'solutionType'
@@ -4119,6 +4165,15 @@ module Google
4119
4165
  end
4120
4166
  end
4121
4167
 
4168
+ class GoogleCloudDiscoveryengineV1ControlPromoteAction
4169
+ # @private
4170
+ class Representation < Google::Apis::Core::JsonRepresentation
4171
+ property :data_store, as: 'dataStore'
4172
+ property :search_link_promotion, as: 'searchLinkPromotion', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchLinkPromotion, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchLinkPromotion::Representation
4173
+
4174
+ end
4175
+ end
4176
+
4122
4177
  class GoogleCloudDiscoveryengineV1ControlRedirectAction
4123
4178
  # @private
4124
4179
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4396,6 +4451,7 @@ module Google
4396
4451
  class GoogleCloudDiscoveryengineV1DocumentInfo
4397
4452
  # @private
4398
4453
  class Representation < Google::Apis::Core::JsonRepresentation
4454
+ property :conversion_value, as: 'conversionValue'
4399
4455
  property :id, as: 'id'
4400
4456
  property :joined, as: 'joined'
4401
4457
  property :name, as: 'name'
@@ -4549,6 +4605,16 @@ module Google
4549
4605
  end
4550
4606
  end
4551
4607
 
4608
+ class GoogleCloudDiscoveryengineV1FactChunk
4609
+ # @private
4610
+ class Representation < Google::Apis::Core::JsonRepresentation
4611
+ property :chunk_text, as: 'chunkText'
4612
+ property :index, as: 'index'
4613
+ property :source, as: 'source'
4614
+ hash :source_metadata, as: 'sourceMetadata'
4615
+ end
4616
+ end
4617
+
4552
4618
  class GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse
4553
4619
  # @private
4554
4620
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4895,6 +4961,8 @@ module Google
4895
4961
  # @private
4896
4962
  class Representation < Google::Apis::Core::JsonRepresentation
4897
4963
  property :display_name, as: 'displayName'
4964
+ collection :documents, as: 'documents', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentInfo::Representation
4965
+
4898
4966
  property :panel_id, as: 'panelId'
4899
4967
  property :panel_position, as: 'panelPosition'
4900
4968
  property :total_panels, as: 'totalPanels'
@@ -5145,6 +5213,17 @@ module Google
5145
5213
  end
5146
5214
  end
5147
5215
 
5216
+ class GoogleCloudDiscoveryengineV1SearchLinkPromotion
5217
+ # @private
5218
+ class Representation < Google::Apis::Core::JsonRepresentation
5219
+ property :description, as: 'description'
5220
+ property :enabled, as: 'enabled'
5221
+ property :image_uri, as: 'imageUri'
5222
+ property :title, as: 'title'
5223
+ property :uri, as: 'uri'
5224
+ end
5225
+ end
5226
+
5148
5227
  class GoogleCloudDiscoveryengineV1SearchRequest
5149
5228
  # @private
5150
5229
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -5381,6 +5460,8 @@ module Google
5381
5460
  property :redirect_uri, as: 'redirectUri'
5382
5461
  collection :results, as: 'results', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResult, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResult::Representation
5383
5462
 
5463
+ collection :search_link_promotions, as: 'searchLinkPromotions', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchLinkPromotion, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchLinkPromotion::Representation
5464
+
5384
5465
  property :session_info, as: 'sessionInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSessionInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSessionInfo::Representation
5385
5466
 
5386
5467
  property :summary, as: 'summary', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSummary, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSummary::Representation
@@ -5528,6 +5609,8 @@ module Google
5528
5609
  # @private
5529
5610
  class Representation < Google::Apis::Core::JsonRepresentation
5530
5611
  property :answer, as: 'answer'
5612
+ property :detailed_answer, as: 'detailedAnswer', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer::Representation
5613
+
5531
5614
  property :query, as: 'query', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Query, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Query::Representation
5532
5615
 
5533
5616
  end
@@ -5696,6 +5779,7 @@ module Google
5696
5779
  property :attribution_token, as: 'attributionToken'
5697
5780
  property :completion_info, as: 'completionInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompletionInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompletionInfo::Representation
5698
5781
 
5782
+ property :conversion_type, as: 'conversionType'
5699
5783
  property :data_store, as: 'dataStore'
5700
5784
  property :direct_user_request, as: 'directUserRequest'
5701
5785
  collection :documents, as: 'documents', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentInfo::Representation
@@ -5710,6 +5794,8 @@ module Google
5710
5794
 
5711
5795
  property :panel, as: 'panel', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PanelInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PanelInfo::Representation
5712
5796
 
5797
+ collection :panels, as: 'panels', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PanelInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PanelInfo::Representation
5798
+
5713
5799
  collection :promotion_ids, as: 'promotionIds'
5714
5800
  property :search_info, as: 'searchInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchInfo::Representation
5715
5801
 
@@ -6009,6 +6095,8 @@ module Google
6009
6095
  property :filter_action, as: 'filterAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlFilterAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlFilterAction::Representation
6010
6096
 
6011
6097
  property :name, as: 'name'
6098
+ property :promote_action, as: 'promoteAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlPromoteAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlPromoteAction::Representation
6099
+
6012
6100
  property :redirect_action, as: 'redirectAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlRedirectAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlRedirectAction::Representation
6013
6101
 
6014
6102
  property :solution_type, as: 'solutionType'
@@ -6035,6 +6123,15 @@ module Google
6035
6123
  end
6036
6124
  end
6037
6125
 
6126
+ class GoogleCloudDiscoveryengineV1alphaControlPromoteAction
6127
+ # @private
6128
+ class Representation < Google::Apis::Core::JsonRepresentation
6129
+ property :data_store, as: 'dataStore'
6130
+ property :search_link_promotion, as: 'searchLinkPromotion', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion::Representation
6131
+
6132
+ end
6133
+ end
6134
+
6038
6135
  class GoogleCloudDiscoveryengineV1alphaControlRedirectAction
6039
6136
  # @private
6040
6137
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -6880,6 +6977,17 @@ module Google
6880
6977
  end
6881
6978
  end
6882
6979
 
6980
+ class GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion
6981
+ # @private
6982
+ class Representation < Google::Apis::Core::JsonRepresentation
6983
+ property :description, as: 'description'
6984
+ property :enabled, as: 'enabled'
6985
+ property :image_uri, as: 'imageUri'
6986
+ property :title, as: 'title'
6987
+ property :uri, as: 'uri'
6988
+ end
6989
+ end
6990
+
6883
6991
  class GoogleCloudDiscoveryengineV1alphaSearchRequest
6884
6992
  # @private
6885
6993
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -7163,6 +7271,8 @@ module Google
7163
7271
  # @private
7164
7272
  class Representation < Google::Apis::Core::JsonRepresentation
7165
7273
  property :answer, as: 'answer'
7274
+ property :detailed_answer, as: 'detailedAnswer', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswer, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswer::Representation
7275
+
7166
7276
  property :query, as: 'query', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaQuery, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaQuery::Representation
7167
7277
 
7168
7278
  end
@@ -7381,6 +7491,8 @@ module Google
7381
7491
  property :filter_action, as: 'filterAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlFilterAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlFilterAction::Representation
7382
7492
 
7383
7493
  property :name, as: 'name'
7494
+ property :promote_action, as: 'promoteAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlPromoteAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlPromoteAction::Representation
7495
+
7384
7496
  property :redirect_action, as: 'redirectAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlRedirectAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlRedirectAction::Representation
7385
7497
 
7386
7498
  property :solution_type, as: 'solutionType'
@@ -7407,6 +7519,15 @@ module Google
7407
7519
  end
7408
7520
  end
7409
7521
 
7522
+ class GoogleCloudDiscoveryengineV1betaControlPromoteAction
7523
+ # @private
7524
+ class Representation < Google::Apis::Core::JsonRepresentation
7525
+ property :data_store, as: 'dataStore'
7526
+ property :search_link_promotion, as: 'searchLinkPromotion', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchLinkPromotion, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchLinkPromotion::Representation
7527
+
7528
+ end
7529
+ end
7530
+
7410
7531
  class GoogleCloudDiscoveryengineV1betaControlRedirectAction
7411
7532
  # @private
7412
7533
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -8018,6 +8139,17 @@ module Google
8018
8139
  end
8019
8140
  end
8020
8141
 
8142
+ class GoogleCloudDiscoveryengineV1betaSearchLinkPromotion
8143
+ # @private
8144
+ class Representation < Google::Apis::Core::JsonRepresentation
8145
+ property :description, as: 'description'
8146
+ property :enabled, as: 'enabled'
8147
+ property :image_uri, as: 'imageUri'
8148
+ property :title, as: 'title'
8149
+ property :uri, as: 'uri'
8150
+ end
8151
+ end
8152
+
8021
8153
  class GoogleCloudDiscoveryengineV1betaSearchRequest
8022
8154
  # @private
8023
8155
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -836,8 +836,8 @@ module Google
836
836
  # Clients can use Operations.GetOperation or other methods to check whether the
837
837
  # cancellation succeeded or whether the operation completed despite cancellation.
838
838
  # On successful cancellation, the operation is not deleted; instead, it becomes
839
- # an operation with an Operation.error value with a google.rpc.Status.code of 1,
840
- # corresponding to `Code.CANCELLED`.
839
+ # an operation with an Operation.error value with a google.rpc.Status.code of `1`
840
+ # , corresponding to `Code.CANCELLED`.
841
841
  # @param [String] name
842
842
  # The name of the operation resource to be cancelled.
843
843
  # @param [Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
@@ -4798,8 +4798,8 @@ module Google
4798
4798
  # Clients can use Operations.GetOperation or other methods to check whether the
4799
4799
  # cancellation succeeded or whether the operation completed despite cancellation.
4800
4800
  # On successful cancellation, the operation is not deleted; instead, it becomes
4801
- # an operation with an Operation.error value with a google.rpc.Status.code of 1,
4802
- # corresponding to `Code.CANCELLED`.
4801
+ # an operation with an Operation.error value with a google.rpc.Status.code of `1`
4802
+ # , corresponding to `Code.CANCELLED`.
4803
4803
  # @param [String] name
4804
4804
  # The name of the operation resource to be cancelled.
4805
4805
  # @param [Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
@@ -6919,6 +6919,44 @@ module Google
6919
6919
  execute_or_queue_command(command, &block)
6920
6920
  end
6921
6921
 
6922
+ # Bulk import of user events. Request processing might be synchronous. Events
6923
+ # that already exist are skipped. Use this method for backfilling historical
6924
+ # user events. Operation.response is of type ImportResponse. Note that it is
6925
+ # possible for a subset of the items to be successfully inserted. Operation.
6926
+ # metadata is of type ImportMetadata.
6927
+ # @param [String] parent
6928
+ # Required. Parent DataStore resource name, of the form `projects/`project`/
6929
+ # locations/`location`/collections/`collection`/dataStores/`data_store``
6930
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportUserEventsRequest] google_cloud_discoveryengine_v1_import_user_events_request_object
6931
+ # @param [String] fields
6932
+ # Selector specifying which fields to include in a partial response.
6933
+ # @param [String] quota_user
6934
+ # Available to use for quota purposes for server-side applications. Can be any
6935
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6936
+ # @param [Google::Apis::RequestOptions] options
6937
+ # Request-specific options
6938
+ #
6939
+ # @yield [result, err] Result & error if block supplied
6940
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
6941
+ # @yieldparam err [StandardError] error object if request failed
6942
+ #
6943
+ # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
6944
+ #
6945
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6946
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6947
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6948
+ def import_project_location_user_event(parent, google_cloud_discoveryengine_v1_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6949
+ command = make_simple_command(:post, 'v1/{+parent}/userEvents:import', options)
6950
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ImportUserEventsRequest::Representation
6951
+ command.request_object = google_cloud_discoveryengine_v1_import_user_events_request_object
6952
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
6953
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
6954
+ command.params['parent'] = parent unless parent.nil?
6955
+ command.query['fields'] = fields unless fields.nil?
6956
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6957
+ execute_or_queue_command(command, &block)
6958
+ end
6959
+
6922
6960
  # Writes a single user event.
6923
6961
  # @param [String] parent
6924
6962
  # Required. The parent resource name. If the write user event action is applied
@@ -6967,8 +7005,8 @@ module Google
6967
7005
  # Clients can use Operations.GetOperation or other methods to check whether the
6968
7006
  # cancellation succeeded or whether the operation completed despite cancellation.
6969
7007
  # On successful cancellation, the operation is not deleted; instead, it becomes
6970
- # an operation with an Operation.error value with a google.rpc.Status.code of 1,
6971
- # corresponding to `Code.CANCELLED`.
7008
+ # an operation with an Operation.error value with a google.rpc.Status.code of `1`
7009
+ # , corresponding to `Code.CANCELLED`.
6972
7010
  # @param [String] name
6973
7011
  # The name of the operation resource to be cancelled.
6974
7012
  # @param [Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.21.0
4
+ version: 0.23.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-11-03 00:00:00.000000000 Z
11
+ date: 2024-12-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.21.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.23.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.5.21
78
+ rubygems_version: 3.5.22
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Discovery Engine API V1