Struct ToolCall 

#[non_exhaustive]
pub struct ToolCall {
    pub tool_display_name: String,
    pub tool_display_details: String,
    pub action: String,
    pub input_parameters: Option<Struct>,
    pub create_time: Option<Timestamp>,
    pub answer_record: String,
    pub state: State,
    pub source: Option<Source>,
    /* private fields */
}

Available on crate features answer-records or conversations or generator-evaluations or generators or participants only.

Represents a call of a specific tool’s action with the specified inputs.

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.

tool_display_name: String

Optional. A human readable short name of the tool, to be shown on the UI.

tool_display_details: String

Optional. A human readable description of the tool.

action: String

Optional. The name of the tool’s action associated with this call.

input_parameters: Option<Struct>

Optional. The action’s input parameters.

create_time: Option<Timestamp>

Output only. Create time of the tool call.

answer_record: String

Optional. The answer record associated with this tool call.

state: State

Output only. State of the tool call.

source: Option<Source>

Specifies the source of this tool call.

Implementations

impl ToolCall

pub fn new() -> Self

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

Sets the value of tool_display_name.

Example

let x = ToolCall::new().set_tool_display_name("example");

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

Sets the value of tool_display_details.

Example

let x = ToolCall::new().set_tool_display_details("example");

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

Sets the value of action.

Example

let x = ToolCall::new().set_action("example");

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

where T: Into<Struct>,

Sets the value of input_parameters.

Example

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

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

where T: Into<Struct>,

Sets or clears the value of input_parameters.

Example

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

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

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = ToolCall::new().set_create_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = ToolCall::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = ToolCall::new().set_or_clear_create_time(None::<Timestamp>);

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

Sets the value of answer_record.

Example

let x = ToolCall::new().set_answer_record("example");

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_dialogflow_v2::model::tool_call::State;
let x0 = ToolCall::new().set_state(State::Triggered);
let x1 = ToolCall::new().set_state(State::NeedsConfirmation);

pub fn set_source<T: Into<Option<Source>>>(self, v: T) -> Self

Sets the value of source.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_dialogflow_v2::model::tool_call::Source;
let x = ToolCall::new().set_source(Some(Source::Tool("example".to_string())));

pub fn tool(&self) -> Option<&String>

The value of source if it holds a Tool, None if the field is not set or holds a different branch.

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

Sets the value of source to hold a Tool.

Note that all the setters affecting source are mutually exclusive.

Example

let x = ToolCall::new().set_tool("example");
assert!(x.tool().is_some());

Trait Implementations

impl Clone for ToolCall

fn clone(&self) -> ToolCall

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolCall

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

Formats the value using the given formatter.

impl Default for ToolCall

fn default() -> ToolCall

Returns the “default value” for a type.

impl Message for ToolCall

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ToolCall

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