# Vocabulary-Aware Search Typo Corrector (`autosecurelogin/vocabulary-search-corrector`) Actor

Suggest conservative corrections to search queries using your own vocabulary and dictionary. Keep original queries, protected words and ambiguous matches intact.

- **URL**: https://apify.com/autosecurelogin/vocabulary-search-corrector.md
- **Developed by:** [Hunter Melnick](https://apify.com/autosecurelogin) (community)
- **Security:** Limited permissions
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$0.05 / actor start

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Vocabulary-Aware Search Typo Corrector

Suggest conservative corrections to search queries using your own vocabulary and dictionary. Keep original queries, protected words and ambiguous matches intact.

### Run and download

1. Keep the included sample or replace **Input data** with your own authorized records.
2. Start a run. Open **Report and CSV downloads** when it finishes.
3. Open **OUTPUT** for the complete JSON report and download the CSV records.
4. Review the findings before importing or publishing changes. This Actor never writes to a store.

### Hosted limits

Up to 50 queries, 5000 supplied corpus words, 10000 dictionary entries, 1000 protected entries or 20 documents of 10000 characters each; 1 MiB total. These tighter hosted limits take precedence over the core format limits below.
Memory is fixed at 256 MB. Default timeout is 60 seconds. Output includes one dataset
summary row; individual findings and records are delivered in OUTPUT and CSV files.
No model subscription, external API key or other product purchase is required.

### Price

**$0.05 per run**, charged once when the Actor starts. All report and CSV output
is included, with no per-row fee or platform-usage surcharge. Set the maximum run
cost to at least $0.05. Starts that reject invalid input or produce no findings
still incur the start charge; validate the input before running.

### Storage and support

Apify stores supplied data and generated reports under its storage access/retention
settings. This hosted edition sends input to Apify; it is not the local-only edition.
Remove sensitive run data when no longer needed. URLs in input are never fetched.
Use the Actor issue tracker for support with a non-sensitive example and run ID.
Do not post private exports or credentials. Hosted use does not grant source redistribution rights.

Input contains either corpus {word: frequency} or documents array, plus dictionary,
optional protected words, queries, and optional dominanceRatio (default 3, minimum 2).
All fields are demonstrated in the prefilled example. A real general-language dictionary
is required for deployment; the tiny sample list demonstrates behavior only. No dictionary
or third-party dictionary rights are sold with this product. Use a list you have rights
to use and retain its notices when redistributing your data.

Words already in the corpus, dictionary or protected list stay unchanged. Other words
need a unique edit-distance-one candidate or the configured frequency advantage. Ambiguous
results explicitly remain unchanged. Mixed alphanumeric identifiers are not corrected.
Original queries are never overwritten; use retrievalQuery for search only and offer users
the unchanged original as an override. Full JSON includes individual refusal decisions,
corpus/dictionary hashes and metadata. JSON is authoritative; CSV guards formula-like prefixes.

Limits: 1 MiB input, 5000 supplied corpus words, 10000 dictionary words, 1000 protected words,
50 queries of 500 characters; words at most 100 characters. Documents: at most 20 of
10000 characters each. Counts are positive integers at most 1 billion. Length buckets
reduce candidate search. Unicode letters supported; this is not a language model or proof
of intended meaning. Dictionary quality and corpus freshness determine behavior.

# Actor input Schema

## `payload` (type: `object`):

Up to 50 queries, 5000 supplied corpus words, 10000 dictionary entries, 1000 protected entries or 20 documents of 10000 characters each; 1 MiB total.

## Actor input object example

```json
{
  "payload": {
    "corpus": {
      "safety": 80,
      "plan": 40,
      "garden": 30,
      "plant": 30
    },
    "dictionary": [
      "safely",
      "plan",
      "garden",
      "plant"
    ],
    "protected": [
      "widgetron"
    ],
    "queries": [
      "safty plan",
      "safely plan",
      "widgetron",
      "12safty"
    ],
    "dominanceRatio": 3
  }
}
```

# Actor output Schema

## `files` (type: `string`):

Open OUTPUT for full JSON and the .csv records for exports.

## `summary` (type: `string`):

One summary row per run; detailed findings are in the report and CSV files.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "payload": {
        "corpus": {
            "safety": 80,
            "plan": 40,
            "garden": 30,
            "plant": 30
        },
        "dictionary": [
            "safely",
            "plan",
            "garden",
            "plant"
        ],
        "protected": [
            "widgetron"
        ],
        "queries": [
            "safty plan",
            "safely plan",
            "widgetron",
            "12safty"
        ],
        "dominanceRatio": 3
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("autosecurelogin/vocabulary-search-corrector").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "payload": {
        "corpus": {
            "safety": 80,
            "plan": 40,
            "garden": 30,
            "plant": 30,
        },
        "dictionary": [
            "safely",
            "plan",
            "garden",
            "plant",
        ],
        "protected": ["widgetron"],
        "queries": [
            "safty plan",
            "safely plan",
            "widgetron",
            "12safty",
        ],
        "dominanceRatio": 3,
    } }

# Run the Actor and wait for it to finish
run = client.actor("autosecurelogin/vocabulary-search-corrector").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "payload": {
    "corpus": {
      "safety": 80,
      "plan": 40,
      "garden": 30,
      "plant": 30
    },
    "dictionary": [
      "safely",
      "plan",
      "garden",
      "plant"
    ],
    "protected": [
      "widgetron"
    ],
    "queries": [
      "safty plan",
      "safely plan",
      "widgetron",
      "12safty"
    ],
    "dominanceRatio": 3
  }
}' |
apify call autosecurelogin/vocabulary-search-corrector --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,autosecurelogin/vocabulary-search-corrector"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/QV02jhAdLOWf2bequ/builds/byv0Z2RcLoFaWL5Xs/openapi.json
