- 0.64.0 (latest)
- 0.63.0
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.7
- 0.13.1
- 0.12.1
- 0.11.5
public static final class Playbook.Builder extends GeneratedMessageV3.Builder<Playbook.Builder> implements PlaybookOrBuilderPlaybook 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Playbook.BuilderImplements
PlaybookOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllInputParameterDefinitions(Iterable<? extends ParameterDefinition> values)
public Playbook.Builder addAllInputParameterDefinitions(Iterable<? extends ParameterDefinition> values)Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.ParameterDefinition> |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
addAllOutputParameterDefinitions(Iterable<? extends ParameterDefinition> values)
public Playbook.Builder addAllOutputParameterDefinitions(Iterable<? extends ParameterDefinition> values)Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.ParameterDefinition> |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
addAllReferencedFlows(Iterable<String> values)
public Playbook.Builder addAllReferencedFlows(Iterable<String> values)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The referencedFlows to add. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
addAllReferencedPlaybooks(Iterable<String> values)
public Playbook.Builder addAllReferencedPlaybooks(Iterable<String> values)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The referencedPlaybooks to add. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
addAllReferencedTools(Iterable<String> values)
public Playbook.Builder addAllReferencedTools(Iterable<String> values)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The referencedTools to add. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
addInputParameterDefinitions(ParameterDefinition value)
public Playbook.Builder addInputParameterDefinitions(ParameterDefinition value)Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ParameterDefinition |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
addInputParameterDefinitions(ParameterDefinition.Builder builderForValue)
public Playbook.Builder addInputParameterDefinitions(ParameterDefinition.Builder builderForValue)Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ParameterDefinition.Builder |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
addInputParameterDefinitions(int index, ParameterDefinition value)
public Playbook.Builder addInputParameterDefinitions(int index, ParameterDefinition value)Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ParameterDefinition |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
addInputParameterDefinitions(int index, ParameterDefinition.Builder builderForValue)
public Playbook.Builder addInputParameterDefinitions(int index, ParameterDefinition.Builder builderForValue)Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ParameterDefinition.Builder |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
addInputParameterDefinitionsBuilder()
public ParameterDefinition.Builder addInputParameterDefinitionsBuilder()Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ParameterDefinition.Builder |
|
addInputParameterDefinitionsBuilder(int index)
public ParameterDefinition.Builder addInputParameterDefinitionsBuilder(int index)Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ParameterDefinition.Builder |
|
addOutputParameterDefinitions(ParameterDefinition value)
public Playbook.Builder addOutputParameterDefinitions(ParameterDefinition value)Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ParameterDefinition |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
addOutputParameterDefinitions(ParameterDefinition.Builder builderForValue)
public Playbook.Builder addOutputParameterDefinitions(ParameterDefinition.Builder builderForValue)Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ParameterDefinition.Builder |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
addOutputParameterDefinitions(int index, ParameterDefinition value)
public Playbook.Builder addOutputParameterDefinitions(int index, ParameterDefinition value)Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ParameterDefinition |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
addOutputParameterDefinitions(int index, ParameterDefinition.Builder builderForValue)
public Playbook.Builder addOutputParameterDefinitions(int index, ParameterDefinition.Builder builderForValue)Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ParameterDefinition.Builder |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
addOutputParameterDefinitionsBuilder()
public ParameterDefinition.Builder addOutputParameterDefinitionsBuilder()Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ParameterDefinition.Builder |
|
addOutputParameterDefinitionsBuilder(int index)
public ParameterDefinition.Builder addOutputParameterDefinitionsBuilder(int index)Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ParameterDefinition.Builder |
|
addReferencedFlows(String value)
public Playbook.Builder addReferencedFlows(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe referencedFlows to add. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
addReferencedFlowsBytes(ByteString value)
public Playbook.Builder addReferencedFlowsBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the referencedFlows to add. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
addReferencedPlaybooks(String value)
public Playbook.Builder addReferencedPlaybooks(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe referencedPlaybooks to add. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
addReferencedPlaybooksBytes(ByteString value)
public Playbook.Builder addReferencedPlaybooksBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the referencedPlaybooks to add. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
addReferencedTools(String value)
public Playbook.Builder addReferencedTools(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe referencedTools to add. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
addReferencedToolsBytes(ByteString value)
public Playbook.Builder addReferencedToolsBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the referencedTools to add. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Playbook.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
build()
public Playbook build()| Returns | |
|---|---|
| Type | Description |
Playbook |
|
buildPartial()
public Playbook buildPartial()| Returns | |
|---|---|
| Type | Description |
Playbook |
|
clear()
public Playbook.Builder clear()| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
clearCreateTime()
public Playbook.Builder clearCreateTime()Output only. The timestamp of initial playbook creation.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
clearDisplayName()
public Playbook.Builder clearDisplayName()Required. The human-readable name of the playbook, unique within an agent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Playbook.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
clearGoal()
public Playbook.Builder clearGoal()Required. High level description of the goal the playbook intend to accomplish.
string goal = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
clearInputParameterDefinitions()
public Playbook.Builder clearInputParameterDefinitions()Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
clearInstruction()
public Playbook.Builder clearInstruction()Instruction to accomplish target goal.
.google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
clearLlmModelSettings()
public Playbook.Builder clearLlmModelSettings()Optional. Llm model settings for the playbook.
.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
clearName()
public Playbook.Builder clearName() The unique identifier of the playbook.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/playbooks/<Playbook ID>.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Playbook.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
clearOutputParameterDefinitions()
public Playbook.Builder clearOutputParameterDefinitions()Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
clearReferencedFlows()
public Playbook.Builder clearReferencedFlows()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) = { ... }
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
clearReferencedPlaybooks()
public Playbook.Builder clearReferencedPlaybooks()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) = { ... }
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
clearReferencedTools()
public Playbook.Builder clearReferencedTools()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) = { ... }
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
clearTokenCount()
public Playbook.Builder clearTokenCount()Output only. Estimated number of tokes current playbook takes when sent to the LLM.
int64 token_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
clearUpdateTime()
public Playbook.Builder clearUpdateTime()Output only. Last time the playbook version was updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
clone()
public Playbook.Builder clone()| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
getCreateTime()
public Timestamp getCreateTime()Output only. The timestamp of initial playbook creation.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. The timestamp of initial playbook creation.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. The timestamp of initial playbook creation.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDefaultInstanceForType()
public Playbook getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Playbook |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisplayName()
public String getDisplayName()Required. The human-readable name of the playbook, unique within an agent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()Required. The human-readable name of the playbook, unique within an agent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getGoal()
public String getGoal()Required. High level description of the goal the playbook intend to accomplish.
string goal = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The goal. |
getGoalBytes()
public ByteString getGoalBytes()Required. High level description of the goal the playbook intend to accomplish.
string goal = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for goal. |
getInputParameterDefinitions(int index)
public ParameterDefinition getInputParameterDefinitions(int index)Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ParameterDefinition |
|
getInputParameterDefinitionsBuilder(int index)
public ParameterDefinition.Builder getInputParameterDefinitionsBuilder(int index)Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ParameterDefinition.Builder |
|
getInputParameterDefinitionsBuilderList()
public List<ParameterDefinition.Builder> getInputParameterDefinitionsBuilderList()Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
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];
| Returns | |
|---|---|
| Type | Description |
int |
|
getInputParameterDefinitionsList()
public List<ParameterDefinition> 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];
| Returns | |
|---|---|
| Type | Description |
List<ParameterDefinition> |
|
getInputParameterDefinitionsOrBuilder(int index)
public ParameterDefinitionOrBuilder getInputParameterDefinitionsOrBuilder(int index)Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ParameterDefinitionOrBuilder |
|
getInputParameterDefinitionsOrBuilderList()
public List<? extends ParameterDefinitionOrBuilder> 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];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.dialogflow.cx.v3beta1.ParameterDefinitionOrBuilder> |
|
getInstruction()
public Playbook.Instruction getInstruction()Instruction to accomplish target goal.
.google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
| Returns | |
|---|---|
| Type | Description |
Playbook.Instruction |
The instruction. |
getInstructionBuilder()
public Playbook.Instruction.Builder getInstructionBuilder()Instruction to accomplish target goal.
.google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
| Returns | |
|---|---|
| Type | Description |
Playbook.Instruction.Builder |
|
getInstructionOrBuilder()
public Playbook.InstructionOrBuilder getInstructionOrBuilder()Instruction to accomplish target goal.
.google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
| Returns | |
|---|---|
| Type | Description |
Playbook.InstructionOrBuilder |
|
getLlmModelSettings()
public LlmModelSettings getLlmModelSettings()Optional. Llm model settings for the playbook.
.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LlmModelSettings |
The llmModelSettings. |
getLlmModelSettingsBuilder()
public LlmModelSettings.Builder getLlmModelSettingsBuilder()Optional. Llm model settings for the playbook.
.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LlmModelSettings.Builder |
|
getLlmModelSettingsOrBuilder()
public LlmModelSettingsOrBuilder getLlmModelSettingsOrBuilder()Optional. Llm model settings for the playbook.
.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LlmModelSettingsOrBuilder |
|
getName()
public String getName() The unique identifier of the playbook.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/playbooks/<Playbook ID>.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes() The unique identifier of the playbook.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/playbooks/<Playbook ID>.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getOutputParameterDefinitions(int index)
public ParameterDefinition getOutputParameterDefinitions(int index)Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ParameterDefinition |
|
getOutputParameterDefinitionsBuilder(int index)
public ParameterDefinition.Builder getOutputParameterDefinitionsBuilder(int index)Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ParameterDefinition.Builder |
|
getOutputParameterDefinitionsBuilderList()
public List<ParameterDefinition.Builder> getOutputParameterDefinitionsBuilderList()Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
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];
| Returns | |
|---|---|
| Type | Description |
int |
|
getOutputParameterDefinitionsList()
public List<ParameterDefinition> 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];
| Returns | |
|---|---|
| Type | Description |
List<ParameterDefinition> |
|
getOutputParameterDefinitionsOrBuilder(int index)
public ParameterDefinitionOrBuilder getOutputParameterDefinitionsOrBuilder(int index)Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ParameterDefinitionOrBuilder |
|
getOutputParameterDefinitionsOrBuilderList()
public List<? extends ParameterDefinitionOrBuilder> 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];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.dialogflow.cx.v3beta1.ParameterDefinitionOrBuilder> |
|
getReferencedFlows(int index)
public String getReferencedFlows(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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The referencedFlows at the given index. |
getReferencedFlowsBytes(int index)
public 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the referencedFlows at the given index. |
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) = { ... }
| Returns | |
|---|---|
| Type | Description |
int |
The count of referencedFlows. |
getReferencedFlowsList()
public 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) = { ... }
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the referencedFlows. |
getReferencedPlaybooks(int index)
public String getReferencedPlaybooks(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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The referencedPlaybooks at the given index. |
getReferencedPlaybooksBytes(int index)
public 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the referencedPlaybooks at the given index. |
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) = { ... }
| Returns | |
|---|---|
| Type | Description |
int |
The count of referencedPlaybooks. |
getReferencedPlaybooksList()
public 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) = { ... }
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the referencedPlaybooks. |
getReferencedTools(int index)
public String getReferencedTools(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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The referencedTools at the given index. |
getReferencedToolsBytes(int index)
public 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the referencedTools at the given index. |
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) = { ... }
| Returns | |
|---|---|
| Type | Description |
int |
The count of referencedTools. |
getReferencedToolsList()
public 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) = { ... }
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the referencedTools. |
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];
| Returns | |
|---|---|
| Type | Description |
long |
The tokenCount. |
getUpdateTime()
public Timestamp getUpdateTime()Output only. Last time the playbook version was updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. Last time the playbook version was updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Last time the playbook version was updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasCreateTime()
public boolean hasCreateTime()Output only. The timestamp of initial playbook creation.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasInstruction()
public boolean hasInstruction()Instruction to accomplish target goal.
.google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the instruction field is set. |
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];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the llmModelSettings field is set. |
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];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCreateTime(Timestamp value)
public Playbook.Builder mergeCreateTime(Timestamp value)Output only. The timestamp of initial playbook creation.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
mergeFrom(Playbook other)
public Playbook.Builder mergeFrom(Playbook other)| Parameter | |
|---|---|
| Name | Description |
other |
Playbook |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Playbook.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Playbook.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
mergeInstruction(Playbook.Instruction value)
public Playbook.Builder mergeInstruction(Playbook.Instruction value)Instruction to accomplish target goal.
.google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
| Parameter | |
|---|---|
| Name | Description |
value |
Playbook.Instruction |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
mergeLlmModelSettings(LlmModelSettings value)
public Playbook.Builder mergeLlmModelSettings(LlmModelSettings value)Optional. Llm model settings for the playbook.
.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
LlmModelSettings |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Playbook.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
mergeUpdateTime(Timestamp value)
public Playbook.Builder mergeUpdateTime(Timestamp value)Output only. Last time the playbook version was updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
removeInputParameterDefinitions(int index)
public Playbook.Builder removeInputParameterDefinitions(int index)Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
removeOutputParameterDefinitions(int index)
public Playbook.Builder removeOutputParameterDefinitions(int index)Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
setCreateTime(Timestamp value)
public Playbook.Builder setCreateTime(Timestamp value)Output only. The timestamp of initial playbook creation.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public Playbook.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. The timestamp of initial playbook creation.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
setDisplayName(String value)
public Playbook.Builder setDisplayName(String value)Required. The human-readable name of the playbook, unique within an agent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Playbook.Builder setDisplayNameBytes(ByteString value)Required. The human-readable name of the playbook, unique within an agent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Playbook.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
setGoal(String value)
public Playbook.Builder setGoal(String value)Required. High level description of the goal the playbook intend to accomplish.
string goal = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe goal to set. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
setGoalBytes(ByteString value)
public Playbook.Builder setGoalBytes(ByteString value)Required. High level description of the goal the playbook intend to accomplish.
string goal = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for goal to set. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
setInputParameterDefinitions(int index, ParameterDefinition value)
public Playbook.Builder setInputParameterDefinitions(int index, ParameterDefinition value)Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ParameterDefinition |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
setInputParameterDefinitions(int index, ParameterDefinition.Builder builderForValue)
public Playbook.Builder setInputParameterDefinitions(int index, ParameterDefinition.Builder builderForValue)Optional. Defined structured input parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ParameterDefinition.Builder |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
setInstruction(Playbook.Instruction value)
public Playbook.Builder setInstruction(Playbook.Instruction value)Instruction to accomplish target goal.
.google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
| Parameter | |
|---|---|
| Name | Description |
value |
Playbook.Instruction |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
setInstruction(Playbook.Instruction.Builder builderForValue)
public Playbook.Builder setInstruction(Playbook.Instruction.Builder builderForValue)Instruction to accomplish target goal.
.google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Playbook.Instruction.Builder |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
setLlmModelSettings(LlmModelSettings value)
public Playbook.Builder setLlmModelSettings(LlmModelSettings value)Optional. Llm model settings for the playbook.
.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
LlmModelSettings |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
setLlmModelSettings(LlmModelSettings.Builder builderForValue)
public Playbook.Builder setLlmModelSettings(LlmModelSettings.Builder builderForValue)Optional. Llm model settings for the playbook.
.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
LlmModelSettings.Builder |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
setName(String value)
public Playbook.Builder setName(String value) The unique identifier of the playbook.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/playbooks/<Playbook ID>.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Playbook.Builder setNameBytes(ByteString value) The unique identifier of the playbook.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/playbooks/<Playbook ID>.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
setOutputParameterDefinitions(int index, ParameterDefinition value)
public Playbook.Builder setOutputParameterDefinitions(int index, ParameterDefinition value)Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ParameterDefinition |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
setOutputParameterDefinitions(int index, ParameterDefinition.Builder builderForValue)
public Playbook.Builder setOutputParameterDefinitions(int index, ParameterDefinition.Builder builderForValue)Optional. Defined structured output parameters for this playbook.
repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition output_parameter_definitions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ParameterDefinition.Builder |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
setReferencedFlows(int index, String value)
public Playbook.Builder setReferencedFlows(int index, String value)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) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe referencedFlows to set. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
setReferencedPlaybooks(int index, String value)
public Playbook.Builder setReferencedPlaybooks(int index, String value)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) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe referencedPlaybooks to set. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
setReferencedTools(int index, String value)
public Playbook.Builder setReferencedTools(int index, String value)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) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe referencedTools to set. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Playbook.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
setTokenCount(long value)
public Playbook.Builder setTokenCount(long value)Output only. Estimated number of tokes current playbook takes when sent to the LLM.
int64 token_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe tokenCount to set. |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Playbook.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
setUpdateTime(Timestamp value)
public Playbook.Builder setUpdateTime(Timestamp value)Output only. Last time the playbook version was updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public Playbook.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. Last time the playbook version was updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Playbook.Builder |
|