com.yelp.nrtsearch.server.grpc.SearchRequestOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of clientlib Show documentation
Show all versions of clientlib Show documentation
GRPC Clientlib for nrtSearch
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: yelp/nrtsearch/search.proto
// Protobuf Java Version: 3.25.3
package com.yelp.nrtsearch.server.grpc;
public interface SearchRequestOrBuilder extends
// @@protoc_insertion_point(interface_extends:luceneserver.SearchRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*index to search against
*
*
* string indexName = 1;
* @return The indexName.
*/
java.lang.String getIndexName();
/**
*
*index to search against
*
*
* string indexName = 1;
* @return The bytes for indexName.
*/
com.google.protobuf.ByteString
getIndexNameBytes();
/**
*
* Which hit to start from (for pagination); default: 0
*
*
* int32 startHit = 2;
* @return The startHit.
*/
int getStartHit();
/**
*
* How many top hits to retrieve; default: 10. It limits the hits returned, starting from index 0. For pagination: set it to startHit + window_size.
*
*
* int32 topHits = 3;
* @return The topHits.
*/
int getTopHits();
/**
*
* Maximum number of seconds spent on each collection phase; note that for
* multi-pass searches (e.g. query-time grouping), this timeout applies to each phase.
*
*
* double timeoutSec = 4;
* @return The timeoutSec.
*/
double getTimeoutSec();
/**
*
*Which fields to highlight or retrieve.
*
*
* repeated string retrieveFields = 5;
* @return A list containing the retrieveFields.
*/
java.util.List
getRetrieveFieldsList();
/**
*
*Which fields to highlight or retrieve.
*
*
* repeated string retrieveFields = 5;
* @return The count of retrieveFields.
*/
int getRetrieveFieldsCount();
/**
*
*Which fields to highlight or retrieve.
*
*
* repeated string retrieveFields = 5;
* @param index The index of the element to return.
* @return The retrieveFields at the given index.
*/
java.lang.String getRetrieveFields(int index);
/**
*
*Which fields to highlight or retrieve.
*
*
* repeated string retrieveFields = 5;
* @param index The index of the value to return.
* @return The bytes of the retrieveFields at the given index.
*/
com.google.protobuf.ByteString
getRetrieveFieldsBytes(int index);
/**
*
*Query text to parse using the specified QueryParser.
*
*
* string queryText = 6;
* @return The queryText.
*/
java.lang.String getQueryText();
/**
*
*Query text to parse using the specified QueryParser.
*
*
* string queryText = 6;
* @return The bytes for queryText.
*/
com.google.protobuf.ByteString
getQueryTextBytes();
/**
*
*Defines virtual fields (name'd dynamic expressions) for this query.
*
*
* repeated .luceneserver.VirtualField virtualFields = 7;
*/
java.util.List
getVirtualFieldsList();
/**
*
*Defines virtual fields (name'd dynamic expressions) for this query.
*
*
* repeated .luceneserver.VirtualField virtualFields = 7;
*/
com.yelp.nrtsearch.server.grpc.VirtualField getVirtualFields(int index);
/**
*
*Defines virtual fields (name'd dynamic expressions) for this query.
*
*
* repeated .luceneserver.VirtualField virtualFields = 7;
*/
int getVirtualFieldsCount();
/**
*
*Defines virtual fields (name'd dynamic expressions) for this query.
*
*
* repeated .luceneserver.VirtualField virtualFields = 7;
*/
java.util.List
getVirtualFieldsOrBuilderList();
/**
*
*Defines virtual fields (name'd dynamic expressions) for this query.
*
*
* repeated .luceneserver.VirtualField virtualFields = 7;
*/
com.yelp.nrtsearch.server.grpc.VirtualFieldOrBuilder getVirtualFieldsOrBuilder(
int index);
/**
*
* Full query to execute using QueryNodes
*
*
* .luceneserver.Query query = 8;
* @return Whether the query field is set.
*/
boolean hasQuery();
/**
*
* Full query to execute using QueryNodes
*
*
* .luceneserver.Query query = 8;
* @return The query.
*/
com.yelp.nrtsearch.server.grpc.Query getQuery();
/**
*
* Full query to execute using QueryNodes
*
*
* .luceneserver.Query query = 8;
*/
com.yelp.nrtsearch.server.grpc.QueryOrBuilder getQueryOrBuilder();
/**
*
*Sort hits by field (default is by relevance).
*
*
* .luceneserver.QuerySortField querySort = 9;
* @return Whether the querySort field is set.
*/
boolean hasQuerySort();
/**
*
*Sort hits by field (default is by relevance).
*
*
* .luceneserver.QuerySortField querySort = 9;
* @return The querySort.
*/
com.yelp.nrtsearch.server.grpc.QuerySortField getQuerySort();
/**
*
*Sort hits by field (default is by relevance).
*
*
* .luceneserver.QuerySortField querySort = 9;
*/
com.yelp.nrtsearch.server.grpc.QuerySortFieldOrBuilder getQuerySortOrBuilder();
/**
*
*Search a generation previously returned by an indexing operation such as #addDocument. Use this to search a non-committed (near-real-time) view of the index.
*
*
* int64 indexGen = 10;
* @return Whether the indexGen field is set.
*/
boolean hasIndexGen();
/**
*
*Search a generation previously returned by an indexing operation such as #addDocument. Use this to search a non-committed (near-real-time) view of the index.
*
*
* int64 indexGen = 10;
* @return The indexGen.
*/
long getIndexGen();
/**
*
*Search a specific searcher version. This is typically used by follow-on searches (e.g., user clicks next page, drills down, or changes sort, etc.) to get the same searcher used by the original search.
*
*
* int64 version = 11;
* @return Whether the version field is set.
*/
boolean hasVersion();
/**
*
*Search a specific searcher version. This is typically used by follow-on searches (e.g., user clicks next page, drills down, or changes sort, etc.) to get the same searcher used by the original search.
*
*
* int64 version = 11;
* @return The version.
*/
long getVersion();
/**
*
*Search a snapshot previously created with #createSnapshot
*
*
* string snapshot = 12;
* @return Whether the snapshot field is set.
*/
boolean hasSnapshot();
/**
*
*Search a snapshot previously created with #createSnapshot
*
*
* string snapshot = 12;
* @return The snapshot.
*/
java.lang.String getSnapshot();
/**
*
*Search a snapshot previously created with #createSnapshot
*
*
* string snapshot = 12;
* @return The bytes for snapshot.
*/
com.google.protobuf.ByteString
getSnapshotBytes();
/**
*
*By default we count hits accurately up to 1000. This makes sure that we don't spend most time on computing hit counts
*
*
* int32 totalHitsThreshold = 13;
* @return The totalHitsThreshold.
*/
int getTotalHitsThreshold();
/**
*
* Which facets to retrieve
*
*
* repeated .luceneserver.Facet facets = 14;
*/
java.util.List
getFacetsList();
/**
*
* Which facets to retrieve
*
*
* repeated .luceneserver.Facet facets = 14;
*/
com.yelp.nrtsearch.server.grpc.Facet getFacets(int index);
/**
*
* Which facets to retrieve
*
*
* repeated .luceneserver.Facet facets = 14;
*/
int getFacetsCount();
/**
*
* Which facets to retrieve
*
*
* repeated .luceneserver.Facet facets = 14;
*/
java.util.List
getFacetsOrBuilderList();
/**
*
* Which facets to retrieve
*
*
* repeated .luceneserver.Facet facets = 14;
*/
com.yelp.nrtsearch.server.grpc.FacetOrBuilder getFacetsOrBuilder(
int index);
/**
*
*Any custom tasks that should be performed on top documents after ranking
*
*
* repeated .luceneserver.FetchTask fetchTasks = 15;
*/
java.util.List
getFetchTasksList();
/**
*
*Any custom tasks that should be performed on top documents after ranking
*
*
* repeated .luceneserver.FetchTask fetchTasks = 15;
*/
com.yelp.nrtsearch.server.grpc.FetchTask getFetchTasks(int index);
/**
*
*Any custom tasks that should be performed on top documents after ranking
*
*
* repeated .luceneserver.FetchTask fetchTasks = 15;
*/
int getFetchTasksCount();
/**
*
*Any custom tasks that should be performed on top documents after ranking
*
*
* repeated .luceneserver.FetchTask fetchTasks = 15;
*/
java.util.List
getFetchTasksOrBuilderList();
/**
*
*Any custom tasks that should be performed on top documents after ranking
*
*
* repeated .luceneserver.FetchTask fetchTasks = 15;
*/
com.yelp.nrtsearch.server.grpc.FetchTaskOrBuilder getFetchTasksOrBuilder(
int index);
/**
*
*Should partial result be a failure condition. Applies when a search request times out. If false, the top documents ranking at the point of timeout are used and the request continues. Also, hitTimeout is set to true in the response.
*
*
* bool disallowPartialResults = 16;
* @return The disallowPartialResults.
*/
boolean getDisallowPartialResults();
/**
*
*nested path we want to query by if we want to query child documents.
*
*
* string queryNestedPath = 17;
* @return The queryNestedPath.
*/
java.lang.String getQueryNestedPath();
/**
*
*nested path we want to query by if we want to query child documents.
*
*
* string queryNestedPath = 17;
* @return The bytes for queryNestedPath.
*/
com.google.protobuf.ByteString
getQueryNestedPathBytes();
/**
*
* Rescorers which are executed in-order after the first pass
*
*
* repeated .luceneserver.Rescorer rescorers = 18;
*/
java.util.List
getRescorersList();
/**
*
* Rescorers which are executed in-order after the first pass
*
*
* repeated .luceneserver.Rescorer rescorers = 18;
*/
com.yelp.nrtsearch.server.grpc.Rescorer getRescorers(int index);
/**
*
* Rescorers which are executed in-order after the first pass
*
*
* repeated .luceneserver.Rescorer rescorers = 18;
*/
int getRescorersCount();
/**
*
* Rescorers which are executed in-order after the first pass
*
*
* repeated .luceneserver.Rescorer rescorers = 18;
*/
java.util.List
getRescorersOrBuilderList();
/**
*
* Rescorers which are executed in-order after the first pass
*
*
* repeated .luceneserver.Rescorer rescorers = 18;
*/
com.yelp.nrtsearch.server.grpc.RescorerOrBuilder getRescorersOrBuilder(
int index);
/**
*
*If detailed request execution profiling should be included in the response
*
*
* bool profile = 19;
* @return The profile.
*/
boolean getProfile();
/**
*
*Check the search timeout condition after each collection of n documents in a segment. If 0, timeout is only checked on the segment boundary.
*
*
* int32 timeoutCheckEvery = 20;
* @return The timeoutCheckEvery.
*/
int getTimeoutCheckEvery();
/**
*
*Additional document collectors. Provides support for operations such as aggregation.
*
*
* map<string, .luceneserver.Collector> collectors = 21;
*/
int getCollectorsCount();
/**
*
*Additional document collectors. Provides support for operations such as aggregation.
*
*
* map<string, .luceneserver.Collector> collectors = 21;
*/
boolean containsCollectors(
java.lang.String key);
/**
* Use {@link #getCollectorsMap()} instead.
*/
@java.lang.Deprecated
java.util.Map
getCollectors();
/**
*
*Additional document collectors. Provides support for operations such as aggregation.
*
*
* map<string, .luceneserver.Collector> collectors = 21;
*/
java.util.Map
getCollectorsMap();
/**
*
*Additional document collectors. Provides support for operations such as aggregation.
*
*
* map<string, .luceneserver.Collector> collectors = 21;
*/
/* nullable */
com.yelp.nrtsearch.server.grpc.Collector getCollectorsOrDefault(
java.lang.String key,
/* nullable */
com.yelp.nrtsearch.server.grpc.Collector defaultValue);
/**
*
*Additional document collectors. Provides support for operations such as aggregation.
*
*
* map<string, .luceneserver.Collector> collectors = 21;
*/
com.yelp.nrtsearch.server.grpc.Collector getCollectorsOrThrow(
java.lang.String key);
/**
*
*Stop document collection in search phase after this many documents, 0 for unlimited.
*
*
* int32 terminateAfter = 22;
* @return The terminateAfter.
*/
int getTerminateAfter();
/**
*
*Set gRPC compression codec to use for response message. If value is unset or invalid, falls back to uncompressed. Valid codecs: identity, gzip, lz4
*
*
* string responseCompression = 23;
* @return The responseCompression.
*/
java.lang.String getResponseCompression();
/**
*
*Set gRPC compression codec to use for response message. If value is unset or invalid, falls back to uncompressed. Valid codecs: identity, gzip, lz4
*
*
* string responseCompression = 23;
* @return The bytes for responseCompression.
*/
com.google.protobuf.ByteString
getResponseCompressionBytes();
/**
*
* Specify how to highlight matched text
*
*
* .luceneserver.Highlight highlight = 24;
* @return Whether the highlight field is set.
*/
boolean hasHighlight();
/**
*
* Specify how to highlight matched text
*
*
* .luceneserver.Highlight highlight = 24;
* @return The highlight.
*/
com.yelp.nrtsearch.server.grpc.Highlight getHighlight();
/**
*
* Specify how to highlight matched text
*
*
* .luceneserver.Highlight highlight = 24;
*/
com.yelp.nrtsearch.server.grpc.HighlightOrBuilder getHighlightOrBuilder();
/**
*
* If Lucene explanation should be included in the response
*
*
* bool explain = 25;
* @return The explain.
*/
boolean getExplain();
/**
*
* Search nested object fields for each hit
*
*
* map<string, .luceneserver.InnerHit> inner_hits = 26;
*/
int getInnerHitsCount();
/**
*
* Search nested object fields for each hit
*
*
* map<string, .luceneserver.InnerHit> inner_hits = 26;
*/
boolean containsInnerHits(
java.lang.String key);
/**
* Use {@link #getInnerHitsMap()} instead.
*/
@java.lang.Deprecated
java.util.Map
getInnerHits();
/**
*
* Search nested object fields for each hit
*
*
* map<string, .luceneserver.InnerHit> inner_hits = 26;
*/
java.util.Map
getInnerHitsMap();
/**
*
* Search nested object fields for each hit
*
*
* map<string, .luceneserver.InnerHit> inner_hits = 26;
*/
/* nullable */
com.yelp.nrtsearch.server.grpc.InnerHit getInnerHitsOrDefault(
java.lang.String key,
/* nullable */
com.yelp.nrtsearch.server.grpc.InnerHit defaultValue);
/**
*
* Search nested object fields for each hit
*
*
* map<string, .luceneserver.InnerHit> inner_hits = 26;
*/
com.yelp.nrtsearch.server.grpc.InnerHit getInnerHitsOrThrow(
java.lang.String key);
/**
*
* Defines runtime fields for this query
*
*
* repeated .luceneserver.RuntimeField runtimeFields = 27;
*/
java.util.List
getRuntimeFieldsList();
/**
*
* Defines runtime fields for this query
*
*
* repeated .luceneserver.RuntimeField runtimeFields = 27;
*/
com.yelp.nrtsearch.server.grpc.RuntimeField getRuntimeFields(int index);
/**
*
* Defines runtime fields for this query
*
*
* repeated .luceneserver.RuntimeField runtimeFields = 27;
*/
int getRuntimeFieldsCount();
/**
*
* Defines runtime fields for this query
*
*
* repeated .luceneserver.RuntimeField runtimeFields = 27;
*/
java.util.List
getRuntimeFieldsOrBuilderList();
/**
*
* Defines runtime fields for this query
*
*
* repeated .luceneserver.RuntimeField runtimeFields = 27;
*/
com.yelp.nrtsearch.server.grpc.RuntimeFieldOrBuilder getRuntimeFieldsOrBuilder(
int index);
/**
*
*Stop document collection in search phase after this many recalled documents, after terminateAfter docs will be counted but not scored upto terminateAfterMaxRecallCount.
*
*
* int32 terminateAfterMaxRecallCount = 28;
* @return The terminateAfterMaxRecallCount.
*/
int getTerminateAfterMaxRecallCount();
/**
*
* Any custom logging that should log hits after ranking
*
*
* .luceneserver.LoggingHits loggingHits = 29;
* @return Whether the loggingHits field is set.
*/
boolean hasLoggingHits();
/**
*
* Any custom logging that should log hits after ranking
*
*
* .luceneserver.LoggingHits loggingHits = 29;
* @return The loggingHits.
*/
com.yelp.nrtsearch.server.grpc.LoggingHits getLoggingHits();
/**
*
* Any custom logging that should log hits after ranking
*
*
* .luceneserver.LoggingHits loggingHits = 29;
*/
com.yelp.nrtsearch.server.grpc.LoggingHitsOrBuilder getLoggingHitsOrBuilder();
/**
*
* Keeps tracks of last hit for search after
*
*
* .luceneserver.LastHitInfo searchAfter = 30;
* @return Whether the searchAfter field is set.
*/
boolean hasSearchAfter();
/**
*
* Keeps tracks of last hit for search after
*
*
* .luceneserver.LastHitInfo searchAfter = 30;
* @return The searchAfter.
*/
com.yelp.nrtsearch.server.grpc.LastHitInfo getSearchAfter();
/**
*
* Keeps tracks of last hit for search after
*
*
* .luceneserver.LastHitInfo searchAfter = 30;
*/
com.yelp.nrtsearch.server.grpc.LastHitInfoOrBuilder getSearchAfterOrBuilder();
/**
*
* Request kNN vector search queries, results will be combined with the standard query (if provided) using the boolean query SHOULD logic
*
*
* repeated .luceneserver.KnnQuery knn = 31;
*/
java.util.List
getKnnList();
/**
*
* Request kNN vector search queries, results will be combined with the standard query (if provided) using the boolean query SHOULD logic
*
*
* repeated .luceneserver.KnnQuery knn = 31;
*/
com.yelp.nrtsearch.server.grpc.KnnQuery getKnn(int index);
/**
*
* Request kNN vector search queries, results will be combined with the standard query (if provided) using the boolean query SHOULD logic
*
*
* repeated .luceneserver.KnnQuery knn = 31;
*/
int getKnnCount();
/**
*
* Request kNN vector search queries, results will be combined with the standard query (if provided) using the boolean query SHOULD logic
*
*
* repeated .luceneserver.KnnQuery knn = 31;
*/
java.util.List
getKnnOrBuilderList();
/**
*
* Request kNN vector search queries, results will be combined with the standard query (if provided) using the boolean query SHOULD logic
*
*
* repeated .luceneserver.KnnQuery knn = 31;
*/
com.yelp.nrtsearch.server.grpc.KnnQueryOrBuilder getKnnOrBuilder(
int index);
com.yelp.nrtsearch.server.grpc.SearchRequest.SearcherCase getSearcherCase();
}