Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Agent (v0.32.2)

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

A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system.

For more information about agents, see the Agent guide.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#api_version

def api_version() -> ::Google::Cloud::Dialogflow::V2::Agent::ApiVersion

Returns

(::Google::Cloud::Dialogflow::V2::Agent::ApiVersion) — Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.

#api_version=

def api_version=(value) -> ::Google::Cloud::Dialogflow::V2::Agent::ApiVersion

Parameter

value (::Google::Cloud::Dialogflow::V2::Agent::ApiVersion) — Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.

Returns

(::Google::Cloud::Dialogflow::V2::Agent::ApiVersion) — Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.

#avatar_uri

def avatar_uri() -> ::String

Returns

(::String) — Optional. 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) — Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

Returns

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

#classification_threshold

def classification_threshold() -> ::Float

Returns

(::Float) — Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.

#classification_threshold=

def classification_threshold=(value) -> ::Float

Parameter

value (::Float) — Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.

Returns

(::Float) — Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.

#default_language_code

def default_language_code() -> ::String

Returns

(::String) — Required. 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 Update method.

#default_language_code=

def default_language_code=(value) -> ::String

Parameter

value (::String) — Required. 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 Update method.

Returns

(::String) — Required. 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 Update method.

#description

def description() -> ::String

Returns

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

#description=

def description=(value) -> ::String

Parameter

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

Returns

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

#display_name

def display_name() -> ::String

Returns

(::String) — Required. The name of this agent.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — Required. The name of this agent.

Returns

(::String) — Required. The name of this agent.

#enable_logging

def enable_logging() -> ::Boolean

Returns

(::Boolean) — Optional. Determines whether this agent should log conversation queries.

#enable_logging=

def enable_logging=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. Determines whether this agent should log conversation queries.

Returns

(::Boolean) — Optional. Determines whether this agent should log conversation queries.

#match_mode

def match_mode() -> ::Google::Cloud::Dialogflow::V2::Agent::MatchMode

Returns

(::Google::Cloud::Dialogflow::V2::Agent::MatchMode) — Optional. Determines how intents are detected from user queries.

#match_mode=

def match_mode=(value) -> ::Google::Cloud::Dialogflow::V2::Agent::MatchMode

Parameter

value (::Google::Cloud::Dialogflow::V2::Agent::MatchMode) — Optional. Determines how intents are detected from user queries.

Returns

(::Google::Cloud::Dialogflow::V2::Agent::MatchMode) — Optional. Determines how intents are detected from user queries.

#parent

def parent() -> ::String

Returns

(::String) — Required. The project of this agent. Format: projects/<Project ID>.

#parent=

def parent=(value) -> ::String

Parameter

value (::String) — Required. The project of this agent. Format: projects/<Project ID>.

Returns

(::String) — Required. The project of this agent. Format: projects/<Project ID>.

#supported_language_codes

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

Returns

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

#supported_language_codes=

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

Parameter

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

Returns

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

#tier

def tier() -> ::Google::Cloud::Dialogflow::V2::Agent::Tier

Returns

(::Google::Cloud::Dialogflow::V2::Agent::Tier) — Optional. The agent tier. If not specified, TIER_STANDARD is assumed.

#tier=

def tier=(value) -> ::Google::Cloud::Dialogflow::V2::Agent::Tier

Parameter

value (::Google::Cloud::Dialogflow::V2::Agent::Tier) — Optional. The agent tier. If not specified, TIER_STANDARD is assumed.

Returns

(::Google::Cloud::Dialogflow::V2::Agent::Tier) — Optional. The agent tier. If not specified, TIER_STANDARD is assumed.

#time_zone

def time_zone() -> ::String

Returns

(::String) — Required. The time zone of this 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 this agent from the time zone database, e.g., America/New_York, Europe/Paris.

Returns

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