Match Narrative (Deprecated v2)

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…
🚧

Deprecated

This version has been deprecated. Please use Match Narrative v4 instead. This version will continue to function but will not receive updates.

📘

Important: This version of match-narrative aligns to Evaluate Candidates v2. 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 4-5 sentence natural language summary to help users interpret an evaluation 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 communicates the primary drivers of a Match. These may include fit based on skills, work history, and education, as well as supporting citations of relevant work experience, important skills, and certifications that a candidate does or does not have, the relevance of a degree program, or other details supporting the evaluation.

AdeptID uses a Large Language Model (LLM) paired with AdeptID’s custom assessments to generate the narrative. AdeptID recommends that customers accompany the match narrative with a short statement that clearly and conspicuously states the narrative text was produced with generative AI.

Additional Notes:

  • Enabling this service: This is a value-added service and is not available by default. To access this service, please contact your AdeptID Partner Success team.
  • Intended Usage: The match-narrative endpoint is intended to be called asynchronously 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). This is a synchronous endpoint with a latency of multiple seconds; users should consider this when configuring API timeout limits.
  • Mitigating Bias: Instead of allowing an LLM to derive any evaluation of fit between candidate and job, an LLM is provided with quantitative evaluations from the audited AdeptID models; the LLM then converts the model outputs into a natural language format. This helps to avoid common hallucination and bias risks associated with LLMs.
  • Privacy: The data provided to an LLM for Match Narrative generation is not utilized in the training of subsequent LLMs. For more information on AdeptID’s approach to data privacy and security, see https://trust.adept-id.com/.
  • Languages: The output language is specified using the IETF BCP 47 (e.g., “en-US”) standard. See Languages for a list of acceptable codes.
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