Google Cloud Discovery Engine V1beta Client - Class ExtractiveContentSpec (0.5.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class ExtractiveContentSpec.

The specification that configs the extractive content in search results.

Generated from protobuf message google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ExtractiveContentSpec

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta \ SearchRequest \ ContentSearchSpec

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ max_extractive_answer_count int

The max number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides precise and contextually relevant answer to the search query. If the number of matching answers is less than the extractive_answer_count, return all of the answers; otherwise, return the extractive_answer_count. At most 5 answers will be returned for each SearchResult.

↳ max_extractive_segment_count int

The max number of extractive segments returned in each search result. An extractive segment is a text segment extracted from the original document which is relevant to the search query and in general more verbose than an extrative 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 the max_extractive_segment_count, return all of the segments; otherwise, return the max_extractive_segment_count. Currently one segment will be returned for each SearchResult.

getMaxExtractiveAnswerCount

The max number of extractive answers returned in each search result.

An extractive answer is a verbatim answer extracted from the original document, which provides precise and contextually relevant answer to the search query. If the number of matching answers is less than the extractive_answer_count, return all of the answers; otherwise, return the extractive_answer_count. At most 5 answers will be returned for each SearchResult.

Returns
TypeDescription
int

setMaxExtractiveAnswerCount

The max number of extractive answers returned in each search result.

An extractive answer is a verbatim answer extracted from the original document, which provides precise and contextually relevant answer to the search query. If the number of matching answers is less than the extractive_answer_count, return all of the answers; otherwise, return the extractive_answer_count. At most 5 answers will be returned for each SearchResult.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMaxExtractiveSegmentCount

The max number of extractive segments returned in each search result.

An extractive segment is a text segment extracted from the original document which is relevant to the search query and in general more verbose than an extrative 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 the max_extractive_segment_count, return all of the segments; otherwise, return the max_extractive_segment_count. Currently one segment will be returned for each SearchResult.

Returns
TypeDescription
int

setMaxExtractiveSegmentCount

The max number of extractive segments returned in each search result.

An extractive segment is a text segment extracted from the original document which is relevant to the search query and in general more verbose than an extrative 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 the max_extractive_segment_count, return all of the segments; otherwise, return the max_extractive_segment_count. Currently one segment will be returned for each SearchResult.

Parameter
NameDescription
var int
Returns
TypeDescription
$this