Struct EventMetadata 

#[non_exhaustive]
pub struct EventMetadata {
    pub grounding_metadata: Option<GroundingMetadata>,
    pub partial: bool,
    pub turn_complete: bool,
    pub interrupted: bool,
    pub long_running_tool_ids: Vec<String>,
    pub branch: String,
    pub custom_metadata: Option<Struct>,
    pub input_transcription: Option<Transcription>,
    pub output_transcription: Option<Transcription>,
    /* private fields */
}

Available on crate feature session-service only.

Metadata relating to a LLM response event.

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.

grounding_metadata: Option<GroundingMetadata>

Optional. Metadata returned to client when grounding is enabled.

partial: bool

Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text.

turn_complete: bool

Optional. Indicates whether the response from the model is complete. Only used for streaming mode.

interrupted: bool

Optional. Flag indicating that LLM was interrupted when generating the content. Usually it’s due to user interruption during a bidi streaming.

long_running_tool_ids: Vec<String>

Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event.

branch: String

Optional. The branch of the event. The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3. Branch is used when multiple child agents shouldn’t see their siblings’ conversation history.

custom_metadata: Option<Struct>

The custom metadata of the LlmResponse.

input_transcription: Option<Transcription>

Optional. Audio transcription of user input.

output_transcription: Option<Transcription>

Optional. Audio transcription of model output.

Implementations

impl EventMetadata

pub fn new() -> Self

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

where T: Into<GroundingMetadata>,

Sets the value of grounding_metadata.

Example

use google_cloud_aiplatform_v1::model::GroundingMetadata;
let x = EventMetadata::new().set_grounding_metadata(GroundingMetadata::default()/* use setters */);

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

where T: Into<GroundingMetadata>,

Sets or clears the value of grounding_metadata.

Example

use google_cloud_aiplatform_v1::model::GroundingMetadata;
let x = EventMetadata::new().set_or_clear_grounding_metadata(Some(GroundingMetadata::default()/* use setters */));
let x = EventMetadata::new().set_or_clear_grounding_metadata(None::<GroundingMetadata>);

pub fn set_partial<T: Into<bool>>(self, v: T) -> Self

Sets the value of partial.

Example

let x = EventMetadata::new().set_partial(true);

pub fn set_turn_complete<T: Into<bool>>(self, v: T) -> Self

Sets the value of turn_complete.

Example

let x = EventMetadata::new().set_turn_complete(true);

pub fn set_interrupted<T: Into<bool>>(self, v: T) -> Self

Sets the value of interrupted.

Example

let x = EventMetadata::new().set_interrupted(true);

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

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of long_running_tool_ids.

Example

let x = EventMetadata::new().set_long_running_tool_ids(["a", "b", "c"]);

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

Sets the value of branch.

Example

let x = EventMetadata::new().set_branch("example");

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

where T: Into<Struct>,

Sets the value of custom_metadata.

Example

use wkt::Struct;
let x = EventMetadata::new().set_custom_metadata(Struct::default()/* use setters */);

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

where T: Into<Struct>,

Sets or clears the value of custom_metadata.

Example

use wkt::Struct;
let x = EventMetadata::new().set_or_clear_custom_metadata(Some(Struct::default()/* use setters */));
let x = EventMetadata::new().set_or_clear_custom_metadata(None::<Struct>);

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

where T: Into<Transcription>,

Sets the value of input_transcription.

Example

use google_cloud_aiplatform_v1::model::Transcription;
let x = EventMetadata::new().set_input_transcription(Transcription::default()/* use setters */);

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

where T: Into<Transcription>,

Sets or clears the value of input_transcription.

Example

use google_cloud_aiplatform_v1::model::Transcription;
let x = EventMetadata::new().set_or_clear_input_transcription(Some(Transcription::default()/* use setters */));
let x = EventMetadata::new().set_or_clear_input_transcription(None::<Transcription>);

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

where T: Into<Transcription>,

Sets the value of output_transcription.

Example

use google_cloud_aiplatform_v1::model::Transcription;
let x = EventMetadata::new().set_output_transcription(Transcription::default()/* use setters */);

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

where T: Into<Transcription>,

Sets or clears the value of output_transcription.

Example

use google_cloud_aiplatform_v1::model::Transcription;
let x = EventMetadata::new().set_or_clear_output_transcription(Some(Transcription::default()/* use setters */));
let x = EventMetadata::new().set_or_clear_output_transcription(None::<Transcription>);

Trait Implementations

impl Clone for EventMetadata

fn clone(&self) -> EventMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventMetadata

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

Formats the value using the given formatter.

impl Default for EventMetadata

fn default() -> EventMetadata

Returns the “default value” for a type.

impl Message for EventMetadata

fn typename() -> &'static str

The typename of this message.

impl PartialEq for EventMetadata

fn eq(&self, other: &EventMetadata) -> 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 EventMetadata