Package com.google.cloud.discoveryengine.v1beta

Class SearchRequest.ContentSearchSpec.ExtractiveContentSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

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

All Implemented Interfaces:

SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder, 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.ExtractiveContentSpec
extends com.google.protobuf.GeneratedMessage
implements SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder

 A specification for configuring the extractive content in a search
 response.
 

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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	A specification for configuring the extractive content in a search response.

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

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessage.BuilderParent

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_EXTRACTIVE_ANSWER_COUNT_FIELD_NUMBER
static final int	MAX_EXTRACTIVE_SEGMENT_COUNT_FIELD_NUMBER
static final int	NUM_NEXT_SEGMENTS_FIELD_NUMBER
static final int	NUM_PREVIOUS_SEGMENTS_FIELD_NUMBER
static final int	RETURN_EXTRACTIVE_SEGMENT_SCORE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, 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	Description
boolean	equals(Object obj)
static SearchRequest.ContentSearchSpec.ExtractiveContentSpec	getDefaultInstance()
SearchRequest.ContentSearchSpec.ExtractiveContentSpec	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getMaxExtractiveAnswerCount()	The maximum number of extractive answers returned in each search result.
int	getMaxExtractiveSegmentCount()	The max number of extractive segments returned in each search result.
int	getNumNextSegments()	Return at most `num_next_segments` segments after each selected segments.
int	getNumPreviousSegments()	Specifies whether to also include the adjacent from each selected segments.
com.google.protobuf.Parser<SearchRequest.ContentSearchSpec.ExtractiveContentSpec>	getParserForType()
boolean	getReturnExtractiveSegmentScore()	Specifies whether to return the confidence score from the extractive segments in each search result.
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	newBuilder()
static SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	newBuilder(SearchRequest.ContentSearchSpec.ExtractiveContentSpec prototype)
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	newBuilderForType()
protected SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static SearchRequest.ContentSearchSpec.ExtractiveContentSpec	parseDelimitedFrom(InputStream input)
static SearchRequest.ContentSearchSpec.ExtractiveContentSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ContentSearchSpec.ExtractiveContentSpec	parseFrom(byte[] data)
static SearchRequest.ContentSearchSpec.ExtractiveContentSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ContentSearchSpec.ExtractiveContentSpec	parseFrom(com.google.protobuf.ByteString data)
static SearchRequest.ContentSearchSpec.ExtractiveContentSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ContentSearchSpec.ExtractiveContentSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchRequest.ContentSearchSpec.ExtractiveContentSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ContentSearchSpec.ExtractiveContentSpec	parseFrom(InputStream input)
static SearchRequest.ContentSearchSpec.ExtractiveContentSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ContentSearchSpec.ExtractiveContentSpec	parseFrom(ByteBuffer data)
static SearchRequest.ContentSearchSpec.ExtractiveContentSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchRequest.ContentSearchSpec.ExtractiveContentSpec>	parser()
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

MAX_EXTRACTIVE_ANSWER_COUNT_FIELD_NUMBER

public static final int MAX_EXTRACTIVE_ANSWER_COUNT_FIELD_NUMBER

See Also:

• Constant Field Values

MAX_EXTRACTIVE_SEGMENT_COUNT_FIELD_NUMBER

public static final int MAX_EXTRACTIVE_SEGMENT_COUNT_FIELD_NUMBER

See Also:

• Constant Field Values

RETURN_EXTRACTIVE_SEGMENT_SCORE_FIELD_NUMBER

public static final int RETURN_EXTRACTIVE_SEGMENT_SCORE_FIELD_NUMBER

See Also:

• Constant Field Values

NUM_PREVIOUS_SEGMENTS_FIELD_NUMBER

public static final int NUM_PREVIOUS_SEGMENTS_FIELD_NUMBER

See Also:

• Constant Field Values

NUM_NEXT_SEGMENTS_FIELD_NUMBER

public static final int NUM_NEXT_SEGMENTS_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getMaxExtractiveAnswerCount

public int getMaxExtractiveAnswerCount()

 The maximum number of extractive answers returned in each search
 result.

 An extractive answer is a verbatim answer extracted from the original
 document, which provides a precise and contextually relevant answer to
 the search query.

 If the number of matching answers is less than the
 `max_extractive_answer_count`, return all of the answers. Otherwise,
 return the `max_extractive_answer_count`.

 At most five answers are returned for each
 [SearchResult][google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult].
 

int32 max_extractive_answer_count = 1;

Specified by:

getMaxExtractiveAnswerCount in interface SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder

Returns:

The maxExtractiveAnswerCount.

getMaxExtractiveSegmentCount

public int getMaxExtractiveSegmentCount()

 The max number of extractive segments returned in each search result.
 Only applied if the
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore] is set to
 [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.CONTENT_REQUIRED]
 or
 [DataStore.solution_types][google.cloud.discoveryengine.v1beta.DataStore.solution_types]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].

 An extractive segment is a text segment extracted from the original
 document that is relevant to the search query, and, in general, more
 verbose than an extractive answer. The segment could then be used as
 input for LLMs to generate summaries and answers.

 If the number of matching segments is less than
 `max_extractive_segment_count`, return all of the segments. Otherwise,
 return the `max_extractive_segment_count`.
 

int32 max_extractive_segment_count = 2;

Specified by:

getMaxExtractiveSegmentCount in interface SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder

Returns:

The maxExtractiveSegmentCount.

getReturnExtractiveSegmentScore

public boolean getReturnExtractiveSegmentScore()

 Specifies whether to return the confidence score from the extractive
 segments in each search result. This feature is available only for new
 or allowlisted data stores. To allowlist your data store,
 contact your Customer Engineer. The default value is `false`.
 

bool return_extractive_segment_score = 3;

Specified by:

getReturnExtractiveSegmentScore in interface SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder

Returns:

The returnExtractiveSegmentScore.

getNumPreviousSegments

public int getNumPreviousSegments()

 Specifies whether to also include the adjacent from each selected
 segments.
 Return at most `num_previous_segments` segments before each selected
 segments.
 

int32 num_previous_segments = 4;

Specified by:

getNumPreviousSegments in interface SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder

Returns:

The numPreviousSegments.

getNumNextSegments

public int getNumNextSegments()

 Return at most `num_next_segments` segments after each selected
 segments.
 

int32 num_next_segments = 5;

Specified by:

getNumNextSegments in interface SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder

Returns:

The numNextSegments.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

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.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

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.ExtractiveContentSpec parseFrom(ByteBuffer data)
                                                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec 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.ExtractiveContentSpec parseFrom(byte[] data)
                                                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.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.ExtractiveContentSpec.Builder newBuilder()

newBuilder

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

toBuilder

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<SearchRequest.ContentSearchSpec.ExtractiveContentSpec> 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.GeneratedMessage

getDefaultInstanceForType

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder