/*
* Copyright 2020 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/discoveryengine/v1beta/search_service.proto
package com.google.cloud.discoveryengine.v1beta;
public interface SearchRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.discoveryengine.v1beta.SearchRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. The resource name of the Search serving config, such as
* `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.
*
*
*
* string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
*
*
* @return The servingConfig.
*/
java.lang.String getServingConfig();
/**
*
*
*
* Required. The resource name of the Search serving config, such as
* `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.
*
*
*
* string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for servingConfig.
*/
com.google.protobuf.ByteString getServingConfigBytes();
/**
*
*
*
* 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.
*
*
* string branch = 2 [(.google.api.resource_reference) = { ... }
*
* @return The branch.
*/
java.lang.String getBranch();
/**
*
*
*
* 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.
*
*
* string branch = 2 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for branch.
*/
com.google.protobuf.ByteString getBranchBytes();
/**
*
*
*
* Raw search query.
*
*
* string query = 3;
*
* @return The query.
*/
java.lang.String getQuery();
/**
*
*
*
* Raw search query.
*
*
* string query = 3;
*
* @return The bytes for query.
*/
com.google.protobuf.ByteString getQueryBytes();
/**
*
*
*
* Maximum number of [Document][google.cloud.discoveryengine.v1beta.Document]s
* to return. If unspecified, defaults to a reasonable value. The maximum
* allowed value is 100. Values above 100 will be coerced to 100.
* If this field is negative, an `INVALID_ARGUMENT` is returned.
*
*
* int32 page_size = 4;
*
* @return The pageSize.
*/
int getPageSize();
/**
*
*
*
* A page token received from a previous
* [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
* call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
* must match the call that provided the page token. Otherwise, an
* `INVALID_ARGUMENT` error is returned.
*
*
* string page_token = 5;
*
* @return The pageToken.
*/
java.lang.String getPageToken();
/**
*
*
*
* A page token received from a previous
* [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
* call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
* must match the call that provided the page token. Otherwise, an
* `INVALID_ARGUMENT` error is returned.
*
*
* string page_token = 5;
*
* @return The bytes for pageToken.
*/
com.google.protobuf.ByteString getPageTokenBytes();
/**
*
*
*
* A 0-indexed integer that specifies the current offset (that is, starting
* result location, amongst the
* [Document][google.cloud.discoveryengine.v1beta.Document]s deemed by the API
* as relevant) in search results. This field is only considered if
* [page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token]
* is unset.
* If this field is negative, an `INVALID_ARGUMENT` is returned.
*
*
* int32 offset = 6;
*
* @return The offset.
*/
int getOffset();
/**
*
*
*
* 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.
*
*
* string filter = 7;
*
* @return The filter.
*/
java.lang.String getFilter();
/**
*
*
*
* 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.
*
*
* string filter = 7;
*
* @return The bytes for filter.
*/
com.google.protobuf.ByteString getFilterBytes();
/**
*
*
*
* The order in which documents are returned. Document can be ordered by
* a field in an [Document][google.cloud.discoveryengine.v1beta.Document]
* object. Leave it unset if ordered by relevance. OrderBy expression is
* case-sensitive.
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
*
*
* string order_by = 8;
*
* @return The orderBy.
*/
java.lang.String getOrderBy();
/**
*
*
*
* The order in which documents are returned. Document can be ordered by
* a field in an [Document][google.cloud.discoveryengine.v1beta.Document]
* object. Leave it unset if ordered by relevance. OrderBy expression is
* case-sensitive.
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
*
*
* string order_by = 8;
*
* @return The bytes for orderBy.
*/
com.google.protobuf.ByteString getOrderByBytes();
/**
*
*
*
* 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.
*
*
* repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;
*
*/
java.util.List
getFacetSpecsList();
/**
*
*
*
* 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.
*
*
* repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;
*
*/
com.google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec getFacetSpecs(int index);
/**
*
*
*
* 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.
*
*
* repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;
*
*/
int getFacetSpecsCount();
/**
*
*
*
* 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.
*
*
* repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;
*
*/
java.util.List
getFacetSpecsOrBuilderList();
/**
*
*
*
* 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.
*
*
* repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;
*
*/
com.google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpecOrBuilder getFacetSpecsOrBuilder(
int index);
/**
*
*
*
* Boost specification to boost certain documents.
*
*
* .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;
*
* @return Whether the boostSpec field is set.
*/
boolean hasBoostSpec();
/**
*
*
*
* Boost specification to boost certain documents.
*
*
* .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;
*
* @return The boostSpec.
*/
com.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec getBoostSpec();
/**
*
*
*
* Boost specification to boost certain documents.
*
*
* .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;
*/
com.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder();
/**
*
*
*
* Additional search parameters.
* For
* [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH]
* vertical, supported values are:
* * `user_country_code`: string. Default empty. If set to non-empty, results
* are restricted or boosted based on the location provided.
* * `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.
* This field is ignored for other verticals.
*
*
* map<string, .google.protobuf.Value> params = 11;
*/
int getParamsCount();
/**
*
*
*
* Additional search parameters.
* For
* [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH]
* vertical, supported values are:
* * `user_country_code`: string. Default empty. If set to non-empty, results
* are restricted or boosted based on the location provided.
* * `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.
* This field is ignored for other verticals.
*
*
* map<string, .google.protobuf.Value> params = 11;
*/
boolean containsParams(java.lang.String key);
/** Use {@link #getParamsMap()} instead. */
@java.lang.Deprecated
java.util.Map getParams();
/**
*
*
*
* Additional search parameters.
* For
* [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH]
* vertical, supported values are:
* * `user_country_code`: string. Default empty. If set to non-empty, results
* are restricted or boosted based on the location provided.
* * `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.
* This field is ignored for other verticals.
*
*
* map<string, .google.protobuf.Value> params = 11;
*/
java.util.Map getParamsMap();
/**
*
*
*
* Additional search parameters.
* For
* [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH]
* vertical, supported values are:
* * `user_country_code`: string. Default empty. If set to non-empty, results
* are restricted or boosted based on the location provided.
* * `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.
* This field is ignored for other verticals.
*
*
* map<string, .google.protobuf.Value> params = 11;
*/
/* nullable */
com.google.protobuf.Value getParamsOrDefault(
java.lang.String key,
/* nullable */
com.google.protobuf.Value defaultValue);
/**
*
*
*
* Additional search parameters.
* For
* [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH]
* vertical, supported values are:
* * `user_country_code`: string. Default empty. If set to non-empty, results
* are restricted or boosted based on the location provided.
* * `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.
* This field is ignored for other verticals.
*
*
* map<string, .google.protobuf.Value> params = 11;
*/
com.google.protobuf.Value getParamsOrThrow(java.lang.String key);
/**
*
*
*
* The query expansion specification that specifies the conditions under which
* query expansion will occur.
*
*
*
* .google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
*
*
* @return Whether the queryExpansionSpec field is set.
*/
boolean hasQueryExpansionSpec();
/**
*
*
*
* The query expansion specification that specifies the conditions under which
* query expansion will occur.
*
*
*
* .google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
*
*
* @return The queryExpansionSpec.
*/
com.google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec getQueryExpansionSpec();
/**
*
*
*
* The query expansion specification that specifies the conditions under which
* query expansion will occur.
*
*
*
* .google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
*
*/
com.google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpecOrBuilder
getQueryExpansionSpecOrBuilder();
/**
*
*
*
* The spell correction specification that specifies the mode under
* which spell correction will take effect.
*
*
*
* .google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
*
*
* @return Whether the spellCorrectionSpec field is set.
*/
boolean hasSpellCorrectionSpec();
/**
*
*
*
* The spell correction specification that specifies the mode under
* which spell correction will take effect.
*
*
*
* .google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
*
*
* @return The spellCorrectionSpec.
*/
com.google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec
getSpellCorrectionSpec();
/**
*
*
*
* The spell correction specification that specifies the mode under
* which spell correction will take effect.
*
*
*
* .google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
*
*/
com.google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpecOrBuilder
getSpellCorrectionSpecOrBuilder();
/**
*
*
*
* 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][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
* and
* [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.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.
*
*
* string user_pseudo_id = 15;
*
* @return The userPseudoId.
*/
java.lang.String getUserPseudoId();
/**
*
*
*
* 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][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
* and
* [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.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.
*
*
* string user_pseudo_id = 15;
*
* @return The bytes for userPseudoId.
*/
com.google.protobuf.ByteString getUserPseudoIdBytes();
/**
*
*
*
* The content search spec that configs the desired behavior of content
* search.
*
*
*
* .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;
*
*
* @return Whether the contentSearchSpec field is set.
*/
boolean hasContentSearchSpec();
/**
*
*
*
* The content search spec that configs the desired behavior of content
* search.
*
*
*
* .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;
*
*
* @return The contentSearchSpec.
*/
com.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec getContentSearchSpec();
/**
*
*
*
* The content search spec that configs the desired behavior of content
* search.
*
*
*
* .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;
*
*/
com.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpecOrBuilder
getContentSearchSpecOrBuilder();
}