Skip to main content

ConversationProfile

Struct ConversationProfile 

Source
#[non_exhaustive]
pub struct ConversationProfile {
Show 16 fields pub name: String, pub display_name: String, pub create_time: Option<Timestamp>, pub update_time: Option<Timestamp>, pub automated_agent_config: Option<AutomatedAgentConfig>, pub human_agent_assistant_config: Option<HumanAgentAssistantConfig>, pub human_agent_handoff_config: Option<HumanAgentHandoffConfig>, pub notification_config: Option<NotificationConfig>, pub logging_config: Option<LoggingConfig>, pub new_message_event_notification_config: Option<NotificationConfig>, pub new_recognition_result_notification_config: Option<NotificationConfig>, pub stt_config: Option<SpeechToTextConfig>, pub language_code: String, pub time_zone: String, pub security_settings: String, pub tts_config: Option<SynthesizeSpeechConfig>, /* private fields */
}
Available on crate features conversation-profiles or conversations only.
Expand description

Defines the services to connect to incoming Dialogflow conversations.

Fields (Non-exhaustive)§

This struct is marked as 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

The unique identifier of this conversation profile. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

§display_name: String

Required. Human readable name for this profile. Max length 1024 bytes.

§create_time: Option<Timestamp>

Output only. Create time of the conversation profile.

§update_time: Option<Timestamp>

Output only. Update time of the conversation profile.

§automated_agent_config: Option<AutomatedAgentConfig>

Configuration for an automated agent to use with this profile.

§human_agent_assistant_config: Option<HumanAgentAssistantConfig>

Configuration for agent assistance to use with this profile.

§human_agent_handoff_config: Option<HumanAgentHandoffConfig>

Configuration for connecting to a live agent.

Currently, this feature is not general available, please contact Google to get access.

§notification_config: Option<NotificationConfig>

Configuration for publishing conversation lifecycle events.

§logging_config: Option<LoggingConfig>

Configuration for logging conversation lifecycle events.

§new_message_event_notification_config: Option<NotificationConfig>

Configuration for publishing new message events. Event will be sent in format of ConversationEvent

§new_recognition_result_notification_config: Option<NotificationConfig>

Optional. Configuration for publishing transcription intermediate results. Event will be sent in format of ConversationEvent. If configured, the following information will be populated as ConversationEvent Pub/Sub message attributes:

  • “participant_id”
  • “participant_role”
  • “message_id”
§stt_config: Option<SpeechToTextConfig>

Settings for speech transcription.

§language_code: String

Language code for the conversation profile. If not specified, the language is en-US. Language at ConversationProfile should be set for all non en-US languages. This should be a BCP-47 language tag. Example: “en-US”.

§time_zone: String

The time zone of this conversational profile from the time zone database, e.g., America/New_York, Europe/Paris. Defaults to America/New_York.

§security_settings: String

Name of the CX SecuritySettings reference for the agent. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

§tts_config: Option<SynthesizeSpeechConfig>

Configuration for Text-to-Speech synthesization.

Used by Phone Gateway to specify synthesization options. If agent defines synthesization options as well, agent settings overrides the option here.

Implementations§

Source§

impl ConversationProfile

Source

pub fn new() -> Self

Source

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

Sets the value of name.

§Example
let x = ConversationProfile::new().set_name("example");
Source

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

Sets the value of display_name.

§Example
let x = ConversationProfile::new().set_display_name("example");
Source

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 = ConversationProfile::new().set_create_time(Timestamp::default()/* use setters */);
Source

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

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 = ConversationProfile::new().set_update_time(Timestamp::default()/* use setters */);
Source

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

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

Sets the value of automated_agent_config.

§Example
use google_cloud_dialogflow_v2::model::AutomatedAgentConfig;
let x = ConversationProfile::new().set_automated_agent_config(AutomatedAgentConfig::default()/* use setters */);
Source

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

Sets or clears the value of automated_agent_config.

§Example
use google_cloud_dialogflow_v2::model::AutomatedAgentConfig;
let x = ConversationProfile::new().set_or_clear_automated_agent_config(Some(AutomatedAgentConfig::default()/* use setters */));
let x = ConversationProfile::new().set_or_clear_automated_agent_config(None::<AutomatedAgentConfig>);
Source

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

Sets the value of human_agent_assistant_config.

§Example
use google_cloud_dialogflow_v2::model::HumanAgentAssistantConfig;
let x = ConversationProfile::new().set_human_agent_assistant_config(HumanAgentAssistantConfig::default()/* use setters */);
Source

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

Sets or clears the value of human_agent_assistant_config.

§Example
use google_cloud_dialogflow_v2::model::HumanAgentAssistantConfig;
let x = ConversationProfile::new().set_or_clear_human_agent_assistant_config(Some(HumanAgentAssistantConfig::default()/* use setters */));
let x = ConversationProfile::new().set_or_clear_human_agent_assistant_config(None::<HumanAgentAssistantConfig>);
Source

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

Sets the value of human_agent_handoff_config.

§Example
use google_cloud_dialogflow_v2::model::HumanAgentHandoffConfig;
let x = ConversationProfile::new().set_human_agent_handoff_config(HumanAgentHandoffConfig::default()/* use setters */);
Source

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

Sets or clears the value of human_agent_handoff_config.

§Example
use google_cloud_dialogflow_v2::model::HumanAgentHandoffConfig;
let x = ConversationProfile::new().set_or_clear_human_agent_handoff_config(Some(HumanAgentHandoffConfig::default()/* use setters */));
let x = ConversationProfile::new().set_or_clear_human_agent_handoff_config(None::<HumanAgentHandoffConfig>);
Source

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

Sets the value of notification_config.

§Example
use google_cloud_dialogflow_v2::model::NotificationConfig;
let x = ConversationProfile::new().set_notification_config(NotificationConfig::default()/* use setters */);
Source

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

Sets or clears the value of notification_config.

§Example
use google_cloud_dialogflow_v2::model::NotificationConfig;
let x = ConversationProfile::new().set_or_clear_notification_config(Some(NotificationConfig::default()/* use setters */));
let x = ConversationProfile::new().set_or_clear_notification_config(None::<NotificationConfig>);
Source

pub fn set_logging_config<T>(self, v: T) -> Self
where T: Into<LoggingConfig>,

Sets the value of logging_config.

§Example
use google_cloud_dialogflow_v2::model::LoggingConfig;
let x = ConversationProfile::new().set_logging_config(LoggingConfig::default()/* use setters */);
Source

pub fn set_or_clear_logging_config<T>(self, v: Option<T>) -> Self
where T: Into<LoggingConfig>,

Sets or clears the value of logging_config.

§Example
use google_cloud_dialogflow_v2::model::LoggingConfig;
let x = ConversationProfile::new().set_or_clear_logging_config(Some(LoggingConfig::default()/* use setters */));
let x = ConversationProfile::new().set_or_clear_logging_config(None::<LoggingConfig>);
Source

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

Sets the value of new_message_event_notification_config.

§Example
use google_cloud_dialogflow_v2::model::NotificationConfig;
let x = ConversationProfile::new().set_new_message_event_notification_config(NotificationConfig::default()/* use setters */);
Source

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

Sets or clears the value of new_message_event_notification_config.

§Example
use google_cloud_dialogflow_v2::model::NotificationConfig;
let x = ConversationProfile::new().set_or_clear_new_message_event_notification_config(Some(NotificationConfig::default()/* use setters */));
let x = ConversationProfile::new().set_or_clear_new_message_event_notification_config(None::<NotificationConfig>);
Source

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

Sets the value of new_recognition_result_notification_config.

§Example
use google_cloud_dialogflow_v2::model::NotificationConfig;
let x = ConversationProfile::new().set_new_recognition_result_notification_config(NotificationConfig::default()/* use setters */);
Source

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

Sets or clears the value of new_recognition_result_notification_config.

§Example
use google_cloud_dialogflow_v2::model::NotificationConfig;
let x = ConversationProfile::new().set_or_clear_new_recognition_result_notification_config(Some(NotificationConfig::default()/* use setters */));
let x = ConversationProfile::new().set_or_clear_new_recognition_result_notification_config(None::<NotificationConfig>);
Source

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

Sets the value of stt_config.

§Example
use google_cloud_dialogflow_v2::model::SpeechToTextConfig;
let x = ConversationProfile::new().set_stt_config(SpeechToTextConfig::default()/* use setters */);
Source

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

Sets or clears the value of stt_config.

§Example
use google_cloud_dialogflow_v2::model::SpeechToTextConfig;
let x = ConversationProfile::new().set_or_clear_stt_config(Some(SpeechToTextConfig::default()/* use setters */));
let x = ConversationProfile::new().set_or_clear_stt_config(None::<SpeechToTextConfig>);
Source

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

Sets the value of language_code.

§Example
let x = ConversationProfile::new().set_language_code("example");
Source

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

Sets the value of time_zone.

§Example
let x = ConversationProfile::new().set_time_zone("example");
Source

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

Sets the value of security_settings.

§Example
let x = ConversationProfile::new().set_security_settings("example");
Source

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

Sets the value of tts_config.

§Example
use google_cloud_dialogflow_v2::model::SynthesizeSpeechConfig;
let x = ConversationProfile::new().set_tts_config(SynthesizeSpeechConfig::default()/* use setters */);
Source

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

Sets or clears the value of tts_config.

§Example
use google_cloud_dialogflow_v2::model::SynthesizeSpeechConfig;
let x = ConversationProfile::new().set_or_clear_tts_config(Some(SynthesizeSpeechConfig::default()/* use setters */));
let x = ConversationProfile::new().set_or_clear_tts_config(None::<SynthesizeSpeechConfig>);

Trait Implementations§

Source§

impl Clone for ConversationProfile

Source§

fn clone(&self) -> ConversationProfile

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConversationProfile

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ConversationProfile

Source§

fn default() -> ConversationProfile

Returns the “default value” for a type. Read more
Source§

impl Message for ConversationProfile

Source§

fn typename() -> &'static str

The typename of this message.
Source§

impl PartialEq for ConversationProfile

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ConversationProfile

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,