Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::Agent (v1.1.0)

Version 1.1.0

• 1.2.0 (latest)
• 1.1.1
• 1.0.0
• 0.26.0
• 0.25.0
• 0.24.2
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.1
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.2
• 0.9.0
• 0.8.1
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Agent.

Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way.

After you create an agent, you can add Intents, [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#advanced_settings

def advanced_settings() -> ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings

Returns

• (::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings) — Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

#advanced_settings=

def advanced_settings=(value) -> ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings

Parameter

• value (::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings) — Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

Returns

• (::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings) — Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

#answer_feedback_settings

def answer_feedback_settings() -> ::Google::Cloud::Dialogflow::CX::V3::Agent::AnswerFeedbackSettings

Returns

• (::Google::Cloud::Dialogflow::CX::V3::Agent::AnswerFeedbackSettings) — Optional. Answer feedback collection settings.

#answer_feedback_settings=

def answer_feedback_settings=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Agent::AnswerFeedbackSettings

Parameter

• value (::Google::Cloud::Dialogflow::CX::V3::Agent::AnswerFeedbackSettings) — Optional. Answer feedback collection settings.

Returns

• (::Google::Cloud::Dialogflow::CX::V3::Agent::AnswerFeedbackSettings) — Optional. Answer feedback collection settings.

#avatar_uri

def avatar_uri() -> ::String

Returns

• (::String) — The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

#avatar_uri=

def avatar_uri=(value) -> ::String

Parameter

• value (::String) — The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

Returns

• (::String) — The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

#default_language_code

def default_language_code() -> ::String

Returns

• (::String) — Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.

#default_language_code=

def default_language_code=(value) -> ::String

Parameter

• value (::String) — Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.

Returns

• (::String) — Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.

#description

def description() -> ::String

Returns

• (::String) — The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

#description=

def description=(value) -> ::String

Parameter

• value (::String) — The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

Returns

• (::String) — The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

#display_name

def display_name() -> ::String

Returns

• (::String) — Required. The human-readable name of the agent, unique within the location.

#display_name=

def display_name=(value) -> ::String

Parameter

• value (::String) — Required. The human-readable name of the agent, unique within the location.

Returns

• (::String) — Required. The human-readable name of the agent, unique within the location.

#enable_multi_language_training

def enable_multi_language_training() -> ::Boolean

Returns

• (::Boolean) — Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.

#enable_multi_language_training=

def enable_multi_language_training=(value) -> ::Boolean

Parameter

• value (::Boolean) — Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.

Returns

• (::Boolean) — Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.

#enable_spell_correction

def enable_spell_correction() -> ::Boolean

Returns

• (::Boolean) — Indicates if automatic spell correction is enabled in detect intent requests.

#enable_spell_correction=

def enable_spell_correction=(value) -> ::Boolean

Parameter

• value (::Boolean) — Indicates if automatic spell correction is enabled in detect intent requests.

Returns

• (::Boolean) — Indicates if automatic spell correction is enabled in detect intent requests.

#enable_stackdriver_logging

def enable_stackdriver_logging() -> ::Boolean

Returns

• (::Boolean) — Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

#enable_stackdriver_logging=

def enable_stackdriver_logging=(value) -> ::Boolean

Parameter

• value (::Boolean) — Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

Returns

• (::Boolean) — Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

#gen_app_builder_settings

def gen_app_builder_settings() -> ::Google::Cloud::Dialogflow::CX::V3::Agent::GenAppBuilderSettings

Returns

• (::Google::Cloud::Dialogflow::CX::V3::Agent::GenAppBuilderSettings) — Gen App Builder-related agent-level settings.

#gen_app_builder_settings=

def gen_app_builder_settings=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Agent::GenAppBuilderSettings

Parameter

• value (::Google::Cloud::Dialogflow::CX::V3::Agent::GenAppBuilderSettings) — Gen App Builder-related agent-level settings.

Returns

• (::Google::Cloud::Dialogflow::CX::V3::Agent::GenAppBuilderSettings) — Gen App Builder-related agent-level settings.

#git_integration_settings

def git_integration_settings() -> ::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings

Returns

• (::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings) — Git integration settings for this agent.

#git_integration_settings=

def git_integration_settings=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings

Parameter

• value (::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings) — Git integration settings for this agent.

Returns

• (::Google::Cloud::Dialogflow::CX::V3::Agent::GitIntegrationSettings) — Git integration settings for this agent.

#locked

def locked() -> ::Boolean

Returns

• (::Boolean) — Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [RestoreAgent][].

#locked=

def locked=(value) -> ::Boolean

Parameter

• value (::Boolean) — Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [RestoreAgent][].

Returns

• (::Boolean) — Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [RestoreAgent][].

#name

def name() -> ::String

Returns

• (::String) — The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

#name=

def name=(value) -> ::String

Parameter

• value (::String) — The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Returns

• (::String) — The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

#personalization_settings

def personalization_settings() -> ::Google::Cloud::Dialogflow::CX::V3::Agent::PersonalizationSettings

Returns

• (::Google::Cloud::Dialogflow::CX::V3::Agent::PersonalizationSettings) — Optional. Settings for end user personalization.

#personalization_settings=

def personalization_settings=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Agent::PersonalizationSettings

Parameter

• value (::Google::Cloud::Dialogflow::CX::V3::Agent::PersonalizationSettings) — Optional. Settings for end user personalization.

Returns

• (::Google::Cloud::Dialogflow::CX::V3::Agent::PersonalizationSettings) — Optional. Settings for end user personalization.

#security_settings

def security_settings() -> ::String

Returns

• (::String) — Name of the 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 SecuritySettings reference for the agent. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

Returns

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

#speech_to_text_settings

def speech_to_text_settings() -> ::Google::Cloud::Dialogflow::CX::V3::SpeechToTextSettings

Returns

• (::Google::Cloud::Dialogflow::CX::V3::SpeechToTextSettings) — Speech recognition related settings.

#speech_to_text_settings=

def speech_to_text_settings=(value) -> ::Google::Cloud::Dialogflow::CX::V3::SpeechToTextSettings

Parameter

• value (::Google::Cloud::Dialogflow::CX::V3::SpeechToTextSettings) — Speech recognition related settings.

Returns

• (::Google::Cloud::Dialogflow::CX::V3::SpeechToTextSettings) — Speech recognition related settings.

#start_flow

def start_flow() -> ::String

Returns

• (::String) — Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

#start_flow=

def start_flow=(value) -> ::String

Parameter

• value (::String) — Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Returns

• (::String) — Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

#supported_language_codes

def supported_language_codes() -> ::Array<::String>

Returns

• (::Array<::String>) — The list of all languages supported by the agent (except for the default_language_code).

#supported_language_codes=

def supported_language_codes=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — The list of all languages supported by the agent (except for the default_language_code).

Returns

• (::Array<::String>) — The list of all languages supported by the agent (except for the default_language_code).

#text_to_speech_settings

def text_to_speech_settings() -> ::Google::Cloud::Dialogflow::CX::V3::TextToSpeechSettings

Returns

• (::Google::Cloud::Dialogflow::CX::V3::TextToSpeechSettings) — Settings on instructing the speech synthesizer on how to generate the output audio content.

#text_to_speech_settings=

def text_to_speech_settings=(value) -> ::Google::Cloud::Dialogflow::CX::V3::TextToSpeechSettings

Parameter

• value (::Google::Cloud::Dialogflow::CX::V3::TextToSpeechSettings) — Settings on instructing the speech synthesizer on how to generate the output audio content.

Returns

• (::Google::Cloud::Dialogflow::CX::V3::TextToSpeechSettings) — Settings on instructing the speech synthesizer on how to generate the output audio content.

#time_zone

def time_zone() -> ::String

Returns

• (::String) — Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

#time_zone=

def time_zone=(value) -> ::String

Parameter

• value (::String) — Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

Returns

• (::String) — Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.