- 0.63.0 (latest)
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.7
- 0.13.1
- 0.12.1
- 0.11.5
public interface AgentOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAdvancedSettings()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
AdvancedSettings |
The advancedSettings. |
getAdvancedSettingsOrBuilder()
public abstract AdvancedSettingsOrBuilder getAdvancedSettingsOrBuilder()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;
| Returns | |
|---|---|
| Type | Description |
AdvancedSettingsOrBuilder |
|
getAnswerFeedbackSettings()
public abstract Agent.AnswerFeedbackSettings getAnswerFeedbackSettings()Optional. Answer feedback collection settings.
.google.cloud.dialogflow.cx.v3beta1.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Agent.AnswerFeedbackSettings |
The answerFeedbackSettings. |
getAnswerFeedbackSettingsOrBuilder()
public abstract Agent.AnswerFeedbackSettingsOrBuilder getAnswerFeedbackSettingsOrBuilder()Optional. Answer feedback collection settings.
.google.cloud.dialogflow.cx.v3beta1.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Agent.AnswerFeedbackSettingsOrBuilder |
|
getAvatarUri()
public abstract String getAvatarUri()The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
string avatar_uri = 7;
| Returns | |
|---|---|
| Type | Description |
String |
The avatarUri. |
getAvatarUriBytes()
public abstract ByteString getAvatarUriBytes()The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
string avatar_uri = 7;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for avatarUri. |
getDefaultLanguageCode()
public abstract String getDefaultLanguageCode()Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
String |
The defaultLanguageCode. |
getDefaultLanguageCodeBytes()
public abstract ByteString getDefaultLanguageCodeBytes()Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for defaultLanguageCode. |
getDescription()
public abstract String getDescription()The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 6;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 6;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDisplayName()
public abstract String getDisplayName()Required. The human-readable name of the agent, unique within the location.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract ByteString getDisplayNameBytes()Required. The human-readable name of the agent, unique within the location.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getEnableMultiLanguageTraining()
public abstract boolean getEnableMultiLanguageTraining()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];
| Returns | |
|---|---|
| Type | Description |
boolean |
The enableMultiLanguageTraining. |
getEnableSpellCorrection()
public abstract boolean getEnableSpellCorrection()Indicates if automatic spell correction is enabled in detect intent requests.
bool enable_spell_correction = 20;
| Returns | |
|---|---|
| Type | Description |
boolean |
The enableSpellCorrection. |
getEnableStackdriverLogging() (deprecated)
public abstract boolean getEnableStackdriverLogging()Deprecated. google.cloud.dialogflow.cx.v3beta1.Agent.enable_stackdriver_logging is deprecated. See google/cloud/dialogflow/cx/v3beta1/agent.proto;l=353
Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
bool enable_stackdriver_logging = 18 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
boolean |
The enableStackdriverLogging. |
getGenAppBuilderSettings()
public abstract Agent.GenAppBuilderSettings getGenAppBuilderSettings()Gen App Builder-related agent-level settings.
optional .google.cloud.dialogflow.cx.v3beta1.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;
| Returns | |
|---|---|
| Type | Description |
Agent.GenAppBuilderSettings |
The genAppBuilderSettings. |
getGenAppBuilderSettingsOrBuilder()
public abstract Agent.GenAppBuilderSettingsOrBuilder getGenAppBuilderSettingsOrBuilder()Gen App Builder-related agent-level settings.
optional .google.cloud.dialogflow.cx.v3beta1.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;
| Returns | |
|---|---|
| Type | Description |
Agent.GenAppBuilderSettingsOrBuilder |
|
getGitIntegrationSettings()
public abstract Agent.GitIntegrationSettings getGitIntegrationSettings()Git integration settings for this agent.
.google.cloud.dialogflow.cx.v3beta1.Agent.GitIntegrationSettings git_integration_settings = 30;
| Returns | |
|---|---|
| Type | Description |
Agent.GitIntegrationSettings |
The gitIntegrationSettings. |
getGitIntegrationSettingsOrBuilder()
public abstract Agent.GitIntegrationSettingsOrBuilder getGitIntegrationSettingsOrBuilder()Git integration settings for this agent.
.google.cloud.dialogflow.cx.v3beta1.Agent.GitIntegrationSettings git_integration_settings = 30;
| Returns | |
|---|---|
| Type | Description |
Agent.GitIntegrationSettingsOrBuilder |
|
getLocked()
public abstract boolean getLocked()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;
| Returns | |
|---|---|
| Type | Description |
boolean |
The locked. |
getName()
public abstract String getName() The unique identifier of the agent.
Required for the
Agents.UpdateAgent
method.
Agents.CreateAgent
populates the name automatically.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes() The unique identifier of the agent.
Required for the
Agents.UpdateAgent
method.
Agents.CreateAgent
populates the name automatically.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getPersonalizationSettings()
public abstract Agent.PersonalizationSettings getPersonalizationSettings()Optional. Settings for end user personalization.
.google.cloud.dialogflow.cx.v3beta1.Agent.PersonalizationSettings personalization_settings = 42 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Agent.PersonalizationSettings |
The personalizationSettings. |
getPersonalizationSettingsOrBuilder()
public abstract Agent.PersonalizationSettingsOrBuilder getPersonalizationSettingsOrBuilder()Optional. Settings for end user personalization.
.google.cloud.dialogflow.cx.v3beta1.Agent.PersonalizationSettings personalization_settings = 42 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Agent.PersonalizationSettingsOrBuilder |
|
getSecuritySettings()
public abstract String getSecuritySettings() Name of the
SecuritySettings
reference for the agent. Format: projects/<Project ID>/locations/<Location
ID>/securitySettings/<Security Settings ID>.
string security_settings = 17 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The securitySettings. |
getSecuritySettingsBytes()
public abstract ByteString getSecuritySettingsBytes() Name of the
SecuritySettings
reference for the agent. Format: projects/<Project ID>/locations/<Location
ID>/securitySettings/<Security Settings ID>.
string security_settings = 17 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for securitySettings. |
getSpeechToTextSettings()
public abstract SpeechToTextSettings getSpeechToTextSettings()Speech recognition related settings.
.google.cloud.dialogflow.cx.v3beta1.SpeechToTextSettings speech_to_text_settings = 13;
| Returns | |
|---|---|
| Type | Description |
SpeechToTextSettings |
The speechToTextSettings. |
getSpeechToTextSettingsOrBuilder()
public abstract SpeechToTextSettingsOrBuilder getSpeechToTextSettingsOrBuilder()Speech recognition related settings.
.google.cloud.dialogflow.cx.v3beta1.SpeechToTextSettings speech_to_text_settings = 13;
| Returns | |
|---|---|
| Type | Description |
SpeechToTextSettingsOrBuilder |
|
getStartFlow()
public abstract String getStartFlow() Immutable. 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>.
string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The startFlow. |
getStartFlowBytes()
public abstract ByteString getStartFlowBytes() Immutable. 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>.
string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for startFlow. |
getStartPlaybook()
public abstract String getStartPlaybook() Optional. 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.
Only one of start_flow or start_playbook should be set, but not both.
string start_playbook = 39 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The startPlaybook. |
getStartPlaybookBytes()
public abstract ByteString getStartPlaybookBytes() Optional. 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.
Only one of start_flow or start_playbook should be set, but not both.
string start_playbook = 39 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for startPlaybook. |
getSupportedLanguageCodes(int index)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The supportedLanguageCodes at the given index. |
getSupportedLanguageCodesBytes(int index)
public abstract ByteString getSupportedLanguageCodesBytes(int index) The list of all languages supported by the agent (except for the
default_language_code).
repeated string supported_language_codes = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the supportedLanguageCodes at the given index. |
getSupportedLanguageCodesCount()
public abstract int getSupportedLanguageCodesCount() The list of all languages supported by the agent (except for the
default_language_code).
repeated string supported_language_codes = 4;
| Returns | |
|---|---|
| Type | Description |
int |
The count of supportedLanguageCodes. |
getSupportedLanguageCodesList()
public abstract List<String> getSupportedLanguageCodesList() The list of all languages supported by the agent (except for the
default_language_code).
repeated string supported_language_codes = 4;
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the supportedLanguageCodes. |
getTextToSpeechSettings()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
TextToSpeechSettings |
The textToSpeechSettings. |
getTextToSpeechSettingsOrBuilder()
public abstract TextToSpeechSettingsOrBuilder getTextToSpeechSettingsOrBuilder()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;
| Returns | |
|---|---|
| Type | Description |
TextToSpeechSettingsOrBuilder |
|
getTimeZone()
public abstract String getTimeZone()Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The timeZone. |
getTimeZoneBytes()
public abstract ByteString getTimeZoneBytes()Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for timeZone. |
hasAdvancedSettings()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the advancedSettings field is set. |
hasAnswerFeedbackSettings()
public abstract boolean hasAnswerFeedbackSettings()Optional. Answer feedback collection settings.
.google.cloud.dialogflow.cx.v3beta1.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the answerFeedbackSettings field is set. |
hasGenAppBuilderSettings()
public abstract boolean hasGenAppBuilderSettings()Gen App Builder-related agent-level settings.
optional .google.cloud.dialogflow.cx.v3beta1.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the genAppBuilderSettings field is set. |
hasGitIntegrationSettings()
public abstract boolean hasGitIntegrationSettings()Git integration settings for this agent.
.google.cloud.dialogflow.cx.v3beta1.Agent.GitIntegrationSettings git_integration_settings = 30;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the gitIntegrationSettings field is set. |
hasPersonalizationSettings()
public abstract boolean hasPersonalizationSettings()Optional. Settings for end user personalization.
.google.cloud.dialogflow.cx.v3beta1.Agent.PersonalizationSettings personalization_settings = 42 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the personalizationSettings field is set. |
hasSpeechToTextSettings()
public abstract boolean hasSpeechToTextSettings()Speech recognition related settings.
.google.cloud.dialogflow.cx.v3beta1.SpeechToTextSettings speech_to_text_settings = 13;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the speechToTextSettings field is set. |
hasTextToSpeechSettings()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the textToSpeechSettings field is set. |