Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dialogflow_v2beta1/classes.rb,
generated/google/apis/dialogflow_v2beta1/representations.rb,
generated/google/apis/dialogflow_v2beta1/representations.rb

Overview

Represents a conversational agent.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1Agent

Returns a new instance of GoogleCloudDialogflowV2beta1Agent



1643
1644
1645
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1643

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#api_version ⇒ String

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. Corresponds to the JSON property apiVersion

Returns:

  • (String) 


1566
1567
1568
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1566

def api_version
  @api_version
end

#avatar_uri ⇒ String

Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration. Corresponds to the JSON property avatarUri

Returns:

  • (String) 


1575
1576
1577
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1575

def avatar_uri
  @avatar_uri
end

#classification_threshold ⇒ 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. Corresponds to the JSON property classificationThreshold

Returns:

  • (Float) 


1586
1587
1588
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1586

def classification_threshold
  @classification_threshold
end

#default_language_code ⇒ 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. Corresponds to the JSON property defaultLanguageCode

Returns:

  • (String) 


1595
1596
1597
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1595

def default_language_code
  @default_language_code
end

#description ⇒ String

Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected. Corresponds to the JSON property description

Returns:

  • (String) 


1601
1602
1603
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1601

def description
  @description
end

#display_name ⇒ String

Required. The name of this agent. Corresponds to the JSON property displayName

Returns:

  • (String) 


1606
1607
1608
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1606

def display_name
  @display_name
end

#enable_logging ⇒ Boolean Also known as: enable_logging?

Optional. Determines whether this agent should log conversation queries. Corresponds to the JSON property enableLogging

Returns:

  • (Boolean) 


1611
1612
1613
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1611

def enable_logging
  @enable_logging
end

#match_mode ⇒ String

Optional. Determines how intents are detected from user queries. Corresponds to the JSON property matchMode

Returns:

  • (String) 


1617
1618
1619
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1617

def match_mode
  @match_mode
end

#parent ⇒ String

Required. The project of this agent. Format: projects/<Project ID>. Corresponds to the JSON property parent

Returns:

  • (String) 


1623
1624
1625
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1623

def parent
  @parent
end

#supported_language_codes ⇒ Array<String>

Optional. The list of all languages supported by this agent (except for the default_language_code). Corresponds to the JSON property supportedLanguageCodes

Returns:

  • (Array<String>) 


1629
1630
1631
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1629

def supported_language_codes
  @supported_language_codes
end

#tier ⇒ String

Optional. The agent tier. If not specified, TIER_STANDARD is assumed. Corresponds to the JSON property tier

Returns:

  • (String) 


1634
1635
1636
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1634

def tier
  @tier
end

#time_zone ⇒ String

Required. The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris. Corresponds to the JSON property timeZone

Returns:

  • (String) 


1641
1642
1643
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1641

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1648

def update!(**args)
  @api_version = args[:api_version] if args.key?(:api_version)
  @avatar_uri = args[:avatar_uri] if args.key?(:avatar_uri)
  @classification_threshold = args[:classification_threshold] if args.key?(:classification_threshold)
  @default_language_code = args[:default_language_code] if args.key?(:default_language_code)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @enable_logging = args[:enable_logging] if args.key?(:enable_logging)
  @match_mode = args[:match_mode] if args.key?(:match_mode)
  @parent = args[:parent] if args.key?(:parent)
  @supported_language_codes = args[:supported_language_codes] if args.key?(:supported_language_codes)
  @tier = args[:tier] if args.key?(:tier)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
end