Discovery Engine v1beta API - Class SearchRequest.Types.SessionSpec (1.0.0-beta16) 

public sealed class SearchRequest.Types.SessionSpec : IMessage<SearchRequest.Types.SessionSpec>, IEquatable<SearchRequest.Types.SessionSpec>, IDeepCloneable<SearchRequest.Types.SessionSpec>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1beta API class SearchRequest.Types.SessionSpec.

Session specification.

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.

Inheritance

object > SearchRequest.Types.SessionSpec

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

SessionSpec()

public SessionSpec()

SessionSpec(SessionSpec)

public SessionSpec(SearchRequest.Types.SessionSpec other)
Parameter
Name Description
other SearchRequestTypesSessionSpec

Properties

HasSearchResultPersistenceCount

public bool HasSearchResultPersistenceCount { get; }

Gets whether the "search_result_persistence_count" field is set

Property Value
Type Description
bool

QueryId

public string QueryId { get; set; }

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.

Property Value
Type Description
string

SearchResultPersistenceCount

public int SearchResultPersistenceCount { get; set; }

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][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count].

At most 10 results for documents mode, or 50 for chunks mode.

Property Value
Type Description
int