com.google.cloud.discoveryengine.v1beta

Class SearchRequest.ContentSearchSpec.SummarySpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec

All Implemented Interfaces:

SearchRequest.ContentSearchSpec.SummarySpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

SearchRequest.ContentSearchSpec

public static final class SearchRequest.ContentSearchSpec.SummarySpec
extends com.google.protobuf.GeneratedMessageV3
implements SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

 A specification for configuring a summary returned in a search
 response.
 

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchRequest.ContentSearchSpec.SummarySpec.Builder A specification for configuring a summary returned in a search response.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER
static int	IGNORE_NON_SUMMARY_SEEKING_QUERY_FIELD_NUMBER
static int	INCLUDE_CITATIONS_FIELD_NUMBER
static int	LANGUAGE_CODE_FIELD_NUMBER
static int	SUMMARY_RESULT_COUNT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static SearchRequest.ContentSearchSpec.SummarySpec	getDefaultInstance()
SearchRequest.ContentSearchSpec.SummarySpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getIgnoreAdversarialQuery() Specifies whether to filter out adversarial queries.
boolean	getIgnoreNonSummarySeekingQuery() Specifies whether to filter out queries that are not summary-seeking.
boolean	getIncludeCitations() Specifies whether to include citations in the summary.
String	getLanguageCode() Language code for Summary.
com.google.protobuf.ByteString	getLanguageCodeBytes() Language code for Summary.
com.google.protobuf.Parser<SearchRequest.ContentSearchSpec.SummarySpec>	getParserForType()
int	getSerializedSize()
int	getSummaryResultCount() The number of top results to generate the summary from.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SearchRequest.ContentSearchSpec.SummarySpec.Builder	newBuilder()
static SearchRequest.ContentSearchSpec.SummarySpec.Builder	newBuilder(SearchRequest.ContentSearchSpec.SummarySpec prototype)
SearchRequest.ContentSearchSpec.SummarySpec.Builder	newBuilderForType()
protected SearchRequest.ContentSearchSpec.SummarySpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SearchRequest.ContentSearchSpec.SummarySpec	parseDelimitedFrom(InputStream input)
static SearchRequest.ContentSearchSpec.SummarySpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ContentSearchSpec.SummarySpec	parseFrom(byte[] data)
static SearchRequest.ContentSearchSpec.SummarySpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ContentSearchSpec.SummarySpec	parseFrom(ByteBuffer data)
static SearchRequest.ContentSearchSpec.SummarySpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ContentSearchSpec.SummarySpec	parseFrom(com.google.protobuf.ByteString data)
static SearchRequest.ContentSearchSpec.SummarySpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ContentSearchSpec.SummarySpec	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchRequest.ContentSearchSpec.SummarySpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ContentSearchSpec.SummarySpec	parseFrom(InputStream input)
static SearchRequest.ContentSearchSpec.SummarySpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchRequest.ContentSearchSpec.SummarySpec>	parser()
SearchRequest.ContentSearchSpec.SummarySpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SUMMARY_RESULT_COUNT_FIELD_NUMBER

public static final int SUMMARY_RESULT_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

INCLUDE_CITATIONS_FIELD_NUMBER

public static final int INCLUDE_CITATIONS_FIELD_NUMBER

See Also:

Constant Field Values

IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER

public static final int IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER

See Also:

Constant Field Values

IGNORE_NON_SUMMARY_SEEKING_QUERY_FIELD_NUMBER

public static final int IGNORE_NON_SUMMARY_SEEKING_QUERY_FIELD_NUMBER

See Also:

Constant Field Values

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSummaryResultCount

public int getSummaryResultCount()

 The number of top results to generate the summary from. If the number
 of results returned is less than `summaryResultCount`, the summary is
 generated from all of the results.

 At most five results can be used to generate a summary.
 

int32 summary_result_count = 1;

Specified by:

getSummaryResultCount in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

Returns:

The summaryResultCount.

getIncludeCitations

public boolean getIncludeCitations()

 Specifies whether to include citations in the summary. The default
 value is `false`.

 When this field is set to `true`, summaries include in-line citation
 numbers.

 Example summary including citations:

 BigQuery is Google Cloud's fully managed and completely serverless
 enterprise data warehouse [1]. BigQuery supports all data types, works
 across clouds, and has built-in machine learning and business
 intelligence, all within a unified platform [2, 3].

 The citation numbers refer to the returned search results and are
 1-indexed. For example, [1] means that the sentence is attributed to
 the first search result. [2, 3] means that the sentence is attributed
 to both the second and third search results.
 

bool include_citations = 2;

Specified by:

getIncludeCitations in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

Returns:

The includeCitations.

getIgnoreAdversarialQuery

public boolean getIgnoreAdversarialQuery()

 Specifies whether to filter out adversarial queries. The default value
 is `false`.

 Google employs search-query classification to detect adversarial
 queries. No summary is returned if the search query is classified as an
 adversarial query. For example, a user might ask a question regarding
 negative comments about the company or submit a query designed to
 generate unsafe, policy-violating output. If this field is set to
 `true`, we skip generating summaries for adversarial queries and return
 fallback messages instead.
 

bool ignore_adversarial_query = 3;

Specified by:

getIgnoreAdversarialQuery in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

Returns:

The ignoreAdversarialQuery.

getIgnoreNonSummarySeekingQuery

public boolean getIgnoreNonSummarySeekingQuery()

 Specifies whether to filter out queries that are not summary-seeking.
 The default value is `false`.

 Google employs search-query classification to detect summary-seeking
 queries. No summary is returned if the search query is classified as a
 non-summary seeking query. For example, `why is the sky blue` and `Who
 is the best soccer player in the world?` are summary-seeking queries,
 but `SFO airport` and `world cup 2026` are not. They are most likely
 navigational queries. If this field is set to `true`, we skip
 generating summaries for non-summary seeking queries and return
 fallback messages instead.
 

bool ignore_non_summary_seeking_query = 4;

Specified by:

getIgnoreNonSummarySeekingQuery in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

Returns:

The ignoreNonSummarySeekingQuery.

getLanguageCode

public String getLanguageCode()

 Language code for Summary. Use language tags defined by
 [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].
 

string language_code = 6;

Specified by:

getLanguageCode in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

Returns:

The languageCode.

getLanguageCodeBytes

public com.google.protobuf.ByteString getLanguageCodeBytes()

 Language code for Summary. Use language tags defined by
 [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].
 

string language_code = 6;

Specified by:

getLanguageCodeBytes in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

Returns:

The bytes for languageCode.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(ByteBuffer data)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(ByteBuffer data,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(com.google.protobuf.ByteString data)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(com.google.protobuf.ByteString data,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(byte[] data)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(byte[] data,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(InputStream input)
                                                             throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(InputStream input,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchRequest.ContentSearchSpec.SummarySpec parseDelimitedFrom(InputStream input)
                                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchRequest.ContentSearchSpec.SummarySpec parseDelimitedFrom(InputStream input,
                                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                      throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(com.google.protobuf.CodedInputStream input)
                                                             throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(com.google.protobuf.CodedInputStream input,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws IOException

Throws:

IOException

newBuilderForType

public SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilder()

newBuilder

public static SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilder(SearchRequest.ContentSearchSpec.SummarySpec prototype)

toBuilder

public SearchRequest.ContentSearchSpec.SummarySpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SearchRequest.ContentSearchSpec.SummarySpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<SearchRequest.ContentSearchSpec.SummarySpec> parser()

getParserForType

public com.google.protobuf.Parser<SearchRequest.ContentSearchSpec.SummarySpec> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SearchRequest.ContentSearchSpec.SummarySpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder