Struct StreamAssistRequest 

#[non_exhaustive]
pub struct StreamAssistRequest {
    pub name: String,
    pub query: Option<Query>,
    pub session: String,
    pub user_metadata: Option<AssistUserMetadata>,
    pub tools_spec: Option<ToolsSpec>,
    pub generation_spec: Option<GenerationSpec>,
    /* private fields */
}

Available on crate feature assistant-service only.

Request for the [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist] method.

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.

name: String

Required. The resource name of the Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

query: Option<Query>

Optional. Current user query.

Empty query is only supported if file_ids are provided. In this case, the answer will be generated based on those context files.

session: String

Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there.

If - is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

user_metadata: Option<AssistUserMetadata>

Optional. Information about the user initiating the query.

tools_spec: Option<ToolsSpec>

Optional. Specification of tools that are used to serve the request.

generation_spec: Option<GenerationSpec>

Optional. Specification of the generation configuration for the request.

Implementations

impl StreamAssistRequest

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of name.

Example

let x = StreamAssistRequest::new().set_name(format!("projects/{project_id}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}/assistants/{assistant_id}"));

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

where T: Into<Query>,

Sets the value of query.

Example

use google_cloud_discoveryengine_v1::model::Query;
let x = StreamAssistRequest::new().set_query(Query::default()/* use setters */);

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

where T: Into<Query>,

Sets or clears the value of query.

Example

use google_cloud_discoveryengine_v1::model::Query;
let x = StreamAssistRequest::new().set_or_clear_query(Some(Query::default()/* use setters */));
let x = StreamAssistRequest::new().set_or_clear_query(None::<Query>);

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

Sets the value of session.

Example

let x = StreamAssistRequest::new().set_session(format!("projects/{project_id}/locations/{location_id}/dataStores/{data_store_id}/sessions/{session_id}"));

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

where T: Into<AssistUserMetadata>,

Sets the value of user_metadata.

Example

use google_cloud_discoveryengine_v1::model::AssistUserMetadata;
let x = StreamAssistRequest::new().set_user_metadata(AssistUserMetadata::default()/* use setters */);

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

where T: Into<AssistUserMetadata>,

Sets or clears the value of user_metadata.

Example

use google_cloud_discoveryengine_v1::model::AssistUserMetadata;
let x = StreamAssistRequest::new().set_or_clear_user_metadata(Some(AssistUserMetadata::default()/* use setters */));
let x = StreamAssistRequest::new().set_or_clear_user_metadata(None::<AssistUserMetadata>);

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

where T: Into<ToolsSpec>,

Sets the value of tools_spec.

Example

use google_cloud_discoveryengine_v1::model::stream_assist_request::ToolsSpec;
let x = StreamAssistRequest::new().set_tools_spec(ToolsSpec::default()/* use setters */);

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

where T: Into<ToolsSpec>,

Sets or clears the value of tools_spec.

Example

use google_cloud_discoveryengine_v1::model::stream_assist_request::ToolsSpec;
let x = StreamAssistRequest::new().set_or_clear_tools_spec(Some(ToolsSpec::default()/* use setters */));
let x = StreamAssistRequest::new().set_or_clear_tools_spec(None::<ToolsSpec>);

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

where T: Into<GenerationSpec>,

Sets the value of generation_spec.

Example

use google_cloud_discoveryengine_v1::model::stream_assist_request::GenerationSpec;
let x = StreamAssistRequest::new().set_generation_spec(GenerationSpec::default()/* use setters */);

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

where T: Into<GenerationSpec>,

Sets or clears the value of generation_spec.

Example

use google_cloud_discoveryengine_v1::model::stream_assist_request::GenerationSpec;
let x = StreamAssistRequest::new().set_or_clear_generation_spec(Some(GenerationSpec::default()/* use setters */));
let x = StreamAssistRequest::new().set_or_clear_generation_spec(None::<GenerationSpec>);

Trait Implementations

impl Clone for StreamAssistRequest

fn clone(&self) -> StreamAssistRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamAssistRequest

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

Formats the value using the given formatter.

impl Default for StreamAssistRequest

fn default() -> StreamAssistRequest

Returns the “default value” for a type.

impl Message for StreamAssistRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for StreamAssistRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StreamAssistRequest