Struct FeaturedResultsItem 

#[non_exhaustive]
pub struct FeaturedResultsItem {
    pub id: Option<String>,
    pub type: Option<QueryResultType>,
    pub additional_attributes: Option<Vec<AdditionalResultAttribute>>,
    pub document_id: Option<String>,
    pub document_title: Option<TextWithHighlights>,
    pub document_excerpt: Option<TextWithHighlights>,
    pub document_uri: Option<String>,
    pub document_attributes: Option<Vec<DocumentAttribute>>,
    pub feedback_token: Option<String>,
}

A single featured result item. A featured result is 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.

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.

id: Option<String>

The identifier of the featured result.

type: Option<QueryResultType>

The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.

additional_attributes: Option<Vec<AdditionalResultAttribute>>

One or more additional attributes associated with the featured result.

document_id: Option<String>

The identifier of the featured document.

document_title: Option<TextWithHighlights>

Provides text and information about where to highlight the text.

document_excerpt: Option<TextWithHighlights>

Provides text and information about where to highlight the text.

document_uri: Option<String>

The source URI location of the featured document.

document_attributes: Option<Vec<DocumentAttribute>>

An array of document attributes assigned to a featured document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.

feedback_token: Option<String>

A token that identifies a particular featured result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.

Implementations

impl FeaturedResultsItem

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

The identifier of the featured result.

pub fn type(&self) -> Option<&QueryResultType>

The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.

pub fn additional_attributes(&self) -> &[AdditionalResultAttribute]

One or more additional attributes associated with the featured result.

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

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

The identifier of the featured document.

pub fn document_title(&self) -> Option<&TextWithHighlights>

Provides text and information about where to highlight the text.

pub fn document_excerpt(&self) -> Option<&TextWithHighlights>

Provides text and information about where to highlight the text.

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

The source URI location of the featured document.

pub fn document_attributes(&self) -> &[DocumentAttribute]

An array of document attributes assigned to a featured document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.

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

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

A token that identifies a particular featured result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.

impl FeaturedResultsItem

pub fn builder() -> FeaturedResultsItemBuilder

Creates a new builder-style object to manufacture FeaturedResultsItem.

Trait Implementations

impl Clone for FeaturedResultsItem

fn clone(&self) -> FeaturedResultsItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FeaturedResultsItem

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

Formats the value using the given formatter.

impl PartialEq for FeaturedResultsItem

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