Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Action

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

Overview

Action performed by end user or Dialogflow agent in the conversation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1Action

Returns a new instance of GoogleCloudDialogflowCxV3beta1Action.



4086
4087
4088
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4086

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

Instance Attribute Details

#agent_utterance ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AgentUtterance

AgentUtterance represents one message sent by the agent. Corresponds to the JSON property agentUtterance

Returns:



3993
3994
3995
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3993

def agent_utterance
  @agent_utterance
end

#complete_time ⇒ String

Output only. Timestamp of the completion of the agent action. Corresponds to the JSON property completeTime

Returns:

  • (String) 


3998
3999
4000
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3998

def complete_time
  @complete_time
end

#display_name ⇒ String

Output only. The display name of the action. Corresponds to the JSON property displayName

Returns:

  • (String) 


4003
4004
4005
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4003

def display_name
  @display_name
end

#event ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Event

Event represents the event sent by the customer. Corresponds to the JSON property event

Returns:



4008
4009
4010
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4008

def event
  @event
end

#flow_invocation ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FlowInvocation

Stores metadata of the invocation of a child CX flow. Flow invocation actions enter the child flow. Corresponds to the JSON property flowInvocation

Returns:



4014
4015
4016
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4014

def flow_invocation
  @flow_invocation
end

#flow_state_update ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ActionFlowStateUpdate

Stores metadata of the state update action, such as a state machine execution in flows. Corresponds to the JSON property flowStateUpdate

Returns:



4020
4021
4022
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4020

def flow_state_update
  @flow_state_update
end

#flow_transition ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FlowTransition

Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. Corresponds to the JSON property flowTransition

Returns:



4026
4027
4028
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4026

def flow_transition
  @flow_transition
end

#intent_match ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ActionIntentMatch

Stores metadata of the intent match action. Corresponds to the JSON property intentMatch

Returns:



4031
4032
4033
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4031

def intent_match
  @intent_match
end

#llm_call ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LlmCall

Stores metadata of the call of an LLM. Corresponds to the JSON property llmCall

Returns:



4036
4037
4038
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4036

def llm_call
  @llm_call
end

#playbook_invocation ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookInvocation

Stores metadata of the invocation of a child playbook. Playbook invocation actions enter the child playbook. Corresponds to the JSON property playbookInvocation

Returns:



4042
4043
4044
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4042

def playbook_invocation
  @playbook_invocation
end

#playbook_transition ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PlaybookTransition

Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. Corresponds to the JSON property playbookTransition

Returns:



4048
4049
4050
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4048

def playbook_transition
  @playbook_transition
end

#start_time ⇒ String

Output only. Timestamp of the start of the agent action. Corresponds to the JSON property startTime

Returns:

  • (String) 


4053
4054
4055
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4053

def start_time
  @start_time
end

#status ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Status

The status of the action. Corresponds to the JSON property status

Returns:



4058
4059
4060
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4058

def status
  @status
end

#stt ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ActionStt

Stores metadata of the Speech-to-Text action. Corresponds to the JSON property stt

Returns:



4063
4064
4065
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4063

def stt
  @stt
end

#sub_execution_steps ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Span>

Optional. The detailed tracing information for sub execution steps of the action. Corresponds to the JSON property subExecutionSteps

Returns:



4069
4070
4071
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4069

def sub_execution_steps
  @sub_execution_steps
end

#tool_use ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolUse

Stores metadata of the invocation of an action supported by a tool. Corresponds to the JSON property toolUse

Returns:



4074
4075
4076
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4074

def tool_use
  @tool_use
end

#tts ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ActionTts

Stores metadata of the Text-to-Speech action. Corresponds to the JSON property tts

Returns:



4079
4080
4081
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4079

def tts
  @tts
end

#user_utterance ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1UserUtterance

UserUtterance represents one message sent by the customer. Corresponds to the JSON property userUtterance

Returns:



4084
4085
4086
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4084

def user_utterance
  @user_utterance
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4091

def update!(**args)
  @agent_utterance = args[:agent_utterance] if args.key?(:agent_utterance)
  @complete_time = args[:complete_time] if args.key?(:complete_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @event = args[:event] if args.key?(:event)
  @flow_invocation = args[:flow_invocation] if args.key?(:flow_invocation)
  @flow_state_update = args[:flow_state_update] if args.key?(:flow_state_update)
  @flow_transition = args[:flow_transition] if args.key?(:flow_transition)
  @intent_match = args[:intent_match] if args.key?(:intent_match)
  @llm_call = args[:llm_call] if args.key?(:llm_call)
  @playbook_invocation = args[:playbook_invocation] if args.key?(:playbook_invocation)
  @playbook_transition = args[:playbook_transition] if args.key?(:playbook_transition)
  @start_time = args[:start_time] if args.key?(:start_time)
  @status = args[:status] if args.key?(:status)
  @stt = args[:stt] if args.key?(:stt)
  @sub_execution_steps = args[:sub_execution_steps] if args.key?(:sub_execution_steps)
  @tool_use = args[:tool_use] if args.key?(:tool_use)
  @tts = args[:tts] if args.key?(:tts)
  @user_utterance = args[:user_utterance] if args.key?(:user_utterance)
end