🧠 Assess Profile Eligibility for Scoring
Validate profiles for HrFlow.ai Scoring API to unlock accurate and efficient matches.
Before indexing a profile to our Scoring API, it's essential to ensure its quality and completeness. This guide will walk you through the process for determining if a profile is eligible for Scoring using HrFlow.ai's SDK.
Why Validate Profile Eligibility?
Validating whether a profile is eligible for scoring is crucial for several reasons:
- Efficient Resource Use: Avoid processing profiles that do not meet the eligibility requirements, saving time and computational resources.
- Improve Scoring Accuracy: Ensure profiles have sufficient information for meaningful scoring profiles.
Eligibility Criteria
The profile must meet the criteria for being indexable on the Searching API. For more information, refer to Profile Searching.
Additionally, the following criteria are used to determine whether a profile should be indexed on the Scoring engine:
- Experiences Check: The profile must contain at least 1 experience with a valid company entry.
- Educations Check: The profile must include at least 1 education entry with essential information such as school or title.
- Summary Check: The summary must be a non-empty string.
- Skills Check: The profile must have at least 1 skill.
- Tasks Check: The profile must contain at least 1 task.
![Profile Scoring Validation Process](https://files.readme.io/65fc668-profile_scoring_validation.png)
Profile Scoring Validation Process
![Profile Experiences Validation Process](https://files.readme.io/c06ee11-profile_experiences_validation.png)
Profile Experiences Validation Process
![Profile Education Validation Process](https://files.readme.io/579c661-profile_educations_validation.png)
Profile Education Validation Process
Profiles failing to meet any of these requirements will not be indexed to the Scoring API.
For a profile to be available through the Scoring API, it must meet all of these criteria, ensuring that only high-quality and relevant profiles are included in the scoring results.
Check Eligibility with Python SDK
You can validate a profile's eligibility for Scoring using its data directly. If you have the profile as a JSON object or a HrFlowProfile schema object, simply pass it to the validation function.
To use this feature, ensure you have HrFlow.ai Python SDK version 4.1.0 or above. Install it via pip with pip install -U hrflow>=4.1.0
or via conda with conda install hrflow>=4.1.0 -c conda-forge
.
from hrflow.utils.scoring import is_valid_for_scoring
from hrflow.schemas import HrFlowProfile
# Assuming you have profile data as a dictionary (JSON)
profile_dict = {...}
# Or as a HrFlowProfile object
profile_obj = HrFlowProfile(...)
is_scoring_dict = is_valid_for_scoring(profile_dict)
is_scoring_obj = is_valid_for_scoring(profile_obj)
print(f"Profile is valid for scoring (dict): {is_scoring_dict}")
print(f"Profile is valid for scoring (object): {is_scoring_obj}")
Additional Resources
- HrFlow.ai Python SDK on PyPI
- HrFlow Cookbook: Repository containing helpful notebooks by the HrFlow.ai team
- API Authentication Documentation
- Profile Object Documentation
- Index a Profile documentation
- Get a Profile documentation
- Use Profile Schema
- Profile Scoring
- How to Determine Profile Eligibility for Searching
Updated 2 months ago