Class: Google::Cloud::Dialogflow::V2::ToolCall

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/tool_call.rb

Overview

Represents a call of a specific tool's action with the specified inputs.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ ::String

Returns Optional. The name of the tool's action associated with this call.

Returns:

  • (::String) —

    Optional. The name of the tool's action associated with this call.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/cloud/dialogflow/v2/tool_call.rb', line 51

class ToolCall
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Tool call states.
  module State
    # Default value.
    STATE_UNSPECIFIED = 0

    # The tool call has been triggered.
    TRIGGERED = 1

    # The tool call requires confirmation from a human.
    NEEDS_CONFIRMATION = 2
  end
end

#answer_record ⇒ ::String

Returns Optional. The answer record associated with this tool call.

Returns:

  • (::String) —

    Optional. The answer record associated with this tool call.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/cloud/dialogflow/v2/tool_call.rb', line 51

class ToolCall
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Tool call states.
  module State
    # Default value.
    STATE_UNSPECIFIED = 0

    # The tool call has been triggered.
    TRIGGERED = 1

    # The tool call requires confirmation from a human.
    NEEDS_CONFIRMATION = 2
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Create time of the tool call.

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/cloud/dialogflow/v2/tool_call.rb', line 51

class ToolCall
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Tool call states.
  module State
    # Default value.
    STATE_UNSPECIFIED = 0

    # The tool call has been triggered.
    TRIGGERED = 1

    # The tool call requires confirmation from a human.
    NEEDS_CONFIRMATION = 2
  end
end

#input_parameters ⇒ ::Google::Protobuf::Struct

Returns Optional. The action's input parameters.

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/cloud/dialogflow/v2/tool_call.rb', line 51

class ToolCall
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Tool call states.
  module State
    # Default value.
    STATE_UNSPECIFIED = 0

    # The tool call has been triggered.
    TRIGGERED = 1

    # The tool call requires confirmation from a human.
    NEEDS_CONFIRMATION = 2
  end
end

#state ⇒ ::Google::Cloud::Dialogflow::V2::ToolCall::State (readonly)

Returns Output only. State of the tool call.

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/cloud/dialogflow/v2/tool_call.rb', line 51

class ToolCall
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Tool call states.
  module State
    # Default value.
    STATE_UNSPECIFIED = 0

    # The tool call has been triggered.
    TRIGGERED = 1

    # The tool call requires confirmation from a human.
    NEEDS_CONFIRMATION = 2
  end
end

#tool ⇒ ::String

Returns Optional. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/tools/<ToolID>.

Returns:

  • (::String) —

    Optional. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/tools/<ToolID>.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/cloud/dialogflow/v2/tool_call.rb', line 51

class ToolCall
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Tool call states.
  module State
    # Default value.
    STATE_UNSPECIFIED = 0

    # The tool call has been triggered.
    TRIGGERED = 1

    # The tool call requires confirmation from a human.
    NEEDS_CONFIRMATION = 2
  end
end

#tool_display_details ⇒ ::String

Returns Optional. A human readable description of the tool.

Returns:

  • (::String) —

    Optional. A human readable description of the tool.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/cloud/dialogflow/v2/tool_call.rb', line 51

class ToolCall
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Tool call states.
  module State
    # Default value.
    STATE_UNSPECIFIED = 0

    # The tool call has been triggered.
    TRIGGERED = 1

    # The tool call requires confirmation from a human.
    NEEDS_CONFIRMATION = 2
  end
end

#tool_display_name ⇒ ::String

Returns Optional. A human readable short name of the tool, to be shown on the UI.

Returns:

  • (::String) —

    Optional. A human readable short name of the tool, to be shown on the UI.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/cloud/dialogflow/v2/tool_call.rb', line 51

class ToolCall
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Tool call states.
  module State
    # Default value.
    STATE_UNSPECIFIED = 0

    # The tool call has been triggered.
    TRIGGERED = 1

    # The tool call requires confirmation from a human.
    NEEDS_CONFIRMATION = 2
  end
end