# Chinese Text & Pinyin Toolkit (`prizable_aster/chinese-text-pinyin-toolkit`) Actor Batch converts Chinese text to pinyin, Simplified or Traditional Chinese, normalized text, slugs, Chinese numerals, and RMB uppercase amounts. - **URL**: https://apify.com/prizable\_aster/chinese-text-pinyin-toolkit.md - **Developed by:** [Vaque Wei](https://apify.com/prizable_aster) (community) - **Categories:** Developer tools, Automation, Other - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $2.00 / 1,000 results 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/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows. 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. Actors are written with capital "A". ## 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. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Chinese Text & Pinyin Toolkit Run common Chinese localization and text-normalization operations in one batch Actor. It is designed for content catalogs, search indexes, URL generation, CRM cleanup, AI pipelines, and multilingual publishing. ### Features - Pinyin with tone marks, tone numbers, no tones, and initials. - Simplified Chinese to Traditional Chinese. - Traditional Chinese to Simplified Chinese. - Unicode NFKC, full-width to half-width, punctuation, and whitespace normalization. - Chinese or mixed-language text to URL-safe pinyin slugs. - Chinese numerals to Arabic numbers. - Arabic numbers to lowercase Chinese numerals. - Numeric amounts to uppercase RMB wording. - Up to 1,000 records and 100,000 total input characters per run. ### Input Use `texts` for a simple batch: ```json { "texts": ["Chinese title", "Traditional Chinese text", "1234.56"], "operations": ["pinyin", "simplified", "traditional", "normalize", "slug"], "pinyinSeparator": " " } ```` The Apify input form contains real Chinese examples. Use `records` instead when each text needs a caller-defined ID: ```json { "records": [ {"id": "product-1", "text": "Chinese product title"}, {"id": "invoice-1", "text": "1234.56"} ], "operations": ["slug", "rmbUppercase"] } ``` When `records` is supplied, it takes precedence over `texts`. ### Operations - `pinyin`: returns `toneMarks`, `toneNumbers`, `plain`, and `initials`. - `simplified`: converts Traditional Chinese to Simplified Chinese. - `traditional`: converts Simplified Chinese to Traditional Chinese. - `normalize`: normalizes width, punctuation, Unicode compatibility forms, and whitespace. - `slug`: creates a lowercase ASCII pinyin slug. - `chineseToNumber`: converts one Chinese numeral expression to a number. - `numberToChinese`: converts one Arabic number to lowercase Chinese wording. - `rmbUppercase`: converts one Arabic amount to uppercase RMB wording. If a number operation receives nonnumeric text, the item status becomes `partial`, an operation-specific error is returned, and other selected operations still succeed. ### Notes Pinyin can be context-dependent for polyphonic characters. The Actor uses phrase-aware dictionaries but cannot infer every proper name or specialist pronunciation. Simplified and Traditional conversion uses OpenCC dictionaries and is linguistic conversion, not human translation. This Actor uses the MIT-licensed pypinyin and cn2an libraries and the Apache-licensed OpenCC Python reimplementation. # Actor input Schema ## `texts` (type: `array`): Simple list of Chinese or mixed-language strings. ## `records` (type: `array`): Optional records that preserve a caller-defined ID. ## `operations` (type: `array`): Transformations to run for every input record. ## `pinyinSeparator` (type: `string`): Separator placed between pinyin tokens. ## Actor input object example ```json { "texts": [ "中文标题", "軟體開發", "1234.56" ], "operations": [ "pinyin", "simplified", "traditional", "normalize", "slug" ], "pinyinSeparator": " " } ``` # Actor output Schema ## `results` (type: `string`): No description # 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "texts": [ "中文标题", "軟體開發", "1234.56" ] }; // Run the Actor and wait for it to finish const run = await client.actor("prizable_aster/chinese-text-pinyin-toolkit").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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "texts": [ "中文标题", "軟體開發", "1234.56", ] } # Run the Actor and wait for it to finish run = client.actor("prizable_aster/chinese-text-pinyin-toolkit").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "texts": [ "中文标题", "軟體開發", "1234.56" ] }' | apify call prizable_aster/chinese-text-pinyin-toolkit --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=prizable_aster/chinese-text-pinyin-toolkit", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Chinese Text & Pinyin Toolkit", "description": "Batch converts Chinese text to pinyin, Simplified or Traditional Chinese, normalized text, slugs, Chinese numerals, and RMB uppercase amounts.", "version": "0.0", "x-build-id": "r8Et9ba7jb8uqmhOr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/prizable_aster~chinese-text-pinyin-toolkit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-prizable_aster-chinese-text-pinyin-toolkit", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/prizable_aster~chinese-text-pinyin-toolkit/runs": { "post": { "operationId": "runs-sync-prizable_aster-chinese-text-pinyin-toolkit", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/prizable_aster~chinese-text-pinyin-toolkit/run-sync": { "post": { "operationId": "run-sync-prizable_aster-chinese-text-pinyin-toolkit", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "texts": { "title": "Texts", "maxItems": 1000, "type": "array", "description": "Simple list of Chinese or mixed-language strings.", "items": { "type": "string" } }, "records": { "title": "Structured text records", "maxItems": 1000, "type": "array", "description": "Optional records that preserve a caller-defined ID.", "items": { "type": "object", "properties": { "id": { "title": "Record ID", "description": "Optional caller-defined identifier returned unchanged.", "type": "string" }, "text": { "title": "Text", "description": "Chinese or mixed-language input text.", "type": "string" } }, "required": [ "text" ] } }, "operations": { "title": "Operations", "type": "array", "description": "Transformations to run for every input record.", "items": { "type": "string" }, "default": [ "pinyin", "simplified", "traditional", "normalize", "slug" ] }, "pinyinSeparator": { "title": "Pinyin separator", "type": "string", "description": "Separator placed between pinyin tokens.", "default": " " } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```