Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::Example (v1.11.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Example.

Example represents a sample execution of the playbook in the conversation.

An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#actions

def actions() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::Action>
Returns

#actions=

def actions=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::Action>
Parameter
Returns

#conversation_state

def conversation_state() -> ::Google::Cloud::Dialogflow::CX::V3::OutputState
Returns

#conversation_state=

def conversation_state=(value) -> ::Google::Cloud::Dialogflow::CX::V3::OutputState
Parameter
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. The high level concise description of the example. The max number of characters is 200.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. The high level concise description of the example. The max number of characters is 200.
Returns
  • (::String) — Optional. The high level concise description of the example. The max number of characters is 200.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The display name of the example.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The display name of the example.
Returns
  • (::String) — Required. The display name of the example.

#language_code

def language_code() -> ::String
Returns
  • (::String) — Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents.

#language_code=

def language_code=(value) -> ::String
Parameter
  • value (::String) — Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents.
Returns
  • (::String) — Optional. The language code of the example. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. Note: example's language code is not currently used in dialogflow agents.

#name

def name() -> ::String
Returns
  • (::String) — The unique identifier of the playbook example. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/examples/<ExampleID>.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The unique identifier of the playbook example. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/examples/<ExampleID>.
Returns
  • (::String) — The unique identifier of the playbook example. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/examples/<ExampleID>.

#playbook_input

def playbook_input() -> ::Google::Cloud::Dialogflow::CX::V3::PlaybookInput
Returns

#playbook_input=

def playbook_input=(value) -> ::Google::Cloud::Dialogflow::CX::V3::PlaybookInput
Parameter
Returns

#playbook_output

def playbook_output() -> ::Google::Cloud::Dialogflow::CX::V3::PlaybookOutput
Returns

#playbook_output=

def playbook_output=(value) -> ::Google::Cloud::Dialogflow::CX::V3::PlaybookOutput
Parameter
Returns

#token_count

def token_count() -> ::Integer
Returns
  • (::Integer) — Output only. Estimated number of tokes current example takes when sent to the LLM.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns