Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput

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

The output from the virtual agent.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput

Returns a new instance of GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput.



476
477
478
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 476

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

Instance Attribute Details

#current_page ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3Page

A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the Page guide. Corresponds to the JSON property currentPage

Returns:



434
435
436
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 434

def current_page
  @current_page
end

#diagnostic_info ⇒ Hash<String,Object>

Required. Input only. The diagnostic info output for the turn. Required to calculate the testing coverage. Corresponds to the JSON property diagnosticInfo

Returns:

  • (Hash<String,Object>) 


440
441
442
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 440

def diagnostic_info
  @diagnostic_info
end

#differences ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3TestRunDifference>

Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any. Corresponds to the JSON property differences

Returns:



446
447
448
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 446

def differences
  @differences
end

#session_parameters ⇒ Hash<String,Object>

The session parameters available to the bot at this point. Corresponds to the JSON property sessionParameters

Returns:

  • (Hash<String,Object>) 


451
452
453
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 451

def session_parameters
  @session_parameters
end

#status ⇒ Google::Apis::DialogflowV3beta1::GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property status

Returns:



461
462
463
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 461

def status
  @status
end

#text_responses ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageText>

The text responses from the agent for the turn. Corresponds to the JSON property textResponses

Returns:



466
467
468
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 466

def text_responses
  @text_responses
end

#triggered_intent ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3Intent

An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. Corresponds to the JSON property triggeredIntent

Returns:



474
475
476
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 474

def triggered_intent
  @triggered_intent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



481
482
483
484
485
486
487
488
489
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 481

def update!(**args)
  @current_page = args[:current_page] if args.key?(:current_page)
  @diagnostic_info = args[:diagnostic_info] if args.key?(:diagnostic_info)
  @differences = args[:differences] if args.key?(:differences)
  @session_parameters = args[:session_parameters] if args.key?(:session_parameters)
  @status = args[:status] if args.key?(:status)
  @text_responses = args[:text_responses] if args.key?(:text_responses)
  @triggered_intent = args[:triggered_intent] if args.key?(:triggered_intent)
end