Match Narrative

Creates a short narrative explaining a candidate's fit for a job.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Important: This version of match-narrative aligns to Evaluate Candidates v5. If used with a different version of evaluate-candidates, the narrative and match scores may not align.

Use this endpoint to create a Match Narrative, a natural language summary that helps users interpret an evaluation (e.g., provided by evaluate-candidates) of a candidate-job pair. Match Narratives help users to instantly understand a Candidate's fit for a Job, streamlining hiring and job searches.

Each narrative includes discrete sections on the candidate's fit for a role based on work history, skills, and education, along with an overall assessment of fit. The detailed sections contain supporting citations of relevant work experience, important skills, and certifications that a candidate does or does not have, the relevance of a degree program, and more.

Additional Notes:

  • Intended Usage: The match-narrative endpoint is intended to be called separately from a search or matching API call, to populate a more detailed UI on demand (instead of being called for every search or match result).
  • Mitigating Bias: Instead of allowing an LLM to derive any evaluation of fit between candidate and job, AdeptID uses a series of rules/logic to construct the narrative based on the quantitative evaluations from the audited AdeptID models.
  • Privacy: LLMs are not used when constructing the Match Narrative.
  • Languages: The output language is specified using the IETF BCP 47 (e.g., “en-US”) standard. See Languages for a list of acceptable codes.
Deprecated Version Information
Match Narrative v3 (Deprecated)
Match Narrative v2 (Deprecated)
Body Params
string
enum
Defaults to en-US
boolean
Defaults to false

When true, the candidate object is not persisted, and operation_id is null in the response.

candidate
object
required
destination_job
object
required
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json