How to use chatur-sdk

Easily generate tailored job descriptions and parse resumes using the powerful Chatur SDK.

Installation

Use the package manager npm to install chatur-sdk.

npm install chatur-sdk

Usage

To generate API-KEY click: Generate API-KEY

import Chatur from "chatur-sdk";

/* Initialize SDK using api-key */
const chatur = new Chatur({apiKey: "api-key"});

/* Use SDK method 
1. To create job description.
2. To parse you resumes.
3. To get the result of job-description and parse resumes.
*/

Creating Job Description

const payload = { 
    company_name: "Wasserstoff", 
    job_title: "Senior Software Engineer",
    department: "Engineering", location: "Gurugram, India", 
    job_type: "Full-time", 
    skills: ["React", "JavaScript", "TypeScript", "Node.js", "AWS"],
    qualifications: ["Bachelor's degree in Computer Science or related field", "5+ years of software development experience"],  
    experience: "5-7 years",
    salary_range: "15-20 LPA",
    about_url: "https://wasserstoff.com/about",
    tone: "professional and engaging",
    language: "English"
    }

chatur.createJobDescription(payload).then((response) => {console.log(response)}).catch((error) => { console.log(error)})

JD creation Response

{
  status_code: 200,
  status: true,
  message: 'JD created Successfully.',
  data: {
    task_id: 'unique strings',
    chat_id: 'unique strings'
  }
}

Getting Details of JD

/* This method is used for getting details of both JD-Creation and Parse-Resume
@ use the unique string that you get from JD-Creation and Parse-Resume response
*/ 
const payload = {
    task_id: "unique strings", 
    chat_id:"unique strings"
    }

chatur.getTaskStatus(payload).then((response) => {console.log(response)}).catch((error) => { console.log(error)})

Response of taskStatus method

{
  status_code: 200,
  status: true,
  message: 'Job description fetched successfully',
  data: {
    jd: { jd_id: 'unique strings', job_description: [object] },
    status: 'SUCCESS'
  }
}

Parsing resumes

/* This method taked Array of files
@ resume_files --> Array of files
@jd_file --> Job description file
@ jd_id --> use that you get from taskStatus method after getting JD-creation result
@job_description --> string of Job description

*/
chatur.parseResume({resume_files: ["file_1", "file_2"....], job_description: ""})

// Note -- ["file_1", "file_2"....] should be actual file array here i am demonstrating how it goes so i am using string only.

Response of Parse Resume

{
  status_code: 200,
  status: true,
  message: 'Resume parsing task queued successfully',
  data: {
    task_id: 'Unique strings',
    chat_id: 'Unique strings'
  }
}