Class SearchRequest.ContentSearchSpec.ExtractiveContentSpec (0.39.0)

Version 0.39.0

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 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 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.v1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Inheritance

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

Implements

SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

MAX_EXTRACTIVE_ANSWER_COUNT_FIELD_NUMBER

public static final int MAX_EXTRACTIVE_ANSWER_COUNT_FIELD_NUMBER

Field Value
Type	Description
int

MAX_EXTRACTIVE_SEGMENT_COUNT_FIELD_NUMBER

public static final int MAX_EXTRACTIVE_SEGMENT_COUNT_FIELD_NUMBER

Field Value
Type	Description
int

NUM_NEXT_SEGMENTS_FIELD_NUMBER

public static final int NUM_NEXT_SEGMENTS_FIELD_NUMBER

Field Value
Type	Description
int

NUM_PREVIOUS_SEGMENTS_FIELD_NUMBER

public static final int NUM_PREVIOUS_SEGMENTS_FIELD_NUMBER

Field Value
Type	Description
int

RETURN_EXTRACTIVE_SEGMENT_SCORE_FIELD_NUMBER

public static final int RETURN_EXTRACTIVE_SEGMENT_SCORE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec getDefaultInstance()

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

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

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

newBuilder(SearchRequest.ContentSearchSpec.ExtractiveContentSpec prototype)

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

Parameter
Name	Description
prototype	SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

parseDelimitedFrom(InputStream input)

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

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

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

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

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

Returns
Type	Description
Parser<ExtractiveContentSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec getDefaultInstanceForType()

Returns
Type	Description
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 five answers are returned for each SearchResult.

int32 max_extractive_answer_count = 1;

Returns
Type	Description
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
Type	Description
int	The maxExtractiveSegmentCount.

getNumNextSegments()

public int getNumNextSegments()

Return at most num_next_segments segments after each selected segments.

int32 num_next_segments = 5;

Returns
Type	Description
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
Type	Description
int	The numPreviousSegments.

getParserForType()

public Parser<SearchRequest.ContentSearchSpec.ExtractiveContentSpec> getParserForType()

Returns
Type	Description
Parser<ExtractiveContentSpec>

Overrides

GeneratedMessageV3.getParserForType()

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;

Returns
Type	Description
boolean	The returnExtractiveSegmentScore.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder newBuilderForType()

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder toBuilder()

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException