google-cloud-discovery_engine-v1beta 0.3.0 → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +21 -3
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +21 -3
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +959 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/paths.rb +176 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +797 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb +450 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +19 -4
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +19 -4
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +42 -0
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/rest.rb +2 -1
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/client.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +42 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +57 -12
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +57 -12
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +16 -2
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +16 -2
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +42 -0
- data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/conversation_pb.rb +55 -0
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +61 -0
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_services_pb.rb +67 -0
- data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +7 -1
- data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/user_event_service_services_pb.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +14 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +10 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb +13 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb +138 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +209 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +2 -4
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +2 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +17 -17
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +295 -61
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +41 -29
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_event_service.rb +1 -1
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- metadata +36 -3
@@ -57,7 +57,7 @@ module Google
|
|
57
57
|
# quality.
|
58
58
|
#
|
59
59
|
# The field must be a UTF-8 encoded string with a length limit of 128
|
60
|
-
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
60
|
+
# characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
61
61
|
#
|
62
62
|
# The field should not contain PII or user-data. We recommend to use Google
|
63
63
|
# Analytics [Client
|
@@ -111,20 +111,20 @@ module Google
|
|
111
111
|
#
|
112
112
|
# The value must be one of:
|
113
113
|
#
|
114
|
-
# *
|
114
|
+
# * {::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse#attribution_token RecommendResponse.attribution_token} for events that are the result of
|
115
115
|
# {::Google::Cloud::DiscoveryEngine::V1beta::RecommendationService::Client#recommend RecommendationService.Recommend}.
|
116
116
|
# * {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#attribution_token SearchResponse.attribution_token} for events that are the result of
|
117
117
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client#search SearchService.Search}.
|
118
|
-
# * [CompleteQueryResponse.attribution_token][] for events that are the
|
119
|
-
# result of
|
120
|
-
# {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#complete_query CompletionService.CompleteQuery}.
|
121
118
|
#
|
122
119
|
# This token enables us to accurately attribute page view or conversion
|
123
120
|
# completion back to the event and the particular predict response containing
|
124
121
|
# this clicked/purchased product. If user clicks on product K in the
|
125
|
-
# recommendation results, pass
|
126
|
-
#
|
127
|
-
#
|
122
|
+
# recommendation results, pass
|
123
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse#attribution_token RecommendResponse.attribution_token}
|
124
|
+
# as a URL parameter to product K's page. When recording events on product
|
125
|
+
# K's page, log the
|
126
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse#attribution_token RecommendResponse.attribution_token}
|
127
|
+
# to this field.
|
128
128
|
# @!attribute [rw] filter
|
129
129
|
# @return [::String]
|
130
130
|
# The filter syntax consists of an expression language for constructing a
|
@@ -142,10 +142,11 @@ module Google
|
|
142
142
|
# to https://google.aip.dev/160#filtering.
|
143
143
|
#
|
144
144
|
# The value must be a UTF-8 encoded string with a length limit of 1,000
|
145
|
-
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
145
|
+
# characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
146
146
|
# @!attribute [rw] documents
|
147
147
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::DocumentInfo>]
|
148
|
-
# List of
|
148
|
+
# List of {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s
|
149
|
+
# associated with this user event.
|
149
150
|
#
|
150
151
|
# This field is optional except for the following event types:
|
151
152
|
#
|
@@ -167,12 +168,14 @@ module Google
|
|
167
168
|
# Panel metadata associated with this user event.
|
168
169
|
# @!attribute [rw] search_info
|
169
170
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchInfo]
|
170
|
-
#
|
171
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client#search SearchService.Search}
|
172
|
+
# details related to the event.
|
171
173
|
#
|
172
174
|
# This field should be set for `search` event.
|
173
175
|
# @!attribute [rw] completion_info
|
174
176
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::CompletionInfo]
|
175
|
-
#
|
177
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client#complete_query CompletionService.CompleteQuery}
|
178
|
+
# details related to the event.
|
176
179
|
#
|
177
180
|
# This field should be set for `search` event when autocomplete function is
|
178
181
|
# enabled and the user clicks a suggestion for search.
|
@@ -212,7 +215,7 @@ module Google
|
|
212
215
|
# * For number attributes, at most 400 values are allowed.
|
213
216
|
#
|
214
217
|
# For product recommendations, an example of extra user information is
|
215
|
-
# `
|
218
|
+
# `traffic_channel`, which is how a user arrives at the site. Users can
|
216
219
|
# arrive
|
217
220
|
# at the site by coming to the site directly, coming through Google
|
218
221
|
# search, or in other ways.
|
@@ -240,7 +243,7 @@ module Google
|
|
240
243
|
#
|
241
244
|
# This should be kept the same for all user events triggered from the same
|
242
245
|
# pageview. For example, an item detail page view could trigger multiple
|
243
|
-
# events as the user is browsing the page. The `
|
246
|
+
# events as the user is browsing the page. The `pageview_id` property should
|
244
247
|
# be kept the same for all these events so that they can be grouped together
|
245
248
|
# properly.
|
246
249
|
#
|
@@ -256,10 +259,10 @@ module Google
|
|
256
259
|
#
|
257
260
|
# Category pages include special pages such as sales or promotions. For
|
258
261
|
# instance, a special sale page may have the category hierarchy:
|
259
|
-
# "pageCategory" : "Sales > 2017 Black Friday Deals"
|
262
|
+
# `"pageCategory" : "Sales > 2017 Black Friday Deals"`.
|
260
263
|
#
|
261
264
|
# Required for `view-category-page` events. Other event types should not set
|
262
|
-
# this field. Otherwise, an INVALID_ARGUMENT error is returned.
|
265
|
+
# this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
263
266
|
# @!attribute [rw] uri
|
264
267
|
# @return [::String]
|
265
268
|
# Complete URL (window.location.href) of the user's current page.
|
@@ -289,14 +292,14 @@ module Google
|
|
289
292
|
# for definition.
|
290
293
|
#
|
291
294
|
# The value must be a UTF-8 encoded string with a length limit of 5,000
|
292
|
-
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
295
|
+
# characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
293
296
|
#
|
294
297
|
# At least one of
|
295
298
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchInfo#search_query search_query}
|
296
299
|
# or
|
297
300
|
# {::Google::Cloud::DiscoveryEngine::V1beta::PageInfo#page_category PageInfo.page_category}
|
298
301
|
# is required for `search` events. Other event types should not set this
|
299
|
-
# field. Otherwise, an INVALID_ARGUMENT error is returned.
|
302
|
+
# field. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
300
303
|
# @!attribute [rw] order_by
|
301
304
|
# @return [::String]
|
302
305
|
# The order in which products are returned, if applicable.
|
@@ -306,10 +309,10 @@ module Google
|
|
306
309
|
# for definition and syntax.
|
307
310
|
#
|
308
311
|
# The value must be a UTF-8 encoded string with a length limit of 1,000
|
309
|
-
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
312
|
+
# characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
310
313
|
#
|
311
314
|
# This can only be set for `search` events. Other event types should not set
|
312
|
-
# this field. Otherwise, an INVALID_ARGUMENT error is returned.
|
315
|
+
# this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
313
316
|
# @!attribute [rw] offset
|
314
317
|
# @return [::Integer]
|
315
318
|
# An integer that specifies the current offset for pagination (the 0-indexed
|
@@ -319,10 +322,10 @@ module Google
|
|
319
322
|
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#offset SearchRequest.offset}
|
320
323
|
# for definition.
|
321
324
|
#
|
322
|
-
# If this field is negative, an INVALID_ARGUMENT is returned.
|
325
|
+
# If this field is negative, an `INVALID_ARGUMENT` is returned.
|
323
326
|
#
|
324
327
|
# This can only be set for `search` events. Other event types should not set
|
325
|
-
# this field. Otherwise, an INVALID_ARGUMENT error is returned.
|
328
|
+
# this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
326
329
|
class SearchInfo
|
327
330
|
include ::Google::Protobuf::MessageExts
|
328
331
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -332,10 +335,12 @@ module Google
|
|
332
335
|
# clicked completion info.
|
333
336
|
# @!attribute [rw] selected_suggestion
|
334
337
|
# @return [::String]
|
335
|
-
# End user selected
|
338
|
+
# End user selected
|
339
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::CompleteQueryResponse::QuerySuggestion#suggestion CompleteQueryResponse.QuerySuggestion.suggestion}.
|
336
340
|
# @!attribute [rw] selected_position
|
337
341
|
# @return [::Integer]
|
338
|
-
# End user selected
|
342
|
+
# End user selected
|
343
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::CompleteQueryResponse::QuerySuggestion#suggestion CompleteQueryResponse.QuerySuggestion.suggestion}
|
339
344
|
# position, starting from 0.
|
340
345
|
class CompletionInfo
|
341
346
|
include ::Google::Protobuf::MessageExts
|
@@ -398,11 +403,16 @@ module Google
|
|
398
403
|
# Detailed document information associated with a user event.
|
399
404
|
# @!attribute [rw] id
|
400
405
|
# @return [::String]
|
401
|
-
#
|
406
|
+
# The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} resource ID.
|
402
407
|
# @!attribute [rw] name
|
403
408
|
# @return [::String]
|
404
|
-
#
|
409
|
+
# The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} resource
|
410
|
+
# full name, of the form:
|
405
411
|
# `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
|
412
|
+
# @!attribute [rw] uri
|
413
|
+
# @return [::String]
|
414
|
+
# The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} URI - only
|
415
|
+
# allowed for website data stores.
|
406
416
|
# @!attribute [rw] quantity
|
407
417
|
# @return [::Integer]
|
408
418
|
# Quantity of the Document associated with the user event. Defaults to 1.
|
@@ -452,11 +462,13 @@ module Google
|
|
452
462
|
# @return [::Google::Protobuf::Duration]
|
453
463
|
# The media progress time in seconds, if applicable.
|
454
464
|
# For example, if the end user has finished 90 seconds of a playback video,
|
455
|
-
# then
|
456
|
-
#
|
465
|
+
# then
|
466
|
+
# {::Google::Protobuf::Duration#seconds MediaInfo.media_progress_duration.seconds}
|
467
|
+
# should be set to 90.
|
457
468
|
# @!attribute [rw] media_progress_percentage
|
458
469
|
# @return [::Float]
|
459
|
-
# Media progress should be computed using only the
|
470
|
+
# Media progress should be computed using only the
|
471
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::MediaInfo#media_progress_duration media_progress_duration}
|
460
472
|
# relative to the media total length.
|
461
473
|
#
|
462
474
|
# This value must be between `[0, 1.0]` inclusive.
|
@@ -47,7 +47,7 @@ module Google
|
|
47
47
|
# @return [::String]
|
48
48
|
# The URL including cgi-parameters but excluding the hash fragment with a
|
49
49
|
# length limit of 5,000 characters. This is often more useful than the
|
50
|
-
# referer URL, because many browsers only send the domain for
|
50
|
+
# referer URL, because many browsers only send the domain for third-party
|
51
51
|
# requests.
|
52
52
|
# @!attribute [rw] ets
|
53
53
|
# @return [::Integer]
|
@@ -0,0 +1,229 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Protobuf
|
22
|
+
# `FieldMask` represents a set of symbolic field paths, for example:
|
23
|
+
#
|
24
|
+
# paths: "f.a"
|
25
|
+
# paths: "f.b.d"
|
26
|
+
#
|
27
|
+
# Here `f` represents a field in some root message, `a` and `b`
|
28
|
+
# fields in the message found in `f`, and `d` a field found in the
|
29
|
+
# message in `f.b`.
|
30
|
+
#
|
31
|
+
# Field masks are used to specify a subset of fields that should be
|
32
|
+
# returned by a get operation or modified by an update operation.
|
33
|
+
# Field masks also have a custom JSON encoding (see below).
|
34
|
+
#
|
35
|
+
# # Field Masks in Projections
|
36
|
+
#
|
37
|
+
# When used in the context of a projection, a response message or
|
38
|
+
# sub-message is filtered by the API to only contain those fields as
|
39
|
+
# specified in the mask. For example, if the mask in the previous
|
40
|
+
# example is applied to a response message as follows:
|
41
|
+
#
|
42
|
+
# f {
|
43
|
+
# a : 22
|
44
|
+
# b {
|
45
|
+
# d : 1
|
46
|
+
# x : 2
|
47
|
+
# }
|
48
|
+
# y : 13
|
49
|
+
# }
|
50
|
+
# z: 8
|
51
|
+
#
|
52
|
+
# The result will not contain specific values for fields x,y and z
|
53
|
+
# (their value will be set to the default, and omitted in proto text
|
54
|
+
# output):
|
55
|
+
#
|
56
|
+
#
|
57
|
+
# f {
|
58
|
+
# a : 22
|
59
|
+
# b {
|
60
|
+
# d : 1
|
61
|
+
# }
|
62
|
+
# }
|
63
|
+
#
|
64
|
+
# A repeated field is not allowed except at the last position of a
|
65
|
+
# paths string.
|
66
|
+
#
|
67
|
+
# If a FieldMask object is not present in a get operation, the
|
68
|
+
# operation applies to all fields (as if a FieldMask of all fields
|
69
|
+
# had been specified).
|
70
|
+
#
|
71
|
+
# Note that a field mask does not necessarily apply to the
|
72
|
+
# top-level response message. In case of a REST get operation, the
|
73
|
+
# field mask applies directly to the response, but in case of a REST
|
74
|
+
# list operation, the mask instead applies to each individual message
|
75
|
+
# in the returned resource list. In case of a REST custom method,
|
76
|
+
# other definitions may be used. Where the mask applies will be
|
77
|
+
# clearly documented together with its declaration in the API. In
|
78
|
+
# any case, the effect on the returned resource/resources is required
|
79
|
+
# behavior for APIs.
|
80
|
+
#
|
81
|
+
# # Field Masks in Update Operations
|
82
|
+
#
|
83
|
+
# A field mask in update operations specifies which fields of the
|
84
|
+
# targeted resource are going to be updated. The API is required
|
85
|
+
# to only change the values of the fields as specified in the mask
|
86
|
+
# and leave the others untouched. If a resource is passed in to
|
87
|
+
# describe the updated values, the API ignores the values of all
|
88
|
+
# fields not covered by the mask.
|
89
|
+
#
|
90
|
+
# If a repeated field is specified for an update operation, new values will
|
91
|
+
# be appended to the existing repeated field in the target resource. Note that
|
92
|
+
# a repeated field is only allowed in the last position of a `paths` string.
|
93
|
+
#
|
94
|
+
# If a sub-message is specified in the last position of the field mask for an
|
95
|
+
# update operation, then new value will be merged into the existing sub-message
|
96
|
+
# in the target resource.
|
97
|
+
#
|
98
|
+
# For example, given the target message:
|
99
|
+
#
|
100
|
+
# f {
|
101
|
+
# b {
|
102
|
+
# d: 1
|
103
|
+
# x: 2
|
104
|
+
# }
|
105
|
+
# c: [1]
|
106
|
+
# }
|
107
|
+
#
|
108
|
+
# And an update message:
|
109
|
+
#
|
110
|
+
# f {
|
111
|
+
# b {
|
112
|
+
# d: 10
|
113
|
+
# }
|
114
|
+
# c: [2]
|
115
|
+
# }
|
116
|
+
#
|
117
|
+
# then if the field mask is:
|
118
|
+
#
|
119
|
+
# paths: ["f.b", "f.c"]
|
120
|
+
#
|
121
|
+
# then the result will be:
|
122
|
+
#
|
123
|
+
# f {
|
124
|
+
# b {
|
125
|
+
# d: 10
|
126
|
+
# x: 2
|
127
|
+
# }
|
128
|
+
# c: [1, 2]
|
129
|
+
# }
|
130
|
+
#
|
131
|
+
# An implementation may provide options to override this default behavior for
|
132
|
+
# repeated and message fields.
|
133
|
+
#
|
134
|
+
# In order to reset a field's value to the default, the field must
|
135
|
+
# be in the mask and set to the default value in the provided resource.
|
136
|
+
# Hence, in order to reset all fields of a resource, provide a default
|
137
|
+
# instance of the resource and set all fields in the mask, or do
|
138
|
+
# not provide a mask as described below.
|
139
|
+
#
|
140
|
+
# If a field mask is not present on update, the operation applies to
|
141
|
+
# all fields (as if a field mask of all fields has been specified).
|
142
|
+
# Note that in the presence of schema evolution, this may mean that
|
143
|
+
# fields the client does not know and has therefore not filled into
|
144
|
+
# the request will be reset to their default. If this is unwanted
|
145
|
+
# behavior, a specific service may require a client to always specify
|
146
|
+
# a field mask, producing an error if not.
|
147
|
+
#
|
148
|
+
# As with get operations, the location of the resource which
|
149
|
+
# describes the updated values in the request message depends on the
|
150
|
+
# operation kind. In any case, the effect of the field mask is
|
151
|
+
# required to be honored by the API.
|
152
|
+
#
|
153
|
+
# ## Considerations for HTTP REST
|
154
|
+
#
|
155
|
+
# The HTTP kind of an update operation which uses a field mask must
|
156
|
+
# be set to PATCH instead of PUT in order to satisfy HTTP semantics
|
157
|
+
# (PUT must only be used for full updates).
|
158
|
+
#
|
159
|
+
# # JSON Encoding of Field Masks
|
160
|
+
#
|
161
|
+
# In JSON, a field mask is encoded as a single string where paths are
|
162
|
+
# separated by a comma. Fields name in each path are converted
|
163
|
+
# to/from lower-camel naming conventions.
|
164
|
+
#
|
165
|
+
# As an example, consider the following message declarations:
|
166
|
+
#
|
167
|
+
# message Profile {
|
168
|
+
# User user = 1;
|
169
|
+
# Photo photo = 2;
|
170
|
+
# }
|
171
|
+
# message User {
|
172
|
+
# string display_name = 1;
|
173
|
+
# string address = 2;
|
174
|
+
# }
|
175
|
+
#
|
176
|
+
# In proto a field mask for `Profile` may look as such:
|
177
|
+
#
|
178
|
+
# mask {
|
179
|
+
# paths: "user.display_name"
|
180
|
+
# paths: "photo"
|
181
|
+
# }
|
182
|
+
#
|
183
|
+
# In JSON, the same mask is represented as below:
|
184
|
+
#
|
185
|
+
# {
|
186
|
+
# mask: "user.displayName,photo"
|
187
|
+
# }
|
188
|
+
#
|
189
|
+
# # Field Masks and Oneof Fields
|
190
|
+
#
|
191
|
+
# Field masks treat fields in oneofs just as regular fields. Consider the
|
192
|
+
# following message:
|
193
|
+
#
|
194
|
+
# message SampleMessage {
|
195
|
+
# oneof test_oneof {
|
196
|
+
# string name = 4;
|
197
|
+
# SubMessage sub_message = 9;
|
198
|
+
# }
|
199
|
+
# }
|
200
|
+
#
|
201
|
+
# The field mask can be:
|
202
|
+
#
|
203
|
+
# mask {
|
204
|
+
# paths: "name"
|
205
|
+
# }
|
206
|
+
#
|
207
|
+
# Or:
|
208
|
+
#
|
209
|
+
# mask {
|
210
|
+
# paths: "sub_message"
|
211
|
+
# }
|
212
|
+
#
|
213
|
+
# Note that oneof type names ("test_oneof" in this case) cannot be used in
|
214
|
+
# paths.
|
215
|
+
#
|
216
|
+
# ## Field Mask Verification
|
217
|
+
#
|
218
|
+
# The implementation of any API method which has a FieldMask type field in the
|
219
|
+
# request should verify the included field paths, and return an
|
220
|
+
# `INVALID_ARGUMENT` error if any path is unmappable.
|
221
|
+
# @!attribute [rw] paths
|
222
|
+
# @return [::Array<::String>]
|
223
|
+
# The set of field mask paths.
|
224
|
+
class FieldMask
|
225
|
+
include ::Google::Protobuf::MessageExts
|
226
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
227
|
+
end
|
228
|
+
end
|
229
|
+
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-discovery_engine-v1beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.5.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: 2023-
|
11
|
+
date: 2023-09-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -44,6 +44,26 @@ dependencies:
|
|
44
44
|
- - "~>"
|
45
45
|
- !ruby/object:Gem::Version
|
46
46
|
version: '1.0'
|
47
|
+
- !ruby/object:Gem::Dependency
|
48
|
+
name: google-cloud-location
|
49
|
+
requirement: !ruby/object:Gem::Requirement
|
50
|
+
requirements:
|
51
|
+
- - ">="
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '0.4'
|
54
|
+
- - "<"
|
55
|
+
- !ruby/object:Gem::Version
|
56
|
+
version: 2.a
|
57
|
+
type: :runtime
|
58
|
+
prerelease: false
|
59
|
+
version_requirements: !ruby/object:Gem::Requirement
|
60
|
+
requirements:
|
61
|
+
- - ">="
|
62
|
+
- !ruby/object:Gem::Version
|
63
|
+
version: '0.4'
|
64
|
+
- - "<"
|
65
|
+
- !ruby/object:Gem::Version
|
66
|
+
version: 2.a
|
47
67
|
- !ruby/object:Gem::Dependency
|
48
68
|
name: google-style
|
49
69
|
requirement: !ruby/object:Gem::Requirement
|
@@ -178,6 +198,13 @@ files:
|
|
178
198
|
- lib/google/cloud/discovery_engine/v1beta/completion_service/rest.rb
|
179
199
|
- lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb
|
180
200
|
- lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb
|
201
|
+
- lib/google/cloud/discovery_engine/v1beta/conversational_search_service.rb
|
202
|
+
- lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb
|
203
|
+
- lib/google/cloud/discovery_engine/v1beta/conversational_search_service/credentials.rb
|
204
|
+
- lib/google/cloud/discovery_engine/v1beta/conversational_search_service/paths.rb
|
205
|
+
- lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest.rb
|
206
|
+
- lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb
|
207
|
+
- lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb
|
181
208
|
- lib/google/cloud/discovery_engine/v1beta/document_service.rb
|
182
209
|
- lib/google/cloud/discovery_engine/v1beta/document_service/client.rb
|
183
210
|
- lib/google/cloud/discovery_engine/v1beta/document_service/credentials.rb
|
@@ -224,6 +251,9 @@ files:
|
|
224
251
|
- lib/google/cloud/discoveryengine/v1beta/common_pb.rb
|
225
252
|
- lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb
|
226
253
|
- lib/google/cloud/discoveryengine/v1beta/completion_service_services_pb.rb
|
254
|
+
- lib/google/cloud/discoveryengine/v1beta/conversation_pb.rb
|
255
|
+
- lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb
|
256
|
+
- lib/google/cloud/discoveryengine/v1beta/conversational_search_service_services_pb.rb
|
227
257
|
- lib/google/cloud/discoveryengine/v1beta/document_pb.rb
|
228
258
|
- lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb
|
229
259
|
- lib/google/cloud/discoveryengine/v1beta/document_service_services_pb.rb
|
@@ -247,6 +277,8 @@ files:
|
|
247
277
|
- proto_docs/google/api/resource.rb
|
248
278
|
- proto_docs/google/cloud/discoveryengine/v1beta/common.rb
|
249
279
|
- proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb
|
280
|
+
- proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb
|
281
|
+
- proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb
|
250
282
|
- proto_docs/google/cloud/discoveryengine/v1beta/document.rb
|
251
283
|
- proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb
|
252
284
|
- proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb
|
@@ -261,6 +293,7 @@ files:
|
|
261
293
|
- proto_docs/google/protobuf/any.rb
|
262
294
|
- proto_docs/google/protobuf/duration.rb
|
263
295
|
- proto_docs/google/protobuf/empty.rb
|
296
|
+
- proto_docs/google/protobuf/field_mask.rb
|
264
297
|
- proto_docs/google/protobuf/struct.rb
|
265
298
|
- proto_docs/google/protobuf/timestamp.rb
|
266
299
|
- proto_docs/google/rpc/status.rb
|
@@ -284,7 +317,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
284
317
|
- !ruby/object:Gem::Version
|
285
318
|
version: '0'
|
286
319
|
requirements: []
|
287
|
-
rubygems_version: 3.4.
|
320
|
+
rubygems_version: 3.4.19
|
288
321
|
signing_key:
|
289
322
|
specification_version: 4
|
290
323
|
summary: Discovery Engine API.
|