com.google.cloud.discoveryengine.v1beta

Class SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder>

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

All Implemented Interfaces:

SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

SearchRequest.ContentSearchSpec.ExtractiveContentSpec

public static final class SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder
extends com.google.protobuf.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.v1beta.SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Method Summary

Modifier and Type	Method and Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchRequest.ContentSearchSpec.ExtractiveContentSpec	build()
SearchRequest.ContentSearchSpec.ExtractiveContentSpec	buildPartial()
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	clear()
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	clearMaxExtractiveAnswerCount() The maximum number of extractive answers returned in each search result.
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	clearMaxExtractiveSegmentCount() The max number of extractive segments returned in each search result.
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	clearNumNextSegments() Return at most `num_next_segments` segments after each selected segments.
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	clearNumPreviousSegments() Specifies whether to also include the adjacent from each selected segments.
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	clearReturnExtractiveSegmentScore() Specifies whether to return the confidence score from the extractive segments in each search result.
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	clone()
SearchRequest.ContentSearchSpec.ExtractiveContentSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
boolean	getReturnExtractiveSegmentScore() Specifies whether to return the confidence score from the extractive segments in each search result.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	mergeFrom(com.google.protobuf.Message other)
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	mergeFrom(SearchRequest.ContentSearchSpec.ExtractiveContentSpec other)
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	setMaxExtractiveAnswerCount(int value) The maximum number of extractive answers returned in each search result.
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	setMaxExtractiveSegmentCount(int value) The max number of extractive segments returned in each search result.
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	setNumNextSegments(int value) Return at most `num_next_segments` segments after each selected segments.
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	setNumPreviousSegments(int value) Specifies whether to also include the adjacent from each selected segments.
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	setReturnExtractiveSegmentScore(boolean value) Specifies whether to return the confidence score from the extractive segments in each search result.
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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.Builder<SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder>

clear

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder>

getDefaultInstanceForType

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder>

setField

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

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder>

clearField

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

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder>

clearOneof

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

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder>

addRepeatedField

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

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder>

mergeFrom

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder>

mergeFrom

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder>

Throws:

IOException

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.

setMaxExtractiveAnswerCount

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][google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult].
 

int32 max_extractive_answer_count = 1;

Parameters:

value - The maxExtractiveAnswerCount to set.

Returns:

This builder for chaining.

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][google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult].
 

int32 max_extractive_answer_count = 1;

Returns:

This builder for chaining.

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.

setMaxExtractiveSegmentCount

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

 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;

Parameters:

value - The maxExtractiveSegmentCount to set.

Returns:

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][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;

Returns:

This builder for chaining.

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.

setReturnExtractiveSegmentScore

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;

Parameters:

value - The returnExtractiveSegmentScore to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

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.

setNumPreviousSegments

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;

Parameters:

value - The numPreviousSegments to set.

Returns:

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:

This builder for chaining.

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.

setNumNextSegments

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

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

int32 num_next_segments = 5;

Parameters:

value - The numNextSegments to set.

Returns:

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:

This builder for chaining.

setUnknownFields

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

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder>

mergeUnknownFields

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

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder>