Struct google_api_proto::google::cloud::discoveryengine::v1alpha::search_request::content_search_spec::ExtractiveContentSpec

pub struct ExtractiveContentSpec {
    pub max_extractive_answer_count: i32,
    pub max_extractive_segment_count: i32,
    pub return_extractive_segment_score: bool,
    pub num_previous_segments: i32,
    pub num_next_segments: i32,
}

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

Fields

max_extractive_answer_count: i32

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

max_extractive_segment_count: i32

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

return_extractive_segment_score: bool

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.

num_previous_segments: i32

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

num_next_segments: i32

Return at most num_next_segments segments after each selected segments.

Trait Implementations

impl Clone for ExtractiveContentSpec

fn clone(&self) -> ExtractiveContentSpec

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExtractiveContentSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ExtractiveContentSpec

fn default() -> Self

Returns the “default value” for a type.

impl Message for ExtractiveContentSpec

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ExtractiveContentSpec

fn eq(&self, other: &ExtractiveContentSpec) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ExtractiveContentSpec

impl StructuralPartialEq for ExtractiveContentSpec