• Home
• com.google.api.grpc
• proto-google-cloud-dialogflow-cx-v3beta1
• 0.65.0
• source code
• ExampleOrBuilder.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.cloud.dialogflow.cx.v3beta1.ExampleOrBuilder Maven / Gradle / Ivy

/*
 * 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/example.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.cx.v3beta1;

public interface ExampleOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.Example)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * 
   * The unique identifier of the playbook example.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/examples/<ExampleID>`.
   * 
   *
   * string name = 1;
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   * 
   * The unique identifier of the playbook example.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/examples/<ExampleID>`.
   * 
   *
   * string name = 1;
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   * 
   * Optional. The input to the playbook in the example.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 3 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return Whether the playbookInput field is set.
   */
  boolean hasPlaybookInput();
  /**
   *
   *
   * 
   * Optional. The input to the playbook in the example.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 3 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The playbookInput.
   */
  com.google.cloud.dialogflow.cx.v3beta1.PlaybookInput getPlaybookInput();
  /**
   *
   *
   * 
   * Optional. The input to the playbook in the example.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.PlaybookInput playbook_input = 3 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.PlaybookInputOrBuilder getPlaybookInputOrBuilder();

  /**
   *
   *
   * 
   * Optional. The output of the playbook in the example.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 4 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return Whether the playbookOutput field is set.
   */
  boolean hasPlaybookOutput();
  /**
   *
   *
   * 
   * Optional. The output of the playbook in the example.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 4 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The playbookOutput.
   */
  com.google.cloud.dialogflow.cx.v3beta1.PlaybookOutput getPlaybookOutput();
  /**
   *
   *
   * 
   * Optional. The output of the playbook in the example.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.PlaybookOutput playbook_output = 4 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.PlaybookOutputOrBuilder getPlaybookOutputOrBuilder();

  /**
   *
   *
   * 
   * Required. The ordered list of actions performed by the end user and the
   * Dialogflow agent.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  java.util.List getActionsList();
  /**
   *
   *
   * 
   * Required. The ordered list of actions performed by the end user and the
   * Dialogflow agent.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.Action getActions(int index);
  /**
   *
   *
   * 
   * Required. The ordered list of actions performed by the end user and the
   * Dialogflow agent.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  int getActionsCount();
  /**
   *
   *
   * 
   * Required. The ordered list of actions performed by the end user and the
   * Dialogflow agent.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  java.util.List
      getActionsOrBuilderList();
  /**
   *
   *
   * 
   * Required. The ordered list of actions performed by the end user and the
   * Dialogflow agent.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.ActionOrBuilder getActionsOrBuilder(int index);

  /**
   *
   *
   * 
   * Required. The display name of the example.
   * 
   *
   * string display_name = 6 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The displayName.
   */
  java.lang.String getDisplayName();
  /**
   *
   *
   * 
   * Required. The display name of the example.
   * 
   *
   * string display_name = 6 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   * 
   * Optional. The high level concise description of the example. The max number
   * of characters is 200.
   * 
   *
   * string description = 8 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *
   *
   * 
   * Optional. The high level concise description of the example. The max number
   * of characters is 200.
   * 
   *
   * string description = 8 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString getDescriptionBytes();

  /**
   *
   *
   * 
   * Output only. Estimated number of tokes current example takes when sent to
   * the LLM.
   * 
   *
   * int64 token_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The tokenCount.
   */
  long getTokenCount();

  /**
   *
   *
   * 
   * Output only. The timestamp of initial example creation.
   * 
   *
   * .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the createTime field is set.
   */
  boolean hasCreateTime();
  /**
   *
   *
   * 
   * Output only. The timestamp of initial example creation.
   * 
   *
   * .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The createTime.
   */
  com.google.protobuf.Timestamp getCreateTime();
  /**
   *
   *
   * 
   * Output only. The timestamp of initial example creation.
   * 
   *
   * .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();

  /**
   *
   *
   * 
   * Output only. Last time the example was updated.
   * 
   *
   * .google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the updateTime field is set.
   */
  boolean hasUpdateTime();
  /**
   *
   *
   * 
   * Output only. Last time the example was updated.
   * 
   *
   * .google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The updateTime.
   */
  com.google.protobuf.Timestamp getUpdateTime();
  /**
   *
   *
   * 
   * Output only. Last time the example was updated.
   * 
   *
   * .google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();

  /**
   *
   *
   * 
   * Required. Example's output state.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.OutputState conversation_state = 12 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The enum numeric value on the wire for conversationState.
   */
  int getConversationStateValue();
  /**
   *
   *
   * 
   * Required. Example's output state.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.OutputState conversation_state = 12 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The conversationState.
   */
  com.google.cloud.dialogflow.cx.v3beta1.OutputState getConversationState();

  /**
   *
   *
   * 
   * Optional. The language code of the example.
   * If not specified, the agent's default language is used.
   * Note: languages must be enabled in the agent before they can be used.
   * Note: example's language code is not currently used in dialogflow agents.
   * 
   *
   * string language_code = 13 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The languageCode.
   */
  java.lang.String getLanguageCode();
  /**
   *
   *
   * 
   * Optional. The language code of the example.
   * If not specified, the agent's default language is used.
   * Note: languages must be enabled in the agent before they can be used.
   * Note: example's language code is not currently used in dialogflow agents.
   * 
   *
   * string language_code = 13 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for languageCode.
   */
  com.google.protobuf.ByteString getLanguageCodeBytes();
}