Interface SearchResponse.SummaryOrBuilder (0.49.0)

Version latest

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.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
Type	Description
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
Type	Description
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
Name	Description
index	int The index of the element to return.

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Name	Description
index	int The index of the value to return.

Returns
Type	Description
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
Type	Description
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
Type	Description
String	The summaryText.

getSummaryTextBytes()

public abstract ByteString getSummaryTextBytes()

The summary content.

string summary_text = 1;

Returns
Type	Description
ByteString	The bytes for summaryText.

getSummaryWithMetadata()

public abstract SearchResponse.Summary.SummaryWithMetadata getSummaryWithMetadata()

Summary with metadata information.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;

Returns
Type	Description
SearchResponse.Summary.SummaryWithMetadata	The summaryWithMetadata.

getSummaryWithMetadataOrBuilder()

public abstract SearchResponse.Summary.SummaryWithMetadataOrBuilder getSummaryWithMetadataOrBuilder()

Summary with metadata information.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;

Returns
Type	Description
SearchResponse.Summary.SummaryWithMetadataOrBuilder

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
Type	Description
boolean	Whether the safetyAttributes field is set.

hasSummaryWithMetadata()

public abstract boolean hasSummaryWithMetadata()

Summary with metadata information.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;

Returns
Type	Description
boolean	Whether the summaryWithMetadata field is set.