google-apis-discoveryengine_v1 0.22.0 → 0.23.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +6 -2
- data/lib/google/apis/discoveryengine_v1/classes.rb +323 -103
- data/lib/google/apis/discoveryengine_v1/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1/representations.rb +111 -34
- data/lib/google/apis/discoveryengine_v1/service.rb +44 -6
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 30a1879dbe64d1967abdf3875b45fedb3e902f1f68a2743659d4e96c376baa17
|
4
|
+
data.tar.gz: 80afdab1f2072bd1928cd289fded63a03a2e23c5d7645f943ee55ae09b801f79
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 71f4093f384d44f24bdf47f3997dace113b5a07adb95db9827da8bc678c48e85b8ca4e9ef83b2f365a10fcbfe5c39112009701c70b92d586a65d573f94595aef
|
7
|
+
data.tar.gz: '0978eadffc5abb7b5ca8d832ad4a4aaee3d6578aab3a6e133bfac3a4ebc70d3e7f3ecdb5833370a1920a51e32330f25313b40706228ccb4b43b42d2bbfb687a5'
|
data/CHANGELOG.md
CHANGED
@@ -1,8 +1,12 @@
|
|
1
1
|
# Release history for google-apis-discoveryengine_v1
|
2
2
|
|
3
|
-
### v0.
|
3
|
+
### v0.23.0 (2024-11-24)
|
4
4
|
|
5
|
-
* Regenerated from discovery document revision
|
5
|
+
* Regenerated from discovery document revision 20241123
|
6
|
+
|
7
|
+
### v0.22.0 (2024-11-17)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20241110
|
6
10
|
|
7
11
|
### v0.21.0 (2024-11-03)
|
8
12
|
|
@@ -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
|
@@ -2616,8 +2623,7 @@ module Google
|
|
2616
2623
|
# Indicates that this claim required grounding check. When the system decided
|
2617
2624
|
# this claim doesn't require attribution/grounding check, this field will be set
|
2618
2625
|
# to false. In that case, no grounding check was done for the claim and
|
2619
|
-
# therefore citation_indices
|
2620
|
-
# returned.
|
2626
|
+
# therefore citation_indices should not be returned.
|
2621
2627
|
# Corresponds to the JSON property `groundingCheckRequired`
|
2622
2628
|
# @return [Boolean]
|
2623
2629
|
attr_accessor :grounding_check_required
|
@@ -2714,7 +2720,7 @@ module Google
|
|
2714
2720
|
|
2715
2721
|
# Output only. Represents the relevance score based on similarity. Higher score
|
2716
2722
|
# indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only
|
2717
|
-
# populated on
|
2723
|
+
# populated on SearchResponse.
|
2718
2724
|
# Corresponds to the JSON property `relevanceScore`
|
2719
2725
|
# @return [Float]
|
2720
2726
|
attr_accessor :relevance_score
|
@@ -3208,6 +3214,13 @@ module Google
|
|
3208
3214
|
# @return [String]
|
3209
3215
|
attr_accessor :name
|
3210
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
|
+
|
3211
3224
|
# Redirects a shopper to the provided URI.
|
3212
3225
|
# Corresponds to the JSON property `redirectAction`
|
3213
3226
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlRedirectAction]
|
@@ -3246,6 +3259,7 @@ module Google
|
|
3246
3259
|
@display_name = args[:display_name] if args.key?(:display_name)
|
3247
3260
|
@filter_action = args[:filter_action] if args.key?(:filter_action)
|
3248
3261
|
@name = args[:name] if args.key?(:name)
|
3262
|
+
@promote_action = args[:promote_action] if args.key?(:promote_action)
|
3249
3263
|
@redirect_action = args[:redirect_action] if args.key?(:redirect_action)
|
3250
3264
|
@solution_type = args[:solution_type] if args.key?(:solution_type)
|
3251
3265
|
@synonyms_action = args[:synonyms_action] if args.key?(:synonyms_action)
|
@@ -3319,6 +3333,34 @@ module Google
|
|
3319
3333
|
end
|
3320
3334
|
end
|
3321
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
|
+
|
3322
3364
|
# Redirects a shopper to the provided URI.
|
3323
3365
|
class GoogleCloudDiscoveryengineV1ControlRedirectAction
|
3324
3366
|
include Google::Apis::Core::Hashable
|
@@ -4332,6 +4374,14 @@ module Google
|
|
4332
4374
|
class GoogleCloudDiscoveryengineV1DocumentInfo
|
4333
4375
|
include Google::Apis::Core::Hashable
|
4334
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
|
+
|
4335
4385
|
# The Document resource ID.
|
4336
4386
|
# Corresponds to the JSON property `id`
|
4337
4387
|
# @return [String]
|
@@ -4375,6 +4425,7 @@ module Google
|
|
4375
4425
|
|
4376
4426
|
# Update properties of this object
|
4377
4427
|
def update!(**args)
|
4428
|
+
@conversion_value = args[:conversion_value] if args.key?(:conversion_value)
|
4378
4429
|
@id = args[:id] if args.key?(:id)
|
4379
4430
|
@joined = args[:joined] if args.key?(:joined)
|
4380
4431
|
@name = args[:name] if args.key?(:name)
|
@@ -4906,77 +4957,6 @@ module Google
|
|
4906
4957
|
end
|
4907
4958
|
end
|
4908
4959
|
|
4909
|
-
# Information about the user feedback. This information will be used for logging
|
4910
|
-
# and metrics purpose.
|
4911
|
-
class GoogleCloudDiscoveryengineV1Feedback
|
4912
|
-
include Google::Apis::Core::Hashable
|
4913
|
-
|
4914
|
-
# Optional. The additional user comment of the feedback if user gives a thumb
|
4915
|
-
# down.
|
4916
|
-
# Corresponds to the JSON property `comment`
|
4917
|
-
# @return [String]
|
4918
|
-
attr_accessor :comment
|
4919
|
-
|
4920
|
-
# The conversation information such as the question index and session name.
|
4921
|
-
# Corresponds to the JSON property `conversationInfo`
|
4922
|
-
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FeedbackConversationInfo]
|
4923
|
-
attr_accessor :conversation_info
|
4924
|
-
|
4925
|
-
# Required. Indicate whether the user gives a positive or negative feedback. If
|
4926
|
-
# the user gives a negative feedback, there might be more feedback details.
|
4927
|
-
# Corresponds to the JSON property `feedbackType`
|
4928
|
-
# @return [String]
|
4929
|
-
attr_accessor :feedback_type
|
4930
|
-
|
4931
|
-
# The version of the LLM model that was used to generate the response.
|
4932
|
-
# Corresponds to the JSON property `llmModelVersion`
|
4933
|
-
# @return [String]
|
4934
|
-
attr_accessor :llm_model_version
|
4935
|
-
|
4936
|
-
# Optional. The reason if user gives a thumb down.
|
4937
|
-
# Corresponds to the JSON property `reasons`
|
4938
|
-
# @return [Array<String>]
|
4939
|
-
attr_accessor :reasons
|
4940
|
-
|
4941
|
-
def initialize(**args)
|
4942
|
-
update!(**args)
|
4943
|
-
end
|
4944
|
-
|
4945
|
-
# Update properties of this object
|
4946
|
-
def update!(**args)
|
4947
|
-
@comment = args[:comment] if args.key?(:comment)
|
4948
|
-
@conversation_info = args[:conversation_info] if args.key?(:conversation_info)
|
4949
|
-
@feedback_type = args[:feedback_type] if args.key?(:feedback_type)
|
4950
|
-
@llm_model_version = args[:llm_model_version] if args.key?(:llm_model_version)
|
4951
|
-
@reasons = args[:reasons] if args.key?(:reasons)
|
4952
|
-
end
|
4953
|
-
end
|
4954
|
-
|
4955
|
-
# The conversation information such as the question index and session name.
|
4956
|
-
class GoogleCloudDiscoveryengineV1FeedbackConversationInfo
|
4957
|
-
include Google::Apis::Core::Hashable
|
4958
|
-
|
4959
|
-
# The index of the user input within the conversation messages.
|
4960
|
-
# Corresponds to the JSON property `questionIndex`
|
4961
|
-
# @return [Fixnum]
|
4962
|
-
attr_accessor :question_index
|
4963
|
-
|
4964
|
-
# Name of the newly generated or continued session.
|
4965
|
-
# Corresponds to the JSON property `session`
|
4966
|
-
# @return [String]
|
4967
|
-
attr_accessor :session
|
4968
|
-
|
4969
|
-
def initialize(**args)
|
4970
|
-
update!(**args)
|
4971
|
-
end
|
4972
|
-
|
4973
|
-
# Update properties of this object
|
4974
|
-
def update!(**args)
|
4975
|
-
@question_index = args[:question_index] if args.key?(:question_index)
|
4976
|
-
@session = args[:session] if args.key?(:session)
|
4977
|
-
end
|
4978
|
-
end
|
4979
|
-
|
4980
4960
|
# Response message for SiteSearchEngineService.FetchDomainVerificationStatus
|
4981
4961
|
# method.
|
4982
4962
|
class GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse
|
@@ -6588,12 +6568,15 @@ module Google
|
|
6588
6568
|
# : Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 "zulu"
|
6589
6569
|
# format. * `userPseudoId`: Double quoted string. Specifying this will delete
|
6590
6570
|
# all events associated with a visitor. * `userId`: Double quoted string.
|
6591
|
-
# Specifying this will delete all events associated with a user.
|
6592
|
-
#
|
6593
|
-
# eventTime
|
6594
|
-
#
|
6595
|
-
#
|
6596
|
-
#
|
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.
|
6597
6580
|
# Corresponds to the JSON property `filter`
|
6598
6581
|
# @return [String]
|
6599
6582
|
attr_accessor :filter
|
@@ -6742,7 +6725,9 @@ module Google
|
|
6742
6725
|
# @return [String]
|
6743
6726
|
attr_accessor :id
|
6744
6727
|
|
6745
|
-
# 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.
|
6746
6731
|
# Corresponds to the JSON property `score`
|
6747
6732
|
# @return [Float]
|
6748
6733
|
attr_accessor :score
|
@@ -6776,8 +6761,8 @@ module Google
|
|
6776
6761
|
# ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags:
|
6777
6762
|
# ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params`
|
6778
6763
|
# field, then attribute-based expressions are expected instead of the above
|
6779
|
-
# described tag-based syntax. Examples: * (
|
6780
|
-
# categories: ANY("Movie")) * (available: true) AND (
|
6764
|
+
# described tag-based syntax. Examples: * (language: ANY("en", "es")) AND NOT (
|
6765
|
+
# categories: ANY("Movie")) * (available: true) AND (language: ANY("en", "es"))
|
6781
6766
|
# OR (categories: ANY("Movie")) If your filter blocks all results, the API
|
6782
6767
|
# returns generic (unfiltered) popular Documents. If you only want results
|
6783
6768
|
# strictly matching the filters, set `strictFiltering` to `true` in
|
@@ -7062,6 +7047,53 @@ module Google
|
|
7062
7047
|
end
|
7063
7048
|
end
|
7064
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
|
+
|
7065
7097
|
# Request message for SearchService.Search method.
|
7066
7098
|
class GoogleCloudDiscoveryengineV1SearchRequest
|
7067
7099
|
include Google::Apis::Core::Hashable
|
@@ -7096,10 +7128,10 @@ module Google
|
|
7096
7128
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec]
|
7097
7129
|
attr_accessor :content_search_spec
|
7098
7130
|
|
7099
|
-
# Specs defining
|
7100
|
-
# those
|
7101
|
-
#
|
7102
|
-
#
|
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.
|
7103
7135
|
# Corresponds to the JSON property `dataStoreSpecs`
|
7104
7136
|
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec>]
|
7105
7137
|
attr_accessor :data_store_specs
|
@@ -8158,6 +8190,11 @@ module Google
|
|
8158
8190
|
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResult>]
|
8159
8191
|
attr_accessor :results
|
8160
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
|
+
|
8161
8198
|
# Information about the session.
|
8162
8199
|
# Corresponds to the JSON property `sessionInfo`
|
8163
8200
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSessionInfo]
|
@@ -8188,6 +8225,7 @@ module Google
|
|
8188
8225
|
@query_expansion_info = args[:query_expansion_info] if args.key?(:query_expansion_info)
|
8189
8226
|
@redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
|
8190
8227
|
@results = args[:results] if args.key?(:results)
|
8228
|
+
@search_link_promotions = args[:search_link_promotions] if args.key?(:search_link_promotions)
|
8191
8229
|
@session_info = args[:session_info] if args.key?(:session_info)
|
8192
8230
|
@summary = args[:summary] if args.key?(:summary)
|
8193
8231
|
@total_size = args[:total_size] if args.key?(:total_size)
|
@@ -8638,6 +8676,11 @@ module Google
|
|
8638
8676
|
# @return [String]
|
8639
8677
|
attr_accessor :answer
|
8640
8678
|
|
8679
|
+
# Defines an answer.
|
8680
|
+
# Corresponds to the JSON property `detailedAnswer`
|
8681
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer]
|
8682
|
+
attr_accessor :detailed_answer
|
8683
|
+
|
8641
8684
|
# Defines a user inputed query.
|
8642
8685
|
# Corresponds to the JSON property `query`
|
8643
8686
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Query]
|
@@ -8650,6 +8693,7 @@ module Google
|
|
8650
8693
|
# Update properties of this object
|
8651
8694
|
def update!(**args)
|
8652
8695
|
@answer = args[:answer] if args.key?(:answer)
|
8696
|
+
@detailed_answer = args[:detailed_answer] if args.key?(:detailed_answer)
|
8653
8697
|
@query = args[:query] if args.key?(:query)
|
8654
8698
|
end
|
8655
8699
|
end
|
@@ -9276,6 +9320,15 @@ module Google
|
|
9276
9320
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompletionInfo]
|
9277
9321
|
attr_accessor :completion_info
|
9278
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
|
+
|
9279
9332
|
# The DataStore resource full name, of the form `projects/`project`/locations/`
|
9280
9333
|
# location`/collections/`collection_id`/dataStores/`data_store_id``. Optional.
|
9281
9334
|
# Only required for user events whose data store can't by determined by
|
@@ -9329,17 +9382,12 @@ module Google
|
|
9329
9382
|
# values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online
|
9330
9383
|
# shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`
|
9331
9384
|
# : Start/resume watching a video, playing a song, etc. * `media-complete`:
|
9332
|
-
# 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.
|
9333
9387
|
# Corresponds to the JSON property `eventType`
|
9334
9388
|
# @return [String]
|
9335
9389
|
attr_accessor :event_type
|
9336
9390
|
|
9337
|
-
# Information about the user feedback. This information will be used for logging
|
9338
|
-
# and metrics purpose.
|
9339
|
-
# Corresponds to the JSON property `feedback`
|
9340
|
-
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Feedback]
|
9341
|
-
attr_accessor :feedback
|
9342
|
-
|
9343
9391
|
# The filter syntax consists of an expression language for constructing a
|
9344
9392
|
# predicate from one or more fields of the documents being filtered. One example
|
9345
9393
|
# is for `search` events, the associated SearchRequest may contain a filter
|
@@ -9435,13 +9483,13 @@ module Google
|
|
9435
9483
|
@attributes = args[:attributes] if args.key?(:attributes)
|
9436
9484
|
@attribution_token = args[:attribution_token] if args.key?(:attribution_token)
|
9437
9485
|
@completion_info = args[:completion_info] if args.key?(:completion_info)
|
9486
|
+
@conversion_type = args[:conversion_type] if args.key?(:conversion_type)
|
9438
9487
|
@data_store = args[:data_store] if args.key?(:data_store)
|
9439
9488
|
@direct_user_request = args[:direct_user_request] if args.key?(:direct_user_request)
|
9440
9489
|
@documents = args[:documents] if args.key?(:documents)
|
9441
9490
|
@engine = args[:engine] if args.key?(:engine)
|
9442
9491
|
@event_time = args[:event_time] if args.key?(:event_time)
|
9443
9492
|
@event_type = args[:event_type] if args.key?(:event_type)
|
9444
|
-
@feedback = args[:feedback] if args.key?(:feedback)
|
9445
9493
|
@filter = args[:filter] if args.key?(:filter)
|
9446
9494
|
@media_info = args[:media_info] if args.key?(:media_info)
|
9447
9495
|
@page_info = args[:page_info] if args.key?(:page_info)
|
@@ -10421,6 +10469,13 @@ module Google
|
|
10421
10469
|
# @return [String]
|
10422
10470
|
attr_accessor :name
|
10423
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
|
+
|
10424
10479
|
# Redirects a shopper to the provided URI.
|
10425
10480
|
# Corresponds to the JSON property `redirectAction`
|
10426
10481
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlRedirectAction]
|
@@ -10459,6 +10514,7 @@ module Google
|
|
10459
10514
|
@display_name = args[:display_name] if args.key?(:display_name)
|
10460
10515
|
@filter_action = args[:filter_action] if args.key?(:filter_action)
|
10461
10516
|
@name = args[:name] if args.key?(:name)
|
10517
|
+
@promote_action = args[:promote_action] if args.key?(:promote_action)
|
10462
10518
|
@redirect_action = args[:redirect_action] if args.key?(:redirect_action)
|
10463
10519
|
@solution_type = args[:solution_type] if args.key?(:solution_type)
|
10464
10520
|
@synonyms_action = args[:synonyms_action] if args.key?(:synonyms_action)
|
@@ -10532,6 +10588,34 @@ module Google
|
|
10532
10588
|
end
|
10533
10589
|
end
|
10534
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
|
+
|
10535
10619
|
# Redirects a shopper to the provided URI.
|
10536
10620
|
class GoogleCloudDiscoveryengineV1alphaControlRedirectAction
|
10537
10621
|
include Google::Apis::Core::Hashable
|
@@ -13492,6 +13576,53 @@ module Google
|
|
13492
13576
|
end
|
13493
13577
|
end
|
13494
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
|
+
|
13495
13626
|
# Request message for SearchService.Search method.
|
13496
13627
|
class GoogleCloudDiscoveryengineV1alphaSearchRequest
|
13497
13628
|
include Google::Apis::Core::Hashable
|
@@ -13531,10 +13662,10 @@ module Google
|
|
13531
13662
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
|
13532
13663
|
attr_accessor :custom_fine_tuning_spec
|
13533
13664
|
|
13534
|
-
# Specs defining
|
13535
|
-
# those
|
13536
|
-
#
|
13537
|
-
#
|
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.
|
13538
13669
|
# Corresponds to the JSON property `dataStoreSpecs`
|
13539
13670
|
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec>]
|
13540
13671
|
attr_accessor :data_store_specs
|
@@ -14766,6 +14897,11 @@ module Google
|
|
14766
14897
|
# @return [String]
|
14767
14898
|
attr_accessor :answer
|
14768
14899
|
|
14900
|
+
# Defines an answer.
|
14901
|
+
# Corresponds to the JSON property `detailedAnswer`
|
14902
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswer]
|
14903
|
+
attr_accessor :detailed_answer
|
14904
|
+
|
14769
14905
|
# Defines a user inputed query.
|
14770
14906
|
# Corresponds to the JSON property `query`
|
14771
14907
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaQuery]
|
@@ -14778,6 +14914,7 @@ module Google
|
|
14778
14914
|
# Update properties of this object
|
14779
14915
|
def update!(**args)
|
14780
14916
|
@answer = args[:answer] if args.key?(:answer)
|
14917
|
+
@detailed_answer = args[:detailed_answer] if args.key?(:detailed_answer)
|
14781
14918
|
@query = args[:query] if args.key?(:query)
|
14782
14919
|
end
|
14783
14920
|
end
|
@@ -15514,6 +15651,13 @@ module Google
|
|
15514
15651
|
# @return [String]
|
15515
15652
|
attr_accessor :name
|
15516
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
|
+
|
15517
15661
|
# Redirects a shopper to the provided URI.
|
15518
15662
|
# Corresponds to the JSON property `redirectAction`
|
15519
15663
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlRedirectAction]
|
@@ -15552,6 +15696,7 @@ module Google
|
|
15552
15696
|
@display_name = args[:display_name] if args.key?(:display_name)
|
15553
15697
|
@filter_action = args[:filter_action] if args.key?(:filter_action)
|
15554
15698
|
@name = args[:name] if args.key?(:name)
|
15699
|
+
@promote_action = args[:promote_action] if args.key?(:promote_action)
|
15555
15700
|
@redirect_action = args[:redirect_action] if args.key?(:redirect_action)
|
15556
15701
|
@solution_type = args[:solution_type] if args.key?(:solution_type)
|
15557
15702
|
@synonyms_action = args[:synonyms_action] if args.key?(:synonyms_action)
|
@@ -15625,6 +15770,34 @@ module Google
|
|
15625
15770
|
end
|
15626
15771
|
end
|
15627
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
|
+
|
15628
15801
|
# Redirects a shopper to the provided URI.
|
15629
15802
|
class GoogleCloudDiscoveryengineV1betaControlRedirectAction
|
15630
15803
|
include Google::Apis::Core::Hashable
|
@@ -17709,6 +17882,53 @@ module Google
|
|
17709
17882
|
end
|
17710
17883
|
end
|
17711
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
|
+
|
17712
17932
|
# Request message for SearchService.Search method.
|
17713
17933
|
class GoogleCloudDiscoveryengineV1betaSearchRequest
|
17714
17934
|
include Google::Apis::Core::Hashable
|
@@ -17743,10 +17963,10 @@ module Google
|
|
17743
17963
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec]
|
17744
17964
|
attr_accessor :content_search_spec
|
17745
17965
|
|
17746
|
-
# Specs defining
|
17747
|
-
# those
|
17748
|
-
#
|
17749
|
-
#
|
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.
|
17750
17970
|
# Corresponds to the JSON property `dataStoreSpecs`
|
17751
17971
|
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec>]
|
17752
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.
|
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 = "
|
25
|
+
REVISION = "20241123"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -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
|
|
@@ -838,18 +844,6 @@ module Google
|
|
838
844
|
include Google::Apis::Core::JsonObjectSupport
|
839
845
|
end
|
840
846
|
|
841
|
-
class GoogleCloudDiscoveryengineV1Feedback
|
842
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
843
|
-
|
844
|
-
include Google::Apis::Core::JsonObjectSupport
|
845
|
-
end
|
846
|
-
|
847
|
-
class GoogleCloudDiscoveryengineV1FeedbackConversationInfo
|
848
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
849
|
-
|
850
|
-
include Google::Apis::Core::JsonObjectSupport
|
851
|
-
end
|
852
|
-
|
853
847
|
class GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse
|
854
848
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
855
849
|
|
@@ -1222,6 +1216,12 @@ module Google
|
|
1222
1216
|
include Google::Apis::Core::JsonObjectSupport
|
1223
1217
|
end
|
1224
1218
|
|
1219
|
+
class GoogleCloudDiscoveryengineV1SearchLinkPromotion
|
1220
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1221
|
+
|
1222
|
+
include Google::Apis::Core::JsonObjectSupport
|
1223
|
+
end
|
1224
|
+
|
1225
1225
|
class GoogleCloudDiscoveryengineV1SearchRequest
|
1226
1226
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1227
1227
|
|
@@ -1726,6 +1726,12 @@ module Google
|
|
1726
1726
|
include Google::Apis::Core::JsonObjectSupport
|
1727
1727
|
end
|
1728
1728
|
|
1729
|
+
class GoogleCloudDiscoveryengineV1alphaControlPromoteAction
|
1730
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1731
|
+
|
1732
|
+
include Google::Apis::Core::JsonObjectSupport
|
1733
|
+
end
|
1734
|
+
|
1729
1735
|
class GoogleCloudDiscoveryengineV1alphaControlRedirectAction
|
1730
1736
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1731
1737
|
|
@@ -2254,6 +2260,12 @@ module Google
|
|
2254
2260
|
include Google::Apis::Core::JsonObjectSupport
|
2255
2261
|
end
|
2256
2262
|
|
2263
|
+
class GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion
|
2264
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
2265
|
+
|
2266
|
+
include Google::Apis::Core::JsonObjectSupport
|
2267
|
+
end
|
2268
|
+
|
2257
2269
|
class GoogleCloudDiscoveryengineV1alphaSearchRequest
|
2258
2270
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
2259
2271
|
|
@@ -2566,6 +2578,12 @@ module Google
|
|
2566
2578
|
include Google::Apis::Core::JsonObjectSupport
|
2567
2579
|
end
|
2568
2580
|
|
2581
|
+
class GoogleCloudDiscoveryengineV1betaControlPromoteAction
|
2582
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
2583
|
+
|
2584
|
+
include Google::Apis::Core::JsonObjectSupport
|
2585
|
+
end
|
2586
|
+
|
2569
2587
|
class GoogleCloudDiscoveryengineV1betaControlRedirectAction
|
2570
2588
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
2571
2589
|
|
@@ -2950,6 +2968,12 @@ module Google
|
|
2950
2968
|
include Google::Apis::Core::JsonObjectSupport
|
2951
2969
|
end
|
2952
2970
|
|
2971
|
+
class GoogleCloudDiscoveryengineV1betaSearchLinkPromotion
|
2972
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
2973
|
+
|
2974
|
+
include Google::Apis::Core::JsonObjectSupport
|
2975
|
+
end
|
2976
|
+
|
2953
2977
|
class GoogleCloudDiscoveryengineV1betaSearchRequest
|
2954
2978
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
2955
2979
|
|
@@ -3507,6 +3531,7 @@ module Google
|
|
3507
3531
|
class GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec
|
3508
3532
|
# @private
|
3509
3533
|
class Representation < Google::Apis::Core::JsonRepresentation
|
3534
|
+
property :filtering_level, as: 'filteringLevel'
|
3510
3535
|
property :include_grounding_supports, as: 'includeGroundingSupports'
|
3511
3536
|
end
|
3512
3537
|
end
|
@@ -4112,6 +4137,8 @@ module Google
|
|
4112
4137
|
property :filter_action, as: 'filterAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlFilterAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlFilterAction::Representation
|
4113
4138
|
|
4114
4139
|
property :name, as: 'name'
|
4140
|
+
property :promote_action, as: 'promoteAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlPromoteAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlPromoteAction::Representation
|
4141
|
+
|
4115
4142
|
property :redirect_action, as: 'redirectAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlRedirectAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlRedirectAction::Representation
|
4116
4143
|
|
4117
4144
|
property :solution_type, as: 'solutionType'
|
@@ -4138,6 +4165,15 @@ module Google
|
|
4138
4165
|
end
|
4139
4166
|
end
|
4140
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
|
+
|
4141
4177
|
class GoogleCloudDiscoveryengineV1ControlRedirectAction
|
4142
4178
|
# @private
|
4143
4179
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -4415,6 +4451,7 @@ module Google
|
|
4415
4451
|
class GoogleCloudDiscoveryengineV1DocumentInfo
|
4416
4452
|
# @private
|
4417
4453
|
class Representation < Google::Apis::Core::JsonRepresentation
|
4454
|
+
property :conversion_value, as: 'conversionValue'
|
4418
4455
|
property :id, as: 'id'
|
4419
4456
|
property :joined, as: 'joined'
|
4420
4457
|
property :name, as: 'name'
|
@@ -4578,26 +4615,6 @@ module Google
|
|
4578
4615
|
end
|
4579
4616
|
end
|
4580
4617
|
|
4581
|
-
class GoogleCloudDiscoveryengineV1Feedback
|
4582
|
-
# @private
|
4583
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
4584
|
-
property :comment, as: 'comment'
|
4585
|
-
property :conversation_info, as: 'conversationInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FeedbackConversationInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FeedbackConversationInfo::Representation
|
4586
|
-
|
4587
|
-
property :feedback_type, as: 'feedbackType'
|
4588
|
-
property :llm_model_version, as: 'llmModelVersion'
|
4589
|
-
collection :reasons, as: 'reasons'
|
4590
|
-
end
|
4591
|
-
end
|
4592
|
-
|
4593
|
-
class GoogleCloudDiscoveryengineV1FeedbackConversationInfo
|
4594
|
-
# @private
|
4595
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
4596
|
-
property :question_index, as: 'questionIndex'
|
4597
|
-
property :session, as: 'session'
|
4598
|
-
end
|
4599
|
-
end
|
4600
|
-
|
4601
4618
|
class GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse
|
4602
4619
|
# @private
|
4603
4620
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -5196,6 +5213,17 @@ module Google
|
|
5196
5213
|
end
|
5197
5214
|
end
|
5198
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
|
+
|
5199
5227
|
class GoogleCloudDiscoveryengineV1SearchRequest
|
5200
5228
|
# @private
|
5201
5229
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -5432,6 +5460,8 @@ module Google
|
|
5432
5460
|
property :redirect_uri, as: 'redirectUri'
|
5433
5461
|
collection :results, as: 'results', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResult, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResult::Representation
|
5434
5462
|
|
5463
|
+
collection :search_link_promotions, as: 'searchLinkPromotions', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchLinkPromotion, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchLinkPromotion::Representation
|
5464
|
+
|
5435
5465
|
property :session_info, as: 'sessionInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSessionInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSessionInfo::Representation
|
5436
5466
|
|
5437
5467
|
property :summary, as: 'summary', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSummary, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSummary::Representation
|
@@ -5579,6 +5609,8 @@ module Google
|
|
5579
5609
|
# @private
|
5580
5610
|
class Representation < Google::Apis::Core::JsonRepresentation
|
5581
5611
|
property :answer, as: 'answer'
|
5612
|
+
property :detailed_answer, as: 'detailedAnswer', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer::Representation
|
5613
|
+
|
5582
5614
|
property :query, as: 'query', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Query, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Query::Representation
|
5583
5615
|
|
5584
5616
|
end
|
@@ -5747,6 +5779,7 @@ module Google
|
|
5747
5779
|
property :attribution_token, as: 'attributionToken'
|
5748
5780
|
property :completion_info, as: 'completionInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompletionInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompletionInfo::Representation
|
5749
5781
|
|
5782
|
+
property :conversion_type, as: 'conversionType'
|
5750
5783
|
property :data_store, as: 'dataStore'
|
5751
5784
|
property :direct_user_request, as: 'directUserRequest'
|
5752
5785
|
collection :documents, as: 'documents', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentInfo::Representation
|
@@ -5754,8 +5787,6 @@ module Google
|
|
5754
5787
|
property :engine, as: 'engine'
|
5755
5788
|
property :event_time, as: 'eventTime'
|
5756
5789
|
property :event_type, as: 'eventType'
|
5757
|
-
property :feedback, as: 'feedback', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Feedback, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Feedback::Representation
|
5758
|
-
|
5759
5790
|
property :filter, as: 'filter'
|
5760
5791
|
property :media_info, as: 'mediaInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1MediaInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1MediaInfo::Representation
|
5761
5792
|
|
@@ -6064,6 +6095,8 @@ module Google
|
|
6064
6095
|
property :filter_action, as: 'filterAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlFilterAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlFilterAction::Representation
|
6065
6096
|
|
6066
6097
|
property :name, as: 'name'
|
6098
|
+
property :promote_action, as: 'promoteAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlPromoteAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlPromoteAction::Representation
|
6099
|
+
|
6067
6100
|
property :redirect_action, as: 'redirectAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlRedirectAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaControlRedirectAction::Representation
|
6068
6101
|
|
6069
6102
|
property :solution_type, as: 'solutionType'
|
@@ -6090,6 +6123,15 @@ module Google
|
|
6090
6123
|
end
|
6091
6124
|
end
|
6092
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
|
+
|
6093
6135
|
class GoogleCloudDiscoveryengineV1alphaControlRedirectAction
|
6094
6136
|
# @private
|
6095
6137
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -6935,6 +6977,17 @@ module Google
|
|
6935
6977
|
end
|
6936
6978
|
end
|
6937
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
|
+
|
6938
6991
|
class GoogleCloudDiscoveryengineV1alphaSearchRequest
|
6939
6992
|
# @private
|
6940
6993
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -7218,6 +7271,8 @@ module Google
|
|
7218
7271
|
# @private
|
7219
7272
|
class Representation < Google::Apis::Core::JsonRepresentation
|
7220
7273
|
property :answer, as: 'answer'
|
7274
|
+
property :detailed_answer, as: 'detailedAnswer', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswer, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAnswer::Representation
|
7275
|
+
|
7221
7276
|
property :query, as: 'query', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaQuery, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaQuery::Representation
|
7222
7277
|
|
7223
7278
|
end
|
@@ -7436,6 +7491,8 @@ module Google
|
|
7436
7491
|
property :filter_action, as: 'filterAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlFilterAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlFilterAction::Representation
|
7437
7492
|
|
7438
7493
|
property :name, as: 'name'
|
7494
|
+
property :promote_action, as: 'promoteAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlPromoteAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlPromoteAction::Representation
|
7495
|
+
|
7439
7496
|
property :redirect_action, as: 'redirectAction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlRedirectAction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlRedirectAction::Representation
|
7440
7497
|
|
7441
7498
|
property :solution_type, as: 'solutionType'
|
@@ -7462,6 +7519,15 @@ module Google
|
|
7462
7519
|
end
|
7463
7520
|
end
|
7464
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
|
+
|
7465
7531
|
class GoogleCloudDiscoveryengineV1betaControlRedirectAction
|
7466
7532
|
# @private
|
7467
7533
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -8073,6 +8139,17 @@ module Google
|
|
8073
8139
|
end
|
8074
8140
|
end
|
8075
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
|
+
|
8076
8153
|
class GoogleCloudDiscoveryengineV1betaSearchRequest
|
8077
8154
|
# @private
|
8078
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.
|
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
|
+
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.
|
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: []
|