Struct RetrieveResultItem 

#[non_exhaustive]
pub struct RetrieveResultItem {
    pub id: Option<String>,
    pub document_id: Option<String>,
    pub document_title: Option<String>,
    pub content: Option<String>,
    pub document_uri: Option<String>,
    pub document_attributes: Option<Vec<DocumentAttribute>>,
    pub score_attributes: Option<ScoreAttributes>,
}

A single retrieved relevant passage result.

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 relevant passage result.

document_id: Option<String>

The identifier of the document.

document_title: Option<String>

The title of the document.

content: Option<String>

The contents of the relevant passage.

document_uri: Option<String>

The URI of the original location of the document.

document_attributes: Option<Vec<DocumentAttribute>>

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

score_attributes: Option<ScoreAttributes>

The confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.

Implementations

impl RetrieveResultItem

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

The identifier of the relevant passage result.

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

The identifier of the document.

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

The title of the document.

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

The contents of the relevant passage.

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

The URI of the original location of the document.

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

An array of document fields/attributes assigned to a 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 score_attributes(&self) -> Option<&ScoreAttributes>

The confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.

impl RetrieveResultItem

pub fn builder() -> RetrieveResultItemBuilder

Creates a new builder-style object to manufacture RetrieveResultItem.

Trait Implementations

impl Clone for RetrieveResultItem

fn clone(&self) -> RetrieveResultItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetrieveResultItem

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

Formats the value using the given formatter.

impl PartialEq for RetrieveResultItem

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