Skip to main content

Squillify development is paused indefinitely. Read why, and discover what this experiment achieved. Read the story

MicroSkills Reference

Keyword Extractor

text.extract_keywords

ProductionHeuristic (Class C)Deterministicbest-effortfastv1.0.0
File inputNo network

Overview

Extracts keyword candidates using single-document term-frequency (TF) analysis with stopword filtering. This is TF only — NOT TF-IDF: there is no reference corpus or inverse-document-frequency weighting, so common-but-uninformative terms are down-weighted only by the stopword list. Deterministic, no LLM. Stable sort by frequency desc, first occurrence, then lexical order. Accepts file input via file_ref — no need to extract file content first.

Word-frequency ranking is statistical, not semantic — we give you deterministic TF-based keywords so tagging and indexing stay reproducible without LLM overhead.

Reliability

BEST_EFFORT and deterministic on this deployment — identical input always yields identical rankings (frequency desc, then first occurrence, then lexical order). Single-document TF only (no IDF/corpus), so common terms may rank high unless you extend stopwords. We lower-case everything and skip one-character words, and a hyphenated or apostrophised word stays whole. Input validation (not retryable): stopwords that is not an array of strings; neither text nor file_ref; both text and file_ref; text longer than 1,048,576 characters.

Context footprint

Accepts inline text up to ~1M chars or file input via file_ref (up to 2 MB). Upload files via POST /v1/files/upload before passing file_ref. A successful call costs 2 execution credits.

When to use it

When you need ranked keyword candidates from a document for tags, search indexes, or classification — especially in batch pipelines.

Do not use for semantic understanding, topic modeling, or named-entity recognition (use text.extract_entities_regex instead).

Scope

Note
We extract ranked keyword candidates from your text using deterministic term-frequency analysis — frequency counts, normalized scores, custom stopwords, and a configurable limit. No LLM involved.

Non-goals

  • Does not perform semantic or contextual analysis — purely statistical
  • Does not use LLM-based extraction or embeddings
  • Does not perform topic modeling or clustering

Properties

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

analysistext-processing

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call2 credits

File handling

Accepts file_refProduces file_refMax input1 MBMax file size1.9 MB

File limits

Constraints this skill applies to your input and generated files. The “Limited by” column shows the static source of each cap; none of these can be raised by upgrading your plan.

LimitValueLimited by
Maximum size per input file1.9 MiBSkill maximum

How we handle your data

Sensitive output possible
What this means

This skill may receive sensitive content and may return submitted, transformed, extracted, or reformatted content.

Squillify guarantees
  • Runs inside Squillify
  • This skill runs inside Squillify.
  • Payloads are not sent to an external service by this skill.
  • Squillify does not permanently store submitted payloads.
  • Telemetry records metadata only, not submitted content.
  • Submitted payloads are not used for training.
  • Submitted payloads are not reviewed by humans.
  • This skill does not target sensitive data.
  • The response may contain submitted or transformed content.
Your responsibility

Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.

Read the Microskill Data Handling Policy

Input schema

FieldTypeRequiredDescription
textstringNoBounded inline text source. Required unless file_ref is provided.
file_refstringNoTenant-scoped opaque text-file reference. Omit it to use the required inline text; never send both.
maxKeywordsintegerNoKeyword cap; omit it for ten.
stopwordsarrayNoBounded optional stopword array; omit it to use the pinned built-in English stopword set. The item shape is defined by the nested schema and the array contains from 0 through 10000 items.

Output schema

FieldTypeRequiredDescription
keywordsarrayYesBounded array of keyword receipts ordered by score with keyword, count, and score properties. The item shape is defined by the nested schema and the array contains from 0 through 1000 items.
totalCandidatesintegerYesCandidate count before truncation.
returnedintegerYesReturned keyword count.
methodstringYesApplied extraction method.
stopwordsVersionstringYesPinned built-in stopword-set version.
truncatedbooleanNoWhether the keyword cap omitted candidates.

API contract

POST /v1/execute
curl
curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"text.extract_keywords","input":{"text":"Cloud computing infrastructure enables scalable resources.","maxKeywords":10}}'
Integrations
TypeScript SDK
import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("text.extract_keywords", {"maxKeywords":5,"text":"Cloud computing infrastructure enables organizations to scale their computing resources on demand. Modern cloud platforms provide computing power, storage, and networking as managed services. Infrastructure as code automates cloud resource provisioning."});

Errors

CodeHTTPRetryableDescription
VALIDATION_ERROR400NoThe request payload failed schema validation.
UNAUTHORIZED401NoMissing or invalid API key.
SKILL_NOT_ACCESSIBLE403NoThe API key is not granted access to this skill.
SKILL_NOT_AVAILABLE_FOR_PLAN403NoThis skill is not included in your current plan.
PLAN_ELIGIBILITY_UNAVAILABLE503YesPlan eligibility could not be decided. Retry after backoff.
SKILL_NOT_FOUND404NoThe requested skill or version does not exist.
TENANT_RATE_LIMITED429YesRequest rate limit exceeded. Retry after backoff.
QUOTA_EXCEEDED429YesPlan quota exhausted. Retryable once the quota period resets.
EXECUTION_TIMEOUT504YesExecution exceeded the allowed time budget.

Other limits

LimitValue
Recommended inline bytes32 KiB

Limitations

  • Does not perform semantic or contextual analysis — purely statistical
  • Does not use LLM-based extraction or embeddings
  • Does not perform topic modeling or clustering
  • Semantic analysis requiring contextual understanding
  • Topic modeling or document clustering
  • Named entity recognition (use text.extract_entities_regex instead)

How to call

POST /v1/execute (requires authentication)

Request bodyjson
{
  "skillKey": "text.extract_keywords",
  "input": {
    "maxKeywords": 5,
    "text": "Cloud computing infrastructure enables organizations to scale their computing resources on demand. Modern cloud platforms provide computing power, storage, and networking as managed services. Infrastructure as code automates cloud resource provisioning."
  }
}

Examples

Extract from technical article

Inputjson
{
  "maxKeywords": 5,
  "text": "Cloud computing infrastructure enables organizations to scale their computing resources on demand. Modern cloud platforms provide computing power, storage, and networking as managed services. Infrastructure as code automates cloud resource provisioning."
}
Expected outputjson
{
  "returned": 5,
  "stopwordsVersion": "english-v1",
  "keywords": [
    {
      "keyword": "cloud",
      "score": 0.12,
      "count": 3
    },
    {
      "keyword": "computing",
      "score": 0.12,
      "count": 3
    },
    {
      "keyword": "infrastructure",
      "score": 0.08,
      "count": 2
    },
    {
      "keyword": "enables",
      "score": 0.04,
      "count": 1
    },
    {
      "keyword": "organizations",
      "score": 0.04,
      "count": 1
    }
  ],
  "truncated": true,
  "method": "tf",
  "totalCandidates": 20
}
Tip
Twenty terms survived filtering, so asking for five sets truncated

Custom stopwords

Inputjson
{
  "text": "Cloud computing infrastructure enables organizations to scale their computing resources on demand.",
  "maxKeywords": 3,
  "stopwords": [
    "cloud",
    "computing"
  ]
}
Expected outputjson
{
  "returned": 3,
  "stopwordsVersion": "english-v1",
  "keywords": [
    {
      "keyword": "infrastructure",
      "score": 0.1111,
      "count": 1
    },
    {
      "keyword": "enables",
      "score": 0.1111,
      "count": 1
    },
    {
      "keyword": "organizations",
      "score": 0.1111,
      "count": 1
    }
  ],
  "truncated": true,
  "method": "tf",
  "totalCandidates": 9
}
Tip
Your list replaces ours, so everyday words like "to" and "their" now count as candidates — add them if you want them filtered
  • Generate content tags for articles or documents
  • Build search indexes from document collections
  • Identify dominant terms for content classification

Avoid for

  • Semantic analysis requiring contextual understanding
  • Topic modeling or document clustering
  • Named entity recognition (use text.extract_entities_regex instead)

Composable with

Safety & privacy

  • Runs without calling any external service.
  • Your payloads are never stored permanently.
  • Telemetry captures metadata only — never your payload contents.
  • We never train models on your payloads.
  • No human reviews your payloads.

Tags

analysistext