com.google.cloud.dialogflow.cx.v3beta1.PlaybookOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-cx-v3beta1 Show documentation
Show all versions of proto-google-cloud-dialogflow-cx-v3beta1 Show documentation
PROTO library for proto-google-cloud-dialogflow-cx-v3beta1
The newest version!
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dialogflow/cx/v3beta1/playbook.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.cx.v3beta1;
public interface PlaybookOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.Playbook)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The unique identifier of the playbook.
* Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
*
*
* string name = 1;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* The unique identifier of the playbook.
* Format:
* `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
*
*
* string name = 1;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Required. The human-readable name of the playbook, unique within an agent.
*
*
* string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* Required. The human-readable name of the playbook, unique within an agent.
*
*
* string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* Required. High level description of the goal the playbook intend to
* accomplish.
*
*
* string goal = 3 [(.google.api.field_behavior) = REQUIRED];
*
* @return The goal.
*/
java.lang.String getGoal();
/**
*
*
*
* Required. High level description of the goal the playbook intend to
* accomplish.
*
*
* string goal = 3 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for goal.
*/
com.google.protobuf.ByteString getGoalBytes();
/**
*
*
*
* Optional. Defined structured input parameters for this playbook.
*
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.ParameterDefinition input_parameter_definitions = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List
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];
*
*/
com.google.cloud.dialogflow.cx.v3beta1.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];
*
*/
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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.dialogflow.cx.v3beta1.ParameterDefinitionOrBuilder
getInputParameterDefinitionsOrBuilder(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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.dialogflow.cx.v3beta1.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];
*
*/
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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.dialogflow.cx.v3beta1.ParameterDefinitionOrBuilder
getOutputParameterDefinitionsOrBuilder(int index);
/**
*
*
*
* Instruction to accomplish target goal.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
*
* @return Whether the instruction field is set.
*/
boolean hasInstruction();
/**
*
*
*
* Instruction to accomplish target goal.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
*
* @return The instruction.
*/
com.google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction getInstruction();
/**
*
*
*
* Instruction to accomplish target goal.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Playbook.Instruction instruction = 17;
*/
com.google.cloud.dialogflow.cx.v3beta1.Playbook.InstructionOrBuilder getInstructionOrBuilder();
/**
*
*
*
* Output only. Estimated number of tokes current playbook takes when sent to
* the LLM.
*
*
* int64 token_count = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The tokenCount.
*/
long getTokenCount();
/**
*
*
*
* Output only. The timestamp of initial playbook creation.
*
*
* .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The timestamp of initial playbook creation.
*
*
* .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. Last time the playbook version was updated.
*
*
* .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. Last time the playbook version was updated.
*
*
* .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* 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) = { ... }
*
*
* @return A list containing the referencedPlaybooks.
*/
java.util.List 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) = { ... }
*
*
* @return The count of referencedPlaybooks.
*/
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) = { ... }
*
*
* @param index The index of the element to return.
* @return The referencedPlaybooks at the given index.
*/
java.lang.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) = { ... }
*
*
* @param index The index of the value to return.
* @return The bytes of the referencedPlaybooks at the given index.
*/
com.google.protobuf.ByteString getReferencedPlaybooksBytes(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) = { ... }
*
*
* @return A list containing the referencedFlows.
*/
java.util.List 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) = { ... }
*
*
* @return The count of referencedFlows.
*/
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) = { ... }
*
*
* @param index The index of the element to return.
* @return The referencedFlows at the given index.
*/
java.lang.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) = { ... }
*
*
* @param index The index of the value to return.
* @return The bytes of the referencedFlows at the given index.
*/
com.google.protobuf.ByteString getReferencedFlowsBytes(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) = { ... }
*
*
* @return A list containing the referencedTools.
*/
java.util.List 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) = { ... }
*
*
* @return The count of referencedTools.
*/
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) = { ... }
*
*
* @param index The index of the element to return.
* @return The referencedTools at the given index.
*/
java.lang.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) = { ... }
*
*
* @param index The index of the value to return.
* @return The bytes of the referencedTools at the given index.
*/
com.google.protobuf.ByteString getReferencedToolsBytes(int index);
/**
*
*
*
* Optional. Llm model settings for the playbook.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the llmModelSettings field is set.
*/
boolean hasLlmModelSettings();
/**
*
*
*
* Optional. Llm model settings for the playbook.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The llmModelSettings.
*/
com.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings getLlmModelSettings();
/**
*
*
*
* Optional. Llm model settings for the playbook.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dialogflow.cx.v3beta1.LlmModelSettingsOrBuilder getLlmModelSettingsOrBuilder();
}