Interface SearchResponse.SummaryOrBuilder (0.27.0)

public static interface SearchResponse.SummaryOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getSafetyAttributes()

public abstract SearchResponse.Summary.SafetyAttributes getSafetyAttributes()

A collection of Safety Attribute categories and their associated confidence scores.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;

Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes

The safetyAttributes.

getSafetyAttributesOrBuilder()

public abstract SearchResponse.Summary.SafetyAttributesOrBuilder getSafetyAttributesOrBuilder()

A collection of Safety Attribute categories and their associated confidence scores.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;

Returns
TypeDescription
SearchResponse.Summary.SafetyAttributesOrBuilder

getSummarySkippedReasons(int index)

public abstract SearchResponse.Summary.SummarySkippedReason getSummarySkippedReasons(int index)

Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
SearchResponse.Summary.SummarySkippedReason

The summarySkippedReasons at the given index.

getSummarySkippedReasonsCount()

public abstract int getSummarySkippedReasonsCount()

Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;

Returns
TypeDescription
int

The count of summarySkippedReasons.

getSummarySkippedReasonsList()

public abstract List<SearchResponse.Summary.SummarySkippedReason> getSummarySkippedReasonsList()

Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;

Returns
TypeDescription
List<SummarySkippedReason>

A list containing the summarySkippedReasons.

getSummarySkippedReasonsValue(int index)

public abstract int getSummarySkippedReasonsValue(int index)

Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
int

The enum numeric value on the wire of summarySkippedReasons at the given index.

getSummarySkippedReasonsValueList()

public abstract List<Integer> getSummarySkippedReasonsValueList()

Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;

Returns
TypeDescription
List<Integer>

A list containing the enum numeric values on the wire for summarySkippedReasons.

getSummaryText()

public abstract String getSummaryText()

The summary content.

string summary_text = 1;

Returns
TypeDescription
String

The summaryText.

getSummaryTextBytes()

public abstract ByteString getSummaryTextBytes()

The summary content.

string summary_text = 1;

Returns
TypeDescription
ByteString

The bytes for summaryText.

hasSafetyAttributes()

public abstract boolean hasSafetyAttributes()

A collection of Safety Attribute categories and their associated confidence scores.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;

Returns
TypeDescription
boolean

Whether the safetyAttributes field is set.