Struct SearchResponse 

#[non_exhaustive]
pub struct SearchResponse {

    pub results: Vec<SearchResult>,
    pub facets: Vec<Facet>,
    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 query_expansion_info: Option<QueryExpansionInfo>,
    pub natural_language_query_understanding_info: Option<NaturalLanguageQueryUnderstandingInfo>,
    pub session_info: Option<SessionInfo>,
    pub search_link_promotions: Vec<SearchLinkPromotion>,
    pub semantic_state: SemanticState,
    /* private fields */
}

Available on crate features conversational-search-service or search-service only.

Response message for SearchService.Search method.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

results: Vec<SearchResult>

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

facets: Vec<Facet>

Results of facets requested by user.

total_size: i32

The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.

attribution_token: String

A unique search token. This should be included in the 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 and attribution_token are set in the response.

next_page_token: String

A token that can be sent as 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 is set.

query_expansion_info: Option<QueryExpansionInfo>

Query expansion information for the returned results.

natural_language_query_understanding_info: Option<NaturalLanguageQueryUnderstandingInfo>

Output only. Natural language query understanding information for the returned results.

session_info: Option<SessionInfo>

Session information.

Only set if SearchRequest.session is provided. See its description for more details.

search_link_promotions: Vec<SearchLinkPromotion>

Promotions for site search.

semantic_state: SemanticState

Output only. Indicates the semantic state of the search response.

Implementations

impl SearchResponse

pub fn new() -> Self

Creates a new default instance.

pub fn set_results<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<SearchResult>,

Sets the value of results.

Example

use google_cloud_discoveryengine_v1::model::search_response::SearchResult;
let x = SearchResponse::new()
    .set_results([
        SearchResult::default()/* use setters */,
        SearchResult::default()/* use (different) setters */,
    ]);

pub fn set_facets<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Facet>,

Sets the value of facets.

Example

use google_cloud_discoveryengine_v1::model::search_response::Facet;
let x = SearchResponse::new()
    .set_facets([
        Facet::default()/* use setters */,
        Facet::default()/* use (different) setters */,
    ]);

pub fn set_total_size<T: Into<i32>>(self, v: T) -> Self

Sets the value of total_size.

Example

let x = SearchResponse::new().set_total_size(42);

pub fn set_attribution_token<T: Into<String>>(self, v: T) -> Self

Sets the value of attribution_token.

Example

let x = SearchResponse::new().set_attribution_token("example");

pub fn set_redirect_uri<T: Into<String>>(self, v: T) -> Self

Sets the value of redirect_uri.

Example

let x = SearchResponse::new().set_redirect_uri("example");

pub fn set_next_page_token<T: Into<String>>(self, v: T) -> Self

Sets the value of next_page_token.

Example

let x = SearchResponse::new().set_next_page_token("example");

pub fn set_corrected_query<T: Into<String>>(self, v: T) -> Self

Sets the value of corrected_query.

Example

let x = SearchResponse::new().set_corrected_query("example");

pub fn set_summary<T>(self, v: T) -> Self

where T: Into<Summary>,

Sets the value of summary.

Example

use google_cloud_discoveryengine_v1::model::search_response::Summary;
let x = SearchResponse::new().set_summary(Summary::default()/* use setters */);

pub fn set_or_clear_summary<T>(self, v: Option<T>) -> Self

where T: Into<Summary>,

Sets or clears the value of summary.

Example

use google_cloud_discoveryengine_v1::model::search_response::Summary;
let x = SearchResponse::new().set_or_clear_summary(Some(Summary::default()/* use setters */));
let x = SearchResponse::new().set_or_clear_summary(None::<Summary>);

pub fn set_query_expansion_info<T>(self, v: T) -> Self

where T: Into<QueryExpansionInfo>,

Sets the value of query_expansion_info.

Example

use google_cloud_discoveryengine_v1::model::search_response::QueryExpansionInfo;
let x = SearchResponse::new().set_query_expansion_info(QueryExpansionInfo::default()/* use setters */);

pub fn set_or_clear_query_expansion_info<T>(self, v: Option<T>) -> Self

where T: Into<QueryExpansionInfo>,

Sets or clears the value of query_expansion_info.

Example

use google_cloud_discoveryengine_v1::model::search_response::QueryExpansionInfo;
let x = SearchResponse::new().set_or_clear_query_expansion_info(Some(QueryExpansionInfo::default()/* use setters */));
let x = SearchResponse::new().set_or_clear_query_expansion_info(None::<QueryExpansionInfo>);

pub fn set_natural_language_query_understanding_info<T>(self, v: T) -> Self

where T: Into<NaturalLanguageQueryUnderstandingInfo>,

Sets the value of natural_language_query_understanding_info.

Example

use google_cloud_discoveryengine_v1::model::search_response::NaturalLanguageQueryUnderstandingInfo;
let x = SearchResponse::new().set_natural_language_query_understanding_info(NaturalLanguageQueryUnderstandingInfo::default()/* use setters */);

pub fn set_or_clear_natural_language_query_understanding_info<T>( self, v: Option<T>, ) -> Self

where T: Into<NaturalLanguageQueryUnderstandingInfo>,

Sets or clears the value of natural_language_query_understanding_info.

Example

use google_cloud_discoveryengine_v1::model::search_response::NaturalLanguageQueryUnderstandingInfo;
let x = SearchResponse::new().set_or_clear_natural_language_query_understanding_info(Some(NaturalLanguageQueryUnderstandingInfo::default()/* use setters */));
let x = SearchResponse::new().set_or_clear_natural_language_query_understanding_info(None::<NaturalLanguageQueryUnderstandingInfo>);

pub fn set_session_info<T>(self, v: T) -> Self

where T: Into<SessionInfo>,

Sets the value of session_info.

Example

use google_cloud_discoveryengine_v1::model::search_response::SessionInfo;
let x = SearchResponse::new().set_session_info(SessionInfo::default()/* use setters */);

pub fn set_or_clear_session_info<T>(self, v: Option<T>) -> Self

where T: Into<SessionInfo>,

Sets or clears the value of session_info.

Example

use google_cloud_discoveryengine_v1::model::search_response::SessionInfo;
let x = SearchResponse::new().set_or_clear_session_info(Some(SessionInfo::default()/* use setters */));
let x = SearchResponse::new().set_or_clear_session_info(None::<SessionInfo>);

pub fn set_search_link_promotions<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<SearchLinkPromotion>,

Sets the value of search_link_promotions.

Example

use google_cloud_discoveryengine_v1::model::SearchLinkPromotion;
let x = SearchResponse::new()
    .set_search_link_promotions([
        SearchLinkPromotion::default()/* use setters */,
        SearchLinkPromotion::default()/* use (different) setters */,
    ]);

pub fn set_semantic_state<T: Into<SemanticState>>(self, v: T) -> Self

Sets the value of semantic_state.

Example

use google_cloud_discoveryengine_v1::model::search_response::SemanticState;
let x0 = SearchResponse::new().set_semantic_state(SemanticState::Disabled);
let x1 = SearchResponse::new().set_semantic_state(SemanticState::Enabled);

Trait Implementations

impl Clone for SearchResponse

fn clone(&self) -> SearchResponse

Returns a duplicate 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() -> SearchResponse

Returns the “default value” for a type.

impl Message for SearchResponse

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SearchResponse

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SearchResponse