public static final class CompanionSuggestion.Guidance.Builder extends GeneratedMessage.Builder<CompanionSuggestion.Guidance.Builder> implements CompanionSuggestion.GuidanceOrBuilderRepresents guidance for companion suggestion.
Protobuf type google.cloud.dialogflow.v2.CompanionSuggestion.Guidance
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > CompanionSuggestion.Guidance.BuilderImplements
CompanionSuggestion.GuidanceOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllKnowledgeSources(Iterable<? extends CompanionSuggestion.Guidance.KnowledgeSource> values)
public CompanionSuggestion.Guidance.Builder addAllKnowledgeSources(Iterable<? extends CompanionSuggestion.Guidance.KnowledgeSource> values)Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource> |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
addAllToolCalls(Iterable<? extends ToolCallSuggestion> values)
public CompanionSuggestion.Guidance.Builder addAllToolCalls(Iterable<? extends ToolCallSuggestion> values)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 |
values |
Iterable<? extends com.google.cloud.dialogflow.v2.ToolCallSuggestion> |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
addAllTriggeringToolCallAnswerRecords(Iterable<String> values)
public CompanionSuggestion.Guidance.Builder addAllTriggeringToolCallAnswerRecords(Iterable<String> values) 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 |
values |
Iterable<String>The triggeringToolCallAnswerRecords to add. |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
This builder for chaining. |
addKnowledgeSources(CompanionSuggestion.Guidance.KnowledgeSource value)
public CompanionSuggestion.Guidance.Builder addKnowledgeSources(CompanionSuggestion.Guidance.KnowledgeSource value)Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
CompanionSuggestion.Guidance.KnowledgeSource |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
addKnowledgeSources(CompanionSuggestion.Guidance.KnowledgeSource.Builder builderForValue)
public CompanionSuggestion.Guidance.Builder addKnowledgeSources(CompanionSuggestion.Guidance.KnowledgeSource.Builder builderForValue)Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CompanionSuggestion.Guidance.KnowledgeSource.Builder |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
addKnowledgeSources(int index, CompanionSuggestion.Guidance.KnowledgeSource value)
public CompanionSuggestion.Guidance.Builder addKnowledgeSources(int index, CompanionSuggestion.Guidance.KnowledgeSource value)Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CompanionSuggestion.Guidance.KnowledgeSource |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
addKnowledgeSources(int index, CompanionSuggestion.Guidance.KnowledgeSource.Builder builderForValue)
public CompanionSuggestion.Guidance.Builder addKnowledgeSources(int index, CompanionSuggestion.Guidance.KnowledgeSource.Builder builderForValue)Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CompanionSuggestion.Guidance.KnowledgeSource.Builder |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
addKnowledgeSourcesBuilder()
public CompanionSuggestion.Guidance.KnowledgeSource.Builder addKnowledgeSourcesBuilder()Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.KnowledgeSource.Builder |
|
addKnowledgeSourcesBuilder(int index)
public CompanionSuggestion.Guidance.KnowledgeSource.Builder addKnowledgeSourcesBuilder(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.Builder |
|
addToolCalls(ToolCallSuggestion value)
public CompanionSuggestion.Guidance.Builder addToolCalls(ToolCallSuggestion value)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 |
value |
ToolCallSuggestion |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
addToolCalls(ToolCallSuggestion.Builder builderForValue)
public CompanionSuggestion.Guidance.Builder addToolCalls(ToolCallSuggestion.Builder builderForValue)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 |
builderForValue |
ToolCallSuggestion.Builder |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
addToolCalls(int index, ToolCallSuggestion value)
public CompanionSuggestion.Guidance.Builder addToolCalls(int index, ToolCallSuggestion value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ToolCallSuggestion |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
addToolCalls(int index, ToolCallSuggestion.Builder builderForValue)
public CompanionSuggestion.Guidance.Builder addToolCalls(int index, ToolCallSuggestion.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ToolCallSuggestion.Builder |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
addToolCallsBuilder()
public ToolCallSuggestion.Builder addToolCallsBuilder()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 |
ToolCallSuggestion.Builder |
|
addToolCallsBuilder(int index)
public ToolCallSuggestion.Builder addToolCallsBuilder(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.Builder |
|
addTriggeringToolCallAnswerRecords(String value)
public CompanionSuggestion.Guidance.Builder addTriggeringToolCallAnswerRecords(String value) 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 |
value |
StringThe triggeringToolCallAnswerRecords to add. |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
This builder for chaining. |
addTriggeringToolCallAnswerRecordsBytes(ByteString value)
public CompanionSuggestion.Guidance.Builder addTriggeringToolCallAnswerRecordsBytes(ByteString value) 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 |
value |
ByteStringThe bytes of the triggeringToolCallAnswerRecords to add. |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
This builder for chaining. |
build()
public CompanionSuggestion.Guidance build()| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance |
|
buildPartial()
public CompanionSuggestion.Guidance buildPartial()| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance |
|
clear()
public CompanionSuggestion.Guidance.Builder clear()| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
clearExplanation()
public CompanionSuggestion.Guidance.Builder clearExplanation()Optional. A brief explanation of why the action is suggested.
string explanation = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
This builder for chaining. |
clearGroundingMetadata()
public CompanionSuggestion.Guidance.Builder clearGroundingMetadata()Optional. Grounding metadata for the generated guidance.
optional .google.cloud.dialogflow.v2.GroundingMetadata grounding_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
clearInstructionSource()
public CompanionSuggestion.Guidance.Builder clearInstructionSource()Guidance instruction source.
.google.cloud.dialogflow.v2.GuidanceInstruction instruction_source = 3;
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
clearKnowledgeSources()
public CompanionSuggestion.Guidance.Builder clearKnowledgeSources()Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
clearSuggestedAction()
public CompanionSuggestion.Guidance.Builder clearSuggestedAction()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 |
CompanionSuggestion.Guidance.Builder |
This builder for chaining. |
clearSuggestedReply()
public CompanionSuggestion.Guidance.Builder clearSuggestedReply()Suggested reply for the agent to respond to the customer.
string suggested_reply = 1;
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
This builder for chaining. |
clearToolCalls()
public CompanionSuggestion.Guidance.Builder clearToolCalls()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 |
CompanionSuggestion.Guidance.Builder |
|
clearTriggeringToolCallAnswerRecords()
public CompanionSuggestion.Guidance.Builder clearTriggeringToolCallAnswerRecords() 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 |
CompanionSuggestion.Guidance.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public CompanionSuggestion.Guidance getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getGroundingMetadata()
public 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. |
getGroundingMetadataBuilder()
public GroundingMetadata.Builder getGroundingMetadataBuilder()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.Builder |
|
getGroundingMetadataOrBuilder()
public 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 GuidanceInstruction getInstructionSource()Guidance instruction source.
.google.cloud.dialogflow.v2.GuidanceInstruction instruction_source = 3;
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction |
The instructionSource. |
getInstructionSourceBuilder()
public GuidanceInstruction.Builder getInstructionSourceBuilder()Guidance instruction source.
.google.cloud.dialogflow.v2.GuidanceInstruction instruction_source = 3;
| Returns | |
|---|---|
| Type | Description |
GuidanceInstruction.Builder |
|
getInstructionSourceOrBuilder()
public GuidanceInstructionOrBuilder getInstructionSourceOrBuilder()Guidance instruction source.
.google.cloud.dialogflow.v2.GuidanceInstruction instruction_source = 3;
| Returns | |
|---|---|
| Type | Description |
GuidanceInstructionOrBuilder |
|
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 |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.KnowledgeSource |
|
getKnowledgeSourcesBuilder(int index)
public CompanionSuggestion.Guidance.KnowledgeSource.Builder getKnowledgeSourcesBuilder(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.Builder |
|
getKnowledgeSourcesBuilderList()
public List<CompanionSuggestion.Guidance.KnowledgeSource.Builder> getKnowledgeSourcesBuilderList()Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
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;
| Returns | |
|---|---|
| Type | Description |
List<KnowledgeSource> |
|
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 |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.KnowledgeSourceOrBuilder |
|
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> |
|
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. |
getToolCalls(int index)
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 |
| Returns | |
|---|---|
| Type | Description |
ToolCallSuggestion |
|
getToolCallsBuilder(int index)
public ToolCallSuggestion.Builder getToolCallsBuilder(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.Builder |
|
getToolCallsBuilderList()
public List<ToolCallSuggestion.Builder> getToolCallsBuilderList()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<Builder> |
|
getToolCallsCount()
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 |
|
getToolCallsList()
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];
| Returns | |
|---|---|
| Type | Description |
List<ToolCallSuggestion> |
|
getToolCallsOrBuilder(int index)
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 |
| Returns | |
|---|---|
| Type | Description |
ToolCallSuggestionOrBuilder |
|
getToolCallsOrBuilderList()
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> |
|
getTriggeringToolCallAnswerRecords(int index)
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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The triggeringToolCallAnswerRecords at the given index. |
getTriggeringToolCallAnswerRecordsBytes(int 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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the triggeringToolCallAnswerRecords at the given index. |
getTriggeringToolCallAnswerRecordsCount()
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. |
getTriggeringToolCallAnswerRecordsList()
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. |
hasGroundingMetadata()
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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CompanionSuggestion.Guidance other)
public CompanionSuggestion.Guidance.Builder mergeFrom(CompanionSuggestion.Guidance other)| Parameter | |
|---|---|
| Name | Description |
other |
CompanionSuggestion.Guidance |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CompanionSuggestion.Guidance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CompanionSuggestion.Guidance.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
mergeGroundingMetadata(GroundingMetadata value)
public CompanionSuggestion.Guidance.Builder mergeGroundingMetadata(GroundingMetadata value)Optional. Grounding metadata for the generated guidance.
optional .google.cloud.dialogflow.v2.GroundingMetadata grounding_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
GroundingMetadata |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
mergeInstructionSource(GuidanceInstruction value)
public CompanionSuggestion.Guidance.Builder mergeInstructionSource(GuidanceInstruction value)Guidance instruction source.
.google.cloud.dialogflow.v2.GuidanceInstruction instruction_source = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
GuidanceInstruction |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
removeKnowledgeSources(int index)
public CompanionSuggestion.Guidance.Builder removeKnowledgeSources(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.Builder |
|
removeToolCalls(int index)
public CompanionSuggestion.Guidance.Builder removeToolCalls(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 |
CompanionSuggestion.Guidance.Builder |
|
setExplanation(String value)
public CompanionSuggestion.Guidance.Builder setExplanation(String value)Optional. A brief explanation of why the action is suggested.
string explanation = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe explanation to set. |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
This builder for chaining. |
setExplanationBytes(ByteString value)
public CompanionSuggestion.Guidance.Builder setExplanationBytes(ByteString value)Optional. A brief explanation of why the action is suggested.
string explanation = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for explanation to set. |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
This builder for chaining. |
setGroundingMetadata(GroundingMetadata value)
public CompanionSuggestion.Guidance.Builder setGroundingMetadata(GroundingMetadata value)Optional. Grounding metadata for the generated guidance.
optional .google.cloud.dialogflow.v2.GroundingMetadata grounding_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
GroundingMetadata |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
setGroundingMetadata(GroundingMetadata.Builder builderForValue)
public CompanionSuggestion.Guidance.Builder setGroundingMetadata(GroundingMetadata.Builder builderForValue)Optional. Grounding metadata for the generated guidance.
optional .google.cloud.dialogflow.v2.GroundingMetadata grounding_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
GroundingMetadata.Builder |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
setInstructionSource(GuidanceInstruction value)
public CompanionSuggestion.Guidance.Builder setInstructionSource(GuidanceInstruction value)Guidance instruction source.
.google.cloud.dialogflow.v2.GuidanceInstruction instruction_source = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
GuidanceInstruction |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
setInstructionSource(GuidanceInstruction.Builder builderForValue)
public CompanionSuggestion.Guidance.Builder setInstructionSource(GuidanceInstruction.Builder builderForValue)Guidance instruction source.
.google.cloud.dialogflow.v2.GuidanceInstruction instruction_source = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
GuidanceInstruction.Builder |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
setKnowledgeSources(int index, CompanionSuggestion.Guidance.KnowledgeSource value)
public CompanionSuggestion.Guidance.Builder setKnowledgeSources(int index, CompanionSuggestion.Guidance.KnowledgeSource value)Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CompanionSuggestion.Guidance.KnowledgeSource |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
setKnowledgeSources(int index, CompanionSuggestion.Guidance.KnowledgeSource.Builder builderForValue)
public CompanionSuggestion.Guidance.Builder setKnowledgeSources(int index, CompanionSuggestion.Guidance.KnowledgeSource.Builder builderForValue)Knowledge sources.
repeated .google.cloud.dialogflow.v2.CompanionSuggestion.Guidance.KnowledgeSource knowledge_sources = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CompanionSuggestion.Guidance.KnowledgeSource.Builder |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
setSuggestedAction(String value)
public CompanionSuggestion.Guidance.Builder setSuggestedAction(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe suggestedAction to set. |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
This builder for chaining. |
setSuggestedActionBytes(ByteString value)
public CompanionSuggestion.Guidance.Builder setSuggestedActionBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for suggestedAction to set. |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
This builder for chaining. |
setSuggestedReply(String value)
public CompanionSuggestion.Guidance.Builder setSuggestedReply(String value)Suggested reply for the agent to respond to the customer.
string suggested_reply = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe suggestedReply to set. |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
This builder for chaining. |
setSuggestedReplyBytes(ByteString value)
public CompanionSuggestion.Guidance.Builder setSuggestedReplyBytes(ByteString value)Suggested reply for the agent to respond to the customer.
string suggested_reply = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for suggestedReply to set. |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
This builder for chaining. |
setToolCalls(int index, ToolCallSuggestion value)
public CompanionSuggestion.Guidance.Builder setToolCalls(int index, ToolCallSuggestion value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ToolCallSuggestion |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
setToolCalls(int index, ToolCallSuggestion.Builder builderForValue)
public CompanionSuggestion.Guidance.Builder setToolCalls(int index, ToolCallSuggestion.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ToolCallSuggestion.Builder |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
|
setTriggeringToolCallAnswerRecords(int index, String value)
public CompanionSuggestion.Guidance.Builder setTriggeringToolCallAnswerRecords(int index, String value) 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) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe triggeringToolCallAnswerRecords to set. |
| Returns | |
|---|---|
| Type | Description |
CompanionSuggestion.Guidance.Builder |
This builder for chaining. |