Struct aws_sdk_kendra::operation::query::QueryOutput

#[non_exhaustive]
pub struct QueryOutput {
    pub query_id: Option<String>,
    pub result_items: Option<Vec<QueryResultItem>>,
    pub facet_results: Option<Vec<FacetResult>>,
    pub total_number_of_results: Option<i32>,
    pub warnings: Option<Vec<Warning>>,
    pub spell_corrected_queries: Option<Vec<SpellCorrectedQuery>>,
    pub featured_results_items: Option<Vec<FeaturedResultsItem>>,
    /* private fields */
}

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.

query_id: Option<String>

The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback API.

result_items: Option<Vec<QueryResultItem>>

The results of the search.

facet_results: Option<Vec<FacetResult>>

Contains the facet results. A FacetResult contains the counts for each field/attribute key that was specified in the Facets input parameter.

total_number_of_results: Option<i32>

The total number of items found by the search. However, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.

warnings: Option<Vec<Warning>>

A list of warning codes and their messages on problems with your query.

Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see Searching with advanced query syntax.

spell_corrected_queries: Option<Vec<SpellCorrectedQuery>>

A list of information related to suggested spell corrections for a query.

featured_results_items: Option<Vec<FeaturedResultsItem>>

The list of featured result items. Featured results are displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.

Implementations

impl QueryOutput

pub fn query_id(&self) -> Option<&str>

The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback API.

pub fn result_items(&self) -> &[QueryResultItem]

The results of the search.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .result_items.is_none().

pub fn facet_results(&self) -> &[FacetResult]

Contains the facet results. A FacetResult contains the counts for each field/attribute key that was specified in the Facets input parameter.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .facet_results.is_none().

pub fn total_number_of_results(&self) -> Option<i32>

The total number of items found by the search. However, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.

pub fn warnings(&self) -> &[Warning]

A list of warning codes and their messages on problems with your query.

Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see Searching with advanced query syntax.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .warnings.is_none().

pub fn spell_corrected_queries(&self) -> &[SpellCorrectedQuery]

A list of information related to suggested spell corrections for a query.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .spell_corrected_queries.is_none().

pub fn featured_results_items(&self) -> &[FeaturedResultsItem]

The list of featured result items. Featured results are displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .featured_results_items.is_none().

impl QueryOutput

pub fn builder() -> QueryOutputBuilder

Creates a new builder-style object to manufacture QueryOutput.

Trait Implementations

impl Clone for QueryOutput

fn clone(&self) -> QueryOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryOutput

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

Formats the value using the given formatter.

impl PartialEq for QueryOutput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl RequestId for QueryOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for QueryOutput