com.google.cloud.dialogflow.cx.v3beta1.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-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/intent.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.dialogflow.cx.v3beta1;
public interface IntentOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.Intent)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The unique identifier of the intent.
* Required for the
* [Intents.UpdateIntent][google.cloud.dialogflow.cx.v3beta1.Intents.UpdateIntent]
* method.
* [Intents.CreateIntent][google.cloud.dialogflow.cx.v3beta1.Intents.CreateIntent]
* populates the name automatically.
* Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/intents/<Intent ID>`.
*
*
* string name = 1;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* The unique identifier of the intent.
* Required for the
* [Intents.UpdateIntent][google.cloud.dialogflow.cx.v3beta1.Intents.UpdateIntent]
* method.
* [Intents.CreateIntent][google.cloud.dialogflow.cx.v3beta1.Intents.CreateIntent]
* populates the name automatically.
* Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/intents/<Intent ID>`.
*
*
* string name = 1;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Required. The human-readable name of the intent, unique within the agent.
*
*
* string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* Required. The human-readable name of the intent, unique within the agent.
*
*
* string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* The collection of training phrases the agent is trained on to identify the
* intent.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase training_phrases = 3;
*
*/
java.util.List
getTrainingPhrasesList();
/**
*
*
*
* The collection of training phrases the agent is trained on to identify the
* intent.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase training_phrases = 3;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase getTrainingPhrases(int index);
/**
*
*
*
* The collection of training phrases the agent is trained on to identify the
* intent.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase training_phrases = 3;
*
*/
int getTrainingPhrasesCount();
/**
*
*
*
* The collection of training phrases the agent is trained on to identify the
* intent.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase training_phrases = 3;
*
*/
java.util.List
getTrainingPhrasesOrBuilderList();
/**
*
*
*
* The collection of training phrases the agent is trained on to identify the
* intent.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase training_phrases = 3;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhraseOrBuilder getTrainingPhrasesOrBuilder(
int index);
/**
*
*
*
* The collection of parameters associated with the intent.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Intent.Parameter parameters = 4;
*/
java.util.List getParametersList();
/**
*
*
*
* The collection of parameters associated with the intent.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Intent.Parameter parameters = 4;
*/
com.google.cloud.dialogflow.cx.v3beta1.Intent.Parameter getParameters(int index);
/**
*
*
*
* The collection of parameters associated with the intent.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Intent.Parameter parameters = 4;
*/
int getParametersCount();
/**
*
*
*
* The collection of parameters associated with the intent.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Intent.Parameter parameters = 4;
*/
java.util.List
getParametersOrBuilderList();
/**
*
*
*
* The collection of parameters associated with the intent.
*
*
* repeated .google.cloud.dialogflow.cx.v3beta1.Intent.Parameter parameters = 4;
*/
com.google.cloud.dialogflow.cx.v3beta1.Intent.ParameterOrBuilder getParametersOrBuilder(
int index);
/**
*
*
*
* 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 = 5;
*
* @return The priority.
*/
int getPriority();
/**
*
*
*
* Indicates whether this is a fallback intent. Currently only default
* fallback intent is allowed in the agent, which is added upon agent
* creation.
* Adding training phrases to fallback intent is useful in the case of
* requests that are mistakenly matched, since training phrases assigned to
* fallback intents act as negative examples that triggers no-match event.
*
*
* bool is_fallback = 6;
*
* @return The isFallback.
*/
boolean getIsFallback();
/**
*
*
*
* The key/value metadata to label an intent. Labels can contain
* lowercase letters, digits and the symbols '-' and '_'. International
* characters are allowed, including letters from unicase alphabets. Keys must
* start with a letter. Keys and values can be no longer than 63 characters
* and no more than 128 bytes.
*
* Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed
* Dialogflow defined labels include:
* * sys-head
* * sys-contextual
* The above labels do not require value. "sys-head" means the intent is a
* head intent. "sys-contextual" means the intent is a contextual intent.
*
*
* map<string, string> labels = 7;
*/
int getLabelsCount();
/**
*
*
*
* The key/value metadata to label an intent. Labels can contain
* lowercase letters, digits and the symbols '-' and '_'. International
* characters are allowed, including letters from unicase alphabets. Keys must
* start with a letter. Keys and values can be no longer than 63 characters
* and no more than 128 bytes.
*
* Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed
* Dialogflow defined labels include:
* * sys-head
* * sys-contextual
* The above labels do not require value. "sys-head" means the intent is a
* head intent. "sys-contextual" means the intent is a contextual intent.
*
*
* map<string, string> labels = 7;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* The key/value metadata to label an intent. Labels can contain
* lowercase letters, digits and the symbols '-' and '_'. International
* characters are allowed, including letters from unicase alphabets. Keys must
* start with a letter. Keys and values can be no longer than 63 characters
* and no more than 128 bytes.
*
* Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed
* Dialogflow defined labels include:
* * sys-head
* * sys-contextual
* The above labels do not require value. "sys-head" means the intent is a
* head intent. "sys-contextual" means the intent is a contextual intent.
*
*
* map<string, string> labels = 7;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* The key/value metadata to label an intent. Labels can contain
* lowercase letters, digits and the symbols '-' and '_'. International
* characters are allowed, including letters from unicase alphabets. Keys must
* start with a letter. Keys and values can be no longer than 63 characters
* and no more than 128 bytes.
*
* Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed
* Dialogflow defined labels include:
* * sys-head
* * sys-contextual
* The above labels do not require value. "sys-head" means the intent is a
* head intent. "sys-contextual" means the intent is a contextual intent.
*
*
* map<string, string> labels = 7;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* The key/value metadata to label an intent. Labels can contain
* lowercase letters, digits and the symbols '-' and '_'. International
* characters are allowed, including letters from unicase alphabets. Keys must
* start with a letter. Keys and values can be no longer than 63 characters
* and no more than 128 bytes.
*
* Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed
* Dialogflow defined labels include:
* * sys-head
* * sys-contextual
* The above labels do not require value. "sys-head" means the intent is a
* head intent. "sys-contextual" means the intent is a contextual intent.
*
*
* map<string, string> labels = 7;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Human readable description for better understanding an intent like its
* scope, content, result etc. Maximum character limit: 140 characters.
*
*
* string description = 8;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* Human readable description for better understanding an intent like its
* scope, content, result etc. Maximum character limit: 140 characters.
*
*
* string description = 8;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
}