Class SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder (0.38.0)

Version 0.38.0

• 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 final class SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder extends GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

Implements

SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec build()

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

buildPartial()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec buildPartial()

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

clear()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder clear()

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearMaxExtractiveAnswerCount()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder clearMaxExtractiveAnswerCount()

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
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	This builder for chaining.

clearMaxExtractiveSegmentCount()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder clearMaxExtractiveSegmentCount()

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
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	This builder for chaining.

clearNumNextSegments()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder clearNumNextSegments()

Return at most num_next_segments segments after each selected segments.

int32 num_next_segments = 5;

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	This builder for chaining.

clearNumPreviousSegments()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder clearNumPreviousSegments()

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
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearReturnExtractiveSegmentScore()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder clearReturnExtractiveSegmentScore()

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
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	This builder for chaining.

clone()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder clone()

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec getDefaultInstanceForType()

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(SearchRequest.ContentSearchSpec.ExtractiveContentSpec other)

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder mergeFrom(SearchRequest.ContentSearchSpec.ExtractiveContentSpec other)

Parameter
Name	Description
other	SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setMaxExtractiveAnswerCount(int value)

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder setMaxExtractiveAnswerCount(int value)

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;

Parameter
Name	Description
value	int The maxExtractiveAnswerCount to set.

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	This builder for chaining.

setMaxExtractiveSegmentCount(int value)

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder setMaxExtractiveSegmentCount(int value)

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;

Parameter
Name	Description
value	int The maxExtractiveSegmentCount to set.

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	This builder for chaining.

setNumNextSegments(int value)

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder setNumNextSegments(int value)

Return at most num_next_segments segments after each selected segments.

int32 num_next_segments = 5;

Parameter
Name	Description
value	int The numNextSegments to set.

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	This builder for chaining.

setNumPreviousSegments(int value)

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder setNumPreviousSegments(int value)

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;

Parameter
Name	Description
value	int The numPreviousSegments to set.

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setReturnExtractiveSegmentScore(boolean value)

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder setReturnExtractiveSegmentScore(boolean value)

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;

Parameter
Name	Description
value	boolean The returnExtractiveSegmentScore to set.

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)