Class: Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/discovery_engine/v1beta/search_service/client.rb

Overview

Client for the SearchService service.

Service for search.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#branch_path, #data_store_path, #serving_config_path, #session_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new SearchService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the SearchService client.

Yield Parameters:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/google/cloud/discovery_engine/v1beta/search_service/client.rb', line 130

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/discoveryengine/v1beta/search_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @search_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @search_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @search_service_stub.endpoint
    config.universe_domain = @search_service_stub.universe_domain
    config.logger = @search_service_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)

Get the associated client for mix-in of the Locations.

Returns:

  • (Google::Cloud::Location::Locations::Client) 


194
195
196
 
# File 'lib/google/cloud/discovery_engine/v1beta/search_service/client.rb', line 194

def location_client
  @location_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the SearchService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all SearchService clients
::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/google/cloud/discovery_engine/v1beta/search_service/client.rb', line 63

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "DiscoveryEngine", "V1beta"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 30.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the SearchService 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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



100
101
102
103
 
# File 'lib/google/cloud/discovery_engine/v1beta/search_service/client.rb', line 100

def configure
  yield @config if block_given?
  @config
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


201
202
203
 
# File 'lib/google/cloud/discovery_engine/v1beta/search_service/client.rb', line 201

def logger
  @search_service_stub.logger
end

#search(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult> #search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: 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, ranking_expression_backend: nil, safe_search: nil, user_labels: nil, natural_language_query_understanding_spec: nil, search_as_you_type_spec: nil, session: nil, session_spec: nil, relevance_threshold: nil, personalization_spec: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>

Performs a search.

Examples:

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::SearchService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DiscoveryEngine::V1beta::SearchRequest.new

# Call the search method.
result = client.search request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult.
  p item
end

Overloads:

  • #search(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>

    Pass arguments to search via a request object, either of type Google::Cloud::DiscoveryEngine::V1beta::SearchRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: 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, ranking_expression_backend: nil, safe_search: nil, user_labels: nil, natural_language_query_understanding_spec: nil, search_as_you_type_spec: nil, session: nil, session_spec: nil, relevance_threshold: nil, personalization_spec: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>

    Pass arguments to search 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).

    Parameters:

    • serving_config (::String) (defaults to: nil) —

      Required. The resource name of the Search serving config, such as projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config, or projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

    • branch (::String) (defaults to: nil) —

      The branch resource name, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0.

      Use default_branch as the branch ID or leave this field empty, to search documents under the default branch.

    • query (::String) (defaults to: nil) —

      Raw search query.

    • image_query (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ImageQuery, ::Hash) (defaults to: nil) —

      Raw image query.

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value.

      • Websites with basic indexing: Default 10, Maximum 25.
      • Websites with advanced indexing: Default 25, Maximum 50.
      • Other: Default 50, Maximum 100.

      If this field is negative, an INVALID_ARGUMENT is returned.

    • page_token (::String) (defaults to: nil) —

      A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

    • offset (::Integer) (defaults to: nil) —

      A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset.

      If this field is negative, an INVALID_ARGUMENT is returned.

    • one_box_page_size (::Integer) (defaults to: nil) —

      The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.

    • data_store_specs (::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec, ::Hash>) (defaults to: nil) —

      Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.

    • filter (::String) (defaults to: nil) —

      The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.

      If this field is unrecognizable, an INVALID_ARGUMENT is returned.

      Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")'

      For more information about filtering including syntax and filter operators, see Filter

    • canonical_filter (::String) (defaults to: nil) —

      The default filter that is applied when a user performs a search without checking any filters on the search page.

      The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality.

      For more information about filter syntax, see SearchRequest.filter.

    • order_by (::String) (defaults to: nil) —

      The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. order_by expression is case-sensitive.

      For more information on ordering the website search results, see Order web search results. For more information on ordering the healthcare search results, see Order healthcare search results. If this field is unrecognizable, an INVALID_ARGUMENT is returned.

    • user_info (::Google::Cloud::DiscoveryEngine::V1beta::UserInfo, ::Hash) (defaults to: nil) —

      Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce device_type for analytics.

    • language_code (::String) (defaults to: nil) —

      The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Standard fields. This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.

    • region_code (::String) (defaults to: nil) —

      The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see Standard fields. If set, then results will be boosted based on the region_code provided.

    • facet_specs (::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec, ::Hash>) (defaults to: nil) —

      Facet specifications for faceted search. If empty, no facets are returned.

      A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

    • boost_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec, ::Hash) (defaults to: nil) —

      Boost specification to boost certain documents. For more information on boosting, see Boosting

    • params (::Hash{::String => ::Google::Protobuf::Value, ::Hash}) (defaults to: nil) —

      Additional search parameters.

      For public website search only, supported values are:

      • user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, user_country_code: "au"

      For available codes see Country Codes

      • search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, search_type: 1
    • query_expansion_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec, ::Hash) (defaults to: nil) —

      The query expansion specification that specifies the conditions under which query expansion occurs.

    • spell_correction_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec, ::Hash) (defaults to: nil) —

      The spell correction specification that specifies the mode under which spell correction takes effect.

    • user_pseudo_id (::String) (defaults to: nil) —

      A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.

      This field should NOT have a fixed value such as unknown_visitor.

      This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id

      The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    • content_search_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec, ::Hash) (defaults to: nil) —

      A specification for configuring the behavior of content search.

    • embedding_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec, ::Hash) (defaults to: nil) —

      Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.

      If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.

    • ranking_expression (::String) (defaults to: nil) —

      The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to RANK_BY_EMBEDDING.

      If ranking_expression_backend is not provided or set to RANK_BY_EMBEDDING, it should be a single function or multiple functions that are joined by "+".

      • ranking_expression = function, { " + ", function };

      Supported functions:

      • double * relevance_score
      • double * dotProduct(embedding_field_path)

      Function variables:

      • relevance_score: pre-defined keywords, used for measure relevance between query and document.
      • embedding_field_path: the document embedding field used with query embedding vector.
      • dotProduct: embedding function between embedding_field_path and query embedding vector.

      Example ranking expression:

      If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).

      If ranking_expression_backend is set to RANK_BY_FORMULA, the following expression types (and combinations of those chained using + or

      • operators) are supported:

        • double
        • signal
        • log(signal)
        • exp(signal)
        • rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant.
        • is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise.
        • fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1.

      Here are a few examples of ranking formulas that use the supported ranking expression types:

      • 0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score) -- mostly rank by the logarithm of keyword_similarity_score with slight semantic_smilarity_score adjustment.
      • 0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score) -- rank by the exponent of semantic_similarity_score filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if semantic_similarity_score is NaN.
      • 0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16) -- mostly rank by the reciprocal rank of keyword_similarity_score with slight adjustment of reciprocal rank of semantic_smilarity_score.

      The following signals are supported:

      • semantic_similarity_score: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document.
      • keyword_similarity_score: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query.
      • relevance_score: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents.
      • pctr_rank: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking.
      • freshness_rank: freshness adjustment as a rank
      • document_age: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes).
      • topicality_rank: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document.
      • base_rank: the default rank of the result
    • ranking_expression_backend (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::RankingExpressionBackend) (defaults to: nil) —

      The backend to use for the ranking expression evaluation.

    • safe_search (::Boolean) (defaults to: nil) —

      Whether to turn on safe search. This is only supported for website search.

    • user_labels (::Hash{::String => ::String}) (defaults to: nil) —

      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.

    • natural_language_query_understanding_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::NaturalLanguageQueryUnderstandingSpec, ::Hash) (defaults to: nil) —

      If naturalLanguageQueryUnderstandingSpec is not specified, no additional natural language query understanding will be done.

    • search_as_you_type_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SearchAsYouTypeSpec, ::Hash) (defaults to: nil) —

      Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.

    • session (::String) (defaults to: nil) —

      The session resource name. Optional.

      Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls.

      Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?".

      Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.

      Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.

    • session_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SessionSpec, ::Hash) (defaults to: nil) —

      Session specification.

      Can be used only when session is set.

    • relevance_threshold (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::RelevanceThreshold) (defaults to: nil) —

      The relevance threshold of the search results.

      Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.

    • personalization_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::PersonalizationSpec, ::Hash) (defaults to: nil) —

      The specification for personalization.

      Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
 
# File 'lib/google/cloud/discovery_engine/v1beta/search_service/client.rb', line 587

def search request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.search.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.serving_config
    header_params["serving_config"] = request.serving_config
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.search.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @search_service_stub.call_rpc :search, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @search_service_stub, :search, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_lite(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult> #search_lite(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: 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, ranking_expression_backend: nil, safe_search: nil, user_labels: nil, natural_language_query_understanding_spec: nil, search_as_you_type_spec: nil, session: nil, session_spec: nil, relevance_threshold: nil, personalization_spec: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>

Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required.

Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a FAILED_PRECONDITION error is returned.

This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security.

Examples:

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::SearchService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DiscoveryEngine::V1beta::SearchRequest.new

# Call the search_lite method.
result = client.search_lite request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult.
  p item
end

Overloads:

  • #search_lite(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>

    Pass arguments to search_lite via a request object, either of type Google::Cloud::DiscoveryEngine::V1beta::SearchRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #search_lite(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: 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, ranking_expression_backend: nil, safe_search: nil, user_labels: nil, natural_language_query_understanding_spec: nil, search_as_you_type_spec: nil, session: nil, session_spec: nil, relevance_threshold: nil, personalization_spec: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>

    Pass arguments to search_lite 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).

    Parameters:

    • serving_config (::String) (defaults to: nil) —

      Required. The resource name of the Search serving config, such as projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config, or projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

    • branch (::String) (defaults to: nil) —

      The branch resource name, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0.

      Use default_branch as the branch ID or leave this field empty, to search documents under the default branch.

    • query (::String) (defaults to: nil) —

      Raw search query.

    • image_query (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ImageQuery, ::Hash) (defaults to: nil) —

      Raw image query.

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value.

      • Websites with basic indexing: Default 10, Maximum 25.
      • Websites with advanced indexing: Default 25, Maximum 50.
      • Other: Default 50, Maximum 100.

      If this field is negative, an INVALID_ARGUMENT is returned.

    • page_token (::String) (defaults to: nil) —

      A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

    • offset (::Integer) (defaults to: nil) —

      A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset.

      If this field is negative, an INVALID_ARGUMENT is returned.

    • one_box_page_size (::Integer) (defaults to: nil) —

      The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.

    • data_store_specs (::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec, ::Hash>) (defaults to: nil) —

      Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.

    • filter (::String) (defaults to: nil) —

      The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.

      If this field is unrecognizable, an INVALID_ARGUMENT is returned.

      Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")'

      For more information about filtering including syntax and filter operators, see Filter

    • canonical_filter (::String) (defaults to: nil) —

      The default filter that is applied when a user performs a search without checking any filters on the search page.

      The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality.

      For more information about filter syntax, see SearchRequest.filter.

    • order_by (::String) (defaults to: nil) —

      The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. order_by expression is case-sensitive.

      For more information on ordering the website search results, see Order web search results. For more information on ordering the healthcare search results, see Order healthcare search results. If this field is unrecognizable, an INVALID_ARGUMENT is returned.

    • user_info (::Google::Cloud::DiscoveryEngine::V1beta::UserInfo, ::Hash) (defaults to: nil) —

      Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce device_type for analytics.

    • language_code (::String) (defaults to: nil) —

      The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Standard fields. This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.

    • region_code (::String) (defaults to: nil) —

      The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see Standard fields. If set, then results will be boosted based on the region_code provided.

    • facet_specs (::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec, ::Hash>) (defaults to: nil) —

      Facet specifications for faceted search. If empty, no facets are returned.

      A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

    • boost_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec, ::Hash) (defaults to: nil) —

      Boost specification to boost certain documents. For more information on boosting, see Boosting

    • params (::Hash{::String => ::Google::Protobuf::Value, ::Hash}) (defaults to: nil) —

      Additional search parameters.

      For public website search only, supported values are:

      • user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, user_country_code: "au"

      For available codes see Country Codes

      • search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, search_type: 1
    • query_expansion_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec, ::Hash) (defaults to: nil) —

      The query expansion specification that specifies the conditions under which query expansion occurs.

    • spell_correction_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec, ::Hash) (defaults to: nil) —

      The spell correction specification that specifies the mode under which spell correction takes effect.

    • user_pseudo_id (::String) (defaults to: nil) —

      A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.

      This field should NOT have a fixed value such as unknown_visitor.

      This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id

      The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    • content_search_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec, ::Hash) (defaults to: nil) —

      A specification for configuring the behavior of content search.

    • embedding_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec, ::Hash) (defaults to: nil) —

      Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.

      If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.

    • ranking_expression (::String) (defaults to: nil) —

      The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to RANK_BY_EMBEDDING.

      If ranking_expression_backend is not provided or set to RANK_BY_EMBEDDING, it should be a single function or multiple functions that are joined by "+".

      • ranking_expression = function, { " + ", function };

      Supported functions:

      • double * relevance_score
      • double * dotProduct(embedding_field_path)

      Function variables:

      • relevance_score: pre-defined keywords, used for measure relevance between query and document.
      • embedding_field_path: the document embedding field used with query embedding vector.
      • dotProduct: embedding function between embedding_field_path and query embedding vector.

      Example ranking expression:

      If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).

      If ranking_expression_backend is set to RANK_BY_FORMULA, the following expression types (and combinations of those chained using + or

      • operators) are supported:

        • double
        • signal
        • log(signal)
        • exp(signal)
        • rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant.
        • is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise.
        • fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1.

      Here are a few examples of ranking formulas that use the supported ranking expression types:

      • 0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score) -- mostly rank by the logarithm of keyword_similarity_score with slight semantic_smilarity_score adjustment.
      • 0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score) -- rank by the exponent of semantic_similarity_score filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if semantic_similarity_score is NaN.
      • 0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16) -- mostly rank by the reciprocal rank of keyword_similarity_score with slight adjustment of reciprocal rank of semantic_smilarity_score.

      The following signals are supported:

      • semantic_similarity_score: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document.
      • keyword_similarity_score: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query.
      • relevance_score: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents.
      • pctr_rank: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking.
      • freshness_rank: freshness adjustment as a rank
      • document_age: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes).
      • topicality_rank: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document.
      • base_rank: the default rank of the result
    • ranking_expression_backend (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::RankingExpressionBackend) (defaults to: nil) —

      The backend to use for the ranking expression evaluation.

    • safe_search (::Boolean) (defaults to: nil) —

      Whether to turn on safe search. This is only supported for website search.

    • user_labels (::Hash{::String => ::String}) (defaults to: nil) —

      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.

    • natural_language_query_understanding_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::NaturalLanguageQueryUnderstandingSpec, ::Hash) (defaults to: nil) —

      If naturalLanguageQueryUnderstandingSpec is not specified, no additional natural language query understanding will be done.

    • search_as_you_type_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SearchAsYouTypeSpec, ::Hash) (defaults to: nil) —

      Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.

    • session (::String) (defaults to: nil) —

      The session resource name. Optional.

      Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls.

      Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?".

      Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.

      Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.

    • session_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SessionSpec, ::Hash) (defaults to: nil) —

      Session specification.

      Can be used only when session is set.

    • relevance_threshold (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::RelevanceThreshold) (defaults to: nil) —

      The relevance threshold of the search results.

      Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.

    • personalization_spec (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::PersonalizationSpec, ::Hash) (defaults to: nil) —

      The specification for personalization.

      Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
 
# File 'lib/google/cloud/discovery_engine/v1beta/search_service/client.rb', line 1022

def search_lite request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.search_lite.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.serving_config
    header_params["serving_config"] = request.serving_config
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.search_lite.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_lite.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @search_service_stub.call_rpc :search_lite, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @search_service_stub, :search_lite, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


110
111
112
 
# File 'lib/google/cloud/discovery_engine/v1beta/search_service/client.rb', line 110

def universe_domain
  @search_service_stub.universe_domain
end