Interface GenerateCompanionSuggestionsResponseOrBuilder (4.105.0)

public interface GenerateCompanionSuggestionsResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAnswerRecord()

public abstract String getAnswerRecord()

Answer record that uniquely identifies the suggestion. Format: projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>.

string answer_record = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The answerRecord.

getAnswerRecordBytes()

public abstract ByteString getAnswerRecordBytes()

Answer record that uniquely identifies the suggestion. Format: projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>.

string answer_record = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for answerRecord.

getCompanionSuggestion()

public abstract CompanionSuggestion getCompanionSuggestion()

Contains the core suggestion generated by the Companion Agent.

.google.cloud.dialogflow.v2.CompanionSuggestion companion_suggestion = 1;

Returns
Type Description
CompanionSuggestion

The companionSuggestion.

getCompanionSuggestionOrBuilder()

public abstract CompanionSuggestionOrBuilder getCompanionSuggestionOrBuilder()

Contains the core suggestion generated by the Companion Agent.

.google.cloud.dialogflow.v2.CompanionSuggestion companion_suggestion = 1;

Returns
Type Description
CompanionSuggestionOrBuilder

getLatestMessage()

public abstract String getLatestMessage()

The name of the latest conversation message used to compile suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

string latest_message = 3;

Returns
Type Description
String

The latestMessage.

getLatestMessageBytes()

public abstract ByteString getLatestMessageBytes()

The name of the latest conversation message used to compile suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

string latest_message = 3;

Returns
Type Description
ByteString

The bytes for latestMessage.

getSuggestionIndex()

public abstract int getSuggestionIndex()

Output only. The 1-based sequential index of the suggestion generated in this session.

int32 suggestion_index = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The suggestionIndex.

hasCompanionSuggestion()

public abstract boolean hasCompanionSuggestion()

Contains the core suggestion generated by the Companion Agent.

.google.cloud.dialogflow.v2.CompanionSuggestion companion_suggestion = 1;

Returns
Type Description
boolean

Whether the companionSuggestion field is set.