Class Example (1.36.0)

Example(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

Attributes

Name Description
name str
The unique identifier of the playbook example. Format: projects/.
playbook_input google.cloud.dialogflowcx_v3beta1.types.PlaybookInput
Optional. The input to the playbook in the example.
playbook_output google.cloud.dialogflowcx_v3beta1.types.PlaybookOutput
Optional. The output of the playbook in the example.
actions MutableSequence[google.cloud.dialogflowcx_v3beta1.types.Action]
Required. The ordered list of actions performed by the end user and the Dialogflow agent.
display_name str
Required. The display name of the example.
description str
Optional. The high level concise description of the example. The max number of characters is 200.
token_count int
Output only. Estimated number of tokes current example takes when sent to the LLM.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The timestamp of initial example creation.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. Last time the example was updated.
conversation_state google.cloud.dialogflowcx_v3beta1.types.OutputState
Required. Example's output state.
language_code str
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.