public static interface SearchRequest.SessionSpecOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getQueryId()
public abstract String getQueryId()
If set, the search result gets stored to the "turn" specified by this query ID.
Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } }
The user can call /search API with a request like this:
session: ".../sessions/xxx"
session_spec { query_id: ".../questions/zzz" }
Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
string query_id = 1;
Returns | |
---|---|
Type | Description |
String |
The queryId. |
getQueryIdBytes()
public abstract ByteString getQueryIdBytes()
If set, the search result gets stored to the "turn" specified by this query ID.
Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } }
The user can call /search API with a request like this:
session: ".../sessions/xxx"
session_spec { query_id: ".../questions/zzz" }
Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
string query_id = 1;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for queryId. |
getSearchResultPersistenceCount()
public abstract int getSearchResultPersistenceCount()
The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call.
This field is simliar to the summary_result_count
field in
SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count.
At most 10 results for documents mode, or 50 for chunks mode.
optional int32 search_result_persistence_count = 2;
Returns | |
---|---|
Type | Description |
int |
The searchResultPersistenceCount. |
hasSearchResultPersistenceCount()
public abstract boolean hasSearchResultPersistenceCount()
The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call.
This field is simliar to the summary_result_count
field in
SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count.
At most 10 results for documents mode, or 50 for chunks mode.
optional int32 search_result_persistence_count = 2;
Returns | |
---|---|
Type | Description |
boolean |
Whether the searchResultPersistenceCount field is set. |