Occurrence Counter
text.count_occurrences
Overview
You pass text (or a file_ref) and one or more literal or regex patterns; we return per-pattern occurrence counts with optional match offsets. Regex uses RE2/J (linear-time, ReDoS-safe). Do not use this for semantic entity extraction.
Batch pattern counting with per-pattern results saves round-trips and avoids LLM miscounting.
Reliability
STRICT and deterministic for literal patterns on this deployment. Regex uses RE2/J (linear-time, ReDoS-safe); regex_engine=re2j when regex patterns are used. Input validation (not retryable): missing patterns; too many patterns; empty literal; pattern too long; invalid regex; neither text nor file_ref.
Context footprint
Batch counting in a single call saves multiple tool invocations and avoids LLM counting errors. Accepts inline text up to 1000000 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 1 execution credit.
When to use it
When you need multiple pattern counts in one call with per-pattern breakdowns.
For semantic entity extraction — use dedicated NLP skills.
Powered by RE2/J, Google's linear-time regular-expression engine that counts pattern matches without risk of catastrophic backtracking.
Scope
Non-goals
- Does not perform semantic analysis
- Does not extract entities
- Regex has safety limits (max pattern length, max pattern count)
Properties
Capabilities
Cost & billing
Flat rate per invocation
File handling
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.
| Limit | Value | Limited by |
|---|---|---|
| Maximum size per input file | 1.9 MiB | Skill maximum |
How we handle your data
What this means
This skill may receive sensitive content, but it does not target sensitive data and returns only a structured non-sensitive result.
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 does not contain submitted 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.
Input schema
| Field | Type | Required | Description |
|---|---|---|---|
| text | string | No | Bounded inline text source. Required unless file_ref is provided. |
| file_ref | string | No | Tenant-scoped opaque text-file reference. Omit it to use the required inline text; never send both. |
| patterns | array | Yes | Bounded array containing from 1 through 50 items in reporting order; each item has id, value, and literal-or-regex type properties. |
| case_sensitive | boolean | No | Whether literal case is significant; omit it for true. |
| overlap | boolean | No | Whether literal matches may overlap; omit it for false. |
| normalization | string | No | Unicode normalization; omit it for none. |
| return_matches | boolean | No | Whether code-point offsets are returned; omit it for false. |
Output schema
| Field | Type | Required | Description |
|---|---|---|---|
| skill | string | Yes | Producing skill key. |
| unit | string | Yes | Measurement unit for the returned match total. |
| policy | string | Yes | Applied search policy. |
| total_count | integer | Yes | Total matches across patterns. This non-negative total is bounded by the documented input limit. |
| counts | array | Yes | Bounded array containing from 1 through 50 items, one per supplied pattern; each item has id, count, and optional match-span properties. |
| case_sensitive | boolean | Yes | Applied literal-case setting. |
| overlap | boolean | Yes | Applied literal-overlap setting. |
| normalized | boolean | Yes | Whether normalization was applied. |
| normalization | string | Yes | Applied normalization form. |
| offset_unit | string | No | Returned offset unit. |
| regex_engine | string | No | Applied regular-expression engine. |
| warnings | array | Yes | Bounded warning array containing from 0 through 50 items, where each item is one non-fatal advisory string. |
API contract
POST /v1/executecurl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"text.count_occurrences","input":{"text":"hello world hello","patterns":[{"id":"hello","value":"hello","type":"literal"}]}}'import { Squillify } from "@squillify/sdk";
const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });
const { output } = await sq.execute("text.count_occurrences", {"patterns":[{"type":"literal","id":"hello","value":"hello"},{"type":"literal","id":"world","value":"world"}],"text":"hello world hello"});Errors
| Code | HTTP | Retryable | Description |
|---|---|---|---|
| VALIDATION_ERROR | 400 | No | The request payload failed schema validation. |
| UNAUTHORIZED | 401 | No | Missing or invalid API key. |
| SKILL_NOT_ACCESSIBLE | 403 | No | The API key is not granted access to this skill. |
| SKILL_NOT_AVAILABLE_FOR_PLAN | 403 | No | This skill is not included in your current plan. |
| PLAN_ELIGIBILITY_UNAVAILABLE | 503 | Yes | Plan eligibility could not be decided. Retry after backoff. |
| SKILL_NOT_FOUND | 404 | No | The requested skill or version does not exist. |
| TENANT_RATE_LIMITED | 429 | Yes | Request rate limit exceeded. Retry after backoff. |
| QUOTA_EXCEEDED | 429 | Yes | Plan quota exhausted. Retryable once the quota period resets. |
| EXECUTION_TIMEOUT | 504 | Yes | Execution exceeded the allowed time budget. |
Other limits
| Limit | Value |
|---|---|
| Recommended inline bytes | 32 KiB |
Limitations
- Does not perform semantic analysis
- Does not extract entities
- Regex has safety limits (max pattern length, max pattern count)
- Entity extraction (use NLP tools)
How to call
POST /v1/execute (requires authentication)
{
"skillKey": "text.count_occurrences",
"input": {
"patterns": [
{
"type": "literal",
"id": "hello",
"value": "hello"
},
{
"type": "literal",
"id": "world",
"value": "world"
}
],
"text": "hello world hello"
}
}Examples
Two literal patterns
{
"patterns": [
{
"type": "literal",
"id": "hello",
"value": "hello"
},
{
"type": "literal",
"id": "world",
"value": "world"
}
],
"text": "hello world hello"
}{
"policy": "multi_pattern",
"normalized": false,
"normalization": "none",
"skill": "text.count_occurrences",
"counts": [
{
"id": "hello",
"count": 2
},
{
"id": "world",
"count": 1
}
],
"warnings": [],
"total_count": 3,
"case_sensitive": true,
"unit": "occurrence",
"overlap": false
}Case-insensitive literal
{
"text": "HELLO hello Hello",
"case_sensitive": false,
"patterns": [
{
"type": "literal",
"id": "hello",
"value": "Hello"
}
]
}{
"policy": "multi_pattern",
"normalized": false,
"normalization": "none",
"skill": "text.count_occurrences",
"counts": [
{
"id": "hello",
"count": 3
}
],
"warnings": [],
"total_count": 3,
"case_sensitive": false,
"unit": "occurrence",
"overlap": false
}Recommended use cases
- Multi-keyword frequency analysis
- Content audit
- Pattern density measurement
Avoid for
- Entity extraction (use NLP tools)
Related skills
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.