Class: Google::Cloud::Dialogflow::V2::SuggestionInput

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

Overview

Represents the action to take for a tool call that requires confirmation.

Defined Under Namespace

Modules: Action

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ ::Google::Cloud::Dialogflow::V2::SuggestionInput::Action

Returns Optional. The type of action to take with the tool.

Returns:



1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 1130

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

  # Indicate what type of action to take with the tool call.
  module Action
    # Action not specified.
    ACTION_UNSPECIFIED = 0

    # Indicates the user chooses to not make the tool call. It
    # is only applicable to tool calls that are waiting for user
    # confirmation.
    CANCEL = 1

    # Makes the tool call with provided parameters. This action is intended
    # for tool calls that only read but not write data.
    REVISE = 2

    # Makes the tool call with provided parameters. This action is intended
    # for tool calls that may write data.
    CONFIRM = 3
  end
end

#answer_record ⇒ ::String

Returns Required. Format: projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID> The answer record associated with the tool call.

Returns:

  • (::String) —

    Required. Format: projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID> The answer record associated with the tool call.



1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 1130

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

  # Indicate what type of action to take with the tool call.
  module Action
    # Action not specified.
    ACTION_UNSPECIFIED = 0

    # Indicates the user chooses to not make the tool call. It
    # is only applicable to tool calls that are waiting for user
    # confirmation.
    CANCEL = 1

    # Makes the tool call with provided parameters. This action is intended
    # for tool calls that only read but not write data.
    REVISE = 2

    # Makes the tool call with provided parameters. This action is intended
    # for tool calls that may write data.
    CONFIRM = 3
  end
end

#parameters ⇒ ::Google::Protobuf::Struct

Returns Optional. Parameters to be used for the tool call. If not provided, the tool will be called without any parameters.

Returns:

  • (::Google::Protobuf::Struct) —

    Optional. Parameters to be used for the tool call. If not provided, the tool will be called without any parameters.



1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 1130

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

  # Indicate what type of action to take with the tool call.
  module Action
    # Action not specified.
    ACTION_UNSPECIFIED = 0

    # Indicates the user chooses to not make the tool call. It
    # is only applicable to tool calls that are waiting for user
    # confirmation.
    CANCEL = 1

    # Makes the tool call with provided parameters. This action is intended
    # for tool calls that only read but not write data.
    REVISE = 2

    # Makes the tool call with provided parameters. This action is intended
    # for tool calls that may write data.
    CONFIRM = 3
  end
end

#send_time ⇒ ::Google::Protobuf::Timestamp

Returns Optional. Time when the current suggest input is sent. For tool calls, this timestamp (along with the answer record) will be included in the corresponding tool call result so that it can be identified.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Optional. Time when the current suggest input is sent. For tool calls, this timestamp (along with the answer record) will be included in the corresponding tool call result so that it can be identified.



1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
 
# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 1130

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

  # Indicate what type of action to take with the tool call.
  module Action
    # Action not specified.
    ACTION_UNSPECIFIED = 0

    # Indicates the user chooses to not make the tool call. It
    # is only applicable to tool calls that are waiting for user
    # confirmation.
    CANCEL = 1

    # Makes the tool call with provided parameters. This action is intended
    # for tool calls that only read but not write data.
    REVISE = 2

    # Makes the tool call with provided parameters. This action is intended
    # for tool calls that may write data.
    CONFIRM = 3
  end
end