Struct UserContext 

#[non_exhaustive]
pub struct UserContext {
    pub token: Option<String>,
    pub user_id: Option<String>,
    pub groups: Option<Vec<String>>,
    pub data_source_groups: Option<Vec<DataSourceGroup>>,
}

Provides information about the user context for an Amazon Kendra index.

User context filtering is a kind of personalized search with the benefit of controlling access to documents. For example, not all teams that search the company portal for information should access top-secret company documents, nor are these documents relevant to all users. Only specific users or groups of teams given access to top-secret documents should see these documents in their search results.

You provide one of the following:

• User token

• User ID, the groups the user belongs to, and any data sources the groups can access.

If you provide both, an exception is thrown.

If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can use UserId, Groups, and DataSourceGroups to filter content. If you set the UserId to a particular user ID, it also includes all public documents.

Amazon Kendra Gen AI Enterprise Edition indices don't support token based document filtering. If you're using an Amazon Kendra Gen AI Enterprise Edition index, Amazon Kendra returns a ValidationException error if the Token field has a non-null value.

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.

token: Option<String>

The user context token for filtering search results for a user. It must be a JWT or a JSON token.

user_id: Option<String>

The identifier of the user you want to filter search results based on their access to documents.

groups: Option<Vec<String>>

The list of groups you want to filter search results based on the groups' access to documents.

data_source_groups: Option<Vec<DataSourceGroup>>

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

Implementations

impl UserContext

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

The user context token for filtering search results for a user. It must be a JWT or a JSON token.

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

The identifier of the user you want to filter search results based on their access to documents.

pub fn groups(&self) -> &[String]

The list of groups you want to filter search results based on the groups' 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 .groups.is_none().

pub fn data_source_groups(&self) -> &[DataSourceGroup]

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

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

impl UserContext

pub fn builder() -> UserContextBuilder

Creates a new builder-style object to manufacture UserContext.

Trait Implementations

impl Clone for UserContext

fn clone(&self) -> UserContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserContext

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

Formats the value using the given formatter.

impl PartialEq for UserContext

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