com.google.cloud.dialogflow.cx.v3beta1.GeneratorOrBuilder 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
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/generator.proto

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

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

  /**
   *
   *
   *    * The unique identifier of the generator.
   * Must be set for the
   * [Generators.UpdateGenerator][google.cloud.dialogflow.cx.v3beta1.Generators.UpdateGenerator]
   * method. [Generators.CreateGenerate][] populates the name automatically.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generators/<GeneratorID>`.
   * 
   *
   * string name = 1;
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * The unique identifier of the generator.
   * Must be set for the
   * [Generators.UpdateGenerator][google.cloud.dialogflow.cx.v3beta1.Generators.UpdateGenerator]
   * method. [Generators.CreateGenerate][] populates the name automatically.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generators/<GeneratorID>`.
   * 
   *
   * string name = 1;
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Required. The human-readable name of the generator, unique within the
   * agent. The prompt contains pre-defined parameters such as $conversation,
   * $last-user-utterance, etc. populated by Dialogflow. It can also contain
   * custom placeholders which will be resolved during fulfillment.
   * 
   *
   * string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The displayName.
   */
  java.lang.String getDisplayName();
  /**
   *
   *
   *    * Required. The human-readable name of the generator, unique within the
   * agent. The prompt contains pre-defined parameters such as $conversation,
   * $last-user-utterance, etc. populated by Dialogflow. It can also contain
   * custom placeholders which will be resolved during fulfillment.
   * 
   *
   * string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   *    * Required. Prompt for the LLM model.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return Whether the promptText field is set.
   */
  boolean hasPromptText();
  /**
   *
   *
   *    * Required. Prompt for the LLM model.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The promptText.
   */
  com.google.cloud.dialogflow.cx.v3beta1.Phrase getPromptText();
  /**
   *
   *
   *    * Required. Prompt for the LLM model.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.PhraseOrBuilder getPromptTextOrBuilder();

  /**
   *
   *
   *    * Optional. List of custom placeholders in the prompt text.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3beta1.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  java.util.List
      getPlaceholdersList();
  /**
   *
   *
   *    * Optional. List of custom placeholders in the prompt text.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3beta1.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.Generator.Placeholder getPlaceholders(int index);
  /**
   *
   *
   *    * Optional. List of custom placeholders in the prompt text.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3beta1.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  int getPlaceholdersCount();
  /**
   *
   *
   *    * Optional. List of custom placeholders in the prompt text.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3beta1.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  java.util.List
      getPlaceholdersOrBuilderList();
  /**
   *
   *
   *    * Optional. List of custom placeholders in the prompt text.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3beta1.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.Generator.PlaceholderOrBuilder getPlaceholdersOrBuilder(
      int index);

  /**
   *
   *
   *    * The LLM model settings.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 9;
   *
   * @return Whether the llmModelSettings field is set.
   */
  boolean hasLlmModelSettings();
  /**
   *
   *
   *    * The LLM model settings.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 9;
   *
   * @return The llmModelSettings.
   */
  com.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings getLlmModelSettings();
  /**
   *
   *
   *    * The LLM model settings.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 9;
   */
  com.google.cloud.dialogflow.cx.v3beta1.LlmModelSettingsOrBuilder getLlmModelSettingsOrBuilder();

  /**
   *
   *
   *    * Parameters passed to the LLM to configure its behavior.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Generator.ModelParameter model_parameter = 8;
   *
   * @return Whether the modelParameter field is set.
   */
  boolean hasModelParameter();
  /**
   *
   *
   *    * Parameters passed to the LLM to configure its behavior.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Generator.ModelParameter model_parameter = 8;
   *
   * @return The modelParameter.
   */
  com.google.cloud.dialogflow.cx.v3beta1.Generator.ModelParameter getModelParameter();
  /**
   *
   *
   *    * Parameters passed to the LLM to configure its behavior.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Generator.ModelParameter model_parameter = 8;
   */
  com.google.cloud.dialogflow.cx.v3beta1.Generator.ModelParameterOrBuilder
      getModelParameterOrBuilder();
}