google-cloud-discovery_engine-v1beta 0.12.0 → 0.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +219 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +205 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb +136 -0
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +19 -1
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +19 -1
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +10 -1
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/client.rb +10 -1
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +3 -1
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/client.rb +824 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/operations.rb +809 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/paths.rb +318 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/client.rb +770 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/operations.rb +1106 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/service_stub.rb +306 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest.rb +54 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service.rb +57 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/rest.rb +3 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/client.rb +1035 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/operations.rb +809 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/paths.rb +73 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/client.rb +967 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/operations.rb +1106 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/service_stub.rb +426 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest.rb +54 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service.rb +57 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/client.rb +911 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/paths.rb +69 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/client.rb +850 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/service_stub.rb +366 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest.rb +53 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service.rb +56 -0
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +60 -5
- data/lib/google/cloud/discovery_engine/v1beta/search_service/paths.rb +68 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +60 -5
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +139 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +132 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb +75 -0
- data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta.rb +3 -0
- data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/chunk_pb.rb +50 -0
- data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/completion_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/completion_service_services_pb.rb +8 -0
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/custom_tuning_model_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/data_store_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/data_store_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_processing_config_pb.rb +4 -1
- data/lib/google/cloud/discoveryengine/v1beta/evaluation_pb.rb +56 -0
- data/lib/google/cloud/discoveryengine/v1beta/evaluation_service_pb.rb +59 -0
- data/lib/google/cloud/discoveryengine/v1beta/evaluation_service_services_pb.rb +57 -0
- data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +12 -1
- data/lib/google/cloud/discoveryengine/v1beta/purge_config_pb.rb +7 -1
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_service_pb.rb +59 -0
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_service_services_pb.rb +63 -0
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_pb.rb +47 -0
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_service_pb.rb +57 -0
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_service_services_pb.rb +59 -0
- data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +20 -1
- data/lib/google/cloud/discoveryengine/v1beta/user_event_service_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/user_event_service_services_pb.rb +5 -0
- data/proto_docs/google/api/client.rb +14 -10
- data/proto_docs/google/api/resource.rb +7 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +14 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/chunk.rb +119 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/completion.rb +31 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +38 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb +16 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb +25 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/data_store_service.rb +10 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +1 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +43 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/evaluation.rb +223 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/evaluation_service.rb +194 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +199 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb +119 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query.rb +82 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query_service.rb +179 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query_set.rb +57 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query_set_service.rb +186 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +401 -8
- data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +11 -5
- metadata +44 -2
@@ -0,0 +1,366 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 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
|
+
require "google/cloud/discoveryengine/v1beta/sample_query_set_service_pb"
|
20
|
+
|
21
|
+
module Google
|
22
|
+
module Cloud
|
23
|
+
module DiscoveryEngine
|
24
|
+
module V1beta
|
25
|
+
module SampleQuerySetService
|
26
|
+
module Rest
|
27
|
+
##
|
28
|
+
# REST service stub for the SampleQuerySetService service.
|
29
|
+
# Service stub contains baseline method implementations
|
30
|
+
# including transcoding, making the REST call, and deserialing the response.
|
31
|
+
#
|
32
|
+
class ServiceStub
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
34
|
+
# These require statements are intentionally placed here to initialize
|
35
|
+
# the REST modules only when it's required.
|
36
|
+
require "gapic/rest"
|
37
|
+
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
39
|
+
endpoint_template: endpoint_template,
|
40
|
+
universe_domain: universe_domain,
|
41
|
+
credentials: credentials,
|
42
|
+
numeric_enums: true,
|
43
|
+
raise_faraday_errors: false
|
44
|
+
end
|
45
|
+
|
46
|
+
##
|
47
|
+
# The effective universe domain
|
48
|
+
#
|
49
|
+
# @return [String]
|
50
|
+
#
|
51
|
+
def universe_domain
|
52
|
+
@client_stub.universe_domain
|
53
|
+
end
|
54
|
+
|
55
|
+
##
|
56
|
+
# The effective endpoint
|
57
|
+
#
|
58
|
+
# @return [String]
|
59
|
+
#
|
60
|
+
def endpoint
|
61
|
+
@client_stub.endpoint
|
62
|
+
end
|
63
|
+
|
64
|
+
##
|
65
|
+
# Baseline implementation for the get_sample_query_set REST call
|
66
|
+
#
|
67
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::GetSampleQuerySetRequest]
|
68
|
+
# A request object representing the call parameters. Required.
|
69
|
+
# @param options [::Gapic::CallOptions]
|
70
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
71
|
+
#
|
72
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
73
|
+
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet]
|
74
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
75
|
+
#
|
76
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet]
|
77
|
+
# A result object deserialized from the server's reply
|
78
|
+
def get_sample_query_set request_pb, options = nil
|
79
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
80
|
+
|
81
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_get_sample_query_set_request request_pb
|
82
|
+
query_string_params = if query_string_params.any?
|
83
|
+
query_string_params.to_h { |p| p.split "=", 2 }
|
84
|
+
else
|
85
|
+
{}
|
86
|
+
end
|
87
|
+
|
88
|
+
response = @client_stub.make_http_request(
|
89
|
+
verb,
|
90
|
+
uri: uri,
|
91
|
+
body: body || "",
|
92
|
+
params: query_string_params,
|
93
|
+
options: options
|
94
|
+
)
|
95
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
96
|
+
result = ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet.decode_json response.body, ignore_unknown_fields: true
|
97
|
+
|
98
|
+
yield result, operation if block_given?
|
99
|
+
result
|
100
|
+
end
|
101
|
+
|
102
|
+
##
|
103
|
+
# Baseline implementation for the list_sample_query_sets REST call
|
104
|
+
#
|
105
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQuerySetsRequest]
|
106
|
+
# A request object representing the call parameters. Required.
|
107
|
+
# @param options [::Gapic::CallOptions]
|
108
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
109
|
+
#
|
110
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
111
|
+
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQuerySetsResponse]
|
112
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
113
|
+
#
|
114
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQuerySetsResponse]
|
115
|
+
# A result object deserialized from the server's reply
|
116
|
+
def list_sample_query_sets request_pb, options = nil
|
117
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
118
|
+
|
119
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_list_sample_query_sets_request request_pb
|
120
|
+
query_string_params = if query_string_params.any?
|
121
|
+
query_string_params.to_h { |p| p.split "=", 2 }
|
122
|
+
else
|
123
|
+
{}
|
124
|
+
end
|
125
|
+
|
126
|
+
response = @client_stub.make_http_request(
|
127
|
+
verb,
|
128
|
+
uri: uri,
|
129
|
+
body: body || "",
|
130
|
+
params: query_string_params,
|
131
|
+
options: options
|
132
|
+
)
|
133
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
134
|
+
result = ::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQuerySetsResponse.decode_json response.body, ignore_unknown_fields: true
|
135
|
+
|
136
|
+
yield result, operation if block_given?
|
137
|
+
result
|
138
|
+
end
|
139
|
+
|
140
|
+
##
|
141
|
+
# Baseline implementation for the create_sample_query_set REST call
|
142
|
+
#
|
143
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::CreateSampleQuerySetRequest]
|
144
|
+
# A request object representing the call parameters. Required.
|
145
|
+
# @param options [::Gapic::CallOptions]
|
146
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
147
|
+
#
|
148
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
149
|
+
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet]
|
150
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
151
|
+
#
|
152
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet]
|
153
|
+
# A result object deserialized from the server's reply
|
154
|
+
def create_sample_query_set request_pb, options = nil
|
155
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
156
|
+
|
157
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_create_sample_query_set_request request_pb
|
158
|
+
query_string_params = if query_string_params.any?
|
159
|
+
query_string_params.to_h { |p| p.split "=", 2 }
|
160
|
+
else
|
161
|
+
{}
|
162
|
+
end
|
163
|
+
|
164
|
+
response = @client_stub.make_http_request(
|
165
|
+
verb,
|
166
|
+
uri: uri,
|
167
|
+
body: body || "",
|
168
|
+
params: query_string_params,
|
169
|
+
options: options
|
170
|
+
)
|
171
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
172
|
+
result = ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet.decode_json response.body, ignore_unknown_fields: true
|
173
|
+
|
174
|
+
yield result, operation if block_given?
|
175
|
+
result
|
176
|
+
end
|
177
|
+
|
178
|
+
##
|
179
|
+
# Baseline implementation for the update_sample_query_set REST call
|
180
|
+
#
|
181
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::UpdateSampleQuerySetRequest]
|
182
|
+
# A request object representing the call parameters. Required.
|
183
|
+
# @param options [::Gapic::CallOptions]
|
184
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
185
|
+
#
|
186
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
187
|
+
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet]
|
188
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
189
|
+
#
|
190
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet]
|
191
|
+
# A result object deserialized from the server's reply
|
192
|
+
def update_sample_query_set request_pb, options = nil
|
193
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
194
|
+
|
195
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_update_sample_query_set_request request_pb
|
196
|
+
query_string_params = if query_string_params.any?
|
197
|
+
query_string_params.to_h { |p| p.split "=", 2 }
|
198
|
+
else
|
199
|
+
{}
|
200
|
+
end
|
201
|
+
|
202
|
+
response = @client_stub.make_http_request(
|
203
|
+
verb,
|
204
|
+
uri: uri,
|
205
|
+
body: body || "",
|
206
|
+
params: query_string_params,
|
207
|
+
options: options
|
208
|
+
)
|
209
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
210
|
+
result = ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet.decode_json response.body, ignore_unknown_fields: true
|
211
|
+
|
212
|
+
yield result, operation if block_given?
|
213
|
+
result
|
214
|
+
end
|
215
|
+
|
216
|
+
##
|
217
|
+
# Baseline implementation for the delete_sample_query_set REST call
|
218
|
+
#
|
219
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::DeleteSampleQuerySetRequest]
|
220
|
+
# A request object representing the call parameters. Required.
|
221
|
+
# @param options [::Gapic::CallOptions]
|
222
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
223
|
+
#
|
224
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
225
|
+
# @yieldparam result [::Google::Protobuf::Empty]
|
226
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
227
|
+
#
|
228
|
+
# @return [::Google::Protobuf::Empty]
|
229
|
+
# A result object deserialized from the server's reply
|
230
|
+
def delete_sample_query_set request_pb, options = nil
|
231
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
232
|
+
|
233
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_delete_sample_query_set_request request_pb
|
234
|
+
query_string_params = if query_string_params.any?
|
235
|
+
query_string_params.to_h { |p| p.split "=", 2 }
|
236
|
+
else
|
237
|
+
{}
|
238
|
+
end
|
239
|
+
|
240
|
+
response = @client_stub.make_http_request(
|
241
|
+
verb,
|
242
|
+
uri: uri,
|
243
|
+
body: body || "",
|
244
|
+
params: query_string_params,
|
245
|
+
options: options
|
246
|
+
)
|
247
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
248
|
+
result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
|
249
|
+
|
250
|
+
yield result, operation if block_given?
|
251
|
+
result
|
252
|
+
end
|
253
|
+
|
254
|
+
##
|
255
|
+
# @private
|
256
|
+
#
|
257
|
+
# GRPC transcoding helper method for the get_sample_query_set REST call
|
258
|
+
#
|
259
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::GetSampleQuerySetRequest]
|
260
|
+
# A request object representing the call parameters. Required.
|
261
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
262
|
+
# Uri, Body, Query string parameters
|
263
|
+
def self.transcode_get_sample_query_set_request request_pb
|
264
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
265
|
+
.with_bindings(
|
266
|
+
uri_method: :get,
|
267
|
+
uri_template: "/v1beta/{name}",
|
268
|
+
matches: [
|
269
|
+
["name", %r{^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/?$}, false]
|
270
|
+
]
|
271
|
+
)
|
272
|
+
transcoder.transcode request_pb
|
273
|
+
end
|
274
|
+
|
275
|
+
##
|
276
|
+
# @private
|
277
|
+
#
|
278
|
+
# GRPC transcoding helper method for the list_sample_query_sets REST call
|
279
|
+
#
|
280
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQuerySetsRequest]
|
281
|
+
# A request object representing the call parameters. Required.
|
282
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
283
|
+
# Uri, Body, Query string parameters
|
284
|
+
def self.transcode_list_sample_query_sets_request request_pb
|
285
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
286
|
+
.with_bindings(
|
287
|
+
uri_method: :get,
|
288
|
+
uri_template: "/v1beta/{parent}/sampleQuerySets",
|
289
|
+
matches: [
|
290
|
+
["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
|
291
|
+
]
|
292
|
+
)
|
293
|
+
transcoder.transcode request_pb
|
294
|
+
end
|
295
|
+
|
296
|
+
##
|
297
|
+
# @private
|
298
|
+
#
|
299
|
+
# GRPC transcoding helper method for the create_sample_query_set REST call
|
300
|
+
#
|
301
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::CreateSampleQuerySetRequest]
|
302
|
+
# A request object representing the call parameters. Required.
|
303
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
304
|
+
# Uri, Body, Query string parameters
|
305
|
+
def self.transcode_create_sample_query_set_request request_pb
|
306
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
307
|
+
.with_bindings(
|
308
|
+
uri_method: :post,
|
309
|
+
uri_template: "/v1beta/{parent}/sampleQuerySets",
|
310
|
+
body: "sample_query_set",
|
311
|
+
matches: [
|
312
|
+
["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
|
313
|
+
]
|
314
|
+
)
|
315
|
+
transcoder.transcode request_pb
|
316
|
+
end
|
317
|
+
|
318
|
+
##
|
319
|
+
# @private
|
320
|
+
#
|
321
|
+
# GRPC transcoding helper method for the update_sample_query_set REST call
|
322
|
+
#
|
323
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::UpdateSampleQuerySetRequest]
|
324
|
+
# A request object representing the call parameters. Required.
|
325
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
326
|
+
# Uri, Body, Query string parameters
|
327
|
+
def self.transcode_update_sample_query_set_request request_pb
|
328
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
329
|
+
.with_bindings(
|
330
|
+
uri_method: :patch,
|
331
|
+
uri_template: "/v1beta/{sample_query_set.name}",
|
332
|
+
body: "sample_query_set",
|
333
|
+
matches: [
|
334
|
+
["sample_query_set.name", %r{^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/?$}, false]
|
335
|
+
]
|
336
|
+
)
|
337
|
+
transcoder.transcode request_pb
|
338
|
+
end
|
339
|
+
|
340
|
+
##
|
341
|
+
# @private
|
342
|
+
#
|
343
|
+
# GRPC transcoding helper method for the delete_sample_query_set REST call
|
344
|
+
#
|
345
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::DeleteSampleQuerySetRequest]
|
346
|
+
# A request object representing the call parameters. Required.
|
347
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
348
|
+
# Uri, Body, Query string parameters
|
349
|
+
def self.transcode_delete_sample_query_set_request request_pb
|
350
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
351
|
+
.with_bindings(
|
352
|
+
uri_method: :delete,
|
353
|
+
uri_template: "/v1beta/{name}",
|
354
|
+
matches: [
|
355
|
+
["name", %r{^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/?$}, false]
|
356
|
+
]
|
357
|
+
)
|
358
|
+
transcoder.transcode request_pb
|
359
|
+
end
|
360
|
+
end
|
361
|
+
end
|
362
|
+
end
|
363
|
+
end
|
364
|
+
end
|
365
|
+
end
|
366
|
+
end
|
@@ -0,0 +1,53 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 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
|
+
require "gapic/rest"
|
20
|
+
require "gapic/config"
|
21
|
+
require "gapic/config/method"
|
22
|
+
|
23
|
+
require "google/cloud/discovery_engine/v1beta/version"
|
24
|
+
|
25
|
+
require "google/cloud/discovery_engine/v1beta/sample_query_set_service/credentials"
|
26
|
+
require "google/cloud/discovery_engine/v1beta/sample_query_set_service/paths"
|
27
|
+
require "google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/client"
|
28
|
+
|
29
|
+
module Google
|
30
|
+
module Cloud
|
31
|
+
module DiscoveryEngine
|
32
|
+
module V1beta
|
33
|
+
##
|
34
|
+
# Service for managing
|
35
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}s,
|
36
|
+
#
|
37
|
+
# To load this service and instantiate a REST client:
|
38
|
+
#
|
39
|
+
# require "google/cloud/discovery_engine/v1beta/sample_query_set_service/rest"
|
40
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client.new
|
41
|
+
#
|
42
|
+
module SampleQuerySetService
|
43
|
+
# Client for the REST transport
|
44
|
+
module Rest
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
helper_path = ::File.join __dir__, "rest", "helpers.rb"
|
53
|
+
require "google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/helpers" if ::File.file? helper_path
|
@@ -0,0 +1,56 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 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
|
+
require "gapic/common"
|
20
|
+
require "gapic/config"
|
21
|
+
require "gapic/config/method"
|
22
|
+
|
23
|
+
require "google/cloud/discovery_engine/v1beta/version"
|
24
|
+
|
25
|
+
require "google/cloud/discovery_engine/v1beta/sample_query_set_service/credentials"
|
26
|
+
require "google/cloud/discovery_engine/v1beta/sample_query_set_service/paths"
|
27
|
+
require "google/cloud/discovery_engine/v1beta/sample_query_set_service/client"
|
28
|
+
require "google/cloud/discovery_engine/v1beta/sample_query_set_service/rest"
|
29
|
+
|
30
|
+
module Google
|
31
|
+
module Cloud
|
32
|
+
module DiscoveryEngine
|
33
|
+
module V1beta
|
34
|
+
##
|
35
|
+
# Service for managing
|
36
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}s,
|
37
|
+
#
|
38
|
+
# @example Load this service and instantiate a gRPC client
|
39
|
+
#
|
40
|
+
# require "google/cloud/discovery_engine/v1beta/sample_query_set_service"
|
41
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client.new
|
42
|
+
#
|
43
|
+
# @example Load this service and instantiate a REST client
|
44
|
+
#
|
45
|
+
# require "google/cloud/discovery_engine/v1beta/sample_query_set_service/rest"
|
46
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Rest::Client.new
|
47
|
+
#
|
48
|
+
module SampleQuerySetService
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
helper_path = ::File.join __dir__, "sample_query_set_service", "helpers.rb"
|
56
|
+
require "google/cloud/discovery_engine/v1beta/sample_query_set_service/helpers" if ::File.file? helper_path
|
@@ -1016,6 +1016,13 @@ module Google
|
|
1016
1016
|
["name", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/operations/[^/]+/?$}, false]
|
1017
1017
|
]
|
1018
1018
|
)
|
1019
|
+
.with_bindings(
|
1020
|
+
uri_method: :get,
|
1021
|
+
uri_template: "/v1beta/{name}",
|
1022
|
+
matches: [
|
1023
|
+
["name", %r{^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/operations/[^/]+/?$}, false]
|
1024
|
+
]
|
1025
|
+
)
|
1019
1026
|
.with_bindings(
|
1020
1027
|
uri_method: :get,
|
1021
1028
|
uri_template: "/v1beta/{name}",
|
@@ -1023,6 +1030,13 @@ module Google
|
|
1023
1030
|
["name", %r{^projects/[^/]+/locations/[^/]+/operations/[^/]+/?$}, false]
|
1024
1031
|
]
|
1025
1032
|
)
|
1033
|
+
.with_bindings(
|
1034
|
+
uri_method: :get,
|
1035
|
+
uri_template: "/v1beta/{name}",
|
1036
|
+
matches: [
|
1037
|
+
["name", %r{^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+/?$}, false]
|
1038
|
+
]
|
1039
|
+
)
|
1026
1040
|
.with_bindings(
|
1027
1041
|
uri_method: :get,
|
1028
1042
|
uri_template: "/v1beta/{name}",
|
@@ -196,7 +196,7 @@ module Google
|
|
196
196
|
# @param options [::Gapic::CallOptions, ::Hash]
|
197
197
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
198
198
|
#
|
199
|
-
# @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, embedding_spec: nil, ranking_expression: nil, safe_search: nil, user_labels: nil)
|
199
|
+
# @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, region_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, embedding_spec: nil, ranking_expression: nil, safe_search: nil, user_labels: nil, natural_language_query_understanding_spec: nil, search_as_you_type_spec: nil, session: nil, session_spec: nil)
|
200
200
|
# Pass arguments to `search` via keyword arguments. Note that at
|
201
201
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
202
202
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -295,6 +295,17 @@ module Google
|
|
295
295
|
# Highly recommended for analytics.
|
296
296
|
# {::Google::Cloud::DiscoveryEngine::V1beta::UserInfo#user_agent UserInfo.user_agent}
|
297
297
|
# is used to deduce `device_type` for analytics.
|
298
|
+
# @param language_code [::String]
|
299
|
+
# The BCP-47 language code, such as "en-US" or "sr-Latn". For more
|
300
|
+
# information, see [Standard
|
301
|
+
# fields](https://cloud.google.com/apis/design/standard_fields). This field
|
302
|
+
# helps to better interpret the query. If a value isn't specified, the query
|
303
|
+
# language code is automatically detected, which may not be accurate.
|
304
|
+
# @param region_code [::String]
|
305
|
+
# The Unicode country/region code (CLDR) of a location, such as "US" and
|
306
|
+
# "419". For more information, see [Standard
|
307
|
+
# fields](https://cloud.google.com/apis/design/standard_fields). If set,
|
308
|
+
# then results will be boosted based on the region_code provided.
|
298
309
|
# @param facet_specs [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec, ::Hash>]
|
299
310
|
# Facet specifications for faceted search. If empty, no facets are returned.
|
300
311
|
#
|
@@ -359,20 +370,26 @@ module Google
|
|
359
370
|
# documents. This overrides
|
360
371
|
# {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#ranking_expression ServingConfig.ranking_expression}.
|
361
372
|
# The ranking expression is a single function or multiple functions that are
|
362
|
-
#
|
373
|
+
# joined by "+".
|
374
|
+
#
|
363
375
|
# * ranking_expression = function, { " + ", function };
|
376
|
+
#
|
364
377
|
# Supported functions:
|
378
|
+
#
|
365
379
|
# * double * relevance_score
|
366
380
|
# * double * dotProduct(embedding_field_path)
|
381
|
+
#
|
367
382
|
# Function variables:
|
368
|
-
#
|
383
|
+
#
|
384
|
+
# * `relevance_score`: pre-defined keywords, used for measure relevance
|
369
385
|
# between query and document.
|
370
|
-
# `embedding_field_path`: the document embedding field
|
386
|
+
# * `embedding_field_path`: the document embedding field
|
371
387
|
# used with query embedding vector.
|
372
|
-
# `dotProduct`: embedding function between embedding_field_path and query
|
388
|
+
# * `dotProduct`: embedding function between embedding_field_path and query
|
373
389
|
# embedding vector.
|
374
390
|
#
|
375
391
|
# Example ranking expression:
|
392
|
+
#
|
376
393
|
# If document has an embedding field doc_embedding, the ranking expression
|
377
394
|
# could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
378
395
|
# @param safe_search [::Boolean]
|
@@ -396,6 +413,44 @@ module Google
|
|
396
413
|
# See [Google Cloud
|
397
414
|
# Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
398
415
|
# for more details.
|
416
|
+
# @param natural_language_query_understanding_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::NaturalLanguageQueryUnderstandingSpec, ::Hash]
|
417
|
+
# If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
|
418
|
+
# natural language query understanding will be done.
|
419
|
+
# @param search_as_you_type_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SearchAsYouTypeSpec, ::Hash]
|
420
|
+
# Search as you type configuration. Only supported for the
|
421
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical::MEDIA IndustryVertical.MEDIA}
|
422
|
+
# vertical.
|
423
|
+
# @param session [::String]
|
424
|
+
# The session resource name. Optional.
|
425
|
+
#
|
426
|
+
# Session allows users to do multi-turn /search API calls or coordination
|
427
|
+
# between /search API calls and /answer API calls.
|
428
|
+
#
|
429
|
+
# Example #1 (multi-turn /search API calls):
|
430
|
+
# 1. Call /search API with the auto-session mode (see below).
|
431
|
+
# 2. Call /search API with the session ID generated in the first call.
|
432
|
+
# Here, the previous search query gets considered in query
|
433
|
+
# standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
434
|
+
# and the current query is "How about 2023?", the current query will
|
435
|
+
# be interpreted as "How did Alphabet do in 2023?".
|
436
|
+
#
|
437
|
+
# Example #2 (coordination between /search API calls and /answer API calls):
|
438
|
+
# 1. Call /search API with the auto-session mode (see below).
|
439
|
+
# 2. Call /answer API with the session ID generated in the first call.
|
440
|
+
# Here, the answer generation happens in the context of the search
|
441
|
+
# results from the first search call.
|
442
|
+
#
|
443
|
+
# Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
444
|
+
# gets automatically created. Otherwise, users can use the create-session API
|
445
|
+
# to create a session manually.
|
446
|
+
#
|
447
|
+
# Multi-turn Search feature is currently at private GA stage. Please use
|
448
|
+
# v1alpha or v1beta version instead before we launch this feature to public
|
449
|
+
# GA. Or ask for allowlisting through Google Support team.
|
450
|
+
# @param session_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SessionSpec, ::Hash]
|
451
|
+
# Session specification.
|
452
|
+
#
|
453
|
+
# Can be used only when `session` is set.
|
399
454
|
#
|
400
455
|
# @yield [response, operation] Access the result along with the RPC operation
|
401
456
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
|