Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page

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

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Page

Returns a new instance of GoogleCloudDialogflowCxV3Page.



2931
2932
2933
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2931

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

Instance Attribute Details

#display_name ⇒ String

Required. The human-readable name of the page, unique within the agent. Corresponds to the JSON property displayName

Returns:

  • (String) 


2874
2875
2876
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2874

def display_name
  @display_name
end

#entry_fulfillment ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Fulfillment

A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. Corresponds to the JSON property entryFulfillment

Returns:



2885
2886
2887
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2885

def entry_fulfillment
  @entry_fulfillment
end

#event_handlers ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EventHandler>

Handlers associated with the page to handle events such as webhook errors, no match or no input. Corresponds to the JSON property eventHandlers

Returns:



2891
2892
2893
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2891

def event_handlers
  @event_handlers
end

#form ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Form

A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. Corresponds to the JSON property form

Returns:



2900
2901
2902
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2900

def form
  @form
end

#name ⇒ String

The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: projects// locations//agents//flows//pages/. Corresponds to the JSON property name

Returns:

  • (String) 


2907
2908
2909
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2907

def name
  @name
end

#transition_route_groups ⇒ Array<String>

Ordered list of TransitionRouteGroups associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format: projects//locations//agents//flows//transitionRouteGroups/. Corresponds to the JSON property transitionRouteGroups

Returns:

  • (Array<String>) 


2918
2919
2920
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2918

def transition_route_groups
  @transition_route_groups
end

#transition_routes ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRoute>

A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the page with only condition specified. Corresponds to the JSON property transitionRoutes

Returns:



2929
2930
2931
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2929

def transition_routes
  @transition_routes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2936
2937
2938
2939
2940
2941
2942
2943
2944
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2936

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @entry_fulfillment = args[:entry_fulfillment] if args.key?(:entry_fulfillment)
  @event_handlers = args[:event_handlers] if args.key?(:event_handlers)
  @form = args[:form] if args.key?(:form)
  @name = args[:name] if args.key?(:name)
  @transition_route_groups = args[:transition_route_groups] if args.key?(:transition_route_groups)
  @transition_routes = args[:transition_routes] if args.key?(:transition_routes)
end