Struct google_api_proto::google::cloud::discoveryengine::v1::search_request::ContentSearchSpec

pub struct ContentSearchSpec {
    pub snippet_spec: Option<SnippetSpec>,
    pub summary_spec: Option<SummarySpec>,
    pub extractive_content_spec: Option<ExtractiveContentSpec>,
    pub search_result_mode: i32,
    pub chunk_spec: Option<ChunkSpec>,
}

A specification for configuring the behavior of content search.

Fields

snippet_spec: Option<SnippetSpec>

If snippetSpec is not specified, snippets are not included in the search response.

summary_spec: Option<SummarySpec>

If summarySpec is not specified, summaries are not included in the search response.

extractive_content_spec: Option<ExtractiveContentSpec>

If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

search_result_mode: i32

Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS.

chunk_spec: Option<ChunkSpec>

Specifies the chunk spec to be returned from the search response. Only available if the [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode] is set to [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]

Implementations

impl ContentSearchSpec

pub fn search_result_mode(&self) -> SearchResultMode

Returns the enum value of search_result_mode, or the default if the field is set to an invalid enum value.

pub fn set_search_result_mode(&mut self, value: SearchResultMode)

Sets search_result_mode to the provided enum value.

Trait Implementations

impl Clone for ContentSearchSpec

fn clone(&self) -> ContentSearchSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContentSearchSpec

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

Formats the value using the given formatter.

impl Default for ContentSearchSpec

fn default() -> Self

Returns the “default value” for a type.

impl Message for ContentSearchSpec

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 ContentSearchSpec

fn eq(&self, other: &ContentSearchSpec) -> 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 StructuralPartialEq for ContentSearchSpec