Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class 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.
Generated from protobuf message google.cloud.dialogflow.cx.v3.Example
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
The unique identifier of the playbook example. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/examples/<ExampleID>
.
↳ playbook_input
↳ playbook_output
↳ actions
array< Action
>
Required. The ordered list of actions performed by the end user and the Dialogflow agent.
↳ display_name
string
Required. The display name of the example.
↳ description
string
Optional. The high level concise description of the example. The max number of characters is 200.
↳ token_count
int|string
Output only. Estimated number of tokes current example takes when sent to the LLM.
↳ create_time
↳ update_time
↳ conversation_state
int
Required. Example's output state.
↳ language_code
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.
getName
The unique identifier of the playbook example.
Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/examples/<ExampleID>
.
string
setName
The unique identifier of the playbook example.
Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/examples/<ExampleID>
.
var
string
$this
getPlaybookInput
Optional. The input to the playbook in the example.
hasPlaybookInput
clearPlaybookInput
setPlaybookInput
Optional. The input to the playbook in the example.
$this
getPlaybookOutput
Optional. The output of the playbook in the example.
hasPlaybookOutput
clearPlaybookOutput
setPlaybookOutput
Optional. The output of the playbook in the example.
$this
getActions
Required. The ordered list of actions performed by the end user and the Dialogflow agent.
setActions
Required. The ordered list of actions performed by the end user and the Dialogflow agent.
$this
getDisplayName
Required. The display name of the example.
string
setDisplayName
Required. The display name of the example.
var
string
$this
getDescription
Optional. The high level concise description of the example. The max number of characters is 200.
string
setDescription
Optional. The high level concise description of the example. The max number of characters is 200.
var
string
$this
getTokenCount
Output only. Estimated number of tokes current example takes when sent to the LLM.
int|string
setTokenCount
Output only. Estimated number of tokes current example takes when sent to the LLM.
var
int|string
$this
getCreateTime
Output only. The timestamp of initial example creation.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp of initial example creation.
$this
getUpdateTime
Output only. Last time the example was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Last time the example was updated.
$this
getConversationState
Required. Example's output state.
setConversationState
Required. Example's output state.
$this
getLanguageCode
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.
string
setLanguageCode
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.
var
string
$this
