public static interface CompanionSuggestion.GuidanceOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getExplanation()
public abstract 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 abstract 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. |
getGroundingMetadata()
public abstract GroundingMetadata getGroundingMetadata()Optional. Grounding metadata for the generated guidance.
optional .google.cloud.dialogflow.v2.GroundingMetadata grounding_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata |
The groundingMetadata. |
getGroundingMetadataOrBuilder()
public abstract GroundingMetadataOrBuilder getGroundingMetadataOrBuilder()Optional. Grounding metadata for the generated guidance.
optional .google.cloud.dialogflow.v2.GroundingMetadata grounding_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GroundingMetadataOrBuilder |
|
getInstructionSource()
public abstract GuidanceInstruction getInstructionSource()Guidance instruction source.
.google.cloud.dialogflow.v2.GuidanceInstruction instruction_source = 3;
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction |
The instructionSource. |
getInstructionSourceOrBuilder()
public abstract GuidanceInstructionOrBuilder getInstructionSourceOrBuilder()Guidance instruction source.
.google.cloud.dialogflow.v2.GuidanceInstruction instruction_source = 3;
| Returns | |
|---|---|
| Type | Description |
GuidanceInstructionOrBuilder |
|
getKnowledgeSources(int index)
public abstract CompanionSuggestion.Guidance.KnowledgeSource getKnowledgeSources(int index)Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.KnowledgeSource |
|
getKnowledgeSourcesCount()
public abstract int getKnowledgeSourcesCount()Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Returns | |
|---|---|
| Type | Description |
int |
|
getKnowledgeSourcesList()
public abstract List<CompanionSuggestion.Guidance.KnowledgeSource> getKnowledgeSourcesList()Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Returns | |
|---|---|
| Type | Description |
List<KnowledgeSource> |
|
getKnowledgeSourcesOrBuilder(int index)
public abstract CompanionSuggestion.Guidance.KnowledgeSourceOrBuilder getKnowledgeSourcesOrBuilder(int index)Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.KnowledgeSourceOrBuilder |
|
getKnowledgeSourcesOrBuilderList()
public abstract 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> |
|
getSuggestedAction()
public abstract 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 abstract 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 abstract String getSuggestedReply()Suggested reply for the agent to respond to the customer.
string suggested_reply = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The suggestedReply. |
getSuggestedReplyBytes()
public abstract ByteString getSuggestedReplyBytes()Suggested reply for the agent to respond to the customer.
string suggested_reply = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for suggestedReply. |
getToolCalls(int index)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
ToolCallSuggestion |
|
getToolCallsCount()
public abstract 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 |
|
getToolCallsList()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
List<ToolCallSuggestion> |
|
getToolCallsOrBuilder(int index)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
ToolCallSuggestionOrBuilder |
|
getToolCallsOrBuilderList()
public abstract 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> |
|
getTriggeringToolCallAnswerRecords(int index)
public abstract 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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The triggeringToolCallAnswerRecords at the given index. |
getTriggeringToolCallAnswerRecordsBytes(int index)
public abstract 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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the triggeringToolCallAnswerRecords at the given index. |
getTriggeringToolCallAnswerRecordsCount()
public abstract 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. |
getTriggeringToolCallAnswerRecordsList()
public abstract List<String> 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 |
List<String> |
A list containing the triggeringToolCallAnswerRecords. |
hasGroundingMetadata()
public abstract 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 abstract boolean hasInstructionSource()Guidance instruction source.
.google.cloud.dialogflow.v2.GuidanceInstruction instruction_source = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the instructionSource field is set. |