Struct SessionSpec 

#[non_exhaustive]
pub struct SessionSpec {
    pub query_id: String,
    pub search_result_persistence_count: Option<i32>,
    /* private fields */
}

Available on crate features assistant-service or conversational-search-service or search-service or serving-config-service only.

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

query_id: String

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.

search_result_persistence_count: Option<i32>

The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call.

This field is similar 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.

Implementations

impl SessionSpec

pub fn new() -> Self

pub fn set_query_id<T: Into<String>>(self, v: T) -> Self

Sets the value of query_id.

Example

let x = SessionSpec::new().set_query_id("example");

pub fn set_search_result_persistence_count<T>(self, v: T) -> Self

where T: Into<i32>,

Sets the value of search_result_persistence_count.

Example

let x = SessionSpec::new().set_search_result_persistence_count(42);

pub fn set_or_clear_search_result_persistence_count<T>( self, v: Option<T>, ) -> Self

where T: Into<i32>,

Sets or clears the value of search_result_persistence_count.

Example

let x = SessionSpec::new().set_or_clear_search_result_persistence_count(Some(42));
let x = SessionSpec::new().set_or_clear_search_result_persistence_count(None::<i32>);

Trait Implementations

impl Clone for SessionSpec

fn clone(&self) -> SessionSpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SessionSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SessionSpec

fn default() -> SessionSpec

Returns the “default value” for a type.

impl Message for SessionSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SessionSpec

fn eq(&self, other: &SessionSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SessionSpec