Class SearchRequest.ContentSearchSpec.ExtractiveContentSpec (0.25.0)

public static final class SearchRequest.ContentSearchSpec.ExtractiveContentSpec extends GeneratedMessageV3 implements SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder

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

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Static Fields

MAX_EXTRACTIVE_ANSWER_COUNT_FIELD_NUMBER

public static final int MAX_EXTRACTIVE_ANSWER_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_EXTRACTIVE_SEGMENT_COUNT_FIELD_NUMBER

public static final int MAX_EXTRACTIVE_SEGMENT_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

NUM_NEXT_SEGMENTS_FIELD_NUMBER

public static final int NUM_NEXT_SEGMENTS_FIELD_NUMBER
Field Value
TypeDescription
int

NUM_PREVIOUS_SEGMENTS_FIELD_NUMBER

public static final int NUM_PREVIOUS_SEGMENTS_FIELD_NUMBER
Field Value
TypeDescription
int

RETURN_EXTRACTIVE_SEGMENT_SCORE_FIELD_NUMBER

public static final int RETURN_EXTRACTIVE_SEGMENT_SCORE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec getDefaultInstance()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder newBuilder()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

newBuilder(SearchRequest.ContentSearchSpec.ExtractiveContentSpec prototype)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder newBuilder(SearchRequest.ContentSearchSpec.ExtractiveContentSpec prototype)
Parameter
NameDescription
prototypeSearchRequest.ContentSearchSpec.ExtractiveContentSpec
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SearchRequest.ContentSearchSpec.ExtractiveContentSpec> parser()
Returns
TypeDescription
Parser<ExtractiveContentSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec getDefaultInstanceForType()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

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 one answer is returned for each SearchResult.

int32 max_extractive_answer_count = 1;

Returns
TypeDescription
int

The maxExtractiveAnswerCount.

getMaxExtractiveSegmentCount()

public int getMaxExtractiveSegmentCount()

The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is 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;

Returns
TypeDescription
int

The maxExtractiveSegmentCount.

getNumNextSegments()

public int getNumNextSegments()

Return at most num_next_segments segments after each selected segments.

int32 num_next_segments = 5;

Returns
TypeDescription
int

The numNextSegments.

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;

Returns
TypeDescription
int

The numPreviousSegments.

getParserForType()

public Parser<SearchRequest.ContentSearchSpec.ExtractiveContentSpec> getParserForType()
Returns
TypeDescription
Parser<ExtractiveContentSpec>
Overrides

getReturnExtractiveSegmentScore()

public boolean getReturnExtractiveSegmentScore()

Specifies whether to return the confidence score from the extractive segments in each search result. The default value is false.

Note: this is a priavte preview feature and only works for allowlisted users, please reach out to Cloud Support team if you want to use it.

bool return_extractive_segment_score = 3;

Returns
TypeDescription
boolean

The returnExtractiveSegmentScore.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder newBuilderForType()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder toBuilder()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException