Merge pull request #21 from magicalapi/update-matcher

Update Resume matcher

Author: AmirAref

README.md

@@ -81,8 +81,8 @@ It offers services like:
 
 ## Supported APIs
 - Resume Parser
-- Resume Checker
-- Resume Matcher
+- Resume Checker(Review)
+- Resume Matcher(Score)
 - LinkedIn Profile Scraper
 - LinkedIn Company Scraper
 

examples/resume_score.py

@@ -7,7 +7,10 @@
 resume_url = (
     "https://resume-resource.com/wp-content/uploads/00123-sales-professional-resume.pdf"
 )
-job_description = "Sales Professional"
+job_description = (
+    "We are hiring a sales professional with proven B2B pipeline management, "
+    "CRM discipline, account growth ownership, and strong written communication."
+)
 output_file_name = "resume_score.json"
 
 

magicalapi/services/company_data_service.py

@@ -1,5 +1,5 @@
 """
-this file stores the implementation of company data Service.
+this file stores the implementation of LinkedIn Company Scraper Service.
 https://magicalapi.com/services/company-data
 
 """
@@ -24,7 +24,7 @@ async def get_company_data(
         company_name: str | None = None,
         company_website: str | None = None,
     ) -> CompanyDataResponse | WebhookCreatedResponse | ErrorResponse:
-        """this method sends request to company data service in magicalAPI.
+        """this method sends request to LinkedIn Company Scraper service in magicalAPI.
         https://magicalapi.com/services/company-data
 
         company_name (``str``):

magicalapi/services/profile_data_service.py

@@ -1,5 +1,5 @@
 """
-this file stores the implementation of profile data Service.
+this file stores the implementation of LinkedIn Profile Scraper Service.
 https://magicalapi.com/services/profile-data
 
 """
@@ -21,7 +21,7 @@ class ProfileDataService(BaseService):
     async def get_profile_data(
         self, profile_name: str
     ) -> ProfileDataResponse | WebhookCreatedResponse | ErrorResponse:
-        """this method sends request to profile data service in magicalAPI.
+        """this method sends request to LinkedIn Profile Scraper service in magicalAPI.
         https://magicalapi.com/services/profile-data
 
         profile_name (``str``):
@@ -49,4 +49,4 @@ async def get_profile_data(
     def validate_response(
         self, response: HttpResponse, validate_model: type[BaseModel]
     ) -> ProfileDataResponse | WebhookCreatedResponse | ErrorResponse:
-        return super().validate_response(response, validate_model)  # type:ignore
+        return super().validate_response(response, validate_model)  # type: ignore

magicalapi/services/resume_review_service.py

@@ -1,5 +1,5 @@
 """
-this file stores the implementation of resume review Service.
+this file stores the implementation of Resume Checker(Review) Service.
 https://magicalapi.com/services/resume-review
 
 """
@@ -19,7 +19,7 @@ class ResumeReviewService(BaseService):
     async def get_resume_review(
         self, url: str
     ) -> ResumeReviewResponse | WebhookCreatedResponse | ErrorResponse:
-        """this method sends request to resume review service in magicalAPI.
+        """this method sends request to Resume Checker(Review) service in magicalAPI.
         https://magicalapi.com/services/resume-review
 
         url (``str``):

magicalapi/services/resume_score_service.py

@@ -1,5 +1,5 @@
 """
-this file stores the implementation of resume score Service.
+this file stores the implementation of Resume Matcher(Score) Service.
 https://magicalapi.com/services/resume-score
 
 """
@@ -19,7 +19,7 @@ class ResumeScoreService(BaseService):
     async def get_resume_score(
         self, url: str, job_description: str
     ) -> ResumeScoreResponse | WebhookCreatedResponse | ErrorResponse:
-        """this method sends request to resume score service in magicalAPI.
+        """this method sends request to Resume Matcher(Score) service in magicalAPI.
         https://magicalapi.com/services/resume-score
 
         url (``str``):
@@ -28,13 +28,22 @@ async def get_resume_score(
         job_description (``str``):
             give some description of the job,
             your resume score will calculate based on your job description.
+            must be between 100 and 5000 characters long.
 
         Returns:
             ResumeScoreResponse: When request completes successfully (no webhook).
             WebhookCreatedResponse: When using webhook_url (immediate acknowledgment).
             ErrorResponse: When an error occurs (e.g., 403 if webhook domain not whitelisted).
 
+        Raises:
+            ValueError: If job_description is not between 100 and 5000 characters long.
+
         """
+        if not 100 <= len(job_description) <= 5000:
+            raise ValueError(
+                "job_description must be between 100 and 5000 characters long"
+            )
+
         request_body = {
             "url": url,
             "job_description": job_description,

magicalapi/types/company_data.py

@@ -64,7 +64,7 @@ class Funding(BaseModelValidated):
 
 class Company(BaseModelValidated):
     """
-    The main type of company data service
+    The main type of LinkedIn Company Scraper service
     """
 
     url: str

magicalapi/types/profile_data.py

@@ -151,7 +151,7 @@ class Patent(BaseModelValidated):
 
 class Profile(BaseModelValidated):
     """
-    The main type of linkedin profile data service
+    The main type of LinkedIn Profile Scraper service
     """
 
     url: str

magicalapi/types/resume_review.py

@@ -1,5 +1,5 @@
 """
-types schem of resume review service
+types schema of Resume Checker(Review) service
 
 """
 

magicalapi/types/resume_score.py

@@ -1,22 +1,102 @@
 """
-types schem of resume score service
+types schema of Resume Matcher(Score) service
 https://magicalapi.com/services/resume-score
 """
 
 from __future__ import annotations
 
+from typing import Literal
+
 from .base import BaseModelValidated, BaseResponse
 
+Category = Literal[
+    "job",
+    "education",
+    "skills",
+    "other",
+]
+
+
+class StrengthItem(BaseModelValidated):
+    text: str | None
+    category: Category
+
+
+class ImprovementItem(BaseModelValidated):
+    text: str | None
+    category: Category
+
+
+class ProsSchema(BaseModelValidated):
+    type: str | None
+    message: str | None
+
+
+class ConsSchema(BaseModelValidated):
+    type: str | None
+    message: str | None
+
+
+class WarnSchema(BaseModelValidated):
+    type: str | None
+    message: str | None
+
+
+class JobMatchResponse(BaseModelValidated):
+    score: int
+    summary: str | None
+    pros: list[ProsSchema]
+    cons: list[ConsSchema]
+    warns: list[WarnSchema]
+
+
+class SkillGroups(BaseModelValidated):
+    all_skills: list[str]
+
+
+class SkillMatch(BaseModelValidated):
+    miss_match: list[str]
+    partial_match: list[str]
+    strong_match: list[str]
+
+
+class SkillMatchResponse(BaseModelValidated):
+    score: int
+    summary: str | None
+    skills: SkillGroups
+    match_result: SkillMatch
+
+
+class EducationMatchResponse(BaseModelValidated):
+    score: int
+    summary: str | None
+    pros: list[ProsSchema]
+    cons: list[ConsSchema]
+    warns: list[WarnSchema]
+
+
+class MoreInformationResponse(BaseModelValidated):
+    region: str | None
+    overqualification_status: bool
+    qualification_reason: str | None
+
 
-class ResumeScore(BaseModelValidated):
+class ScoreResponse(BaseModelValidated):
     score: int
-    reason: str
+    summary: str
+    strengths: list[StrengthItem]
+    improvements: list[ImprovementItem]
+    job_match: JobMatchResponse
+    skill_match: SkillMatchResponse
+    education_match: EducationMatchResponse
+    more_information: MoreInformationResponse
+    jd_text: str | None
 
 
 class ResumeScoreResponse(BaseResponse):
     """
-    the main resposne schema for resume score service
+    the main response schema for Resume Matcher(Score) service
     https://magicalapi.com/services/resume-score
     """
 
-    data: ResumeScore
+    data: ScoreResponse