Struct google_api_proto::google::cloud::discoveryengine::v1beta::search_request::SessionSpec

pub struct SessionSpec {
    pub query_id: String,
    pub search_result_persistence_count: Option<i32>,
}

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

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 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.

Implementations

impl SessionSpec

pub fn search_result_persistence_count(&self) -> i32

Returns the value of search_result_persistence_count, or the default value if search_result_persistence_count is unset.

Trait Implementations

impl Clone for SessionSpec

fn clone(&self) -> SessionSpec

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for SessionSpec

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for SessionSpec

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SessionSpec