Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::ConversationProfile (v1.9.1)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::ConversationProfile.

Defines the services to connect to incoming Dialogflow conversations.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#automated_agent_config

def automated_agent_config() -> ::Google::Cloud::Dialogflow::V2::AutomatedAgentConfig

Returns

(::Google::Cloud::Dialogflow::V2::AutomatedAgentConfig) — Configuration for an automated agent to use with this profile.

#automated_agent_config=

def automated_agent_config=(value) -> ::Google::Cloud::Dialogflow::V2::AutomatedAgentConfig

Parameter

value (::Google::Cloud::Dialogflow::V2::AutomatedAgentConfig) — Configuration for an automated agent to use with this profile.

Returns

(::Google::Cloud::Dialogflow::V2::AutomatedAgentConfig) — Configuration for an automated agent to use with this profile.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Create time of the conversation profile.

#display_name

def display_name() -> ::String

Returns

(::String) — Required. Human readable name for this profile. Max length 1024 bytes.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — Required. Human readable name for this profile. Max length 1024 bytes.

Returns

(::String) — Required. Human readable name for this profile. Max length 1024 bytes.

#human_agent_assistant_config

def human_agent_assistant_config() -> ::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig

Returns

(::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig) — Configuration for agent assistance to use with this profile.

#human_agent_assistant_config=

def human_agent_assistant_config=(value) -> ::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig

Parameter

value (::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig) — Configuration for agent assistance to use with this profile.

Returns

(::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig) — Configuration for agent assistance to use with this profile.

#human_agent_handoff_config

def human_agent_handoff_config() -> ::Google::Cloud::Dialogflow::V2::HumanAgentHandoffConfig

Returns

(::Google::Cloud::Dialogflow::V2::HumanAgentHandoffConfig) — Configuration for connecting to a live agent.

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

#human_agent_handoff_config=

def human_agent_handoff_config=(value) -> ::Google::Cloud::Dialogflow::V2::HumanAgentHandoffConfig

Parameter

value (::Google::Cloud::Dialogflow::V2::HumanAgentHandoffConfig) — Configuration for connecting to a live agent.

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

Returns

(::Google::Cloud::Dialogflow::V2::HumanAgentHandoffConfig) — Configuration for connecting to a live agent.

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

#language_code

def language_code() -> ::String

Returns

(::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".

#language_code=

def language_code=(value) -> ::String

Parameter

value (::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".

Returns

(::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".

#logging_config

def logging_config() -> ::Google::Cloud::Dialogflow::V2::LoggingConfig

Returns

(::Google::Cloud::Dialogflow::V2::LoggingConfig) — Configuration for logging conversation lifecycle events.

#logging_config=

def logging_config=(value) -> ::Google::Cloud::Dialogflow::V2::LoggingConfig

Parameter

value (::Google::Cloud::Dialogflow::V2::LoggingConfig) — Configuration for logging conversation lifecycle events.

Returns

(::Google::Cloud::Dialogflow::V2::LoggingConfig) — Configuration for logging conversation lifecycle events.

#name

def name() -> ::String

Returns

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

#name=

def name=(value) -> ::String

Parameter

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

Returns

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

#new_message_event_notification_config

def new_message_event_notification_config() -> ::Google::Cloud::Dialogflow::V2::NotificationConfig

Returns

(::Google::Cloud::Dialogflow::V2::NotificationConfig) — Configuration for publishing new message events. Event will be sent in format of ConversationEvent

#new_message_event_notification_config=

def new_message_event_notification_config=(value) -> ::Google::Cloud::Dialogflow::V2::NotificationConfig

Parameter

value (::Google::Cloud::Dialogflow::V2::NotificationConfig) — Configuration for publishing new message events. Event will be sent in format of ConversationEvent

Returns

(::Google::Cloud::Dialogflow::V2::NotificationConfig) — Configuration for publishing new message events. Event will be sent in format of ConversationEvent

#new_recognition_result_notification_config

def new_recognition_result_notification_config() -> ::Google::Cloud::Dialogflow::V2::NotificationConfig

Returns

(::Google::Cloud::Dialogflow::V2::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"

#new_recognition_result_notification_config=

def new_recognition_result_notification_config=(value) -> ::Google::Cloud::Dialogflow::V2::NotificationConfig

Parameter

value (::Google::Cloud::Dialogflow::V2::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"

Returns

(::Google::Cloud::Dialogflow::V2::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"

#notification_config

def notification_config() -> ::Google::Cloud::Dialogflow::V2::NotificationConfig

Returns

(::Google::Cloud::Dialogflow::V2::NotificationConfig) — Configuration for publishing conversation lifecycle events.

#notification_config=

def notification_config=(value) -> ::Google::Cloud::Dialogflow::V2::NotificationConfig

Parameter

value (::Google::Cloud::Dialogflow::V2::NotificationConfig) — Configuration for publishing conversation lifecycle events.

Returns

(::Google::Cloud::Dialogflow::V2::NotificationConfig) — Configuration for publishing conversation lifecycle events.

#security_settings

def security_settings() -> ::String

Returns

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

#security_settings=

def security_settings=(value) -> ::String

Parameter

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

Returns

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

#stt_config

def stt_config() -> ::Google::Cloud::Dialogflow::V2::SpeechToTextConfig

Returns

(::Google::Cloud::Dialogflow::V2::SpeechToTextConfig) — Settings for speech transcription.

#stt_config=

def stt_config=(value) -> ::Google::Cloud::Dialogflow::V2::SpeechToTextConfig

Parameter

value (::Google::Cloud::Dialogflow::V2::SpeechToTextConfig) — Settings for speech transcription.

Returns

(::Google::Cloud::Dialogflow::V2::SpeechToTextConfig) — Settings for speech transcription.

#time_zone

def time_zone() -> ::String

Returns

(::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.

#time_zone=

def time_zone=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#tts_config

def tts_config() -> ::Google::Cloud::Dialogflow::V2::SynthesizeSpeechConfig

Returns

(::Google::Cloud::Dialogflow::V2::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.

#tts_config=

def tts_config=(value) -> ::Google::Cloud::Dialogflow::V2::SynthesizeSpeechConfig

Parameter

value (::Google::Cloud::Dialogflow::V2::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.

Returns

(::Google::Cloud::Dialogflow::V2::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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Update time of the conversation profile.