Struct google_api_proto::google::cloud::discoveryengine::v1beta::SearchResponse

pub struct SearchResponse {

    pub results: Vec<SearchResult>,
    pub facets: Vec<Facet>,
    pub guided_search_result: Option<GuidedSearchResult>,
    pub total_size: i32,
    pub attribution_token: String,
    pub redirect_uri: String,
    pub next_page_token: String,
    pub corrected_query: String,
    pub summary: Option<Summary>,
    pub applied_controls: Vec<String>,
    pub geo_search_debug_info: Vec<GeoSearchDebugInfo>,
    pub query_expansion_info: Option<QueryExpansionInfo>,
    pub natural_language_query_understanding_info: Option<NaturalLanguageQueryUnderstandingInfo>,
    pub session_info: Option<SessionInfo>,
    pub one_box_results: Vec<OneBoxResult>,
}

Response message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.

Fields

results: Vec<SearchResult>

A list of matched documents. The order represents the ranking.

facets: Vec<Facet>

Results of facets requested by user.

guided_search_result: Option<GuidedSearchResult>

Guided search result.

total_size: i32

The estimated total count of matched items irrespective of pagination. The count of [results][google.cloud.discoveryengine.v1beta.SearchResponse.results] returned by pagination may be less than the [total_size][google.cloud.discoveryengine.v1beta.SearchResponse.total_size] that matches.

attribution_token: String

A unique search token. This should be included in the [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios.

redirect_uri: String

The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only [redirect_uri][google.cloud.discoveryengine.v1beta.SearchResponse.redirect_uri] and [attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] are set in the response.

next_page_token: String

A token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page. If this field is omitted, there are no subsequent pages.

corrected_query: String

Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.

summary: Option<Summary>

A summary as part of the search results. This field is only returned if [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec] is set.

applied_controls: Vec<String>

Controls applied as part of the Control service.

geo_search_debug_info: Vec<GeoSearchDebugInfo>

query_expansion_info: Option<QueryExpansionInfo>

Query expansion information for the returned results.

natural_language_query_understanding_info: Option<NaturalLanguageQueryUnderstandingInfo>

Natural language query understanding information for the returned results.

session_info: Option<SessionInfo>

Session information.

Only set if [SearchRequest.session][google.cloud.discoveryengine.v1beta.SearchRequest.session] is provided. See its description for more details.

one_box_results: Vec<OneBoxResult>

A list of One Box results. There can be multiple One Box results of different types.

Trait Implementations

impl Clone for SearchResponse

fn clone(&self) -> SearchResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchResponse

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

Formats the value using the given formatter.

impl Default for SearchResponse

fn default() -> Self

Returns the “default value” for a type.

impl Message for SearchResponse

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 SearchResponse

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