Interface ConversationSummarizationSuggestionDataOrBuilder (2.37.0)

public interface ConversationSummarizationSuggestionDataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMetadata(String key)

public abstract boolean containsMetadata(String key)

A map that contains metadata about the summarization and the document from which it originates.

map<string, string> metadata = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsTextSections(String key)

public abstract boolean containsTextSections(String key)

The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.

map<string, string> text_sections = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getAnswerRecord()

public abstract String getAnswerRecord()

The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}

string answer_record = 4;

Returns
TypeDescription
String

The answerRecord.

getAnswerRecordBytes()

public abstract ByteString getAnswerRecordBytes()

The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}

string answer_record = 4;

Returns
TypeDescription
ByteString

The bytes for answerRecord.

getConfidence()

public abstract float getConfidence()

The confidence score of the summarization.

float confidence = 2;

Returns
TypeDescription
float

The confidence.

getConversationModel()

public abstract String getConversationModel()

The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}

string conversation_model = 6;

Returns
TypeDescription
String

The conversationModel.

getConversationModelBytes()

public abstract ByteString getConversationModelBytes()

The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}

string conversation_model = 6;

Returns
TypeDescription
ByteString

The bytes for conversationModel.

getMetadata() (deprecated)

public abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
TypeDescription
Map<String,String>

getMetadataCount()

public abstract int getMetadataCount()

A map that contains metadata about the summarization and the document from which it originates.

map<string, string> metadata = 3;

Returns
TypeDescription
int

getMetadataMap()

public abstract Map<String,String> getMetadataMap()

A map that contains metadata about the summarization and the document from which it originates.

map<string, string> metadata = 3;

Returns
TypeDescription
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public abstract String getMetadataOrDefault(String key, String defaultValue)

A map that contains metadata about the summarization and the document from which it originates.

map<string, string> metadata = 3;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getMetadataOrThrow(String key)

public abstract String getMetadataOrThrow(String key)

A map that contains metadata about the summarization and the document from which it originates.

map<string, string> metadata = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getText()

public abstract String getText()

The summarization content that is concatenated into one string.

string text = 1;

Returns
TypeDescription
String

The text.

getTextBytes()

public abstract ByteString getTextBytes()

The summarization content that is concatenated into one string.

string text = 1;

Returns
TypeDescription
ByteString

The bytes for text.

getTextSections() (deprecated)

public abstract Map<String,String> getTextSections()

Use #getTextSectionsMap() instead.

Returns
TypeDescription
Map<String,String>

getTextSectionsCount()

public abstract int getTextSectionsCount()

The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.

map<string, string> text_sections = 5;

Returns
TypeDescription
int

getTextSectionsMap()

public abstract Map<String,String> getTextSectionsMap()

The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.

map<string, string> text_sections = 5;

Returns
TypeDescription
Map<String,String>

getTextSectionsOrDefault(String key, String defaultValue)

public abstract String getTextSectionsOrDefault(String key, String defaultValue)

The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.

map<string, string> text_sections = 5;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getTextSectionsOrThrow(String key)

public abstract String getTextSectionsOrThrow(String key)

The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.

map<string, string> text_sections = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
String