JSPM

@sharpapi/sharpapi-node-related-job-positions

1.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 9
  • Score
    100M100P100Q30771F
  • License MIT

SharpAPI.com Node.js SDK for finding related job positions

Package Exports

  • @sharpapi/sharpapi-node-related-job-positions
  • @sharpapi/sharpapi-node-related-job-positions/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@sharpapi/sharpapi-node-related-job-positions) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

SharpAPI GitHub cover

Related Job Positions Generator API for Node.js

npm version License

SharpAPI Related Job Positions Generator uses AI to generate a list of related job positions based on the provided position name. Perfect for HR tech, job boards, recruitment platforms, and career development tools.


📋 Table of Contents

  1. Requirements
  2. Installation
  3. Usage
  4. API Documentation
  5. Response Format
  6. Examples
  7. License

Requirements

  • Node.js >= 16.x
  • npm or yarn

Installation

Step 1. Install the package via npm:

npm install @sharpapi/sharpapi-node-related-job-positions

Step 2. Get your API key

Visit SharpAPI.com to get your API key.


Usage

const { SharpApiRelatedJobPositionsService } = require('@sharpapi/sharpapi-node-related-job-positions');

const apiKey = process.env.SHARP_API_KEY; // Store your API key in environment variables
const service = new SharpApiRelatedJobPositionsService(apiKey);

const jobPosition = 'Frontend Developer';

async function generateRelatedPositions() {
  try {
    // Submit related job positions generation job
    const statusUrl = await service.generateRelatedJobPositions(jobPosition, 'English', 10);
    console.log('Job submitted. Status URL:', statusUrl);

    // Fetch results (polls automatically until complete)
    const result = await service.fetchResults(statusUrl);
    console.log('Related positions:', result.getResultJson());
  } catch (error) {
    console.error('Error:', error.message);
  }
}

generateRelatedPositions();

API Documentation

Methods

generateRelatedJobPositions(jobPositionName: string, language?: string, maxQuantity?: number, voiceTone?: string, context?: string): Promise<string>

Generates a list of related job positions based on the provided position name.

Parameters:

  • jobPositionName (string, required): The job position name to find related positions for
  • language (string, optional): Output language (default: 'English')
  • maxQuantity (number, optional): Maximum number of related positions to return (default: 10)
  • voiceTone (string, optional): Tone of the response (e.g., 'Professional', 'Casual')
  • context (string, optional): Additional context for the AI

Returns:

  • Promise: Status URL for polling the job result

Example:

const statusUrl = await service.generateRelatedJobPositions(
  'Data Scientist',
  'English',
  8,
  'Professional',
  'Focus on senior-level positions in tech companies'
);
const result = await service.fetchResults(statusUrl);

Response Format

The API returns related job positions with relevance scores (weight: 0-10, where 10 is the highest relevance):

{
  "data": {
    "type": "api_job_result",
    "id": "80d0a822-0e2a-40e1-97fd-e7fd62ec9eb0",
    "attributes": {
      "status": "success",
      "type": "hr_related_job_positions",
      "result": {
        "job_position": "Flutter Mobile Developer",
        "related_job_positions": [
          {
            "name": "Android Developer",
            "weight": 8
          },
          {
            "name": "iOS Developer",
            "weight": 8.5
          },
          {
            "name": "Mobile App Developer",
            "weight": 9.5
          },
          {
            "name": "React Native Developer",
            "weight": 7.5
          },
          {
            "name": "Flutter Developer",
            "weight": 10
          },
          {
            "name": "Cross-Platform Mobile Developer",
            "weight": 7
          },
          {
            "name": "Mobile Software Engineer",
            "weight": 9
          },
          {
            "name": "App Developer",
            "weight": 7
          }
        ]
      }
    }
  }
}

Weight Scale:

  • 10.0 - Exact match or extremely similar position
  • 8.0-9.9 - Highly related (very similar responsibilities)
  • 6.0-7.9 - Moderately related (overlapping skills and duties)
  • 4.0-5.9 - Somewhat related (some transferable skills)
  • 1.0-3.9 - Loosely related (adjacent career paths)

Examples

const { SharpApiRelatedJobPositionsService } = require('@sharpapi/sharpapi-node-related-job-positions');

const service = new SharpApiRelatedJobPositionsService(process.env.SHARP_API_KEY);

service.generateRelatedJobPositions('DevOps Engineer', 'English', 6)
  .then(statusUrl => service.fetchResults(statusUrl))
  .then(result => {
    const data = result.getResultJson();
    console.log(`Related positions for ${data.result.job_position}:`);

    data.result.related_job_positions
      .sort((a, b) => b.weight - a.weight)
      .forEach((position, index) => {
        console.log(`${index + 1}. ${position.name} (relevance: ${position.weight}/10)`);
      });
  })
  .catch(error => console.error('Generation failed:', error));

Job Recommendation System

const service = new SharpApiRelatedJobPositionsService(process.env.SHARP_API_KEY);

async function recommendCareerPaths(currentPosition) {
  const statusUrl = await service.generateRelatedJobPositions(
    currentPosition,
    'English',
    15
  );

  const result = await service.fetchResults(statusUrl);
  const data = result.getResultJson();

  // Categorize by relevance
  const exactMatch = data.result.related_job_positions.filter(p => p.weight === 10);
  const highlyRelated = data.result.related_job_positions.filter(p => p.weight >= 8 && p.weight < 10);
  const related = data.result.related_job_positions.filter(p => p.weight >= 6 && p.weight < 8);

  return {
    current: currentPosition,
    exactMatches: exactMatch.map(p => p.name),
    lateralMoves: highlyRelated.map(p => p.name),
    careerPivots: related.map(p => p.name)
  };
}

const recommendations = await recommendCareerPaths('Product Manager');

console.log('Career Path Recommendations:');
console.log('\nLateral Moves (Similar Roles):');
recommendations.lateralMoves.forEach(job => console.log(`  - ${job}`));

console.log('\nCareer Pivot Options:');
recommendations.careerPivots.forEach(job => console.log(`  - ${job}`));

Job Board Enhancement

const service = new SharpApiRelatedJobPositionsService(process.env.SHARP_API_KEY);

async function expandJobSearch(userSearchTerm) {
  const statusUrl = await service.generateRelatedJobPositions(
    userSearchTerm,
    'English',
    20
  );

  const result = await service.fetchResults(statusUrl);
  const data = result.getResultJson();

  // Filter high-relevance positions for expanded search
  const expandedSearchTerms = data.result.related_job_positions
    .filter(position => position.weight >= 7)
    .map(position => position.name);

  return {
    original: userSearchTerm,
    expanded: [userSearchTerm, ...expandedSearchTerms],
    message: `Searching for ${expandedSearchTerms.length + 1} related positions`
  };
}

const expandedSearch = await expandJobSearch('Full Stack Developer');

console.log(expandedSearch.message);
console.log('Search terms:', expandedSearch.expanded.join(', '));

Talent Pool Mapping

const service = new SharpApiRelatedJobPositionsService(process.env.SHARP_API_KEY);

async function mapTalentPool(targetPosition) {
  const statusUrl = await service.generateRelatedJobPositions(
    targetPosition,
    'English',
    12
  );

  const result = await service.fetchResults(statusUrl);
  const data = result.getResultJson();

  // Identify candidates with transferable experience
  const transferablePositions = data.result.related_job_positions
    .filter(position => position.weight >= 6)
    .map(position => ({
      title: position.name,
      relevance: position.weight,
      trainingRequired: position.weight < 8 ? 'Moderate' : 'Minimal'
    }));

  return {
    targetRole: targetPosition,
    candidates: transferablePositions,
    totalPool: transferablePositions.length
  };
}

const talentMap = await mapTalentPool('Machine Learning Engineer');

console.log(`Talent Pool for ${talentMap.targetRole}:`);
console.log(`Total candidate sources: ${talentMap.totalPool}`);

talentMap.candidates.forEach(candidate => {
  console.log(`\n${candidate.title}`);
  console.log(`  Relevance: ${candidate.relevance}/10`);
  console.log(`  Training: ${candidate.trainingRequired}`);
});

Use Cases

  • Job Recommendations: Suggest related positions to job seekers
  • Career Pathing: Guide professionals on potential career moves
  • Recruitment Expansion: Broaden candidate search beyond exact title matches
  • Job Board Search: Enhance search with related position suggestions
  • Internal Mobility: Help HR identify lateral move opportunities
  • Talent Mapping: Identify candidates with transferable experience
  • Job Description Writing: Suggest alternative titles for positions

API Endpoint

POST /hr/related_job_positions

For detailed API specifications, refer to:



License

This project is licensed under the MIT License. See the LICENSE.md file for details.


Support


Powered by SharpAPI - AI-Powered API Workflow Automation