Struct GetSimilarProfilesOutput

#[non_exhaustive]
pub struct GetSimilarProfilesOutput {
    pub profile_ids: Option<Vec<String>>,
    pub match_id: Option<String>,
    pub match_type: Option<MatchType>,
    pub rule_level: Option<i32>,
    pub confidence_score: Option<f64>,
    pub next_token: Option<String>,
    /* 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.

profile_ids: Option<Vec<String>>

Set of profileIds that belong to the same matching group.

match_id: Option<String>

The string matchId that the similar profiles belong to.

match_type: Option<MatchType>

Specify the type of matching to get similar profiles for.

rule_level: Option<i32>

The integer rule level that the profiles matched on.

confidence_score: Option<f64>

It only has value when the MatchType is ML_BASED_MATCHING.A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used as an absolute measure of matching quality.

next_token: Option<String>

The pagination token from the previous GetSimilarProfiles API call.

Implementations

impl GetSimilarProfilesOutput

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

Set of profileIds that belong to the same matching group.

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

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

The string matchId that the similar profiles belong to.

pub fn match_type(&self) -> Option<&MatchType>

Specify the type of matching to get similar profiles for.

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

The integer rule level that the profiles matched on.

pub fn confidence_score(&self) -> Option<f64>

It only has value when the MatchType is ML_BASED_MATCHING.A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used as an absolute measure of matching quality.

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

The pagination token from the previous GetSimilarProfiles API call.

impl GetSimilarProfilesOutput

pub fn builder() -> GetSimilarProfilesOutputBuilder

Creates a new builder-style object to manufacture GetSimilarProfilesOutput.

Trait Implementations

impl Clone for GetSimilarProfilesOutput

fn clone(&self) -> GetSimilarProfilesOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetSimilarProfilesOutput

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

Formats the value using the given formatter.

impl PartialEq for GetSimilarProfilesOutput

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

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

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

impl StructuralPartialEq for GetSimilarProfilesOutput