public final class Example extends GeneratedMessageV3 implements ExampleOrBuilder
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.
Protobuf type google.cloud.dialogflow.cx.v3beta1.Example
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ACTIONS_FIELD_NUMBER
public static final int ACTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONVERSATION_STATE_FIELD_NUMBER
public static final int CONVERSATION_STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LANGUAGE_CODE_FIELD_NUMBER
public static final int LANGUAGE_CODE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PLAYBOOK_INPUT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PLAYBOOK_OUTPUT_FIELD_NUMBER
public static final int PLAYBOOK_OUTPUT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TOKEN_COUNT_FIELD_NUMBER
public static final int TOKEN_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Example getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Example.Builder newBuilder()
newBuilder(Example prototype)
public static Example.Builder newBuilder(Example prototype)
| Parameter |
| Name |
Description |
prototype |
Example
|
public static Example parseDelimitedFrom(InputStream input)
public static Example parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Example parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Example parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Example parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Example parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Example parseFrom(CodedInputStream input)
public static Example parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Example parseFrom(InputStream input)
public static Example parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Example parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Example parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Example> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getActions(int index)
public Action getActions(int index)
Required. The ordered list of actions performed by the end user and the
Dialogflow agent.
repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
index |
int
|
| Returns |
| Type |
Description |
Action |
|
getActionsCount()
public int getActionsCount()
Required. The ordered list of actions performed by the end user and the
Dialogflow agent.
repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
int |
|
getActionsList()
public List<Action> getActionsList()
Required. The ordered list of actions performed by the end user and the
Dialogflow agent.
repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];
getActionsOrBuilder(int index)
public ActionOrBuilder getActionsOrBuilder(int index)
Required. The ordered list of actions performed by the end user and the
Dialogflow agent.
repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
index |
int
|
getActionsOrBuilderList()
public List<? extends ActionOrBuilder> getActionsOrBuilderList()
Required. The ordered list of actions performed by the end user and the
Dialogflow agent.
repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.dialogflow.cx.v3beta1.ActionOrBuilder> |
|
getConversationState()
public OutputState getConversationState()
Required. Example's output state.
.google.cloud.dialogflow.cx.v3beta1.OutputState conversation_state = 12 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
OutputState |
The conversationState.
|
getConversationStateValue()
public int getConversationStateValue()
Required. Example's output state.
.google.cloud.dialogflow.cx.v3beta1.OutputState conversation_state = 12 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for conversationState.
|
getCreateTime()
public Timestamp getCreateTime()
Output only. The timestamp of initial example creation.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp of initial example creation.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Example getDefaultInstanceForType()
getDescription()
public String getDescription()
Optional. The high level concise description of the example. The max number
of characters is 200.
string description = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. The high level concise description of the example. The max number
of characters is 200.
string description = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getDisplayName()
public String getDisplayName()
Required. The display name of the example.
string display_name = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Required. The display name of the example.
string display_name = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getLanguageCode()
public String 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 language_code = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The languageCode.
|
getLanguageCodeBytes()
public ByteString getLanguageCodeBytes()
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 language_code = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for languageCode.
|
getName()
The unique identifier of the playbook example.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/examples/<ExampleID>.
string name = 1;
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
The unique identifier of the playbook example.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/examples/<ExampleID>.
string name = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<Example> getParserForType()
Overrides
public PlaybookInput getPlaybookInput()
Optional. The input to the playbook in the example.
.google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 3 [(.google.api.field_behavior) = OPTIONAL];
public PlaybookInputOrBuilder getPlaybookInputOrBuilder()
Optional. The input to the playbook in the example.
.google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 3 [(.google.api.field_behavior) = OPTIONAL];
getPlaybookOutput()
public PlaybookOutput getPlaybookOutput()
Optional. The output of the playbook in the example.
.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 4 [(.google.api.field_behavior) = OPTIONAL];
getPlaybookOutputOrBuilder()
public PlaybookOutputOrBuilder getPlaybookOutputOrBuilder()
Optional. The output of the playbook in the example.
.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 4 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTokenCount()
public long getTokenCount()
Output only. Estimated number of tokes current example takes when sent to
the LLM.
int64 token_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
long |
The tokenCount.
|
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Last time the example was updated.
.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Last time the example was updated.
.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. The timestamp of initial example creation.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
public boolean hasPlaybookInput()
Optional. The input to the playbook in the example.
.google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the playbookInput field is set.
|
hasPlaybookOutput()
public boolean hasPlaybookOutput()
Optional. The output of the playbook in the example.
.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the playbookOutput field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. Last time the example was updated.
.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Example.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Example.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Example.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
