public static final class CompanionSuggestion.Guidance extends GeneratedMessage implements CompanionSuggestion.GuidanceOrBuilder
Represents guidance for companion suggestion.
Protobuf type google.cloud.dialogflow.v2.CompanionSuggestion.Guidance
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
EXPLANATION_FIELD_NUMBER
public static final int EXPLANATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int GROUNDING_METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INSTRUCTION_SOURCE_FIELD_NUMBER
public static final int INSTRUCTION_SOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
KNOWLEDGE_SOURCES_FIELD_NUMBER
public static final int KNOWLEDGE_SOURCES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SUGGESTED_ACTION_FIELD_NUMBER
public static final int SUGGESTED_ACTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SUGGESTED_REPLY_FIELD_NUMBER
public static final int SUGGESTED_REPLY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TOOL_CALLS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TRIGGERING_TOOL_CALL_ANSWER_RECORDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static CompanionSuggestion.Guidance getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CompanionSuggestion.Guidance.Builder newBuilder()
newBuilder(CompanionSuggestion.Guidance prototype)
public static CompanionSuggestion.Guidance.Builder newBuilder(CompanionSuggestion.Guidance prototype)
public static CompanionSuggestion.Guidance parseDelimitedFrom(InputStream input)
public static CompanionSuggestion.Guidance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CompanionSuggestion.Guidance parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CompanionSuggestion.Guidance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CompanionSuggestion.Guidance parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CompanionSuggestion.Guidance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CompanionSuggestion.Guidance parseFrom(CodedInputStream input)
public static CompanionSuggestion.Guidance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CompanionSuggestion.Guidance parseFrom(InputStream input)
public static CompanionSuggestion.Guidance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CompanionSuggestion.Guidance parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CompanionSuggestion.Guidance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CompanionSuggestion.Guidance> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public CompanionSuggestion.Guidance getDefaultInstanceForType()
getExplanation()
public String getExplanation()
Optional. A brief explanation of why the action is suggested.
string explanation = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The explanation.
|
getExplanationBytes()
public ByteString getExplanationBytes()
Optional. A brief explanation of why the action is suggested.
string explanation = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for explanation.
|
public GroundingMetadata getGroundingMetadata()
Optional. Grounding metadata for the generated guidance.
optional .google.cloud.dialogflow.v2.GroundingMetadata grounding_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];
public GroundingMetadataOrBuilder getGroundingMetadataOrBuilder()
Optional. Grounding metadata for the generated guidance.
optional .google.cloud.dialogflow.v2.GroundingMetadata grounding_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];
getInstructionSource()
public GuidanceInstruction getInstructionSource()
Guidance instruction source.
.google.cloud.dialogflow.v2.GuidanceInstruction instruction_source = 3;
getInstructionSourceOrBuilder()
public GuidanceInstructionOrBuilder getInstructionSourceOrBuilder()
Guidance instruction source.
.google.cloud.dialogflow.v2.GuidanceInstruction instruction_source = 3;
getKnowledgeSources(int index)
public CompanionSuggestion.Guidance.KnowledgeSource getKnowledgeSources(int index)
Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Parameter |
| Name |
Description |
index |
int
|
getKnowledgeSourcesCount()
public int getKnowledgeSourcesCount()
Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Returns |
| Type |
Description |
int |
|
getKnowledgeSourcesList()
public List<CompanionSuggestion.Guidance.KnowledgeSource> getKnowledgeSourcesList()
Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
getKnowledgeSourcesOrBuilder(int index)
public CompanionSuggestion.Guidance.KnowledgeSourceOrBuilder getKnowledgeSourcesOrBuilder(int index)
Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Parameter |
| Name |
Description |
index |
int
|
getKnowledgeSourcesOrBuilderList()
public List<? extends CompanionSuggestion.Guidance.KnowledgeSourceOrBuilder> getKnowledgeSourcesOrBuilderList()
Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSourceOrBuilder> |
|
getParserForType()
public Parser<CompanionSuggestion.Guidance> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSuggestedAction()
public String getSuggestedAction()
Suggested action to human agent. For example, "Ask the customer for
their shipping address" or "Create a new case for the customer".
string suggested_action = 2;
| Returns |
| Type |
Description |
String |
The suggestedAction.
|
getSuggestedActionBytes()
public ByteString getSuggestedActionBytes()
Suggested action to human agent. For example, "Ask the customer for
their shipping address" or "Create a new case for the customer".
string suggested_action = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for suggestedAction.
|
getSuggestedReply()
public String getSuggestedReply()
Suggested reply for the agent to respond to the customer.
string suggested_reply = 1;
| Returns |
| Type |
Description |
String |
The suggestedReply.
|
getSuggestedReplyBytes()
public ByteString getSuggestedReplyBytes()
Suggested reply for the agent to respond to the customer.
string suggested_reply = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for suggestedReply.
|
public ToolCallSuggestion getToolCalls(int index)
Optional. Rich structured tool calls and their associated citations
delivered directly as suggestions.
repeated .google.cloud.dialogflow.v2.ToolCallSuggestion tool_calls = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
public int getToolCallsCount()
Optional. Rich structured tool calls and their associated citations
delivered directly as suggestions.
repeated .google.cloud.dialogflow.v2.ToolCallSuggestion tool_calls = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
public List<ToolCallSuggestion> getToolCallsList()
Optional. Rich structured tool calls and their associated citations
delivered directly as suggestions.
repeated .google.cloud.dialogflow.v2.ToolCallSuggestion tool_calls = 7 [(.google.api.field_behavior) = OPTIONAL];
public ToolCallSuggestionOrBuilder getToolCallsOrBuilder(int index)
Optional. Rich structured tool calls and their associated citations
delivered directly as suggestions.
repeated .google.cloud.dialogflow.v2.ToolCallSuggestion tool_calls = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
public List<? extends ToolCallSuggestionOrBuilder> getToolCallsOrBuilderList()
Optional. Rich structured tool calls and their associated citations
delivered directly as suggestions.
repeated .google.cloud.dialogflow.v2.ToolCallSuggestion tool_calls = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.dialogflow.v2.ToolCallSuggestionOrBuilder> |
|
public String getTriggeringToolCallAnswerRecords(int index)
Optional. The AnswerRecords of the tool calls that triggered this
guidance.
Format: projects/<Project ID>/locations/<Location
ID>/answerRecords/<Answer Record ID>.
repeated string triggering_tool_call_answer_records = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The triggeringToolCallAnswerRecords at the given index.
|
public ByteString getTriggeringToolCallAnswerRecordsBytes(int index)
Optional. The AnswerRecords of the tool calls that triggered this
guidance.
Format: projects/<Project ID>/locations/<Location
ID>/answerRecords/<Answer Record ID>.
repeated string triggering_tool_call_answer_records = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the triggeringToolCallAnswerRecords at the given index.
|
public int getTriggeringToolCallAnswerRecordsCount()
Optional. The AnswerRecords of the tool calls that triggered this
guidance.
Format: projects/<Project ID>/locations/<Location
ID>/answerRecords/<Answer Record ID>.
repeated string triggering_tool_call_answer_records = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
int |
The count of triggeringToolCallAnswerRecords.
|
public ProtocolStringList getTriggeringToolCallAnswerRecordsList()
Optional. The AnswerRecords of the tool calls that triggered this
guidance.
Format: projects/<Project ID>/locations/<Location
ID>/answerRecords/<Answer Record ID>.
repeated string triggering_tool_call_answer_records = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ProtocolStringList |
A list containing the triggeringToolCallAnswerRecords.
|
public boolean hasGroundingMetadata()
Optional. Grounding metadata for the generated guidance.
optional .google.cloud.dialogflow.v2.GroundingMetadata grounding_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the groundingMetadata field is set.
|
hasInstructionSource()
public boolean hasInstructionSource()
Guidance instruction source.
.google.cloud.dialogflow.v2.GuidanceInstruction instruction_source = 3;
| Returns |
| Type |
Description |
boolean |
Whether the instructionSource field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CompanionSuggestion.Guidance.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected CompanionSuggestion.Guidance.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public CompanionSuggestion.Guidance.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
