Discovery Engine v1 API - Class SearchRequest.Types.ContentSearchSpec.Types.ExtractiveContentSpec (1.3.0) 

public sealed class SearchRequest.Types.ContentSearchSpec.Types.ExtractiveContentSpec : IMessage<SearchRequest.Types.ContentSearchSpec.Types.ExtractiveContentSpec>, IEquatable<SearchRequest.Types.ContentSearchSpec.Types.ExtractiveContentSpec>, IDeepCloneable<SearchRequest.Types.ContentSearchSpec.Types.ExtractiveContentSpec>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class SearchRequest.Types.ContentSearchSpec.Types.ExtractiveContentSpec.

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

Inheritance

object > SearchRequest.Types.ContentSearchSpec.Types.ExtractiveContentSpec

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

ExtractiveContentSpec()

public ExtractiveContentSpec()

ExtractiveContentSpec(ExtractiveContentSpec)

public ExtractiveContentSpec(SearchRequest.Types.ContentSearchSpec.Types.ExtractiveContentSpec other)
Parameter
Name Description
other SearchRequestTypesContentSearchSpecTypesExtractiveContentSpec

Properties

MaxExtractiveAnswerCount

public int MaxExtractiveAnswerCount { get; set; }

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.v1.SearchResponse.SearchResult].

Property Value
Type Description
int

MaxExtractiveSegmentCount

public int MaxExtractiveSegmentCount { get; set; }

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

Property Value
Type Description
int

NumNextSegments

public int NumNextSegments { get; set; }

Return at most num_next_segments segments after each selected segments.

Property Value
Type Description
int

NumPreviousSegments

public int NumPreviousSegments { get; set; }

Specifies whether to also include the adjacent from each selected segments. Return at most num_previous_segments segments before each selected segments.

Property Value
Type Description
int

ReturnExtractiveSegmentScore

public bool ReturnExtractiveSegmentScore { get; set; }

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.

Property Value
Type Description
bool