com.google.cloud.retail.v2.SearchResponseOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-retail-v2 Show documentation
Proto library for google-cloud-retail
The newest version!
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/retail/v2/search_service.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.retail.v2;

public interface SearchResponseOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.retail.v2.SearchResponse)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * A list of matched items. The order represents the ranking.
   * 
   *
   * repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;
   */
  java.util.List getResultsList();
  /**
   *
   *
   *    * A list of matched items. The order represents the ranking.
   * 
   *
   * repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;
   */
  com.google.cloud.retail.v2.SearchResponse.SearchResult getResults(int index);
  /**
   *
   *
   *    * A list of matched items. The order represents the ranking.
   * 
   *
   * repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;
   */
  int getResultsCount();
  /**
   *
   *
   *    * A list of matched items. The order represents the ranking.
   * 
   *
   * repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;
   */
  java.util.List
      getResultsOrBuilderList();
  /**
   *
   *
   *    * A list of matched items. The order represents the ranking.
   * 
   *
   * repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;
   */
  com.google.cloud.retail.v2.SearchResponse.SearchResultOrBuilder getResultsOrBuilder(int index);

  /**
   *
   *
   *    * Results of facets requested by user.
   * 
   *
   * repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;
   */
  java.util.List getFacetsList();
  /**
   *
   *
   *    * Results of facets requested by user.
   * 
   *
   * repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;
   */
  com.google.cloud.retail.v2.SearchResponse.Facet getFacets(int index);
  /**
   *
   *
   *    * Results of facets requested by user.
   * 
   *
   * repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;
   */
  int getFacetsCount();
  /**
   *
   *
   *    * Results of facets requested by user.
   * 
   *
   * repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;
   */
  java.util.List
      getFacetsOrBuilderList();
  /**
   *
   *
   *    * Results of facets requested by user.
   * 
   *
   * repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;
   */
  com.google.cloud.retail.v2.SearchResponse.FacetOrBuilder getFacetsOrBuilder(int index);

  /**
   *
   *
   *    * The estimated total count of matched items irrespective of pagination. The
   * count of [results][google.cloud.retail.v2.SearchResponse.results] returned
   * by pagination may be less than the
   * [total_size][google.cloud.retail.v2.SearchResponse.total_size] that
   * matches.
   * 
   *
   * int32 total_size = 3;
   *
   * @return The totalSize.
   */
  int getTotalSize();

  /**
   *
   *
   *    * Contains the spell corrected query, if found. If the spell correction type
   * is AUTOMATIC, then the search results are based on corrected_query.
   * Otherwise the original query is used for search.
   * 
   *
   * string corrected_query = 4;
   *
   * @return The correctedQuery.
   */
  java.lang.String getCorrectedQuery();
  /**
   *
   *
   *    * Contains the spell corrected query, if found. If the spell correction type
   * is AUTOMATIC, then the search results are based on corrected_query.
   * Otherwise the original query is used for search.
   * 
   *
   * string corrected_query = 4;
   *
   * @return The bytes for correctedQuery.
   */
  com.google.protobuf.ByteString getCorrectedQueryBytes();

  /**
   *
   *
   *    * A unique search token. This should be included in the
   * [UserEvent][google.cloud.retail.v2.UserEvent] logs resulting from this
   * search, which enables accurate attribution of search model performance.
   * 
   *
   * string attribution_token = 5;
   *
   * @return The attributionToken.
   */
  java.lang.String getAttributionToken();
  /**
   *
   *
   *    * A unique search token. This should be included in the
   * [UserEvent][google.cloud.retail.v2.UserEvent] logs resulting from this
   * search, which enables accurate attribution of search model performance.
   * 
   *
   * string attribution_token = 5;
   *
   * @return The bytes for attributionToken.
   */
  com.google.protobuf.ByteString getAttributionTokenBytes();

  /**
   *
   *
   *    * A token that can be sent as
   * [SearchRequest.page_token][google.cloud.retail.v2.SearchRequest.page_token]
   * to retrieve the next page. If this field is omitted, there are no
   * subsequent pages.
   * 
   *
   * string next_page_token = 6;
   *
   * @return The nextPageToken.
   */
  java.lang.String getNextPageToken();
  /**
   *
   *
   *    * A token that can be sent as
   * [SearchRequest.page_token][google.cloud.retail.v2.SearchRequest.page_token]
   * to retrieve the next page. If this field is omitted, there are no
   * subsequent pages.
   * 
   *
   * string next_page_token = 6;
   *
   * @return The bytes for nextPageToken.
   */
  com.google.protobuf.ByteString getNextPageTokenBytes();

  /**
   *
   *
   *    * Query expansion information for the returned results.
   * 
   *
   * .google.cloud.retail.v2.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
   * 
   *
   * @return Whether the queryExpansionInfo field is set.
   */
  boolean hasQueryExpansionInfo();
  /**
   *
   *
   *    * Query expansion information for the returned results.
   * 
   *
   * .google.cloud.retail.v2.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
   * 
   *
   * @return The queryExpansionInfo.
   */
  com.google.cloud.retail.v2.SearchResponse.QueryExpansionInfo getQueryExpansionInfo();
  /**
   *
   *
   *    * Query expansion information for the returned results.
   * 
   *
   * .google.cloud.retail.v2.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
   * 
   */
  com.google.cloud.retail.v2.SearchResponse.QueryExpansionInfoOrBuilder
      getQueryExpansionInfoOrBuilder();

  /**
   *
   *
   *    * The URI of a customer-defined redirect page. If redirect action is
   * triggered, no search is performed, and only
   * [redirect_uri][google.cloud.retail.v2.SearchResponse.redirect_uri] and
   * [attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token]
   * are set in the response.
   * 
   *
   * string redirect_uri = 10;
   *
   * @return The redirectUri.
   */
  java.lang.String getRedirectUri();
  /**
   *
   *
   *    * The URI of a customer-defined redirect page. If redirect action is
   * triggered, no search is performed, and only
   * [redirect_uri][google.cloud.retail.v2.SearchResponse.redirect_uri] and
   * [attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token]
   * are set in the response.
   * 
   *
   * string redirect_uri = 10;
   *
   * @return The bytes for redirectUri.
   */
  com.google.protobuf.ByteString getRedirectUriBytes();

  /**
   *
   *
   *    * The fully qualified resource name of applied
   * [controls](https://cloud.google.com/retail/docs/serving-control-rules).
   * 
   *
   * repeated string applied_controls = 12;
   *
   * @return A list containing the appliedControls.
   */
  java.util.List getAppliedControlsList();
  /**
   *
   *
   *    * The fully qualified resource name of applied
   * [controls](https://cloud.google.com/retail/docs/serving-control-rules).
   * 
   *
   * repeated string applied_controls = 12;
   *
   * @return The count of appliedControls.
   */
  int getAppliedControlsCount();
  /**
   *
   *
   *    * The fully qualified resource name of applied
   * [controls](https://cloud.google.com/retail/docs/serving-control-rules).
   * 
   *
   * repeated string applied_controls = 12;
   *
   * @param index The index of the element to return.
   * @return The appliedControls at the given index.
   */
  java.lang.String getAppliedControls(int index);
  /**
   *
   *
   *    * The fully qualified resource name of applied
   * [controls](https://cloud.google.com/retail/docs/serving-control-rules).
   * 
   *
   * repeated string applied_controls = 12;
   *
   * @param index The index of the value to return.
   * @return The bytes of the appliedControls at the given index.
   */
  com.google.protobuf.ByteString getAppliedControlsBytes(int index);

  /**
   *
   *
   *    * The invalid
   * [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
   * that are not applied during serving.
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;
   * 
   */
  java.util.List
      getInvalidConditionBoostSpecsList();
  /**
   *
   *
   *    * The invalid
   * [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
   * that are not applied during serving.
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;
   * 
   */
  com.google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec
      getInvalidConditionBoostSpecs(int index);
  /**
   *
   *
   *    * The invalid
   * [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
   * that are not applied during serving.
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;
   * 
   */
  int getInvalidConditionBoostSpecsCount();
  /**
   *
   *
   *    * The invalid
   * [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
   * that are not applied during serving.
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;
   * 
   */
  java.util.List<
          ? extends com.google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder>
      getInvalidConditionBoostSpecsOrBuilderList();
  /**
   *
   *
   *    * The invalid
   * [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
   * that are not applied during serving.
   * 
   *
   * 
   * repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;
   * 
   */
  com.google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder
      getInvalidConditionBoostSpecsOrBuilder(int index);

  /**
   *
   *
   *    * Metadata related to A/B testing [Experiment][] associated with this
   * response. Only exists when an experiment is triggered.
   * 
   *
   * repeated .google.cloud.retail.v2.ExperimentInfo experiment_info = 17;
   */
  java.util.List getExperimentInfoList();
  /**
   *
   *
   *    * Metadata related to A/B testing [Experiment][] associated with this
   * response. Only exists when an experiment is triggered.
   * 
   *
   * repeated .google.cloud.retail.v2.ExperimentInfo experiment_info = 17;
   */
  com.google.cloud.retail.v2.ExperimentInfo getExperimentInfo(int index);
  /**
   *
   *
   *    * Metadata related to A/B testing [Experiment][] associated with this
   * response. Only exists when an experiment is triggered.
   * 
   *
   * repeated .google.cloud.retail.v2.ExperimentInfo experiment_info = 17;
   */
  int getExperimentInfoCount();
  /**
   *
   *
   *    * Metadata related to A/B testing [Experiment][] associated with this
   * response. Only exists when an experiment is triggered.
   * 
   *
   * repeated .google.cloud.retail.v2.ExperimentInfo experiment_info = 17;
   */
  java.util.List
      getExperimentInfoOrBuilderList();
  /**
   *
   *
   *    * Metadata related to A/B testing [Experiment][] associated with this
   * response. Only exists when an experiment is triggered.
   * 
   *
   * repeated .google.cloud.retail.v2.ExperimentInfo experiment_info = 17;
   */
  com.google.cloud.retail.v2.ExperimentInfoOrBuilder getExperimentInfoOrBuilder(int index);

  /**
   *
   *
   *    * This field specifies all related information that is needed on client
   * side for UI rendering of conversational retail search.
   * 
   *
   * 
   * .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult conversational_search_result = 18;
   * 
   *
   * @return Whether the conversationalSearchResult field is set.
   */
  boolean hasConversationalSearchResult();
  /**
   *
   *
   *    * This field specifies all related information that is needed on client
   * side for UI rendering of conversational retail search.
   * 
   *
   * 
   * .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult conversational_search_result = 18;
   * 
   *
   * @return The conversationalSearchResult.
   */
  com.google.cloud.retail.v2.SearchResponse.ConversationalSearchResult
      getConversationalSearchResult();
  /**
   *
   *
   *    * This field specifies all related information that is needed on client
   * side for UI rendering of conversational retail search.
   * 
   *
   * 
   * .google.cloud.retail.v2.SearchResponse.ConversationalSearchResult conversational_search_result = 18;
   * 
   */
  com.google.cloud.retail.v2.SearchResponse.ConversationalSearchResultOrBuilder
      getConversationalSearchResultOrBuilder();

  /**
   *
   *
   *    * This field specifies all related information for tile navigation that will
   * be used in client side.
   * 
   *
   * .google.cloud.retail.v2.SearchResponse.TileNavigationResult tile_navigation_result = 19;
   * 
   *
   * @return Whether the tileNavigationResult field is set.
   */
  boolean hasTileNavigationResult();
  /**
   *
   *
   *    * This field specifies all related information for tile navigation that will
   * be used in client side.
   * 
   *
   * .google.cloud.retail.v2.SearchResponse.TileNavigationResult tile_navigation_result = 19;
   * 
   *
   * @return The tileNavigationResult.
   */
  com.google.cloud.retail.v2.SearchResponse.TileNavigationResult getTileNavigationResult();
  /**
   *
   *
   *    * This field specifies all related information for tile navigation that will
   * be used in client side.
   * 
   *
   * .google.cloud.retail.v2.SearchResponse.TileNavigationResult tile_navigation_result = 19;
   * 
   */
  com.google.cloud.retail.v2.SearchResponse.TileNavigationResultOrBuilder
      getTileNavigationResultOrBuilder();
}