Class: Google::Cloud::Dialogflow::V2::Agent

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb

Overview

Represents a conversational agent.

Defined Under Namespace

Modules: MatchMode

Instance Attribute Summary collapse

Instance Attribute Details

#avatar_uri ⇒ String

Returns 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.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 66

class Agent
  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end
end

#classification_threshold ⇒ Float

Returns 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 is 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 is 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.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 66

class Agent
  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end
end

#default_language_code ⇒ String

Returns 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.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 66

class Agent
  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end
end

#description ⇒ String

Returns 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.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 66

class Agent
  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end
end

#display_name ⇒ String

Returns Required. The name of this agent.

Returns:

  • (String) —

    Required. The name of this agent.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 66

class Agent
  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end
end

#enable_logging ⇒ true, false

Returns Optional. Determines whether this agent should log conversation queries.

Returns:

  • (true, false) —

    Optional. Determines whether this agent should log conversation queries.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 66

class Agent
  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end
end

#match_mode ⇒ Google::Cloud::Dialogflow::V2::Agent::MatchMode

Returns Optional. Determines how intents are detected from user queries.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 66

class Agent
  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end
end

#parent ⇒ String

Returns Required. The project of this agent. Format: +projects/+.

Returns:

  • (String) —

    Required. The project of this agent. Format: +projects/+.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 66

class Agent
  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end
end

#supported_language_codes ⇒ Array<String>

Returns 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+).



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 66

class Agent
  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end
end

#time_zone ⇒ String

Returns 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.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 66

class Agent
  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end
end