Struct Generator 

#[non_exhaustive]
pub struct Generator {

    pub name: String,
    pub description: String,
    pub inference_parameter: Option<InferenceParameter>,
    pub trigger_event: TriggerEvent,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub tools: Vec<String>,
    pub suggestion_deduping_config: Option<SuggestionDedupingConfig>,
    pub toolset_tools: Vec<ToolsetTool>,
    pub ces_tool_specs: Vec<CesToolSpec>,
    pub ces_app_specs: Vec<CesAppSpec>,
    pub context: Option<Context>,
    pub foundation_model: Option<FoundationModel>,
    /* private fields */
}

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

LLM generator.

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

Output only. Identifier. The resource name of the generator. Format: projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>

description: String

Optional. Human readable description of the generator.

inference_parameter: Option<InferenceParameter>

Optional. Inference parameters for this generator.

trigger_event: TriggerEvent

Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation.

create_time: Option<Timestamp>

Output only. Creation time of this generator.

update_time: Option<Timestamp>

Output only. Update time of this generator.

tools: Vec<String>

Optional. Resource names of the tools that the generator can choose from. Format: projects/<Project ID>/locations/<Location ID>/tools/<tool ID>.

suggestion_deduping_config: Option<SuggestionDedupingConfig>

Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature.

toolset_tools: Vec<ToolsetTool>

Optional. List of CES toolset specs that the generator can choose from.

ces_tool_specs: Vec<CesToolSpec>

Optional. List of CES tool specs that the generator can choose from.

ces_app_specs: Vec<CesAppSpec>

Optional. List of CES app specs that the generator can choose from.

context: Option<Context>

Required. Input context of the generator.

foundation_model: Option<FoundationModel>

The foundation model to use for generating suggestions. If a foundation model isn’t specified here, a model specifically tuned for the feature type (and version when applicable) will be used.

Implementations

impl Generator

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 = Generator::new().set_name(format!("projects/{project_id}/locations/{location_id}/generators/{generator_id}"));

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

Sets the value of description.

Example

let x = Generator::new().set_description("example");

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

where T: Into<InferenceParameter>,

Sets the value of inference_parameter.

Example

use google_cloud_dialogflow_v2::model::InferenceParameter;
let x = Generator::new().set_inference_parameter(InferenceParameter::default()/* use setters */);

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

where T: Into<InferenceParameter>,

Sets or clears the value of inference_parameter.

Example

use google_cloud_dialogflow_v2::model::InferenceParameter;
let x = Generator::new().set_or_clear_inference_parameter(Some(InferenceParameter::default()/* use setters */));
let x = Generator::new().set_or_clear_inference_parameter(None::<InferenceParameter>);

pub fn set_trigger_event<T: Into<TriggerEvent>>(self, v: T) -> Self

Sets the value of trigger_event.

Example

use google_cloud_dialogflow_v2::model::TriggerEvent;
let x0 = Generator::new().set_trigger_event(TriggerEvent::EndOfUtterance);
let x1 = Generator::new().set_trigger_event(TriggerEvent::ManualCall);
let x2 = Generator::new().set_trigger_event(TriggerEvent::CustomerMessage);

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 = Generator::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 = Generator::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = Generator::new().set_or_clear_create_time(None::<Timestamp>);

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

where T: Into<Timestamp>,

Sets the value of update_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

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

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

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

Sets the value of tools.

Example

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

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

where T: Into<SuggestionDedupingConfig>,

Sets the value of suggestion_deduping_config.

Example

use google_cloud_dialogflow_v2::model::SuggestionDedupingConfig;
let x = Generator::new().set_suggestion_deduping_config(SuggestionDedupingConfig::default()/* use setters */);

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

where T: Into<SuggestionDedupingConfig>,

Sets or clears the value of suggestion_deduping_config.

Example

use google_cloud_dialogflow_v2::model::SuggestionDedupingConfig;
let x = Generator::new().set_or_clear_suggestion_deduping_config(Some(SuggestionDedupingConfig::default()/* use setters */));
let x = Generator::new().set_or_clear_suggestion_deduping_config(None::<SuggestionDedupingConfig>);

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

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

Sets the value of toolset_tools.

Example

use google_cloud_dialogflow_v2::model::ToolsetTool;
let x = Generator::new()
    .set_toolset_tools([
        ToolsetTool::default()/* use setters */,
        ToolsetTool::default()/* use (different) setters */,
    ]);

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

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

Sets the value of ces_tool_specs.

Example

use google_cloud_dialogflow_v2::model::CesToolSpec;
let x = Generator::new()
    .set_ces_tool_specs([
        CesToolSpec::default()/* use setters */,
        CesToolSpec::default()/* use (different) setters */,
    ]);

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

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

Sets the value of ces_app_specs.

Example

use google_cloud_dialogflow_v2::model::CesAppSpec;
let x = Generator::new()
    .set_ces_app_specs([
        CesAppSpec::default()/* use setters */,
        CesAppSpec::default()/* use (different) setters */,
    ]);

pub fn set_context<T: Into<Option<Context>>>(self, v: T) -> Self

Sets the value of context.

Note that all the setters affecting context are mutually exclusive.

Example

use google_cloud_dialogflow_v2::model::FreeFormContext;
let x = Generator::new().set_context(Some(
    google_cloud_dialogflow_v2::model::generator::Context::FreeFormContext(FreeFormContext::default().into())));

pub fn free_form_context(&self) -> Option<&Box<FreeFormContext>>

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

pub fn set_free_form_context<T: Into<Box<FreeFormContext>>>(self, v: T) -> Self

Sets the value of context to hold a FreeFormContext.

Note that all the setters affecting context are mutually exclusive.

Example

use google_cloud_dialogflow_v2::model::FreeFormContext;
let x = Generator::new().set_free_form_context(FreeFormContext::default()/* use setters */);
assert!(x.free_form_context().is_some());
assert!(x.agent_coaching_context().is_none());
assert!(x.summarization_context().is_none());

pub fn agent_coaching_context(&self) -> Option<&Box<AgentCoachingContext>>

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

pub fn set_agent_coaching_context<T: Into<Box<AgentCoachingContext>>>( self, v: T, ) -> Self

Sets the value of context to hold a AgentCoachingContext.

Note that all the setters affecting context are mutually exclusive.

Example

use google_cloud_dialogflow_v2::model::AgentCoachingContext;
let x = Generator::new().set_agent_coaching_context(AgentCoachingContext::default()/* use setters */);
assert!(x.agent_coaching_context().is_some());
assert!(x.free_form_context().is_none());
assert!(x.summarization_context().is_none());

pub fn summarization_context(&self) -> Option<&Box<SummarizationContext>>

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

pub fn set_summarization_context<T: Into<Box<SummarizationContext>>>( self, v: T, ) -> Self

Sets the value of context to hold a SummarizationContext.

Note that all the setters affecting context are mutually exclusive.

Example

use google_cloud_dialogflow_v2::model::SummarizationContext;
let x = Generator::new().set_summarization_context(SummarizationContext::default()/* use setters */);
assert!(x.summarization_context().is_some());
assert!(x.free_form_context().is_none());
assert!(x.agent_coaching_context().is_none());

pub fn set_foundation_model<T: Into<Option<FoundationModel>>>( self, v: T, ) -> Self

Sets the value of foundation_model.

Note that all the setters affecting foundation_model are mutually exclusive.

Example

use google_cloud_dialogflow_v2::model::generator::FoundationModel;
let x = Generator::new().set_foundation_model(Some(FoundationModel::PublishedModel("example".to_string())));

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

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

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

Sets the value of foundation_model to hold a PublishedModel.

Note that all the setters affecting foundation_model are mutually exclusive.

Example

let x = Generator::new().set_published_model("example");
assert!(x.published_model().is_some());

Trait Implementations

impl Clone for Generator

fn clone(&self) -> Generator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Generator

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

Formats the value using the given formatter.

impl Default for Generator

fn default() -> Generator

Returns the “default value” for a type.

impl Message for Generator

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Generator

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Generator