com.google.cloud.dialogflow.v2.AgentOrBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-v2 Show documentation
PROTO library for proto-google-cloud-dialogflow-v2
There is a newer version: 4.55.0
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/dialogflow/v2/agent.proto

package com.google.cloud.dialogflow.v2;

public interface AgentOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2.Agent)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Required. The project of this agent.
   * Format: `projects/<Project ID>`.
   * 
   *
   * string parent = 1;
   */
  java.lang.String getParent();
  /**
   *    * Required. The project of this agent.
   * Format: `projects/<Project ID>`.
   * 
   *
   * string parent = 1;
   */
  com.google.protobuf.ByteString
      getParentBytes();

  /**
   *    * Required. The name of this agent.
   * 
   *
   * string display_name = 2;
   */
  java.lang.String getDisplayName();
  /**
   *    * Required. The name of this agent.
   * 
   *
   * string display_name = 2;
   */
  com.google.protobuf.ByteString
      getDisplayNameBytes();

  /**
   *    * Required. The default language of the agent as a language tag. See
   * [Language Support](https://dialogflow.com/docs/reference/language) for a
   * list of the currently supported language codes.
   * This field cannot be set by the `Update` method.
   * 
   *
   * string default_language_code = 3;
   */
  java.lang.String getDefaultLanguageCode();
  /**
   *    * Required. The default language of the agent as a language tag. See
   * [Language Support](https://dialogflow.com/docs/reference/language) for a
   * list of the currently supported language codes.
   * This field cannot be set by the `Update` method.
   * 
   *
   * string default_language_code = 3;
   */
  com.google.protobuf.ByteString
      getDefaultLanguageCodeBytes();

  /**
   *    * Optional. The list of all languages supported by this agent (except for the
   * `default_language_code`).
   * 
   *
   * repeated string supported_language_codes = 4;
   */
  java.util.List
      getSupportedLanguageCodesList();
  /**
   *    * Optional. The list of all languages supported by this agent (except for the
   * `default_language_code`).
   * 
   *
   * repeated string supported_language_codes = 4;
   */
  int getSupportedLanguageCodesCount();
  /**
   *    * Optional. The list of all languages supported by this agent (except for the
   * `default_language_code`).
   * 
   *
   * repeated string supported_language_codes = 4;
   */
  java.lang.String getSupportedLanguageCodes(int index);
  /**
   *    * Optional. The list of all languages supported by this agent (except for the
   * `default_language_code`).
   * 
   *
   * repeated string supported_language_codes = 4;
   */
  com.google.protobuf.ByteString
      getSupportedLanguageCodesBytes(int index);

  /**
   *    * Required. The time zone of this agent from the
   * [time zone database](https://www.iana.org/time-zones), e.g.,
   * America/New_York, Europe/Paris.
   * 
   *
   * string time_zone = 5;
   */
  java.lang.String getTimeZone();
  /**
   *    * Required. The time zone of this agent from the
   * [time zone database](https://www.iana.org/time-zones), e.g.,
   * America/New_York, Europe/Paris.
   * 
   *
   * string time_zone = 5;
   */
  com.google.protobuf.ByteString
      getTimeZoneBytes();

  /**
   *    * Optional. The description of this agent.
   * The maximum length is 500 characters. If exceeded, the request is rejected.
   * 
   *
   * string description = 6;
   */
  java.lang.String getDescription();
  /**
   *    * Optional. The description of this agent.
   * The maximum length is 500 characters. If exceeded, the request is rejected.
   * 
   *
   * string description = 6;
   */
  com.google.protobuf.ByteString
      getDescriptionBytes();

  /**
   *    * Optional. The URI of the agent's avatar.
   * Avatars are used throughout the Dialogflow console and in the self-hosted
   * [Web Demo](https://dialogflow.com/docs/integrations/web-demo) integration.
   * 
   *
   * string avatar_uri = 7;
   */
  java.lang.String getAvatarUri();
  /**
   *    * Optional. The URI of the agent's avatar.
   * Avatars are used throughout the Dialogflow console and in the self-hosted
   * [Web Demo](https://dialogflow.com/docs/integrations/web-demo) integration.
   * 
   *
   * string avatar_uri = 7;
   */
  com.google.protobuf.ByteString
      getAvatarUriBytes();

  /**
   *    * Optional. Determines whether this agent should log conversation queries.
   * 
   *
   * bool enable_logging = 8;
   */
  boolean getEnableLogging();

  /**
   *    * Optional. Determines how intents are detected from user queries.
   * 
   *
   * .google.cloud.dialogflow.v2.Agent.MatchMode match_mode = 9;
   */
  int getMatchModeValue();
  /**
   *    * Optional. Determines how intents are detected from user queries.
   * 
   *
   * .google.cloud.dialogflow.v2.Agent.MatchMode match_mode = 9;
   */
  com.google.cloud.dialogflow.v2.Agent.MatchMode getMatchMode();

  /**
   *    * Optional. To filter out false positive results and still get variety in
   * matched natural language inputs for your agent, you can tune the machine
   * learning classification threshold. If the returned score value is less than
   * the threshold value, then a fallback intent is be triggered or, if there
   * are no fallback intents defined, no intent will be triggered. The score
   * values range from 0.0 (completely uncertain) to 1.0 (completely certain).
   * If set to 0.0, the default of 0.3 is used.
   * 
   *
   * float classification_threshold = 10;
   */
  float getClassificationThreshold();
}