google-cloud-discovery_engine-v1 0.7.0 → 0.8.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/v1/completion_service/client.rb +9 -3
- data/lib/google/cloud/discovery_engine/v1/completion_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb +9 -3
- data/lib/google/cloud/discovery_engine/v1/completion_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/control_service/client.rb +875 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/paths.rb +167 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb +814 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/rest/service_stub.rb +440 -0
- data/lib/google/cloud/discovery_engine/v1/control_service/rest.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1/control_service.rb +58 -0
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +764 -6
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/paths.rb +199 -0
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +715 -6
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/service_stub.rb +520 -0
- data/lib/google/cloud/discovery_engine/v1/data_store_service/client.rb +15 -7
- data/lib/google/cloud/discovery_engine/v1/data_store_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/data_store_service/paths.rb +45 -0
- data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/client.rb +15 -7
- data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/document_service/client.rb +23 -13
- data/lib/google/cloud/discovery_engine/v1/document_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb +23 -13
- data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/engine_service/client.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/engine_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/engine_service/rest/client.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/engine_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/client.rb +471 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/paths.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/client.rb +438 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/service_stub.rb +129 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/grounded_generation_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/client.rb +485 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/operations.rb +809 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/paths.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/rest/client.rb +452 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/rest/operations.rb +1114 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/rest/service_stub.rb +129 -0
- data/lib/google/cloud/discovery_engine/v1/project_service/rest.rb +54 -0
- data/lib/google/cloud/discovery_engine/v1/project_service.rb +57 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/client.rb +481 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/paths.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/rest/client.rb +448 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/rest/service_stub.rb +129 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/rank_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/client.rb +24 -19
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/paths.rb +66 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/rest/client.rb +24 -19
- data/lib/google/cloud/discovery_engine/v1/rest.rb +4 -0
- data/lib/google/cloud/discovery_engine/v1/schema_service/client.rb +18 -10
- data/lib/google/cloud/discovery_engine/v1/schema_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/schema_service/rest/client.rb +18 -10
- data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +15 -8
- data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +15 -8
- data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb +27 -12
- data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/client.rb +27 -12
- data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/user_event_service/client.rb +23 -6
- data/lib/google/cloud/discovery_engine/v1/user_event_service/operations.rb +13 -5
- data/lib/google/cloud/discovery_engine/v1/user_event_service/paths.rb +21 -0
- data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/client.rb +23 -6
- data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +28 -5
- data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/service_stub.rb +8 -0
- data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1.rb +4 -0
- data/lib/google/cloud/discoveryengine/v1/answer_pb.rb +69 -0
- data/lib/google/cloud/discoveryengine/v1/common_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1/control_pb.rb +55 -0
- data/lib/google/cloud/discoveryengine/v1/control_service_pb.rb +57 -0
- data/lib/google/cloud/discoveryengine/v1/control_service_services_pb.rb +69 -0
- data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +32 -1
- data/lib/google/cloud/discoveryengine/v1/conversational_search_service_services_pb.rb +25 -0
- data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1/document_processing_config_pb.rb +48 -0
- data/lib/google/cloud/discoveryengine/v1/document_service_services_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/engine_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_pb.rb +52 -0
- data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_services_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1/grounding_pb.rb +46 -0
- data/lib/google/cloud/discoveryengine/v1/project_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1/project_service_pb.rb +50 -0
- data/lib/google/cloud/discoveryengine/v1/project_service_services_pb.rb +51 -0
- data/lib/google/cloud/discoveryengine/v1/rank_service_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1/rank_service_services_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1/session_pb.rb +50 -0
- data/lib/google/cloud/discoveryengine/v1/site_search_engine_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/user_event_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/user_event_service_services_pb.rb +1 -1
- data/proto_docs/google/cloud/discoveryengine/v1/answer.rb +362 -0
- data/proto_docs/google/cloud/discoveryengine/v1/common.rb +16 -0
- data/proto_docs/google/cloud/discoveryengine/v1/control.rb +207 -0
- data/proto_docs/google/cloud/discoveryengine/v1/control_service.rb +126 -0
- data/proto_docs/google/cloud/discoveryengine/v1/conversation.rb +2 -2
- data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +485 -0
- data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +3 -0
- data/proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb +2 -2
- data/proto_docs/google/cloud/discoveryengine/v1/document_processing_config.rb +102 -0
- data/proto_docs/google/cloud/discoveryengine/v1/document_service.rb +5 -5
- data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +3 -3
- data/proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb +144 -0
- data/proto_docs/google/cloud/discoveryengine/v1/grounding.rb +79 -0
- data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +4 -4
- data/proto_docs/google/cloud/discoveryengine/v1/project.rb +106 -0
- data/proto_docs/google/cloud/discoveryengine/v1/project_service.rb +57 -0
- data/proto_docs/google/cloud/discoveryengine/v1/rank_service.rb +124 -0
- data/proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb +20 -19
- data/proto_docs/google/cloud/discoveryengine/v1/schema_service.rb +5 -5
- data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +23 -18
- data/proto_docs/google/cloud/discoveryengine/v1/session.rb +88 -0
- data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine.rb +3 -0
- data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +24 -3
- data/proto_docs/google/cloud/discoveryengine/v1/user_event_service.rb +13 -1
- metadata +56 -2
@@ -0,0 +1,448 @@
|
|
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/errors"
|
20
|
+
require "google/cloud/discoveryengine/v1/rank_service_pb"
|
21
|
+
require "google/cloud/discovery_engine/v1/rank_service/rest/service_stub"
|
22
|
+
require "google/cloud/location/rest"
|
23
|
+
|
24
|
+
module Google
|
25
|
+
module Cloud
|
26
|
+
module DiscoveryEngine
|
27
|
+
module V1
|
28
|
+
module RankService
|
29
|
+
module Rest
|
30
|
+
##
|
31
|
+
# REST client for the RankService service.
|
32
|
+
#
|
33
|
+
# Service for ranking text records.
|
34
|
+
#
|
35
|
+
class Client
|
36
|
+
# @private
|
37
|
+
API_VERSION = ""
|
38
|
+
|
39
|
+
# @private
|
40
|
+
DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
|
41
|
+
|
42
|
+
include Paths
|
43
|
+
|
44
|
+
# @private
|
45
|
+
attr_reader :rank_service_stub
|
46
|
+
|
47
|
+
##
|
48
|
+
# Configure the RankService Client class.
|
49
|
+
#
|
50
|
+
# See {::Google::Cloud::DiscoveryEngine::V1::RankService::Rest::Client::Configuration}
|
51
|
+
# for a description of the configuration fields.
|
52
|
+
#
|
53
|
+
# @example
|
54
|
+
#
|
55
|
+
# # Modify the configuration for all RankService clients
|
56
|
+
# ::Google::Cloud::DiscoveryEngine::V1::RankService::Rest::Client.configure do |config|
|
57
|
+
# config.timeout = 10.0
|
58
|
+
# end
|
59
|
+
#
|
60
|
+
# @yield [config] Configure the Client client.
|
61
|
+
# @yieldparam config [Client::Configuration]
|
62
|
+
#
|
63
|
+
# @return [Client::Configuration]
|
64
|
+
#
|
65
|
+
def self.configure
|
66
|
+
@configure ||= begin
|
67
|
+
namespace = ["Google", "Cloud", "DiscoveryEngine", "V1"]
|
68
|
+
parent_config = while namespace.any?
|
69
|
+
parent_name = namespace.join "::"
|
70
|
+
parent_const = const_get parent_name
|
71
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
72
|
+
namespace.pop
|
73
|
+
end
|
74
|
+
default_config = Client::Configuration.new parent_config
|
75
|
+
|
76
|
+
default_config.timeout = 30.0
|
77
|
+
default_config.retry_policy = {
|
78
|
+
initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
|
79
|
+
}
|
80
|
+
|
81
|
+
default_config
|
82
|
+
end
|
83
|
+
yield @configure if block_given?
|
84
|
+
@configure
|
85
|
+
end
|
86
|
+
|
87
|
+
##
|
88
|
+
# Configure the RankService Client instance.
|
89
|
+
#
|
90
|
+
# The configuration is set to the derived mode, meaning that values can be changed,
|
91
|
+
# but structural changes (adding new fields, etc.) are not allowed. Structural changes
|
92
|
+
# should be made on {Client.configure}.
|
93
|
+
#
|
94
|
+
# See {::Google::Cloud::DiscoveryEngine::V1::RankService::Rest::Client::Configuration}
|
95
|
+
# for a description of the configuration fields.
|
96
|
+
#
|
97
|
+
# @yield [config] Configure the Client client.
|
98
|
+
# @yieldparam config [Client::Configuration]
|
99
|
+
#
|
100
|
+
# @return [Client::Configuration]
|
101
|
+
#
|
102
|
+
def configure
|
103
|
+
yield @config if block_given?
|
104
|
+
@config
|
105
|
+
end
|
106
|
+
|
107
|
+
##
|
108
|
+
# The effective universe domain
|
109
|
+
#
|
110
|
+
# @return [String]
|
111
|
+
#
|
112
|
+
def universe_domain
|
113
|
+
@rank_service_stub.universe_domain
|
114
|
+
end
|
115
|
+
|
116
|
+
##
|
117
|
+
# Create a new RankService REST client object.
|
118
|
+
#
|
119
|
+
# @example
|
120
|
+
#
|
121
|
+
# # Create a client using the default configuration
|
122
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1::RankService::Rest::Client.new
|
123
|
+
#
|
124
|
+
# # Create a client using a custom configuration
|
125
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1::RankService::Rest::Client.new do |config|
|
126
|
+
# config.timeout = 10.0
|
127
|
+
# end
|
128
|
+
#
|
129
|
+
# @yield [config] Configure the RankService client.
|
130
|
+
# @yieldparam config [Client::Configuration]
|
131
|
+
#
|
132
|
+
def initialize
|
133
|
+
# Create the configuration object
|
134
|
+
@config = Configuration.new Client.configure
|
135
|
+
|
136
|
+
# Yield the configuration if needed
|
137
|
+
yield @config if block_given?
|
138
|
+
|
139
|
+
# Create credentials
|
140
|
+
credentials = @config.credentials
|
141
|
+
# Use self-signed JWT if the endpoint is unchanged from default,
|
142
|
+
# but only if the default endpoint does not have a region prefix.
|
143
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
144
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
145
|
+
!@config.endpoint.split(".").first.include?("-"))
|
146
|
+
credentials ||= Credentials.default scope: @config.scope,
|
147
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
148
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
149
|
+
credentials = Credentials.new credentials, scope: @config.scope
|
150
|
+
end
|
151
|
+
|
152
|
+
@quota_project_id = @config.quota_project
|
153
|
+
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
154
|
+
|
155
|
+
@rank_service_stub = ::Google::Cloud::DiscoveryEngine::V1::RankService::Rest::ServiceStub.new(
|
156
|
+
endpoint: @config.endpoint,
|
157
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
158
|
+
universe_domain: @config.universe_domain,
|
159
|
+
credentials: credentials
|
160
|
+
)
|
161
|
+
|
162
|
+
@location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
|
163
|
+
config.credentials = credentials
|
164
|
+
config.quota_project = @quota_project_id
|
165
|
+
config.endpoint = @rank_service_stub.endpoint
|
166
|
+
config.universe_domain = @rank_service_stub.universe_domain
|
167
|
+
end
|
168
|
+
end
|
169
|
+
|
170
|
+
##
|
171
|
+
# Get the associated client for mix-in of the Locations.
|
172
|
+
#
|
173
|
+
# @return [Google::Cloud::Location::Locations::Rest::Client]
|
174
|
+
#
|
175
|
+
attr_reader :location_client
|
176
|
+
|
177
|
+
# Service calls
|
178
|
+
|
179
|
+
##
|
180
|
+
# Ranks a list of text records based on the given input query.
|
181
|
+
#
|
182
|
+
# @overload rank(request, options = nil)
|
183
|
+
# Pass arguments to `rank` via a request object, either of type
|
184
|
+
# {::Google::Cloud::DiscoveryEngine::V1::RankRequest} or an equivalent Hash.
|
185
|
+
#
|
186
|
+
# @param request [::Google::Cloud::DiscoveryEngine::V1::RankRequest, ::Hash]
|
187
|
+
# A request object representing the call parameters. Required. To specify no
|
188
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
189
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
190
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
191
|
+
#
|
192
|
+
# @overload rank(ranking_config: nil, model: nil, top_n: nil, query: nil, records: nil, ignore_record_details_in_response: nil, user_labels: nil)
|
193
|
+
# Pass arguments to `rank` via keyword arguments. Note that at
|
194
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
195
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
196
|
+
#
|
197
|
+
# @param ranking_config [::String]
|
198
|
+
# Required. The resource name of the rank service config, such as
|
199
|
+
# `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
|
200
|
+
# @param model [::String]
|
201
|
+
# The identifier of the model to use. It is one of:
|
202
|
+
#
|
203
|
+
# * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
|
204
|
+
# token size 512.
|
205
|
+
#
|
206
|
+
# It is set to `semantic-ranker-512@latest` by default if unspecified.
|
207
|
+
# @param top_n [::Integer]
|
208
|
+
# The number of results to return. If this is unset or no bigger than zero,
|
209
|
+
# returns all results.
|
210
|
+
# @param query [::String]
|
211
|
+
# The query to use.
|
212
|
+
# @param records [::Array<::Google::Cloud::DiscoveryEngine::V1::RankingRecord, ::Hash>]
|
213
|
+
# Required. A list of records to rank. At most 200 records to rank.
|
214
|
+
# @param ignore_record_details_in_response [::Boolean]
|
215
|
+
# If true, the response will contain only record ID and score. By default, it
|
216
|
+
# is false, the response will contain record details.
|
217
|
+
# @param user_labels [::Hash{::String => ::String}]
|
218
|
+
# The user labels applied to a resource must meet the following requirements:
|
219
|
+
#
|
220
|
+
# * Each resource can have multiple labels, up to a maximum of 64.
|
221
|
+
# * Each label must be a key-value pair.
|
222
|
+
# * Keys have a minimum length of 1 character and a maximum length of 63
|
223
|
+
# characters and cannot be empty. Values can be empty and have a maximum
|
224
|
+
# length of 63 characters.
|
225
|
+
# * Keys and values can contain only lowercase letters, numeric characters,
|
226
|
+
# underscores, and dashes. All characters must use UTF-8 encoding, and
|
227
|
+
# international characters are allowed.
|
228
|
+
# * The key portion of a label must be unique. However, you can use the same
|
229
|
+
# key with multiple resources.
|
230
|
+
# * Keys must start with a lowercase letter or international character.
|
231
|
+
#
|
232
|
+
# See [Google Cloud
|
233
|
+
# Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
234
|
+
# for more details.
|
235
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
236
|
+
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::RankResponse]
|
237
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
238
|
+
#
|
239
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::RankResponse]
|
240
|
+
#
|
241
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
242
|
+
#
|
243
|
+
# @example Basic example
|
244
|
+
# require "google/cloud/discovery_engine/v1"
|
245
|
+
#
|
246
|
+
# # Create a client object. The client can be reused for multiple calls.
|
247
|
+
# client = Google::Cloud::DiscoveryEngine::V1::RankService::Rest::Client.new
|
248
|
+
#
|
249
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
250
|
+
# request = Google::Cloud::DiscoveryEngine::V1::RankRequest.new
|
251
|
+
#
|
252
|
+
# # Call the rank method.
|
253
|
+
# result = client.rank request
|
254
|
+
#
|
255
|
+
# # The returned object is of type Google::Cloud::DiscoveryEngine::V1::RankResponse.
|
256
|
+
# p result
|
257
|
+
#
|
258
|
+
def rank request, options = nil
|
259
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
260
|
+
|
261
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::RankRequest
|
262
|
+
|
263
|
+
# Converts hash and nil to an options object
|
264
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
265
|
+
|
266
|
+
# Customize the options with defaults
|
267
|
+
call_metadata = @config.rpcs.rank.metadata.to_h
|
268
|
+
|
269
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
270
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
271
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
272
|
+
gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION,
|
273
|
+
transports_version_send: [:rest]
|
274
|
+
|
275
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
276
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
277
|
+
|
278
|
+
options.apply_defaults timeout: @config.rpcs.rank.timeout,
|
279
|
+
metadata: call_metadata,
|
280
|
+
retry_policy: @config.rpcs.rank.retry_policy
|
281
|
+
|
282
|
+
options.apply_defaults timeout: @config.timeout,
|
283
|
+
metadata: @config.metadata,
|
284
|
+
retry_policy: @config.retry_policy
|
285
|
+
|
286
|
+
@rank_service_stub.rank request, options do |result, operation|
|
287
|
+
yield result, operation if block_given?
|
288
|
+
return result
|
289
|
+
end
|
290
|
+
rescue ::Gapic::Rest::Error => e
|
291
|
+
raise ::Google::Cloud::Error.from_error(e)
|
292
|
+
end
|
293
|
+
|
294
|
+
##
|
295
|
+
# Configuration class for the RankService REST API.
|
296
|
+
#
|
297
|
+
# This class represents the configuration for RankService REST,
|
298
|
+
# providing control over timeouts, retry behavior, logging, transport
|
299
|
+
# parameters, and other low-level controls. Certain parameters can also be
|
300
|
+
# applied individually to specific RPCs. See
|
301
|
+
# {::Google::Cloud::DiscoveryEngine::V1::RankService::Rest::Client::Configuration::Rpcs}
|
302
|
+
# for a list of RPCs that can be configured independently.
|
303
|
+
#
|
304
|
+
# Configuration can be applied globally to all clients, or to a single client
|
305
|
+
# on construction.
|
306
|
+
#
|
307
|
+
# @example
|
308
|
+
#
|
309
|
+
# # Modify the global config, setting the timeout for
|
310
|
+
# # rank to 20 seconds,
|
311
|
+
# # and all remaining timeouts to 10 seconds.
|
312
|
+
# ::Google::Cloud::DiscoveryEngine::V1::RankService::Rest::Client.configure do |config|
|
313
|
+
# config.timeout = 10.0
|
314
|
+
# config.rpcs.rank.timeout = 20.0
|
315
|
+
# end
|
316
|
+
#
|
317
|
+
# # Apply the above configuration only to a new client.
|
318
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1::RankService::Rest::Client.new do |config|
|
319
|
+
# config.timeout = 10.0
|
320
|
+
# config.rpcs.rank.timeout = 20.0
|
321
|
+
# end
|
322
|
+
#
|
323
|
+
# @!attribute [rw] endpoint
|
324
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
325
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
326
|
+
# @return [::String,nil]
|
327
|
+
# @!attribute [rw] credentials
|
328
|
+
# Credentials to send with calls. You may provide any of the following types:
|
329
|
+
# * (`String`) The path to a service account key file in JSON format
|
330
|
+
# * (`Hash`) A service account key as a Hash
|
331
|
+
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
332
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
333
|
+
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
334
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
335
|
+
# * (`nil`) indicating no credentials
|
336
|
+
# @return [::Object]
|
337
|
+
# @!attribute [rw] scope
|
338
|
+
# The OAuth scopes
|
339
|
+
# @return [::Array<::String>]
|
340
|
+
# @!attribute [rw] lib_name
|
341
|
+
# The library name as recorded in instrumentation and logging
|
342
|
+
# @return [::String]
|
343
|
+
# @!attribute [rw] lib_version
|
344
|
+
# The library version as recorded in instrumentation and logging
|
345
|
+
# @return [::String]
|
346
|
+
# @!attribute [rw] timeout
|
347
|
+
# The call timeout in seconds.
|
348
|
+
# @return [::Numeric]
|
349
|
+
# @!attribute [rw] metadata
|
350
|
+
# Additional headers to be sent with the call.
|
351
|
+
# @return [::Hash{::Symbol=>::String}]
|
352
|
+
# @!attribute [rw] retry_policy
|
353
|
+
# The retry policy. The value is a hash with the following keys:
|
354
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
355
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
356
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
357
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
358
|
+
# trigger a retry.
|
359
|
+
# @return [::Hash]
|
360
|
+
# @!attribute [rw] quota_project
|
361
|
+
# A separate project against which to charge quota.
|
362
|
+
# @return [::String]
|
363
|
+
# @!attribute [rw] universe_domain
|
364
|
+
# The universe domain within which to make requests. This determines the
|
365
|
+
# default endpoint URL. The default value of nil uses the environment
|
366
|
+
# universe (usually the default "googleapis.com" universe).
|
367
|
+
# @return [::String,nil]
|
368
|
+
#
|
369
|
+
class Configuration
|
370
|
+
extend ::Gapic::Config
|
371
|
+
|
372
|
+
# @private
|
373
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
374
|
+
DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"
|
375
|
+
|
376
|
+
config_attr :endpoint, nil, ::String, nil
|
377
|
+
config_attr :credentials, nil do |value|
|
378
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
379
|
+
allowed.any? { |klass| klass === value }
|
380
|
+
end
|
381
|
+
config_attr :scope, nil, ::String, ::Array, nil
|
382
|
+
config_attr :lib_name, nil, ::String, nil
|
383
|
+
config_attr :lib_version, nil, ::String, nil
|
384
|
+
config_attr :timeout, nil, ::Numeric, nil
|
385
|
+
config_attr :metadata, nil, ::Hash, nil
|
386
|
+
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
387
|
+
config_attr :quota_project, nil, ::String, nil
|
388
|
+
config_attr :universe_domain, nil, ::String, nil
|
389
|
+
|
390
|
+
# @private
|
391
|
+
def initialize parent_config = nil
|
392
|
+
@parent_config = parent_config unless parent_config.nil?
|
393
|
+
|
394
|
+
yield self if block_given?
|
395
|
+
end
|
396
|
+
|
397
|
+
##
|
398
|
+
# Configurations for individual RPCs
|
399
|
+
# @return [Rpcs]
|
400
|
+
#
|
401
|
+
def rpcs
|
402
|
+
@rpcs ||= begin
|
403
|
+
parent_rpcs = nil
|
404
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
405
|
+
Rpcs.new parent_rpcs
|
406
|
+
end
|
407
|
+
end
|
408
|
+
|
409
|
+
##
|
410
|
+
# Configuration RPC class for the RankService API.
|
411
|
+
#
|
412
|
+
# Includes fields providing the configuration for each RPC in this service.
|
413
|
+
# Each configuration object is of type `Gapic::Config::Method` and includes
|
414
|
+
# the following configuration fields:
|
415
|
+
#
|
416
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
417
|
+
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
|
418
|
+
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
419
|
+
# include the following keys:
|
420
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
421
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
422
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
423
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
424
|
+
# trigger a retry.
|
425
|
+
#
|
426
|
+
class Rpcs
|
427
|
+
##
|
428
|
+
# RPC-specific configuration for `rank`
|
429
|
+
# @return [::Gapic::Config::Method]
|
430
|
+
#
|
431
|
+
attr_reader :rank
|
432
|
+
|
433
|
+
# @private
|
434
|
+
def initialize parent_rpcs = nil
|
435
|
+
rank_config = parent_rpcs.rank if parent_rpcs.respond_to? :rank
|
436
|
+
@rank = ::Gapic::Config::Method.new rank_config
|
437
|
+
|
438
|
+
yield self if block_given?
|
439
|
+
end
|
440
|
+
end
|
441
|
+
end
|
442
|
+
end
|
443
|
+
end
|
444
|
+
end
|
445
|
+
end
|
446
|
+
end
|
447
|
+
end
|
448
|
+
end
|
@@ -0,0 +1,129 @@
|
|
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/v1/rank_service_pb"
|
20
|
+
|
21
|
+
module Google
|
22
|
+
module Cloud
|
23
|
+
module DiscoveryEngine
|
24
|
+
module V1
|
25
|
+
module RankService
|
26
|
+
module Rest
|
27
|
+
##
|
28
|
+
# REST service stub for the RankService 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 rank REST call
|
66
|
+
#
|
67
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1::RankRequest]
|
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::V1::RankResponse]
|
74
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
75
|
+
#
|
76
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::RankResponse]
|
77
|
+
# A result object deserialized from the server's reply
|
78
|
+
def rank 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_rank_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::V1::RankResponse.decode_json response.body, ignore_unknown_fields: true
|
97
|
+
|
98
|
+
yield result, operation if block_given?
|
99
|
+
result
|
100
|
+
end
|
101
|
+
|
102
|
+
##
|
103
|
+
# @private
|
104
|
+
#
|
105
|
+
# GRPC transcoding helper method for the rank REST call
|
106
|
+
#
|
107
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1::RankRequest]
|
108
|
+
# A request object representing the call parameters. Required.
|
109
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
110
|
+
# Uri, Body, Query string parameters
|
111
|
+
def self.transcode_rank_request request_pb
|
112
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
113
|
+
.with_bindings(
|
114
|
+
uri_method: :post,
|
115
|
+
uri_template: "/v1/{ranking_config}:rank",
|
116
|
+
body: "*",
|
117
|
+
matches: [
|
118
|
+
["ranking_config", %r{^projects/[^/]+/locations/[^/]+/rankingConfigs/[^/]+/?$}, false]
|
119
|
+
]
|
120
|
+
)
|
121
|
+
transcoder.transcode request_pb
|
122
|
+
end
|
123
|
+
end
|
124
|
+
end
|
125
|
+
end
|
126
|
+
end
|
127
|
+
end
|
128
|
+
end
|
129
|
+
end
|
@@ -0,0 +1,52 @@
|
|
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/v1/version"
|
24
|
+
|
25
|
+
require "google/cloud/discovery_engine/v1/rank_service/credentials"
|
26
|
+
require "google/cloud/discovery_engine/v1/rank_service/paths"
|
27
|
+
require "google/cloud/discovery_engine/v1/rank_service/rest/client"
|
28
|
+
|
29
|
+
module Google
|
30
|
+
module Cloud
|
31
|
+
module DiscoveryEngine
|
32
|
+
module V1
|
33
|
+
##
|
34
|
+
# Service for ranking text records.
|
35
|
+
#
|
36
|
+
# To load this service and instantiate a REST client:
|
37
|
+
#
|
38
|
+
# require "google/cloud/discovery_engine/v1/rank_service/rest"
|
39
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1::RankService::Rest::Client.new
|
40
|
+
#
|
41
|
+
module RankService
|
42
|
+
# Client for the REST transport
|
43
|
+
module Rest
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
helper_path = ::File.join __dir__, "rest", "helpers.rb"
|
52
|
+
require "google/cloud/discovery_engine/v1/rank_service/rest/helpers" if ::File.file? helper_path
|
@@ -0,0 +1,55 @@
|
|
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/v1/version"
|
24
|
+
|
25
|
+
require "google/cloud/discovery_engine/v1/rank_service/credentials"
|
26
|
+
require "google/cloud/discovery_engine/v1/rank_service/paths"
|
27
|
+
require "google/cloud/discovery_engine/v1/rank_service/client"
|
28
|
+
require "google/cloud/discovery_engine/v1/rank_service/rest"
|
29
|
+
|
30
|
+
module Google
|
31
|
+
module Cloud
|
32
|
+
module DiscoveryEngine
|
33
|
+
module V1
|
34
|
+
##
|
35
|
+
# Service for ranking text records.
|
36
|
+
#
|
37
|
+
# @example Load this service and instantiate a gRPC client
|
38
|
+
#
|
39
|
+
# require "google/cloud/discovery_engine/v1/rank_service"
|
40
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1::RankService::Client.new
|
41
|
+
#
|
42
|
+
# @example Load this service and instantiate a REST client
|
43
|
+
#
|
44
|
+
# require "google/cloud/discovery_engine/v1/rank_service/rest"
|
45
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1::RankService::Rest::Client.new
|
46
|
+
#
|
47
|
+
module RankService
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
helper_path = ::File.join __dir__, "rank_service", "helpers.rb"
|
55
|
+
require "google/cloud/discovery_engine/v1/rank_service/helpers" if ::File.file? helper_path
|