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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int MAX_EXTRACTIVE_ANSWER_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MAX_EXTRACTIVE_SEGMENT_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NUM_NEXT_SEGMENTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NUM_PREVIOUS_SEGMENTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RETURN_EXTRACTIVE_SEGMENT_SCORE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder newBuilder()
public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder newBuilder(SearchRequest.ContentSearchSpec.ExtractiveContentSpec prototype)
public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseDelimitedFrom(InputStream input)
public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(ByteString data)
public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(CodedInputStream input)
public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(InputStream input)
public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(ByteBuffer data)
public static SearchRequest.ContentSearchSpec.ExtractiveContentSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<SearchRequest.ContentSearchSpec.ExtractiveContentSpec> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public SearchRequest.ContentSearchSpec.ExtractiveContentSpec getDefaultInstanceForType()
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.
|
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.
|
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.
|
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.
|
public Parser<SearchRequest.ContentSearchSpec.ExtractiveContentSpec> getParserForType()
Overrides
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.
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder newBuilderForType()
protected SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
