Class Playbook
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.Playbook
- All Implemented Interfaces:
PlaybookOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class Playbook
extends com.google.protobuf.GeneratedMessage
implements PlaybookOrBuilder
Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.Protobuf type
google.cloud.dialogflow.cx.v3beta1.Playbook- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classPlaybook is the basic building block to instruct the LLM how to execute a certain task.static final classMessage of the Instruction of the playbook.static interfacestatic enumType of the playbook.static final classMessage of single step execution.static interfaceNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanOptional.Optional.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.static Playbookstatic final com.google.protobuf.Descriptors.DescriptorRequired.com.google.protobuf.ByteStringRequired.getGoal()Required.com.google.protobuf.ByteStringRequired.getHandlers(int index) Optional.intOptional.Optional.getHandlersOrBuilder(int index) Optional.List<? extends HandlerOrBuilder>Optional.getInlineActions(int index) Optional.com.google.protobuf.ByteStringgetInlineActionsBytes(int index) Optional.intOptional.com.google.protobuf.ProtocolStringListOptional.getInputParameterDefinitions(int index) Optional.intOptional.Optional.getInputParameterDefinitionsOrBuilder(int index) Optional.List<? extends ParameterDefinitionOrBuilder>Optional.Instruction to accomplish target goal.Instruction to accomplish target goal.Optional.Optional.getName()The unique identifier of the playbook.com.google.protobuf.ByteStringThe unique identifier of the playbook.getOutputParameterDefinitions(int index) Optional.intOptional.Optional.getOutputParameterDefinitionsOrBuilder(int index) Optional.List<? extends ParameterDefinitionOrBuilder>Optional.com.google.protobuf.Parser<Playbook>Optional.intOptional.getReferencedFlows(int index) Output only.com.google.protobuf.ByteStringgetReferencedFlowsBytes(int index) Output only.intOutput only.com.google.protobuf.ProtocolStringListOutput only.getReferencedPlaybooks(int index) Output only.com.google.protobuf.ByteStringgetReferencedPlaybooksBytes(int index) Output only.intOutput only.com.google.protobuf.ProtocolStringListOutput only.getReferencedTools(int index) Optional.com.google.protobuf.ByteStringgetReferencedToolsBytes(int index) Optional.intOptional.com.google.protobuf.ProtocolStringListOptional.intOptional.Optional.longOutput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanOptional.booleanOutput only.inthashCode()booleanInstruction to accomplish target goal.booleanOptional.booleanOptional.booleanOutput only.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic Playbook.Builderstatic Playbook.BuildernewBuilder(Playbook prototype) protected Playbook.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static PlaybookparseDelimitedFrom(InputStream input) static PlaybookparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PlaybookparseFrom(byte[] data) static PlaybookparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PlaybookparseFrom(com.google.protobuf.ByteString data) static PlaybookparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PlaybookparseFrom(com.google.protobuf.CodedInputStream input) static PlaybookparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PlaybookparseFrom(InputStream input) static PlaybookparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PlaybookparseFrom(ByteBuffer data) static PlaybookparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Playbook>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER- See Also:
-
GOAL_FIELD_NUMBER
public static final int GOAL_FIELD_NUMBER- See Also:
-
INPUT_PARAMETER_DEFINITIONS_FIELD_NUMBER
public static final int INPUT_PARAMETER_DEFINITIONS_FIELD_NUMBER- See Also:
-
OUTPUT_PARAMETER_DEFINITIONS_FIELD_NUMBER
public static final int OUTPUT_PARAMETER_DEFINITIONS_FIELD_NUMBER- See Also:
-
INSTRUCTION_FIELD_NUMBER
public static final int INSTRUCTION_FIELD_NUMBER- See Also:
-
TOKEN_COUNT_FIELD_NUMBER
public static final int TOKEN_COUNT_FIELD_NUMBER- See Also:
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER- See Also:
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER- See Also:
-
REFERENCED_PLAYBOOKS_FIELD_NUMBER
public static final int REFERENCED_PLAYBOOKS_FIELD_NUMBER- See Also:
-
REFERENCED_FLOWS_FIELD_NUMBER
public static final int REFERENCED_FLOWS_FIELD_NUMBER- See Also:
-
REFERENCED_TOOLS_FIELD_NUMBER
public static final int REFERENCED_TOOLS_FIELD_NUMBER- See Also:
-
INLINE_ACTIONS_FIELD_NUMBER
public static final int INLINE_ACTIONS_FIELD_NUMBER- See Also:
-
CODE_BLOCK_FIELD_NUMBER
public static final int CODE_BLOCK_FIELD_NUMBER- See Also:
-
LLM_MODEL_SETTINGS_FIELD_NUMBER
public static final int LLM_MODEL_SETTINGS_FIELD_NUMBER- See Also:
-
SPEECH_SETTINGS_FIELD_NUMBER
public static final int SPEECH_SETTINGS_FIELD_NUMBER- See Also:
-
HANDLERS_FIELD_NUMBER
public static final int HANDLERS_FIELD_NUMBER- See Also:
-
PLAYBOOK_TYPE_FIELD_NUMBER
public static final int PLAYBOOK_TYPE_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getName
The unique identifier of the playbook. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
string name = 1;- Specified by:
getNamein interfacePlaybookOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()The unique identifier of the playbook. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
string name = 1;- Specified by:
getNameBytesin interfacePlaybookOrBuilder- Returns:
- The bytes for name.
-
getDisplayName
Required. The human-readable name of the playbook, unique within an agent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getDisplayNamein interfacePlaybookOrBuilder- Returns:
- The displayName.
-
getDisplayNameBytes
public com.google.protobuf.ByteString getDisplayNameBytes()Required. The human-readable name of the playbook, unique within an agent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getDisplayNameBytesin interfacePlaybookOrBuilder- Returns:
- The bytes for displayName.
-
getGoal
Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
string goal = 3 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getGoalin interfacePlaybookOrBuilder- Returns:
- The goal.
-
getGoalBytes
public com.google.protobuf.ByteString getGoalBytes()Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
string goal = 3 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getGoalBytesin interfacePlaybookOrBuilder- Returns:
- The bytes for goal.
-
getInputParameterDefinitionsList
Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getInputParameterDefinitionsListin interfacePlaybookOrBuilder
-
getInputParameterDefinitionsOrBuilderList
Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getInputParameterDefinitionsOrBuilderListin interfacePlaybookOrBuilder
-
getInputParameterDefinitionsCount
public int getInputParameterDefinitionsCount()Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getInputParameterDefinitionsCountin interfacePlaybookOrBuilder
-
getInputParameterDefinitions
Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getInputParameterDefinitionsin interfacePlaybookOrBuilder
-
getInputParameterDefinitionsOrBuilder
Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getInputParameterDefinitionsOrBuilderin interfacePlaybookOrBuilder
-
getOutputParameterDefinitionsList
Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getOutputParameterDefinitionsListin interfacePlaybookOrBuilder
-
getOutputParameterDefinitionsOrBuilderList
Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getOutputParameterDefinitionsOrBuilderListin interfacePlaybookOrBuilder
-
getOutputParameterDefinitionsCount
public int getOutputParameterDefinitionsCount()Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getOutputParameterDefinitionsCountin interfacePlaybookOrBuilder
-
getOutputParameterDefinitions
Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getOutputParameterDefinitionsin interfacePlaybookOrBuilder
-
getOutputParameterDefinitionsOrBuilder
Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getOutputParameterDefinitionsOrBuilderin interfacePlaybookOrBuilder
-
hasInstruction
public boolean hasInstruction()Instruction to accomplish target goal.
.google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;- Specified by:
hasInstructionin interfacePlaybookOrBuilder- Returns:
- Whether the instruction field is set.
-
getInstruction
Instruction to accomplish target goal.
.google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;- Specified by:
getInstructionin interfacePlaybookOrBuilder- Returns:
- The instruction.
-
getInstructionOrBuilder
Instruction to accomplish target goal.
.google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;- Specified by:
getInstructionOrBuilderin interfacePlaybookOrBuilder
-
getTokenCount
public long getTokenCount()Output only. Estimated number of tokes current playbook takes when sent to the LLM.
int64 token_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getTokenCountin interfacePlaybookOrBuilder- Returns:
- The tokenCount.
-
hasCreateTime
public boolean hasCreateTime()Output only. The timestamp of initial playbook creation.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasCreateTimein interfacePlaybookOrBuilder- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.Timestamp getCreateTime()Output only. The timestamp of initial playbook creation.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimein interfacePlaybookOrBuilder- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. The timestamp of initial playbook creation.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimeOrBuilderin interfacePlaybookOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()Output only. Last time the playbook version was updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasUpdateTimein interfacePlaybookOrBuilder- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public com.google.protobuf.Timestamp getUpdateTime()Output only. Last time the playbook version was updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimein interfacePlaybookOrBuilder- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Last time the playbook version was updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimeOrBuilderin interfacePlaybookOrBuilder
-
getReferencedPlaybooksList
public com.google.protobuf.ProtocolStringList getReferencedPlaybooksList()Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
repeated string referenced_playbooks = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getReferencedPlaybooksListin interfacePlaybookOrBuilder- Returns:
- A list containing the referencedPlaybooks.
-
getReferencedPlaybooksCount
public int getReferencedPlaybooksCount()Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
repeated string referenced_playbooks = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getReferencedPlaybooksCountin interfacePlaybookOrBuilder- Returns:
- The count of referencedPlaybooks.
-
getReferencedPlaybooks
Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
repeated string referenced_playbooks = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getReferencedPlaybooksin interfacePlaybookOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The referencedPlaybooks at the given index.
-
getReferencedPlaybooksBytes
public com.google.protobuf.ByteString getReferencedPlaybooksBytes(int index) Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
repeated string referenced_playbooks = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getReferencedPlaybooksBytesin interfacePlaybookOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the referencedPlaybooks at the given index.
-
getReferencedFlowsList
public com.google.protobuf.ProtocolStringList getReferencedFlowsList()Output only. The resource name of flows referenced by the current playbook in the instructions.
repeated string referenced_flows = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getReferencedFlowsListin interfacePlaybookOrBuilder- Returns:
- A list containing the referencedFlows.
-
getReferencedFlowsCount
public int getReferencedFlowsCount()Output only. The resource name of flows referenced by the current playbook in the instructions.
repeated string referenced_flows = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getReferencedFlowsCountin interfacePlaybookOrBuilder- Returns:
- The count of referencedFlows.
-
getReferencedFlows
Output only. The resource name of flows referenced by the current playbook in the instructions.
repeated string referenced_flows = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getReferencedFlowsin interfacePlaybookOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The referencedFlows at the given index.
-
getReferencedFlowsBytes
public com.google.protobuf.ByteString getReferencedFlowsBytes(int index) Output only. The resource name of flows referenced by the current playbook in the instructions.
repeated string referenced_flows = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getReferencedFlowsBytesin interfacePlaybookOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the referencedFlows at the given index.
-
getReferencedToolsList
public com.google.protobuf.ProtocolStringList getReferencedToolsList()Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
repeated string referenced_tools = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Specified by:
getReferencedToolsListin interfacePlaybookOrBuilder- Returns:
- A list containing the referencedTools.
-
getReferencedToolsCount
public int getReferencedToolsCount()Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
repeated string referenced_tools = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Specified by:
getReferencedToolsCountin interfacePlaybookOrBuilder- Returns:
- The count of referencedTools.
-
getReferencedTools
Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
repeated string referenced_tools = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Specified by:
getReferencedToolsin interfacePlaybookOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The referencedTools at the given index.
-
getReferencedToolsBytes
public com.google.protobuf.ByteString getReferencedToolsBytes(int index) Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
repeated string referenced_tools = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Specified by:
getReferencedToolsBytesin interfacePlaybookOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the referencedTools at the given index.
-
getInlineActionsList
public com.google.protobuf.ProtocolStringList getInlineActionsList()Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
repeated string inline_actions = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getInlineActionsListin interfacePlaybookOrBuilder- Returns:
- A list containing the inlineActions.
-
getInlineActionsCount
public int getInlineActionsCount()Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
repeated string inline_actions = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getInlineActionsCountin interfacePlaybookOrBuilder- Returns:
- The count of inlineActions.
-
getInlineActions
Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
repeated string inline_actions = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getInlineActionsin interfacePlaybookOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The inlineActions at the given index.
-
getInlineActionsBytes
public com.google.protobuf.ByteString getInlineActionsBytes(int index) Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
repeated string inline_actions = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getInlineActionsBytesin interfacePlaybookOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the inlineActions at the given index.
-
hasCodeBlock
public boolean hasCodeBlock()Optional. The playbook's scoped code block, which may implement handlers and actions.
.google.cloud.dialogflow.cx.v3beta1.CodeBlock code_block = 21 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasCodeBlockin interfacePlaybookOrBuilder- Returns:
- Whether the codeBlock field is set.
-
getCodeBlock
Optional. The playbook's scoped code block, which may implement handlers and actions.
.google.cloud.dialogflow.cx.v3beta1.CodeBlock code_block = 21 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getCodeBlockin interfacePlaybookOrBuilder- Returns:
- The codeBlock.
-
getCodeBlockOrBuilder
Optional. The playbook's scoped code block, which may implement handlers and actions.
.google.cloud.dialogflow.cx.v3beta1.CodeBlock code_block = 21 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getCodeBlockOrBuilderin interfacePlaybookOrBuilder
-
hasLlmModelSettings
public boolean hasLlmModelSettings()Optional. Llm model settings for the playbook.
.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasLlmModelSettingsin interfacePlaybookOrBuilder- Returns:
- Whether the llmModelSettings field is set.
-
getLlmModelSettings
Optional. Llm model settings for the playbook.
.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getLlmModelSettingsin interfacePlaybookOrBuilder- Returns:
- The llmModelSettings.
-
getLlmModelSettingsOrBuilder
Optional. Llm model settings for the playbook.
.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getLlmModelSettingsOrBuilderin interfacePlaybookOrBuilder
-
hasSpeechSettings
public boolean hasSpeechSettings()Optional. Playbook level Settings for speech to text detection.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings.SpeechSettings speech_settings = 20 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasSpeechSettingsin interfacePlaybookOrBuilder- Returns:
- Whether the speechSettings field is set.
-
getSpeechSettings
Optional. Playbook level Settings for speech to text detection.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings.SpeechSettings speech_settings = 20 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getSpeechSettingsin interfacePlaybookOrBuilder- Returns:
- The speechSettings.
-
getSpeechSettingsOrBuilder
Optional. Playbook level Settings for speech to text detection.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings.SpeechSettings speech_settings = 20 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getSpeechSettingsOrBuilderin interfacePlaybookOrBuilder
-
getHandlersList
Optional. A list of registered handlers to execute based on the specified triggers.
repeated .google.cloud.dialogflow.cx.v3beta1.Handler handlers = 16 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getHandlersListin interfacePlaybookOrBuilder
-
getHandlersOrBuilderList
Optional. A list of registered handlers to execute based on the specified triggers.
repeated .google.cloud.dialogflow.cx.v3beta1.Handler handlers = 16 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getHandlersOrBuilderListin interfacePlaybookOrBuilder
-
getHandlersCount
public int getHandlersCount()Optional. A list of registered handlers to execute based on the specified triggers.
repeated .google.cloud.dialogflow.cx.v3beta1.Handler handlers = 16 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getHandlersCountin interfacePlaybookOrBuilder
-
getHandlers
Optional. A list of registered handlers to execute based on the specified triggers.
repeated .google.cloud.dialogflow.cx.v3beta1.Handler handlers = 16 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getHandlersin interfacePlaybookOrBuilder
-
getHandlersOrBuilder
Optional. A list of registered handlers to execute based on the specified triggers.
repeated .google.cloud.dialogflow.cx.v3beta1.Handler handlers = 16 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getHandlersOrBuilderin interfacePlaybookOrBuilder
-
getPlaybookTypeValue
public int getPlaybookTypeValue()Optional. Type of the playbook.
.google.cloud.dialogflow.cx.v3beta1.Playbook.PlaybookType playbook_type = 19 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getPlaybookTypeValuein interfacePlaybookOrBuilder- Returns:
- The enum numeric value on the wire for playbookType.
-
getPlaybookType
Optional. Type of the playbook.
.google.cloud.dialogflow.cx.v3beta1.Playbook.PlaybookType playbook_type = 19 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getPlaybookTypein interfacePlaybookOrBuilder- Returns:
- The playbookType.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Playbook parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Playbook parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Playbook parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Playbook parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Playbook parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Playbook parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Playbook parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Playbook parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Playbook parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Playbook.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-