com.google.cloud.dialogflow.v2.IntentOrBuilder 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-v2 Show documentation
Show all versions of proto-google-cloud-dialogflow-v2 Show documentation
PROTO library for proto-google-cloud-dialogflow-v2
/*
* 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/v2/intent.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.dialogflow.v2;
public interface IntentOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2.Intent)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Optional. The unique identifier of this intent.
* Required for
* [Intents.UpdateIntent][google.cloud.dialogflow.v2.Intents.UpdateIntent] and
* [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2.Intents.BatchUpdateIntents]
* methods.
* Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*
*
* string name = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Optional. The unique identifier of this intent.
* Required for
* [Intents.UpdateIntent][google.cloud.dialogflow.v2.Intents.UpdateIntent] and
* [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2.Intents.BatchUpdateIntents]
* methods.
* Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*
*
* string name = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Required. The name of this intent.
*
*
* string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* Required. The name of this intent.
*
*
* string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* Optional. Indicates whether webhooks are enabled for the intent.
*
*
*
* .google.cloud.dialogflow.v2.Intent.WebhookState webhook_state = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The enum numeric value on the wire for webhookState.
*/
int getWebhookStateValue();
/**
*
*
*
* Optional. Indicates whether webhooks are enabled for the intent.
*
*
*
* .google.cloud.dialogflow.v2.Intent.WebhookState webhook_state = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The webhookState.
*/
com.google.cloud.dialogflow.v2.Intent.WebhookState getWebhookState();
/**
*
*
*
* Optional. The priority of this intent. Higher numbers represent higher
* priorities.
*
* - If the supplied value is unspecified or 0, the service
* translates the value to 500,000, which corresponds to the
* `Normal` priority in the console.
* - If the supplied value is negative, the intent is ignored
* in runtime detect intent requests.
*
*
* int32 priority = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The priority.
*/
int getPriority();
/**
*
*
*
* Optional. Indicates whether this is a fallback intent.
*
*
* bool is_fallback = 4 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The isFallback.
*/
boolean getIsFallback();
/**
*
*
*
* Optional. Indicates whether Machine Learning is disabled for the intent.
* Note: If `ml_disabled` setting is set to true, then this intent is not
* taken into account during inference in `ML ONLY` match mode. Also,
* auto-markup in the UI is turned off.
*
*
* bool ml_disabled = 19 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The mlDisabled.
*/
boolean getMlDisabled();
/**
*
*
*
* Optional. Indicates that a live agent should be brought in to handle the
* interaction with the user. In most cases, when you set this flag to true,
* you would also want to set end_interaction to true as well. Default is
* false.
*
*
* bool live_agent_handoff = 20 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The liveAgentHandoff.
*/
boolean getLiveAgentHandoff();
/**
*
*
*
* Optional. Indicates that this intent ends an interaction. Some integrations
* (e.g., Actions on Google or Dialogflow phone gateway) use this information
* to close interaction with an end user. Default is false.
*
*
* bool end_interaction = 21 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The endInteraction.
*/
boolean getEndInteraction();
/**
*
*
*
* Optional. The list of context names required for this intent to be
* triggered.
* Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
*
*
* repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @return A list containing the inputContextNames.
*/
java.util.List getInputContextNamesList();
/**
*
*
*
* Optional. The list of context names required for this intent to be
* triggered.
* Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
*
*
* repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The count of inputContextNames.
*/
int getInputContextNamesCount();
/**
*
*
*
* Optional. The list of context names required for this intent to be
* triggered.
* Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
*
*
* repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @param index The index of the element to return.
* @return The inputContextNames at the given index.
*/
java.lang.String getInputContextNames(int index);
/**
*
*
*
* Optional. The list of context names required for this intent to be
* triggered.
* Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
*
*
* repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @param index The index of the value to return.
* @return The bytes of the inputContextNames at the given index.
*/
com.google.protobuf.ByteString getInputContextNamesBytes(int index);
/**
*
*
*
* Optional. The collection of event names that trigger the intent.
* If the collection of input contexts is not empty, all of the contexts must
* be present in the active user session for an event to trigger this intent.
* Event names are limited to 150 characters.
*
*
* repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];
*
* @return A list containing the events.
*/
java.util.List getEventsList();
/**
*
*
*
* Optional. The collection of event names that trigger the intent.
* If the collection of input contexts is not empty, all of the contexts must
* be present in the active user session for an event to trigger this intent.
* Event names are limited to 150 characters.
*
*
* repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The count of events.
*/
int getEventsCount();
/**
*
*
*
* Optional. The collection of event names that trigger the intent.
* If the collection of input contexts is not empty, all of the contexts must
* be present in the active user session for an event to trigger this intent.
* Event names are limited to 150 characters.
*
*
* repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];
*
* @param index The index of the element to return.
* @return The events at the given index.
*/
java.lang.String getEvents(int index);
/**
*
*
*
* Optional. The collection of event names that trigger the intent.
* If the collection of input contexts is not empty, all of the contexts must
* be present in the active user session for an event to trigger this intent.
* Event names are limited to 150 characters.
*
*
* repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];
*
* @param index The index of the value to return.
* @return The bytes of the events at the given index.
*/
com.google.protobuf.ByteString getEventsBytes(int index);
/**
*
*
*
* Optional. The collection of examples that the agent is
* trained on.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List getTrainingPhrasesList();
/**
*
*
*
* Optional. The collection of examples that the agent is
* trained on.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dialogflow.v2.Intent.TrainingPhrase getTrainingPhrases(int index);
/**
*
*
*
* Optional. The collection of examples that the agent is
* trained on.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];
*
*/
int getTrainingPhrasesCount();
/**
*
*
*
* Optional. The collection of examples that the agent is
* trained on.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List
getTrainingPhrasesOrBuilderList();
/**
*
*
*
* Optional. The collection of examples that the agent is
* trained on.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dialogflow.v2.Intent.TrainingPhraseOrBuilder getTrainingPhrasesOrBuilder(
int index);
/**
*
*
*
* Optional. The name of the action associated with the intent.
* Note: The action name must not contain whitespaces.
*
*
* string action = 10 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The action.
*/
java.lang.String getAction();
/**
*
*
*
* Optional. The name of the action associated with the intent.
* Note: The action name must not contain whitespaces.
*
*
* string action = 10 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for action.
*/
com.google.protobuf.ByteString getActionBytes();
/**
*
*
*
* Optional. The collection of contexts that are activated when the intent
* is matched. Context messages in this collection should not set the
* parameters field. Setting the `lifespan_count` to 0 will reset the context
* when the intent is matched.
* Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
*
*
*
* repeated .google.cloud.dialogflow.v2.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List getOutputContextsList();
/**
*
*
*
* Optional. The collection of contexts that are activated when the intent
* is matched. Context messages in this collection should not set the
* parameters field. Setting the `lifespan_count` to 0 will reset the context
* when the intent is matched.
* Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
*
*
*
* repeated .google.cloud.dialogflow.v2.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dialogflow.v2.Context getOutputContexts(int index);
/**
*
*
*
* Optional. The collection of contexts that are activated when the intent
* is matched. Context messages in this collection should not set the
* parameters field. Setting the `lifespan_count` to 0 will reset the context
* when the intent is matched.
* Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
*
*
*
* repeated .google.cloud.dialogflow.v2.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];
*
*/
int getOutputContextsCount();
/**
*
*
*
* Optional. The collection of contexts that are activated when the intent
* is matched. Context messages in this collection should not set the
* parameters field. Setting the `lifespan_count` to 0 will reset the context
* when the intent is matched.
* Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
*
*
*
* repeated .google.cloud.dialogflow.v2.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List
getOutputContextsOrBuilderList();
/**
*
*
*
* Optional. The collection of contexts that are activated when the intent
* is matched. Context messages in this collection should not set the
* parameters field. Setting the `lifespan_count` to 0 will reset the context
* when the intent is matched.
* Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
*
*
*
* repeated .google.cloud.dialogflow.v2.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dialogflow.v2.ContextOrBuilder getOutputContextsOrBuilder(int index);
/**
*
*
*
* Optional. Indicates whether to delete all contexts in the current
* session when this intent is matched.
*
*
* bool reset_contexts = 12 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The resetContexts.
*/
boolean getResetContexts();
/**
*
*
*
* Optional. The collection of parameters associated with the intent.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List getParametersList();
/**
*
*
*
* Optional. The collection of parameters associated with the intent.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dialogflow.v2.Intent.Parameter getParameters(int index);
/**
*
*
*
* Optional. The collection of parameters associated with the intent.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*/
int getParametersCount();
/**
*
*
*
* Optional. The collection of parameters associated with the intent.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List
getParametersOrBuilderList();
/**
*
*
*
* Optional. The collection of parameters associated with the intent.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dialogflow.v2.Intent.ParameterOrBuilder getParametersOrBuilder(int index);
/**
*
*
*
* Optional. The collection of rich messages corresponding to the
* `Response` field in the Dialogflow console.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message messages = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List getMessagesList();
/**
*
*
*
* Optional. The collection of rich messages corresponding to the
* `Response` field in the Dialogflow console.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message messages = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dialogflow.v2.Intent.Message getMessages(int index);
/**
*
*
*
* Optional. The collection of rich messages corresponding to the
* `Response` field in the Dialogflow console.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message messages = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*/
int getMessagesCount();
/**
*
*
*
* Optional. The collection of rich messages corresponding to the
* `Response` field in the Dialogflow console.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message messages = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List
getMessagesOrBuilderList();
/**
*
*
*
* Optional. The collection of rich messages corresponding to the
* `Response` field in the Dialogflow console.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message messages = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dialogflow.v2.Intent.MessageOrBuilder getMessagesOrBuilder(int index);
/**
*
*
*
* Optional. The list of platforms for which the first responses will be
* copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return A list containing the defaultResponsePlatforms.
*/
java.util.List
getDefaultResponsePlatformsList();
/**
*
*
*
* Optional. The list of platforms for which the first responses will be
* copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The count of defaultResponsePlatforms.
*/
int getDefaultResponsePlatformsCount();
/**
*
*
*
* Optional. The list of platforms for which the first responses will be
* copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @param index The index of the element to return.
* @return The defaultResponsePlatforms at the given index.
*/
com.google.cloud.dialogflow.v2.Intent.Message.Platform getDefaultResponsePlatforms(int index);
/**
*
*
*
* Optional. The list of platforms for which the first responses will be
* copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return A list containing the enum numeric values on the wire for defaultResponsePlatforms.
*/
java.util.List getDefaultResponsePlatformsValueList();
/**
*
*
*
* Optional. The list of platforms for which the first responses will be
* copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @param index The index of the value to return.
* @return The enum numeric value on the wire of defaultResponsePlatforms at the given index.
*/
int getDefaultResponsePlatformsValue(int index);
/**
*
*
*
* Output only.
* Read-only. The unique identifier of the root intent in the chain of
* followup intents. It identifies the correct followup intents chain for
* this intent. We populate this field only in the output.
*
* Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*
*
* string root_followup_intent_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The rootFollowupIntentName.
*/
java.lang.String getRootFollowupIntentName();
/**
*
*
*
* Output only.
* Read-only. The unique identifier of the root intent in the chain of
* followup intents. It identifies the correct followup intents chain for
* this intent. We populate this field only in the output.
*
* Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*
*
* string root_followup_intent_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The bytes for rootFollowupIntentName.
*/
com.google.protobuf.ByteString getRootFollowupIntentNameBytes();
/**
*
*
*
* Read-only after creation. The unique identifier of the parent intent in the
* chain of followup intents. You can set this field when creating an intent,
* for example with
* [CreateIntent][google.cloud.dialogflow.v2.Intents.CreateIntent] or
* [BatchUpdateIntents][google.cloud.dialogflow.v2.Intents.BatchUpdateIntents],
* in order to make this intent a followup intent.
*
* It identifies the parent followup intent.
* Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*
*
* string parent_followup_intent_name = 17;
*
* @return The parentFollowupIntentName.
*/
java.lang.String getParentFollowupIntentName();
/**
*
*
*
* Read-only after creation. The unique identifier of the parent intent in the
* chain of followup intents. You can set this field when creating an intent,
* for example with
* [CreateIntent][google.cloud.dialogflow.v2.Intents.CreateIntent] or
* [BatchUpdateIntents][google.cloud.dialogflow.v2.Intents.BatchUpdateIntents],
* in order to make this intent a followup intent.
*
* It identifies the parent followup intent.
* Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*
*
* string parent_followup_intent_name = 17;
*
* @return The bytes for parentFollowupIntentName.
*/
com.google.protobuf.ByteString getParentFollowupIntentNameBytes();
/**
*
*
*
* Output only. Read-only. Information about all followup intents that have
* this intent as a direct or indirect parent. We populate this field only in
* the output.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List
getFollowupIntentInfoList();
/**
*
*
*
* Output only. Read-only. Information about all followup intents that have
* this intent as a direct or indirect parent. We populate this field only in
* the output.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.dialogflow.v2.Intent.FollowupIntentInfo getFollowupIntentInfo(int index);
/**
*
*
*
* Output only. Read-only. Information about all followup intents that have
* this intent as a direct or indirect parent. We populate this field only in
* the output.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
int getFollowupIntentInfoCount();
/**
*
*
*
* Output only. Read-only. Information about all followup intents that have
* this intent as a direct or indirect parent. We populate this field only in
* the output.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List
getFollowupIntentInfoOrBuilderList();
/**
*
*
*
* Output only. Read-only. Information about all followup intents that have
* this intent as a direct or indirect parent. We populate this field only in
* the output.
*
*
*
* repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.dialogflow.v2.Intent.FollowupIntentInfoOrBuilder getFollowupIntentInfoOrBuilder(
int index);
}