:doc:`CustomerProfiles <../../customer-profiles>` / Client / get_similar_profiles

********************
get_similar_profiles
********************



.. py:method:: CustomerProfiles.Client.get_similar_profiles(**kwargs)

  

  Returns a set of profiles that belong to the same matching group using the ``matchId`` or ``profileId``. You can also specify the type of matching that you want for finding similar profiles using either ``RULE_BASED_MATCHING`` or ``ML_BASED_MATCHING``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSimilarProfiles>`_  


  **Request Syntax**
  ::

    response = client.get_similar_profiles(
        NextToken='string',
        MaxResults=123,
        DomainName='string',
        MatchType='RULE_BASED_MATCHING'|'ML_BASED_MATCHING',
        SearchKey='string',
        SearchValue='string'
    )
    
  :type NextToken: string
  :param NextToken: 

    The pagination token from the previous ``GetSimilarProfiles`` API call.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of objects returned per page.

    

  
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    The unique name of the domain.

    

  
  :type MatchType: string
  :param MatchType: **[REQUIRED]** 

    Specify the type of matching to get similar profiles for.

    

  
  :type SearchKey: string
  :param SearchKey: **[REQUIRED]** 

    The string indicating the search key to be used.

    

  
  :type SearchValue: string
  :param SearchValue: **[REQUIRED]** 

    The string based on ``SearchKey`` to be searched for similar profiles.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ProfileIds': [
              'string',
          ],
          'MatchId': 'string',
          'MatchType': 'RULE_BASED_MATCHING'|'ML_BASED_MATCHING',
          'RuleLevel': 123,
          'ConfidenceScore': 123.0,
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ProfileIds** *(list) --* 

        Set of ``profileId``s that belong to the same matching group.

        
        

        - *(string) --* 
    
      

      - **MatchId** *(string) --* 

        The string ``matchId`` that the similar profiles belong to.

        
      

      - **MatchType** *(string) --* 

        Specify the type of matching to get similar profiles for.

        
      

      - **RuleLevel** *(integer) --* 

        The integer rule level that the profiles matched on.

        
      

      - **ConfidenceScore** *(float) --* 

        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.

        
      

      - **NextToken** *(string) --* 

        The pagination token from the previous ``GetSimilarProfiles`` API call.

        
  
  **Exceptions**
  
  *   :py:class:`CustomerProfiles.Client.exceptions.BadRequestException`

  
  *   :py:class:`CustomerProfiles.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`CustomerProfiles.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CustomerProfiles.Client.exceptions.ThrottlingException`

  
  *   :py:class:`CustomerProfiles.Client.exceptions.InternalServerException`

  