JSPM

@sharpapi/sharpapi-node-generate-keywords

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

SharpAPI.com Node.js SDK for generating keywords from text

Package Exports

  • @sharpapi/sharpapi-node-generate-keywords
  • @sharpapi/sharpapi-node-generate-keywords/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-generate-keywords) 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

Keywords & Tags Generator API for Node.js

šŸ·ļø Extract keywords and generate tags from text — powered by SharpAPI AI.

npm version License

SharpAPI Keywords & Tags Generator uses advanced AI to extract relevant keywords and generate tags from text content. Perfect for SEO, content categorization, and metadata generation.


šŸ“‹ Table of Contents

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

Requirements

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

Installation

Step 1. Install the package via npm:

npm install @sharpapi/sharpapi-node-generate-keywords

Step 2. Get your API key

Visit SharpAPI.com to get your API key.


Usage

const { SharpApiGenerateKeywordsService } = require('@sharpapi/sharpapi-node-generate-keywords');

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

const text = `
Cloud computing has revolutionized how businesses operate by providing on-demand access
to computing resources. Companies can now scale their infrastructure automatically based
on demand, reducing costs and improving efficiency.
`;

async function generateKeywords() {
  try {
    // Submit keyword generation job
    const statusUrl = await service.generateKeywords(text);
    console.log('Job submitted. Status URL:', statusUrl);

    // Fetch results (polls automatically until complete)
    const result = await service.fetchResults(statusUrl);
    const keywords = result.getResultJson();

    console.log('Generated keywords:', keywords);
  } catch (error) {
    console.error('Error:', error.message);
  }
}

generateKeywords();

API Documentation

Methods

generateKeywords(text: string, maxKeywords?: number, language?: string): Promise<string>

Extracts keywords and generates tags from the provided text.

Parameters:

  • text (string, required): The text content to analyze
  • maxKeywords (number, optional): Maximum number of keywords to return (default: 10)
  • language (string, optional): The language of the text (default: 'English')

Returns:

  • Promise: Status URL for polling the job result

Example:

const statusUrl = await service.generateKeywords(articleText, 15, 'English');
const result = await service.fetchResults(statusUrl);

Response Format

The API returns extracted keywords with relevance scores:

{
  "keywords": [
    {
      "keyword": "cloud computing",
      "relevance": 0.95,
      "occurrences": 3
    },
    {
      "keyword": "on-demand access",
      "relevance": 0.88,
      "occurrences": 2
    },
    {
      "keyword": "computing resources",
      "relevance": 0.82,
      "occurrences": 2
    }
  ],
  "tags": [
    "cloud-computing",
    "infrastructure",
    "scalability",
    "business-technology"
  ]
}

Examples

Basic Keyword Extraction

const { SharpApiGenerateKeywordsService } = require('@sharpapi/sharpapi-node-generate-keywords');

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

const blogPost = `
Artificial intelligence is transforming healthcare through predictive analytics,
personalized treatment plans, and automated diagnostics. Machine learning algorithms
can now detect diseases earlier than traditional methods.
`;

service.generateKeywords(blogPost, 8)
  .then(statusUrl => service.fetchResults(statusUrl))
  .then(result => {
    const data = result.getResultJson();
    console.log('šŸ”‘ Top Keywords:');
    data.keywords.forEach((kw, index) => {
      console.log(`${index + 1}. ${kw.keyword} (relevance: ${kw.relevance})`);
    });
    console.log('\nšŸ·ļø Suggested Tags:', data.tags.join(', '));
  })
  .catch(error => console.error('Generation failed:', error));

SEO Keyword Analysis

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

const productDescription = `
Professional noise-canceling wireless headphones with 40-hour battery life.
Features advanced Bluetooth 5.0 technology, premium sound quality, and
comfortable over-ear design. Perfect for travel, work, and entertainment.
`;

const statusUrl = await service.generateKeywords(productDescription, 12);
const result = await service.fetchResults(statusUrl);
const keywordData = result.getResultJson();

// Filter high-relevance keywords for SEO
const seoKeywords = keywordData.keywords
  .filter(kw => kw.relevance >= 0.8)
  .map(kw => kw.keyword);

console.log('High-value SEO keywords:', seoKeywords);

Content Categorization

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

const articles = [
  { id: 1, content: 'Article about web development...' },
  { id: 2, content: 'Article about digital marketing...' },
  { id: 3, content: 'Article about machine learning...' }
];

const categorized = await Promise.all(
  articles.map(async (article) => {
    const statusUrl = await service.generateKeywords(article.content, 5);
    const result = await service.fetchResults(statusUrl);
    const data = result.getResultJson();

    return {
      id: article.id,
      category: data.tags[0], // Primary category
      keywords: data.keywords.slice(0, 3).map(kw => kw.keyword),
      tags: data.tags
    };
  })
);

console.log('Categorized content:', categorized);

Use Cases

  • SEO Optimization: Generate keywords for meta tags and content optimization
  • Content Categorization: Auto-tag articles, products, and documents
  • Search Enhancement: Improve search functionality with extracted keywords
  • Metadata Generation: Automatically create metadata for CMS systems
  • Topic Modeling: Identify main topics and themes in text
  • Content Discovery: Enable better content recommendations
  • Analytics: Track keyword trends and content themes

Keyword Types

The generator identifies various keyword types:

  • Single Keywords: Individual important terms
  • Key Phrases: Multi-word expressions (2-4 words)
  • Named Entities: People, places, organizations
  • Technical Terms: Industry-specific terminology
  • Action Words: Verbs and action-oriented phrases
  • Topic Tags: High-level categorical tags

API Endpoint

POST /content/keywords

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