Struct Document 

#[non_exhaustive]
pub struct Document {
    pub id: String,
    pub title: Option<String>,
    pub blob: Option<Blob>,
    pub s3_path: Option<S3Path>,
    pub attributes: Option<Vec<DocumentAttribute>>,
    pub access_control_list: Option<Vec<Principal>>,
    pub hierarchical_access_control_list: Option<Vec<HierarchicalPrincipal>>,
    pub content_type: Option<ContentType>,
    pub access_control_configuration_id: Option<String>,
}

A document in an index.

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: String

A identifier of the document in the index.

Note, each document ID must be unique per index. You cannot create a data source to index your documents with their unique IDs and then use the BatchPutDocument API to index the same documents, or vice versa. You can delete a data source and then use the BatchPutDocument API to index the same documents, or vice versa.

title: Option<String>

The title of the document.

blob: Option<Blob>

The contents of the document.

Documents passed to the Blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.

s3_path: Option<S3Path>

Information required to find a specific file in an Amazon S3 bucket.

attributes: Option<Vec<DocumentAttribute>>

Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

access_control_list: Option<Vec<Principal>>

Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

hierarchical_access_control_list: Option<Vec<HierarchicalPrincipal>>

The list of principal lists that define the hierarchy for which documents users should have access to.

content_type: Option<ContentType>

The file type of the document in the Blob field.

If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you must add the HTML start and closing tags (content) around the content.

access_control_configuration_id: Option<String>

The identifier of the access control configuration that you want to apply to the document.

Implementations

impl Document

pub fn id(&self) -> &str

A identifier of the document in the index.

Note, each document ID must be unique per index. You cannot create a data source to index your documents with their unique IDs and then use the BatchPutDocument API to index the same documents, or vice versa. You can delete a data source and then use the BatchPutDocument API to index the same documents, or vice versa.

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

The title of the document.

pub fn blob(&self) -> Option<&Blob>

The contents of the document.

Documents passed to the Blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.

pub fn s3_path(&self) -> Option<&S3Path>

Information required to find a specific file in an Amazon S3 bucket.

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

Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

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

pub fn access_control_list(&self) -> &[Principal]

Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

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

pub fn hierarchical_access_control_list(&self) -> &[HierarchicalPrincipal]

The list of principal lists that define the hierarchy for which documents users should have access to.

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

pub fn content_type(&self) -> Option<&ContentType>

The file type of the document in the Blob field.

If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you must add the HTML start and closing tags (content) around the content.

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

The identifier of the access control configuration that you want to apply to the document.

impl Document

pub fn builder() -> DocumentBuilder

Creates a new builder-style object to manufacture Document.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl PartialEq for Document

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