Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ExtractiveContentSpec.
A specification for configuring the extractive content in a search response.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#max_extractive_answer_count
def max_extractive_answer_count() -> ::Integer-
(::Integer) — 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 themax_extractive_answer_count.At most five answers are returned for each SearchResult.
#max_extractive_answer_count=
def max_extractive_answer_count=(value) -> ::Integer-
value (::Integer) — 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 themax_extractive_answer_count.At most five answers are returned for each SearchResult.
-
(::Integer) — 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 themax_extractive_answer_count.At most five answers are returned for each SearchResult.
#max_extractive_segment_count
def max_extractive_segment_count() -> ::Integer-
(::Integer) — 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 themax_extractive_segment_count.
#max_extractive_segment_count=
def max_extractive_segment_count=(value) -> ::Integer-
value (::Integer) — 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 themax_extractive_segment_count.
-
(::Integer) — 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 themax_extractive_segment_count.
#num_next_segments
def num_next_segments() -> ::Integer-
(::Integer) — Return at most
num_next_segmentssegments after each selected segments.
#num_next_segments=
def num_next_segments=(value) -> ::Integer-
value (::Integer) — Return at most
num_next_segmentssegments after each selected segments.
-
(::Integer) — Return at most
num_next_segmentssegments after each selected segments.
#num_previous_segments
def num_previous_segments() -> ::Integer-
(::Integer) — Specifies whether to also include the adjacent from each selected
segments.
Return at most
num_previous_segmentssegments before each selected segments.
#num_previous_segments=
def num_previous_segments=(value) -> ::Integer-
value (::Integer) — Specifies whether to also include the adjacent from each selected
segments.
Return at most
num_previous_segmentssegments before each selected segments.
-
(::Integer) — Specifies whether to also include the adjacent from each selected
segments.
Return at most
num_previous_segmentssegments before each selected segments.
#return_extractive_segment_score
def return_extractive_segment_score() -> ::Boolean-
(::Boolean) — Specifies whether to return the confidence score from the extractive
segments in each search result. The default value is
false.Note: this is a priavte preview feature and only works for allowlisted users, please reach out to Cloud Support team if you want to use it.
#return_extractive_segment_score=
def return_extractive_segment_score=(value) -> ::Boolean-
value (::Boolean) — Specifies whether to return the confidence score from the extractive
segments in each search result. The default value is
false.Note: this is a priavte preview feature and only works for allowlisted users, please reach out to Cloud Support team if you want to use it.
-
(::Boolean) — Specifies whether to return the confidence score from the extractive
segments in each search result. The default value is
false.Note: this is a priavte preview feature and only works for allowlisted users, please reach out to Cloud Support team if you want to use it.