public sealed class Example : IMessage<Example>, IEquatable<Example>, IDeepCloneable<Example>, IBufferMessage, IMessageReference documentation and code samples for the Dialogflow v3 API 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.
Namespace
Google.Cloud.Dialogflow.Cx.V3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Constructors
Example()
public Example()Example(Example)
public Example(Example other)| Parameter | |
|---|---|
| Name | Description |
other |
Example |
Properties
Actions
public RepeatedField<Action> Actions { get; }Required. The ordered list of actions performed by the end user and the Dialogflow agent.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldAction |
|
ConversationState
public OutputState ConversationState { get; set; }Required. Example's output state.
| Property Value | |
|---|---|
| Type | Description |
OutputState |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. The timestamp of initial example creation.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Description
public string Description { get; set; }Optional. The high level concise description of the example. The max number of characters is 200.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DisplayName
public string DisplayName { get; set; }Required. The display name of the example.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ExampleName
public ExampleName ExampleName { get; set; }ExampleName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
ExampleName |
|
LanguageCode
public string LanguageCode { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Name
public string Name { get; set; }The unique identifier of the playbook example.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/examples/<ExampleID>.
| Property Value | |
|---|---|
| Type | Description |
string |
|
PlaybookInput
public PlaybookInput PlaybookInput { get; set; }Optional. The input to the playbook in the example.
| Property Value | |
|---|---|
| Type | Description |
PlaybookInput |
|
PlaybookOutput
public PlaybookOutput PlaybookOutput { get; set; }Optional. The output of the playbook in the example.
| Property Value | |
|---|---|
| Type | Description |
PlaybookOutput |
|
TokenCount
public long TokenCount { get; set; }Output only. Estimated number of tokes current example takes when sent to the LLM.
| Property Value | |
|---|---|
| Type | Description |
long |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. Last time the example was updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|