public interface AgentOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
AdvancedSettings |
getAdvancedSettings()
Hierarchical advanced settings for this agent.
|
AdvancedSettingsOrBuilder |
getAdvancedSettingsOrBuilder()
Hierarchical advanced settings for this agent.
|
Agent.AnswerFeedbackSettings |
getAnswerFeedbackSettings()
Optional.
|
Agent.AnswerFeedbackSettingsOrBuilder |
getAnswerFeedbackSettingsOrBuilder()
Optional.
|
String |
getAvatarUri()
The URI of the agent's avatar.
|
com.google.protobuf.ByteString |
getAvatarUriBytes()
The URI of the agent's avatar.
|
BigQueryExportSettings |
getBigqueryExportSettings()
Optional.
|
BigQueryExportSettingsOrBuilder |
getBigqueryExportSettingsOrBuilder()
Optional.
|
Agent.ClientCertificateSettings |
getClientCertificateSettings()
Optional.
|
Agent.ClientCertificateSettingsOrBuilder |
getClientCertificateSettingsOrBuilder()
Optional.
|
String |
getDefaultLanguageCode()
Required.
|
com.google.protobuf.ByteString |
getDefaultLanguageCodeBytes()
Required.
|
String |
getDescription()
The description of the agent.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
The description of the agent.
|
String |
getDisplayName()
Required.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Required.
|
boolean |
getEnableMultiLanguageTraining()
Optional.
|
boolean |
getEnableSpellCorrection()
Indicates if automatic spell correction is enabled in detect intent
requests.
|
boolean |
getEnableStackdriverLogging()
Deprecated.
google.cloud.dialogflow.cx.v3beta1.Agent.enable_stackdriver_logging is deprecated.
See google/cloud/dialogflow/cx/v3beta1/agent.proto;l=414
|
Agent.GenAppBuilderSettings |
getGenAppBuilderSettings()
Gen App Builder-related agent-level settings.
|
Agent.GenAppBuilderSettingsOrBuilder |
getGenAppBuilderSettingsOrBuilder()
Gen App Builder-related agent-level settings.
|
Agent.GitIntegrationSettings |
getGitIntegrationSettings()
Git integration settings for this agent.
|
Agent.GitIntegrationSettingsOrBuilder |
getGitIntegrationSettingsOrBuilder()
Git integration settings for this agent.
|
boolean |
getLocked()
Indicates whether the agent is locked for changes.
|
String |
getName()
The unique identifier of the agent.
|
com.google.protobuf.ByteString |
getNameBytes()
The unique identifier of the agent.
|
Agent.PersonalizationSettings |
getPersonalizationSettings()
Optional.
|
Agent.PersonalizationSettingsOrBuilder |
getPersonalizationSettingsOrBuilder()
Optional.
|
boolean |
getSatisfiesPzi()
Optional.
|
boolean |
getSatisfiesPzs()
Optional.
|
String |
getSecuritySettings()
Name of the
[SecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettings]
reference for the agent.
|
com.google.protobuf.ByteString |
getSecuritySettingsBytes()
Name of the
[SecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettings]
reference for the agent.
|
Agent.SessionEntryResourceCase |
getSessionEntryResourceCase() |
SpeechToTextSettings |
getSpeechToTextSettings()
Speech recognition related settings.
|
SpeechToTextSettingsOrBuilder |
getSpeechToTextSettingsOrBuilder()
Speech recognition related settings.
|
String |
getStartFlow()
Name of the start flow in this agent.
|
com.google.protobuf.ByteString |
getStartFlowBytes()
Name of the start flow in this agent.
|
String |
getStartPlaybook()
Name of the start playbook in this agent.
|
com.google.protobuf.ByteString |
getStartPlaybookBytes()
Name of the start playbook in this agent.
|
String |
getSupportedLanguageCodes(int index)
The list of all languages supported by the agent (except for the
`default_language_code`).
|
com.google.protobuf.ByteString |
getSupportedLanguageCodesBytes(int index)
The list of all languages supported by the agent (except for the
`default_language_code`).
|
int |
getSupportedLanguageCodesCount()
The list of all languages supported by the agent (except for the
`default_language_code`).
|
List<String> |
getSupportedLanguageCodesList()
The list of all languages supported by the agent (except for the
`default_language_code`).
|
TextToSpeechSettings |
getTextToSpeechSettings()
Settings on instructing the speech synthesizer on how to generate the
output audio content.
|
TextToSpeechSettingsOrBuilder |
getTextToSpeechSettingsOrBuilder()
Settings on instructing the speech synthesizer on how to generate the
output audio content.
|
String |
getTimeZone()
Required.
|
com.google.protobuf.ByteString |
getTimeZoneBytes()
Required.
|
boolean |
hasAdvancedSettings()
Hierarchical advanced settings for this agent.
|
boolean |
hasAnswerFeedbackSettings()
Optional.
|
boolean |
hasBigqueryExportSettings()
Optional.
|
boolean |
hasClientCertificateSettings()
Optional.
|
boolean |
hasGenAppBuilderSettings()
Gen App Builder-related agent-level settings.
|
boolean |
hasGitIntegrationSettings()
Git integration settings for this agent.
|
boolean |
hasPersonalizationSettings()
Optional.
|
boolean |
hasSatisfiesPzi()
Optional.
|
boolean |
hasSatisfiesPzs()
Optional.
|
boolean |
hasSpeechToTextSettings()
Speech recognition related settings.
|
boolean |
hasStartFlow()
Name of the start flow in this agent.
|
boolean |
hasStartPlaybook()
Name of the start playbook in this agent.
|
boolean |
hasTextToSpeechSettings()
Settings on instructing the speech synthesizer on how to generate the
output audio content.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofString 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
string name = 1;com.google.protobuf.ByteString getNameBytes()
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/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
string name = 1;String getDisplayName()
Required. The human-readable name of the agent, unique within the location.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];com.google.protobuf.ByteString getDisplayNameBytes()
Required. The human-readable name of the agent, unique within the location.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];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];
com.google.protobuf.ByteString getDefaultLanguageCodeBytes()
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];
List<String> getSupportedLanguageCodesList()
The list of all languages supported by the agent (except for the `default_language_code`).
repeated string supported_language_codes = 4;int getSupportedLanguageCodesCount()
The list of all languages supported by the agent (except for the `default_language_code`).
repeated string supported_language_codes = 4;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;index - The index of the element to return.com.google.protobuf.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;index - The index of the value to return.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];com.google.protobuf.ByteString getTimeZoneBytes()
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];String getDescription()
The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 6;com.google.protobuf.ByteString getDescriptionBytes()
The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 6;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;com.google.protobuf.ByteString getAvatarUriBytes()
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;boolean hasSpeechToTextSettings()
Speech recognition related settings.
.google.cloud.dialogflow.cx.v3beta1.SpeechToTextSettings speech_to_text_settings = 13;
SpeechToTextSettings getSpeechToTextSettings()
Speech recognition related settings.
.google.cloud.dialogflow.cx.v3beta1.SpeechToTextSettings speech_to_text_settings = 13;
SpeechToTextSettingsOrBuilder getSpeechToTextSettingsOrBuilder()
Speech recognition related settings.
.google.cloud.dialogflow.cx.v3beta1.SpeechToTextSettings speech_to_text_settings = 13;
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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.
string start_flow = 16 [(.google.api.resource_reference) = { ... }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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.
string start_flow = 16 [(.google.api.resource_reference) = { ... }com.google.protobuf.ByteString getStartFlowBytes()
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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.
string start_flow = 16 [(.google.api.resource_reference) = { ... }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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
string start_playbook = 39 [(.google.api.resource_reference) = { ... }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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
string start_playbook = 39 [(.google.api.resource_reference) = { ... }com.google.protobuf.ByteString getStartPlaybookBytes()
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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
string start_playbook = 39 [(.google.api.resource_reference) = { ... }String getSecuritySettings()
Name of the [SecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettings] reference for the agent. Format: `projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>`.
string security_settings = 17 [(.google.api.resource_reference) = { ... }com.google.protobuf.ByteString getSecuritySettingsBytes()
Name of the [SecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettings] reference for the agent. Format: `projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>`.
string security_settings = 17 [(.google.api.resource_reference) = { ... }@Deprecated boolean getEnableStackdriverLogging()
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];boolean getEnableSpellCorrection()
Indicates if automatic spell correction is enabled in detect intent requests.
bool enable_spell_correction = 20;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];
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;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;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;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;boolean hasGitIntegrationSettings()
Git integration settings for this agent.
.google.cloud.dialogflow.cx.v3beta1.Agent.GitIntegrationSettings git_integration_settings = 30;
Agent.GitIntegrationSettings getGitIntegrationSettings()
Git integration settings for this agent.
.google.cloud.dialogflow.cx.v3beta1.Agent.GitIntegrationSettings git_integration_settings = 30;
Agent.GitIntegrationSettingsOrBuilder getGitIntegrationSettingsOrBuilder()
Git integration settings for this agent.
.google.cloud.dialogflow.cx.v3beta1.Agent.GitIntegrationSettings git_integration_settings = 30;
boolean hasBigqueryExportSettings()
Optional. The BigQuery export settings for this agent. The conversation data will be exported to BigQuery tables if it is enabled. By default, BigQuery export settings will not be exported with agent. You need to set [include_bigquery_export_settings][google.cloud.dialogflow.cx.v3beta1.ExportAgentRequest.include_bigquery_export_settings] to include it in the exported agent.
.google.cloud.dialogflow.cx.v3beta1.BigQueryExportSettings bigquery_export_settings = 29 [(.google.api.field_behavior) = OPTIONAL];
BigQueryExportSettings getBigqueryExportSettings()
Optional. The BigQuery export settings for this agent. The conversation data will be exported to BigQuery tables if it is enabled. By default, BigQuery export settings will not be exported with agent. You need to set [include_bigquery_export_settings][google.cloud.dialogflow.cx.v3beta1.ExportAgentRequest.include_bigquery_export_settings] to include it in the exported agent.
.google.cloud.dialogflow.cx.v3beta1.BigQueryExportSettings bigquery_export_settings = 29 [(.google.api.field_behavior) = OPTIONAL];
BigQueryExportSettingsOrBuilder getBigqueryExportSettingsOrBuilder()
Optional. The BigQuery export settings for this agent. The conversation data will be exported to BigQuery tables if it is enabled. By default, BigQuery export settings will not be exported with agent. You need to set [include_bigquery_export_settings][google.cloud.dialogflow.cx.v3beta1.ExportAgentRequest.include_bigquery_export_settings] to include it in the exported agent.
.google.cloud.dialogflow.cx.v3beta1.BigQueryExportSettings bigquery_export_settings = 29 [(.google.api.field_behavior) = OPTIONAL];
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;
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;
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;
boolean hasGenAppBuilderSettings()
Gen App Builder-related agent-level settings.
optional .google.cloud.dialogflow.cx.v3beta1.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;
Agent.GenAppBuilderSettings getGenAppBuilderSettings()
Gen App Builder-related agent-level settings.
optional .google.cloud.dialogflow.cx.v3beta1.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;
Agent.GenAppBuilderSettingsOrBuilder getGenAppBuilderSettingsOrBuilder()
Gen App Builder-related agent-level settings.
optional .google.cloud.dialogflow.cx.v3beta1.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;
boolean hasAnswerFeedbackSettings()
Optional. Answer feedback collection settings.
.google.cloud.dialogflow.cx.v3beta1.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];
Agent.AnswerFeedbackSettings getAnswerFeedbackSettings()
Optional. Answer feedback collection settings.
.google.cloud.dialogflow.cx.v3beta1.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];
Agent.AnswerFeedbackSettingsOrBuilder getAnswerFeedbackSettingsOrBuilder()
Optional. Answer feedback collection settings.
.google.cloud.dialogflow.cx.v3beta1.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];
boolean hasPersonalizationSettings()
Optional. Settings for end user personalization.
.google.cloud.dialogflow.cx.v3beta1.Agent.PersonalizationSettings personalization_settings = 42 [(.google.api.field_behavior) = OPTIONAL];
Agent.PersonalizationSettings getPersonalizationSettings()
Optional. Settings for end user personalization.
.google.cloud.dialogflow.cx.v3beta1.Agent.PersonalizationSettings personalization_settings = 42 [(.google.api.field_behavior) = OPTIONAL];
Agent.PersonalizationSettingsOrBuilder getPersonalizationSettingsOrBuilder()
Optional. Settings for end user personalization.
.google.cloud.dialogflow.cx.v3beta1.Agent.PersonalizationSettings personalization_settings = 42 [(.google.api.field_behavior) = OPTIONAL];
boolean hasClientCertificateSettings()
Optional. Settings for custom client certificates.
.google.cloud.dialogflow.cx.v3beta1.Agent.ClientCertificateSettings client_certificate_settings = 43 [(.google.api.field_behavior) = OPTIONAL];
Agent.ClientCertificateSettings getClientCertificateSettings()
Optional. Settings for custom client certificates.
.google.cloud.dialogflow.cx.v3beta1.Agent.ClientCertificateSettings client_certificate_settings = 43 [(.google.api.field_behavior) = OPTIONAL];
Agent.ClientCertificateSettingsOrBuilder getClientCertificateSettingsOrBuilder()
Optional. Settings for custom client certificates.
.google.cloud.dialogflow.cx.v3beta1.Agent.ClientCertificateSettings client_certificate_settings = 43 [(.google.api.field_behavior) = OPTIONAL];
boolean hasSatisfiesPzs()
Optional. Output only. A read only boolean field reflecting Zone Separation status of the agent.
optional bool satisfies_pzs = 45 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
boolean getSatisfiesPzs()
Optional. Output only. A read only boolean field reflecting Zone Separation status of the agent.
optional bool satisfies_pzs = 45 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
boolean hasSatisfiesPzi()
Optional. Output only. A read only boolean field reflecting Zone Isolation status of the agent.
optional bool satisfies_pzi = 46 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
boolean getSatisfiesPzi()
Optional. Output only. A read only boolean field reflecting Zone Isolation status of the agent.
optional bool satisfies_pzi = 46 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
Agent.SessionEntryResourceCase getSessionEntryResourceCase()
Copyright © 2025 Google LLC. All rights reserved.