Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::RankService::Rest::Client.
REST client for the RankService service.
Service for ranking text records.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the RankService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all RankService clients ::Google::Cloud::DiscoveryEngine::V1beta::RankService::Rest::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the RankService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#initialize
def initialize() { |config| ... } -> Client
Create a new RankService REST client object.
- (config) — Configure the RankService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::DiscoveryEngine::V1beta::RankService::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::DiscoveryEngine::V1beta::RankService::Rest::Client.new do |config| config.timeout = 10.0 end
#location_client
def location_client() -> Google::Cloud::Location::Locations::Rest::Client
Get the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Rest::Client)
#rank
def rank(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::RankResponse
def rank(ranking_config: nil, model: nil, top_n: nil, query: nil, records: nil, ignore_record_details_in_response: nil, user_labels: nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::RankResponse
Ranks a list of text records based on the given input query.
def rank(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::RankResponse
rank
via a request object, either of type
Google::Cloud::DiscoveryEngine::V1beta::RankRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1beta::RankRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def rank(ranking_config: nil, model: nil, top_n: nil, query: nil, records: nil, ignore_record_details_in_response: nil, user_labels: nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::RankResponse
rank
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
ranking_config (::String) — Required. The resource name of the rank service config, such as
projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config
. -
model (::String) — The identifier of the model to use. It is one of:
semantic-ranker-512@latest
: Semantic ranking model with maxiumn input token size 512.
It is set to
semantic-ranker-512@latest
by default if unspecified. - top_n (::Integer) — The number of results to return. If this is unset or no bigger than zero, returns all results.
- query (::String) — The query to use.
- records (::Array<::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord, ::Hash>) — Required. A list of records to rank. At most 200 records to rank.
- ignore_record_details_in_response (::Boolean) — If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.
-
user_labels (::Hash{::String => ::String}) — The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
- Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DiscoveryEngine::V1beta::RankResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/discovery_engine/v1beta" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1beta::RankService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1beta::RankRequest.new # Call the rank method. result = client.rank request # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::RankResponse. p result
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)