com.google.cloud.dialogflow.cx.v3beta1.AgentOrBuilder 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
/*
* 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/agent.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.cx.v3beta1;
public interface AgentOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.Agent)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The unique identifier of the agent.
* Required for the
* [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3beta1.Agents.UpdateAgent]
* method.
* [Agents.CreateAgent][google.cloud.dialogflow.cx.v3beta1.Agents.CreateAgent]
* populates the name automatically.
* Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
*
*
* string name = 1;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* The unique identifier of the agent.
* Required for the
* [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3beta1.Agents.UpdateAgent]
* method.
* [Agents.CreateAgent][google.cloud.dialogflow.cx.v3beta1.Agents.CreateAgent]
* populates the name automatically.
* Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
*
*
* string name = 1;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Required. The human-readable name of the agent, unique within the location.
*
*
* string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* Required. The human-readable name of the agent, unique within the location.
*
*
* string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* Required. Immutable. The default language of the agent as a language tag.
* See [Language
* Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
* for a list of the currently supported language codes.
* This field cannot be set by the
* [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3beta1.Agents.UpdateAgent]
* method.
*
*
*
* string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The defaultLanguageCode.
*/
java.lang.String getDefaultLanguageCode();
/**
*
*
*
* Required. Immutable. The default language of the agent as a language tag.
* See [Language
* Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
* for a list of the currently supported language codes.
* This field cannot be set by the
* [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3beta1.Agents.UpdateAgent]
* method.
*
*
*
* string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The bytes for defaultLanguageCode.
*/
com.google.protobuf.ByteString getDefaultLanguageCodeBytes();
/**
*
*
*
* The list of all languages supported by the agent (except for the
* `default_language_code`).
*
*
* repeated string supported_language_codes = 4;
*
* @return A list containing the supportedLanguageCodes.
*/
java.util.List getSupportedLanguageCodesList();
/**
*
*
*
* The list of all languages supported by the agent (except for the
* `default_language_code`).
*
*
* repeated string supported_language_codes = 4;
*
* @return The count of supportedLanguageCodes.
*/
int getSupportedLanguageCodesCount();
/**
*
*
*
* The list of all languages supported by the agent (except for the
* `default_language_code`).
*
*
* repeated string supported_language_codes = 4;
*
* @param index The index of the element to return.
* @return The supportedLanguageCodes at the given index.
*/
java.lang.String getSupportedLanguageCodes(int index);
/**
*
*
*
* The list of all languages supported by the agent (except for the
* `default_language_code`).
*
*
* repeated string supported_language_codes = 4;
*
* @param index The index of the value to return.
* @return The bytes of the supportedLanguageCodes at the given index.
*/
com.google.protobuf.ByteString getSupportedLanguageCodesBytes(int index);
/**
*
*
*
* Required. The time zone of the agent from the [time zone
* database](https://www.iana.org/time-zones), e.g., America/New_York,
* Europe/Paris.
*
*
* string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];
*
* @return The timeZone.
*/
java.lang.String getTimeZone();
/**
*
*
*
* Required. The time zone of the agent from the [time zone
* database](https://www.iana.org/time-zones), e.g., America/New_York,
* Europe/Paris.
*
*
* string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for timeZone.
*/
com.google.protobuf.ByteString getTimeZoneBytes();
/**
*
*
*
* The description of the agent. The maximum length is 500 characters. If
* exceeded, the request is rejected.
*
*
* string description = 6;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* The description of the agent. The maximum length is 500 characters. If
* exceeded, the request is rejected.
*
*
* string description = 6;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* The URI of the agent's avatar. Avatars are used throughout the Dialogflow
* console and in the self-hosted [Web
* Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
* integration.
*
*
* string avatar_uri = 7;
*
* @return The avatarUri.
*/
java.lang.String getAvatarUri();
/**
*
*
*
* The URI of the agent's avatar. Avatars are used throughout the Dialogflow
* console and in the self-hosted [Web
* Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
* integration.
*
*
* string avatar_uri = 7;
*
* @return The bytes for avatarUri.
*/
com.google.protobuf.ByteString getAvatarUriBytes();
/**
*
*
*
* Speech recognition related settings.
*
*
* .google.cloud.dialogflow.cx.v3beta1.SpeechToTextSettings speech_to_text_settings = 13;
*
*
* @return Whether the speechToTextSettings field is set.
*/
boolean hasSpeechToTextSettings();
/**
*
*
*
* Speech recognition related settings.
*
*
* .google.cloud.dialogflow.cx.v3beta1.SpeechToTextSettings speech_to_text_settings = 13;
*
*
* @return The speechToTextSettings.
*/
com.google.cloud.dialogflow.cx.v3beta1.SpeechToTextSettings getSpeechToTextSettings();
/**
*
*
*
* Speech recognition related settings.
*
*
* .google.cloud.dialogflow.cx.v3beta1.SpeechToTextSettings speech_to_text_settings = 13;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.SpeechToTextSettingsOrBuilder
getSpeechToTextSettingsOrBuilder();
/**
*
*
*
* Name of the start flow in this agent. A start flow will be automatically
* created when the agent is created, and can only be deleted by deleting
* the agent.
* Format: `projects/<Project ID>/locations/<Location
* ID>/agents/<Agent ID>/flows/<Flow ID>`. Currently only the default start
* flow with id "00000000-0000-0000-0000-000000000000" is allowed.
*
*
* string start_flow = 16 [(.google.api.resource_reference) = { ... }
*
* @return Whether the startFlow field is set.
*/
boolean hasStartFlow();
/**
*
*
*
* Name of the start flow in this agent. A start flow will be automatically
* created when the agent is created, and can only be deleted by deleting
* the agent.
* Format: `projects/<Project ID>/locations/<Location
* ID>/agents/<Agent ID>/flows/<Flow ID>`. Currently only the default start
* flow with id "00000000-0000-0000-0000-000000000000" is allowed.
*
*
* string start_flow = 16 [(.google.api.resource_reference) = { ... }
*
* @return The startFlow.
*/
java.lang.String getStartFlow();
/**
*
*
*
* Name of the start flow in this agent. A start flow will be automatically
* created when the agent is created, and can only be deleted by deleting
* the agent.
* Format: `projects/<Project ID>/locations/<Location
* ID>/agents/<Agent ID>/flows/<Flow ID>`. Currently only the default start
* flow with id "00000000-0000-0000-0000-000000000000" is allowed.
*
*
* string start_flow = 16 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for startFlow.
*/
com.google.protobuf.ByteString getStartFlowBytes();
/**
*
*
*
* Name of the start playbook in this agent. A start playbook will be
* automatically created when the agent is created, and can only be deleted
* by deleting the agent.
* Format: `projects/<Project ID>/locations/<Location
* ID>/agents/<Agent ID>/playbooks/<Playbook ID>`. Currently only the
* default playbook with id
* "00000000-0000-0000-0000-000000000000" is allowed.
*
*
* string start_playbook = 39 [(.google.api.resource_reference) = { ... }
*
* @return Whether the startPlaybook field is set.
*/
boolean hasStartPlaybook();
/**
*
*
*
* Name of the start playbook in this agent. A start playbook will be
* automatically created when the agent is created, and can only be deleted
* by deleting the agent.
* Format: `projects/<Project ID>/locations/<Location
* ID>/agents/<Agent ID>/playbooks/<Playbook ID>`. Currently only the
* default playbook with id
* "00000000-0000-0000-0000-000000000000" is allowed.
*
*
* string start_playbook = 39 [(.google.api.resource_reference) = { ... }
*
* @return The startPlaybook.
*/
java.lang.String getStartPlaybook();
/**
*
*
*
* Name of the start playbook in this agent. A start playbook will be
* automatically created when the agent is created, and can only be deleted
* by deleting the agent.
* Format: `projects/<Project ID>/locations/<Location
* ID>/agents/<Agent ID>/playbooks/<Playbook ID>`. Currently only the
* default playbook with id
* "00000000-0000-0000-0000-000000000000" is allowed.
*
*
* string start_playbook = 39 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for startPlaybook.
*/
com.google.protobuf.ByteString getStartPlaybookBytes();
/**
*
*
*
* Name of the
* [SecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettings]
* reference for the agent. Format: `projects/<Project ID>/locations/<Location
* ID>/securitySettings/<Security Settings ID>`.
*
*
* string security_settings = 17 [(.google.api.resource_reference) = { ... }
*
* @return The securitySettings.
*/
java.lang.String getSecuritySettings();
/**
*
*
*
* Name of the
* [SecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettings]
* reference for the agent. Format: `projects/<Project ID>/locations/<Location
* ID>/securitySettings/<Security Settings ID>`.
*
*
* string security_settings = 17 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for securitySettings.
*/
com.google.protobuf.ByteString getSecuritySettingsBytes();
/**
*
*
*
* Indicates if stackdriver logging is enabled for the agent.
* Please use
* [agent.advanced_settings][google.cloud.dialogflow.cx.v3beta1.AdvancedSettings.LoggingSettings]
* instead.
*
*
* bool enable_stackdriver_logging = 18 [deprecated = true];
*
* @deprecated google.cloud.dialogflow.cx.v3beta1.Agent.enable_stackdriver_logging is deprecated.
* See google/cloud/dialogflow/cx/v3beta1/agent.proto;l=352
* @return The enableStackdriverLogging.
*/
@java.lang.Deprecated
boolean getEnableStackdriverLogging();
/**
*
*
*
* Indicates if automatic spell correction is enabled in detect intent
* requests.
*
*
* bool enable_spell_correction = 20;
*
* @return The enableSpellCorrection.
*/
boolean getEnableSpellCorrection();
/**
*
*
*
* Optional. Enable training multi-lingual models for this agent. These models
* will be trained on all the languages supported by the agent.
*
*
* bool enable_multi_language_training = 40 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The enableMultiLanguageTraining.
*/
boolean getEnableMultiLanguageTraining();
/**
*
*
*
* Indicates whether the agent is locked for changes. If the agent is locked,
* modifications to the agent will be rejected except for [RestoreAgent][].
*
*
* bool locked = 27;
*
* @return The locked.
*/
boolean getLocked();
/**
*
*
*
* Hierarchical advanced settings for this agent. The settings exposed at the
* lower level overrides the settings exposed at the higher level.
*
*
* .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 22;
*
* @return Whether the advancedSettings field is set.
*/
boolean hasAdvancedSettings();
/**
*
*
*
* Hierarchical advanced settings for this agent. The settings exposed at the
* lower level overrides the settings exposed at the higher level.
*
*
* .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 22;
*
* @return The advancedSettings.
*/
com.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings getAdvancedSettings();
/**
*
*
*
* Hierarchical advanced settings for this agent. The settings exposed at the
* lower level overrides the settings exposed at the higher level.
*
*
* .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 22;
*/
com.google.cloud.dialogflow.cx.v3beta1.AdvancedSettingsOrBuilder getAdvancedSettingsOrBuilder();
/**
*
*
*
* Git integration settings for this agent.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.Agent.GitIntegrationSettings git_integration_settings = 30;
*
*
* @return Whether the gitIntegrationSettings field is set.
*/
boolean hasGitIntegrationSettings();
/**
*
*
*
* Git integration settings for this agent.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.Agent.GitIntegrationSettings git_integration_settings = 30;
*
*
* @return The gitIntegrationSettings.
*/
com.google.cloud.dialogflow.cx.v3beta1.Agent.GitIntegrationSettings getGitIntegrationSettings();
/**
*
*
*
* Git integration settings for this agent.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.Agent.GitIntegrationSettings git_integration_settings = 30;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.Agent.GitIntegrationSettingsOrBuilder
getGitIntegrationSettingsOrBuilder();
/**
*
*
*
* Settings on instructing the speech synthesizer on how to generate the
* output audio content.
*
*
* .google.cloud.dialogflow.cx.v3beta1.TextToSpeechSettings text_to_speech_settings = 31;
*
*
* @return Whether the textToSpeechSettings field is set.
*/
boolean hasTextToSpeechSettings();
/**
*
*
*
* Settings on instructing the speech synthesizer on how to generate the
* output audio content.
*
*
* .google.cloud.dialogflow.cx.v3beta1.TextToSpeechSettings text_to_speech_settings = 31;
*
*
* @return The textToSpeechSettings.
*/
com.google.cloud.dialogflow.cx.v3beta1.TextToSpeechSettings getTextToSpeechSettings();
/**
*
*
*
* Settings on instructing the speech synthesizer on how to generate the
* output audio content.
*
*
* .google.cloud.dialogflow.cx.v3beta1.TextToSpeechSettings text_to_speech_settings = 31;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.TextToSpeechSettingsOrBuilder
getTextToSpeechSettingsOrBuilder();
/**
*
*
*
* Gen App Builder-related agent-level settings.
*
*
*
* optional .google.cloud.dialogflow.cx.v3beta1.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;
*
*
* @return Whether the genAppBuilderSettings field is set.
*/
boolean hasGenAppBuilderSettings();
/**
*
*
*
* Gen App Builder-related agent-level settings.
*
*
*
* optional .google.cloud.dialogflow.cx.v3beta1.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;
*
*
* @return The genAppBuilderSettings.
*/
com.google.cloud.dialogflow.cx.v3beta1.Agent.GenAppBuilderSettings getGenAppBuilderSettings();
/**
*
*
*
* Gen App Builder-related agent-level settings.
*
*
*
* optional .google.cloud.dialogflow.cx.v3beta1.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.Agent.GenAppBuilderSettingsOrBuilder
getGenAppBuilderSettingsOrBuilder();
/**
*
*
*
* Optional. Answer feedback collection settings.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the answerFeedbackSettings field is set.
*/
boolean hasAnswerFeedbackSettings();
/**
*
*
*
* Optional. Answer feedback collection settings.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The answerFeedbackSettings.
*/
com.google.cloud.dialogflow.cx.v3beta1.Agent.AnswerFeedbackSettings getAnswerFeedbackSettings();
/**
*
*
*
* Optional. Answer feedback collection settings.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dialogflow.cx.v3beta1.Agent.AnswerFeedbackSettingsOrBuilder
getAnswerFeedbackSettingsOrBuilder();
/**
*
*
*
* Optional. Settings for end user personalization.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.Agent.PersonalizationSettings personalization_settings = 42 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the personalizationSettings field is set.
*/
boolean hasPersonalizationSettings();
/**
*
*
*
* Optional. Settings for end user personalization.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.Agent.PersonalizationSettings personalization_settings = 42 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The personalizationSettings.
*/
com.google.cloud.dialogflow.cx.v3beta1.Agent.PersonalizationSettings getPersonalizationSettings();
/**
*
*
*
* Optional. Settings for end user personalization.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.Agent.PersonalizationSettings personalization_settings = 42 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dialogflow.cx.v3beta1.Agent.PersonalizationSettingsOrBuilder
getPersonalizationSettingsOrBuilder();
com.google.cloud.dialogflow.cx.v3beta1.Agent.SessionEntryResourceCase
getSessionEntryResourceCase();
}