
Linkfox Eureka Patent Image Search
- 215 installs
- 64 repo stars
- Updated August 3, 2026
- linkfox-ai/linkfox-skills
Helps with ai & agent building tasks.
About
linkfox-eureka-patent-image-search is a Claude Code skill in the AI & Agent Building category.
- linkfox-eureka-patent-image-search
- AI & Agent Building
- AI-coding skill
Linkfox Eureka Patent Image Search by the numbers
- 215 all-time installs (skills.sh)
- +16 installs in the week ending Aug 2, 2026 (Skillselion tracking)
- Ranked #2,774 of 16,546 AI & Agent Building skills by installs in the Skillselion catalog
- Data as of Aug 4, 2026 (Skillselion catalog sync)
npx skills add https://github.com/linkfox-ai/linkfox-skills --skill linkfox-eureka-patent-image-searchAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 215 |
|---|---|
| repo stars | ★ 64 |
| Last updated | August 3, 2026 |
| Repository | linkfox-ai/linkfox-skills ↗ |
What it does
Helps with ai & agent building tasks.
Files
Eureka Patent Image Search (Single Image)
This skill guides you on how to perform patent image search (search-by-image) via the Eureka patent platform. Given a single image URL, it finds visually similar patents in the design or utility patent databases, supporting multiple search models and extensive filtering options.
Core Concepts
The Eureka Patent Image Search tool enables visual similarity search across patent databases:
1. Search Models — Four models are available depending on the patent type and search intent:
- Model 1: Design smart association — finds design patents with intelligent visual association
- Model 2: Design search this image — exact visual match for design patents
- Model 3: Utility match shape — matches utility patents by shape/contour
- Model 4: Utility match shape + pattern + color — matches utility patents by shape, pattern, and color combined
2. Patent Types — Two patent types are supported:
D(Design) — search within design/industrial design patents (use models 1 or 2)U(Utility) — search within utility model patents (use models 3 or 4)
3. Filtering — Extensive optional filters for country/authority, Locarno classification, date ranges, legal status, assignees, and keyword fields.
4. Scoring — Results include a similarity score and can be sorted by score, application date, publication date, or issue date.
Parameter Guide
Required Parameters
| Parameter | Type | Description |
|---|---|---|
| url | string | The URL of the image to search with. Must be a publicly accessible image URL. |
| model | integer | Search model: 1 = design smart association, 2 = design search this image, 3 = utility match shape, 4 = utility match shape + pattern + color |
| patentType | string | Patent type to search: "D" = design patent, "U" = utility patent |
Optional Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| country | string | — | Patent authority codes, comma-separated (e.g., CN,US,JP,EP,WO) |
| loc | string | — | Locarno classification code. Supports AND/OR/NOT boolean operators. |
| applyStartTime | string | — | Application date range start (format: yyyyMMdd) |
| applyEndTime | string | — | Application date range end (format: yyyyMMdd) |
| publicStartTime | string | — | Publication date range start (format: yyyyMMdd) |
| publicEndTime | string | — | Publication date range end (format: yyyyMMdd) |
| mainField | string | — | Search keyword within specific fields: title, abstract, claims, description, pn, applicant, inventor, IPC, UPC, LOC |
| assignees | string | — | Filter by assignee/rights holder name |
| legalStatus | string | — | Legal status codes, comma-separated. Values: 1=Published, 2=Examining, 3=Granted, 11=Withdrawn, 13=Rejected, 14=Revoked, 15=Expired, etc. |
| simpleLegalStatus | string | — | Simplified legal status: 0=Invalid, 1=Valid, 2=Pending, 220=PCT expired, 221=PCT in period, 999=Undetermined |
| preFilter | integer | 1 | Enable (1) or disable (0) pre-filtering by country and LOC classification |
| scoreExpansion | boolean | — | Enable score expansion for broader results |
| stemming | integer | 0 | Enable (1) or disable (0) word stemming in keyword search |
| includeMachineTranslation | boolean | — | Include machine-translated content in search |
| field | string | SCORE | Sort field: SCORE (similarity), APD (application date), PBD (publication date), ISD (issue date) |
| order | string | desc | Sort order: desc or asc |
| limit | integer | 10 | Results per page, range 1–100 |
| offset | integer | 0 | Pagination offset, range 0–1000 |
| lang | string | — | Title language preference: original, cn, en |
| isHttps | integer | — | Return image URLs with HTTPS (1) or HTTP (0) |
| returnImgId | boolean | — | Include image ID in results |
Model & Patent Type Combinations
| Patent Type | Recommended Models | Description |
|---|---|---|
| D (Design) | 1, 2 | Model 1 for smart association, Model 2 for exact visual match |
| U (Utility) | 3, 4 | Model 3 for shape match, Model 4 for shape + pattern + color |
Response Fields
| Field | Description |
|---|---|
| patentId | The patent's internal ID |
| patentPn | Publication number |
| title | Patent title |
| url | URL of the similar image found in the patent |
| score | Similarity score |
| apdt | Application date |
| pbdt | Publication date |
| authority | Patent authority (country code) |
| inventor | Inventor name |
| apno | Application number |
| originalAssignee | Original applicant/assignee |
| currentAssignee | Current rights holder |
| loc | Array of Locarno classification codes |
| imgId | Image ID (when returnImgId is enabled) |
| locMatch | Whether the Locarno classification matched the filter |
| total | Number of results in current page |
| allRecordsCount | Total number of matching results |
| costToken | Token cost for this query |
Usage Examples
1. Search for similar design patents using an image
Search for design patents similar to this image: https://example.com/product-image.jpg — look in CN and US patent databases.→ Use model=1 or 2, patentType="D", country="CN,US"
2. Find utility patents with a similar shape
Find utility patents that have a similar shape to this product image: https://example.com/gadget.png→ Use model=3, patentType="U"
3. Search with date and legal status filters
Search for valid design patents similar to this image, filed after 2020, in the CN database: https://example.com/design.jpg→ Use model=2, patentType="D", country="CN", applyStartTime="20200101", simpleLegalStatus="1"
4. Search with Locarno classification
Find design patents in LOC 14-01 similar to this product: https://example.com/phone-case.jpg→ Use model=1, patentType="D", loc="14-01"
5. Search with keyword and assignee filters
Search for design patents similar to this image from Apple Inc.: https://example.com/device.jpg→ Use model=2, patentType="D", assignees="Apple"
6. Get more results with pagination
Show me the next 20 design patents similar to this image: https://example.com/product.jpg→ Use limit=20, offset=20
Display Rules
1. Present results as a visual gallery when possible: Show the patent publication number, title, similarity score, and image URL for each result. 2. Score interpretation: Higher scores indicate greater visual similarity. Present scores as percentages or relative rankings for user clarity. 3. Key metadata: Always include patent number, title, authority, application date, and assignee for each result. 4. Total count: Mention allRecordsCount to indicate how many total matches were found, and how many are displayed. 5. Model explanation: When presenting results, briefly note which search model was used so the user understands the matching approach. 6. Error handling: If the query fails, check common issues: invalid image URL, unsupported image format, invalid model/patentType combination. 7. Pagination guidance: If there are more results than displayed, inform the user they can request more.
Important Limitations
- Single image only: This endpoint accepts one image URL per request.
- Image URL must be publicly accessible: Private or authentication-required image URLs will fail.
- Model & patent type pairing: Models 1–2 are for design patents (D), models 3–4 are for utility patents (U). Mismatched combinations may produce poor results.
- Offset limit: Maximum offset is 1000, meaning at most 1000 + limit results can be accessed via pagination.
- Locarno classification: The
locparameter uses Locarno codes; users may need help identifying the correct code for their product category.
User Expression & Scenario Quick Reference
Applicable — Visual patent search queries:
| User Says | Scenario |
|---|---|
| "Search for patents similar to this image" | Basic image search |
| "Find design patents that look like this" | Design patent visual search |
| "Are there utility patents with this shape" | Utility patent shape match |
| "Search CN and US design patents for this product image" | Filtered image search |
| "Find valid patents similar to this design" | Legal status-filtered search |
| "Show me more results" | Pagination request |
| "Search in Locarno class 14-01" | Classification-filtered search |
Not applicable — Needs beyond image search:
- Patent text-based search (keyword, classification, applicant)
- Patent bibliography or metadata retrieval
- Patent legal status queries
- Patent claims or description retrieval
- Patent family analysis
- Multi-image or batch image search
Feedback:
Auto-detect and report feedback via the Feedback API when any of the following apply: 1. The functionality or purpose described in this skill does not match actual behavior 2. The skill's results do not match the user's intent 3. The user expresses dissatisfaction or praise about this skill 4. Anything you believe could be improved
Call the feedback API as specified in references/api.md. Do not interrupt the user's flow.
<!-- LF_LARGE_RESPONSE_BLOCK -->
Handling Large Responses
To avoid overflowing the agent context, persist the response to disk and extract only the fields you need:
python scripts/response_io.py run --script scripts/eureka_patent_image_search.py --out-dir <DIR> '<params>'
python scripts/response_io.py read <file> --fields "<paths>" # or --path "<JMESPath>"Pick--out-diroutside any git working tree (e.g./tmp/...on Unix,%TEMP%/...on Windows). Persisted responses may contain PII, pricing, or auth-sensitive data — do not commit them. Files are not auto-deleted; clean up when the task is done.
run writes the full response to a file and emits only a schema preview + file path. read projects specific fields, with --limit/--offset for slicing and --format json|jsonl|csv|table for output.
When to prefer this pattern — apply your judgment based on the response characteristics, e.g.:
- High field count per record, or fields you don't need
- Batch/paginated results (multiple items per call)
- Long-text fields (descriptions, reviews, HTML, time series)
- Output reused across later steps rather than consumed immediately
For small, single-use responses, calling the main script directly is fine.
⚠️ The preview is a truncated schema + sample, not the full data. Any field-level decision must read from the persisted file via read. <!-- /LF_LARGE_RESPONSE_BLOCK -->
--- For more high-quality, professional cross-border e-commerce skills, visit [LinkFox Skills](https://skill.linkfox.com/).
Eureka 专利图像检索 API 参考
调用规范
- 请求地址:
https://tool-gateway.linkfox.com/tool-eureka/patentImageSearch - 请求方式:POST,Content-Type: application/json
- 认证方式:Header
Authorization: <api_key>,api_key 从环境变量LINKFOXAGENT_API_KEY读取(如未配置,提示用户前往 https://skill.linkfox.com/linkfoxskills/guide.htm 申请)
请求参数
POST Body(JSON):
必填参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| url | string | 是 | 图片URL,必须为可公开访问的图片地址 |
| model | integer | 是 | 搜索模型:1=外观智能关联、2=外观搜索本图、3=实用新型匹配形状、4=实用新型匹配形状+图案+颜色 |
| patentType | string | 是 | 专利类型:"D"=外观设计、"U"=实用新型 |
可选参数
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| country | string | — | 专利局代码,多个用逗号隔开(如 CN,US,JP,EP,WO) |
| loc | string | — | 洛迦诺分类号,支持 AND/OR/NOT 布尔运算 |
| applyStartTime | string | — | 申请日范围起始(格式:yyyyMMdd) |
| applyEndTime | string | — | 申请日范围结束(格式:yyyyMMdd) |
| publicStartTime | string | — | 公开日范围起始(格式:yyyyMMdd) |
| publicEndTime | string | — | 公开日范围结束(格式:yyyyMMdd) |
| mainField | string | — | 在指定字段中搜索关键词:title/abstract/claims/description/pn/applicant/inventor/IPC/UPC/LOC |
| assignees | string | — | 按权利人名称筛选 |
| legalStatus | string | — | 法律状态代码,多个用逗号隔开。可选值:1=公开、2=实质审查、3=授权、11=撤回、13=驳回、14=撤销、15=过期 等 |
| simpleLegalStatus | string | — | 简单法律状态:0=失效、1=有效、2=审中、220=PCT指定期满、221=PCT指定期内、999=未确认 |
| preFilter | integer | 1 | 是否启用国家/LOC预过滤:1=启用、0=禁用 |
| scoreExpansion | boolean | — | 是否启用分数扩展以获取更广泛的结果 |
| stemming | integer | 0 | 是否启用词干提取:1=启用、0=禁用 |
| includeMachineTranslation | boolean | — | 是否包含机器翻译内容 |
| field | string | SCORE | 排序字段:SCORE(相似度)、APD(申请日)、PBD(公开日)、ISD(授权日) |
| order | string | desc | 排序方向:desc(降序)、asc(升序) |
| limit | integer | 10 | 每页结果数,范围 1-100 |
| offset | integer | 0 | 分页偏移量,范围 0-1000 |
| lang | string | — | 标题语言偏好:original(原文)、cn(中文)、en(英文) |
| isHttps | integer | — | 返回的图片URL是否使用HTTPS:1=是、0=否 |
| returnImgId | boolean | — | 是否在结果中返回图片ID |
响应结构
| 字段 | 类型 | 说明 |
|---|---|---|
| total | integer | 当前页结果数 |
| allRecordsCount | integer | 匹配的总记录数 |
| data | array | 相似专利列表 |
| data[].patentId | string | 专利ID |
| data[].patentPn | string | 公开(公告)号 |
| data[].title | string | 专利标题 |
| data[].url | string | 相似图片的URL |
| data[].score | number | 相似度分数 |
| data[].apdt | string | 申请日 |
| data[].pbdt | string | 公开日 |
| data[].authority | string | 专利局(国家代码) |
| data[].inventor | string | 发明人 |
| data[].apno | string | 申请号 |
| data[].originalAssignee | string | 原始申请人 |
| data[].currentAssignee | string | 当前权利人 |
| data[].loc | array | 洛迦诺分类号 |
| data[].imgId | string | 图片ID(当 returnImgId 启用时) |
| data[].locMatch | boolean | 洛迦诺分类是否匹配筛选条件 |
| costToken | integer | 消耗token |
错误码
正常情况下,接口的 HTTP 状态码均为 200,业务的成功与否通过响应体中的 errorCode 字段区分(errorCode = 200 表示成功,其他值表示业务错误)。当遇到未授权等情况时,HTTP 状态码为 401,且对应的 errorCode 也是 401。
| errcode | 含义 | 处理建议 |
|---|---|---|
| 200 | 成功 | 正常解析 data 等业务字段 |
| 401 | 认证失败 | 检查请求头 Authorization 是否正确携带 API Key;API Key 申请方式请参考上述调用规范下的认证方式。 |
| 其他非200值 | 业务异常 | 参考 errmsg 字段获取具体错误原因 |
错误响应示例:
{
"errcode": 401,
"errmsg": "authorized error"
}curl 示例
# 外观设计智能关联搜索
curl -X POST https://tool-gateway.linkfox.com/tool-eureka/patentImageSearch \
-H "Authorization: $LINKFOXAGENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com/product-image.jpg",
"model": 1,
"patentType": "D",
"country": "CN,US",
"limit": 10
}'# 实用新型形状匹配搜索(带日期和法律状态过滤)
curl -X POST https://tool-gateway.linkfox.com/tool-eureka/patentImageSearch \
-H "Authorization: $LINKFOXAGENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com/gadget.png",
"model": 3,
"patentType": "U",
"applyStartTime": "20200101",
"simpleLegalStatus": "1",
"limit": 20
}'# 外观设计搜索(按洛迦诺分类过滤)
curl -X POST https://tool-gateway.linkfox.com/tool-eureka/patentImageSearch \
-H "Authorization: $LINKFOXAGENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com/phone-case.jpg",
"model": 2,
"patentType": "D",
"loc": "14-01",
"country": "CN",
"field": "SCORE",
"order": "desc",
"limit": 10,
"offset": 0
}'---
Feedback API
This endpoint is separate from the tool API above. Do not mix the two base URLs.
- POST
https://skill-api.linkfox.com/api/v1/public/feedback - Content-Type:
application/json
{
"skillName": "linkfox-eureka-patent-image-search",
"sentiment": "POSITIVE",
"category": "OTHER",
"content": "Results were accurate, user was satisfied."
}Field rules:
skillName: Use this skill'snamefrom the YAML frontmattersentiment: Choose ONE —POSITIVE(praise),NEUTRAL(suggestion without emotion),NEGATIVE(complaint or error)category: Choose ONE —BUG(malfunction or wrong data),COMPLAINT(user dissatisfaction),SUGGESTION(improvement idea),OTHERcontent: Include what the user said or intended, what actually happened, and why it is a problem or praise
#!/usr/bin/env python3
"""
Eureka Patent Image Search - LinkFox Skill
Calls the eureka/patentImageSearch API endpoint to find visually similar patents.
Usage:
python eureka_patent_image_search.py '{"url": "https://example.com/img.jpg", "model": 1, "patentType": "D"}'
python eureka_patent_image_search.py '{"url": "https://example.com/img.jpg", "model": 3, "patentType": "U", "country": "CN,US", "limit": 20}'
"""
import json
import os
import sys
from urllib.request import urlopen, Request
from urllib.error import HTTPError, URLError
API_URL = "https://tool-gateway.linkfox.com/tool-eureka/patentImageSearch"
VALID_MODELS = {1, 2, 3, 4}
VALID_PATENT_TYPES = {"D", "U"}
def get_api_key():
key = os.environ.get("LINKFOXAGENT_API_KEY")
if not key:
print(
"API Key not configured. Please complete authorization first:\n"
"1. Visit https://skill.linkfox.com/linkfoxskills/guide.htm to obtain your Key\n"
"2. Set the environment variable: export LINKFOXAGENT_API_KEY=your-key-here",
file=sys.stderr,
)
sys.exit(1)
return key
def validate_params(params: dict):
url = params.get("url", "").strip()
if not url:
print("Error: 'url' (image URL) is required.", file=sys.stderr)
sys.exit(1)
model = params.get("model")
if model is None:
print("Error: 'model' is required (1/2/3/4).", file=sys.stderr)
sys.exit(1)
if int(model) not in VALID_MODELS:
print(
f"Error: 'model' must be one of {sorted(VALID_MODELS)}, got {model}.",
file=sys.stderr,
)
sys.exit(1)
patent_type = params.get("patentType", "").strip()
if not patent_type:
print('Error: \'patentType\' is required ("D" or "U").', file=sys.stderr)
sys.exit(1)
if patent_type not in VALID_PATENT_TYPES:
print(
f"Error: 'patentType' must be one of {sorted(VALID_PATENT_TYPES)}, got '{patent_type}'.",
file=sys.stderr,
)
sys.exit(1)
def call_api(params: dict) -> dict:
api_key = get_api_key()
data = json.dumps(params).encode("utf-8")
req = Request(
API_URL,
data=data,
headers={
"Authorization": api_key,
"Content-Type": "application/json",
"User-Agent": "LinkFox-Skill/1.0",
},
method="POST",
)
try:
with urlopen(req, timeout=120) as response:
return json.loads(response.read().decode("utf-8"))
except HTTPError as e:
body = e.read().decode("utf-8") if e.fp else ""
return {"error": f"HTTP {e.code}: {e.reason}", "details": body}
except URLError as e:
return {"error": f"Connection failed: {e.reason}"}
def main():
if len(sys.argv) < 2:
print(
"Usage: eureka_patent_image_search.py '<JSON parameters>'",
file=sys.stderr,
)
print("Examples:", file=sys.stderr)
print(
' eureka_patent_image_search.py \'{"url": "https://example.com/img.jpg", "model": 1, "patentType": "D"}\'',
file=sys.stderr,
)
print(
' eureka_patent_image_search.py \'{"url": "https://example.com/img.jpg", "model": 3, "patentType": "U", "limit": 20}\'',
file=sys.stderr,
)
sys.exit(1)
try:
params = json.loads(sys.argv[1])
except json.JSONDecodeError as e:
print(f"Invalid parameter format: {e}", file=sys.stderr)
sys.exit(1)
validate_params(params)
result = call_api(params)
print(json.dumps(result, indent=2, ensure_ascii=False))
if __name__ == "__main__":
main()
#!/usr/bin/env python3
"""
Skill response I/O helper — wraps any main script to persist large API
responses to disk, then offers a `read` subcommand to extract specific fields
from those persisted files. Generic, business-agnostic.
This script is bundled into each skill's scripts/ directory by tools/response_io/sync.py.
The agent must pass --script <path> to identify which main script to execute.
Usage:
python scripts/response_io.py run --script <PATH> --out-dir <DIR> '<json_params>' [--label NAME] [--timeout SEC]
python scripts/response_io.py read <file> (--path "<JMESPath>" | --fields "f1,f2,...") [--limit N] [--offset M] [--format json|jsonl|csv|table]
"""
from __future__ import annotations
import sys
if sys.version_info < (3, 10):
sys.exit(
"Error: Python 3.10+ required (current: "
f"{sys.version_info.major}.{sys.version_info.minor}). "
"Please upgrade Python."
)
import argparse
import csv
import io
import json
import os
import re
import secrets
import subprocess
from datetime import datetime
from pathlib import Path
from typing import Any
# Force UTF-8 stdout/stderr so non-ASCII chars in previews and API responses
# print correctly on Windows (default cp936 / gbk).
for stream in (sys.stdout, sys.stderr):
try:
stream.reconfigure(encoding="utf-8") # type: ignore[attr-defined]
except (AttributeError, OSError):
pass
try:
import jmespath # type: ignore
HAS_JMESPATH = True
except ImportError:
HAS_JMESPATH = False
MAX_STRING_LEN = 120
MAX_DEPTH = 3
SAMPLE_KEY_CAP = 15
RAW_TEXT_PEEK = 500
DEFAULT_TIMEOUT_SEC = 300
# ---------------------------------------------------------------------------
# Shared helpers
# ---------------------------------------------------------------------------
def _err(msg: str, code: int = 1) -> None:
print(msg, file=sys.stderr)
sys.exit(code)
def _resolve_script(script_arg: str) -> Path:
p = Path(script_arg).expanduser()
if not p.is_absolute():
# Resolve relative to the current working directory the agent invoked from.
p = (Path.cwd() / p).resolve()
else:
p = p.resolve()
if not p.is_file():
_err(f"--script path not found: {p}")
return p
def _resolve_skill_name(main_script: Path) -> str:
"""Best-effort skill name extraction for filename prefixing.
main_script lives at <skill_dir>/scripts/<name>.py — return <skill_dir>'s
folder name. Fall back to the script's stem if structure differs.
"""
try:
if main_script.parent.name == "scripts":
return main_script.parents[1].name
except IndexError:
pass
return main_script.stem
def _sanitize_label(label: str) -> str:
"""Allow only safe filename chars in --label to prevent path traversal."""
cleaned = re.sub(r"[^\w\-]", "_", label)
return cleaned[:64] # cap length
def _truncate_string(s: str) -> str:
if len(s) <= MAX_STRING_LEN:
return s
return s[:MAX_STRING_LEN] + f"...(truncated, total {len(s)} chars)"
def _truncate_value(value: Any, depth: int = 0) -> Any:
"""Recursively truncate strings, deep nesting, and large arrays for preview."""
if depth >= MAX_DEPTH:
if isinstance(value, dict):
return f"<truncated nested object, keys: {list(value.keys())[:10]}>"
if isinstance(value, list):
return f"<truncated nested array, length: {len(value)}>"
if isinstance(value, str):
return _truncate_string(value)
return value
if isinstance(value, str):
return _truncate_string(value)
if isinstance(value, dict):
out = {k: _truncate_value(v, depth + 1) for k, v in value.items()}
return out
if isinstance(value, list):
if not value:
return []
truncated = [_truncate_value(value[0], depth + 1)]
if len(value) > 1:
# Note total length on the parent — keep the array type-homogeneous
# so downstream consumers can iterate without special-casing strings.
truncated.append({"_omitted_items": len(value) - 1})
return truncated
return value
def _shape_of(value: Any, top: bool = False) -> Any:
"""Lightweight schema description for the preview block."""
if isinstance(value, dict):
keys = list(value.keys())
out: dict[str, Any] = {"type": "object", "top_keys" if top else "keys": keys}
if top:
for k in keys[:8]:
out[k] = _shape_of(value[k])
return out
if isinstance(value, list):
out = {"type": "array", "length": len(value)}
if value and isinstance(value[0], dict):
out["item_keys"] = list(value[0].keys())
elif value:
out["item_type"] = type(value[0]).__name__
return out
return {"type": type(value).__name__}
def _build_sample(value: Any) -> Any:
"""First-record sample with explicit truncation marker."""
if isinstance(value, list):
if not value:
return {"_truncated_record": True, "_note": "array is empty"}
first = value[0]
if isinstance(first, dict):
sample = {"_truncated_record": True, "_note": f"first of {len(value)} items"}
sample.update(_truncate_value(first, depth=1))
return sample
return {"_truncated_record": True, "_note": f"first of {len(value)} items", "value": _truncate_value(first, depth=1)}
if isinstance(value, dict):
sample = {"_truncated_record": True, "_note": "top-level object (truncated)"}
sample.update(_truncate_value(value, depth=1))
return sample
return {"_truncated_record": True, "value": _truncate_value(value, depth=1)}
def _shrink_preview(preview: dict) -> dict:
"""Cap the sample's value fields when it has many keys.
`shape.*.item_keys` is the single source of truth for the full key list
(always complete, no truncation). The sample only ever shows up to
SAMPLE_KEY_CAP fields with their concrete values, since the agent only
needs a feel for value shapes — for the full menu of available fields,
they read `shape`.
"""
sample = preview.get("sample")
if isinstance(sample, dict):
meta_keys = {"_truncated_record", "_note"}
data_keys = [k for k in sample.keys() if k not in meta_keys]
if len(data_keys) > SAMPLE_KEY_CAP:
kept = data_keys[:SAMPLE_KEY_CAP]
new_sample = {k: v for k, v in sample.items() if k in meta_keys or k in kept}
base_note = sample.get("_note", "")
extra = (
f"showing first {SAMPLE_KEY_CAP} of {len(data_keys)} fields "
f"(see `shape` for the complete key list)"
)
new_sample["_note"] = f"{base_note}; {extra}" if base_note else extra
preview["sample"] = new_sample
return preview
# ---------------------------------------------------------------------------
# `run` subcommand
# ---------------------------------------------------------------------------
def cmd_run(args: argparse.Namespace) -> int:
main_script = _resolve_script(args.script)
skill_name = _resolve_skill_name(main_script)
out_dir = Path(args.out_dir).expanduser().resolve()
try:
out_dir.mkdir(parents=True, exist_ok=True)
except OSError as e:
_err(f"Failed to create --out-dir {out_dir}: {e}")
if not os.access(out_dir, os.W_OK):
_err(f"--out-dir is not writable: {out_dir}")
timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
rand = secrets.token_hex(3)
safe_label = _sanitize_label(args.label) if args.label else ""
label_part = f"__{safe_label}" if safe_label else ""
out_file = out_dir / f"{skill_name}__{timestamp}_{rand}{label_part}.json"
# Force the child process to emit UTF-8 regardless of the host console
# encoding (Windows defaults to cp936 / gbk and would otherwise corrupt
# non-ASCII bytes when we read them back).
child_env = os.environ.copy()
child_env["PYTHONIOENCODING"] = "utf-8"
timed_out = False
try:
proc = subprocess.run(
[sys.executable, str(main_script), args.params],
capture_output=True,
text=True,
encoding="utf-8",
errors="replace",
env=child_env,
timeout=args.timeout,
)
stdout_text = proc.stdout or ""
stderr_text = proc.stderr or ""
returncode = proc.returncode
except subprocess.TimeoutExpired as e:
timed_out = True
stdout_text = (e.stdout.decode("utf-8", errors="replace") if isinstance(e.stdout, bytes) else (e.stdout or "")) or ""
stderr_text = (e.stderr.decode("utf-8", errors="replace") if isinstance(e.stderr, bytes) else (e.stderr or "")) or ""
returncode = 124 # convention for timeout
# Always write the captured stdout to disk, even if not JSON.
try:
out_file.write_text(stdout_text, encoding="utf-8")
except OSError as e:
_err(f"Failed to write output file {out_file}: {e}")
if stderr_text:
sys.stderr.write(stderr_text)
# Try to parse the captured stdout as JSON for the preview.
try:
parsed = json.loads(stdout_text) if stdout_text.strip() else None
format_kind = "json"
except json.JSONDecodeError:
parsed = None
format_kind = "raw_text"
preview: dict[str, Any] = {
"_preview": {
"is_preview": True,
"warning": (
"PREVIEW ONLY — NOT FULL DATA. The full response is saved to `file`. "
"Use `python scripts/response_io.py read <file> --fields '...'` to extract "
"specific fields, or `--path '<JMESPath>'` for complex projections."
),
},
}
# Surface failures prominently so agents don't mistake a stub preview for success.
if returncode != 0 or timed_out:
stderr_snippet = stderr_text[-500:] if stderr_text else ""
preview["_error"] = {
"exit_code": returncode,
"timed_out": timed_out,
"stderr_snippet": stderr_snippet,
"hint": "The wrapped script failed or timed out. The output file may be empty or partial.",
}
preview.update({
"file": str(out_file),
"size_bytes": out_file.stat().st_size,
"skill": skill_name,
"exit_code": returncode,
"format": format_kind,
"label": safe_label or None,
"next_steps_hint": (
"use: python scripts/response_io.py read <file> --fields '...' | --path '...'"
),
})
if format_kind == "json":
preview["shape"] = _shape_of(parsed, top=True)
preview["sample"] = _build_sample(parsed)
else:
peek = stdout_text[:RAW_TEXT_PEEK]
preview["raw_text_peek"] = peek
preview["raw_text_total_chars"] = len(stdout_text)
preview["sample"] = {
"_truncated_record": True,
"_note": f"stdout was not valid JSON; first {RAW_TEXT_PEEK} chars shown above in raw_text_peek",
}
preview = _shrink_preview(preview)
print(json.dumps(preview, ensure_ascii=False, indent=2))
return returncode
# ---------------------------------------------------------------------------
# `read` subcommand
# ---------------------------------------------------------------------------
def _load_json(path: Path) -> Any:
try:
text = path.read_text(encoding="utf-8")
except OSError as e:
_err(f"Failed to read file {path}: {e}")
try:
return json.loads(text)
except json.JSONDecodeError as e:
_err(f"File is not valid JSON: {path}\n{e}")
def _basic_dot_path(data: Any, path: str) -> Any:
"""Pure-stdlib dot-path resolver. No [*] support — callers fall back here only when jmespath is unavailable AND the path has no [*]."""
cur = data
for part in path.split("."):
if isinstance(cur, dict):
cur = cur.get(part)
else:
return None
return cur
def _resolve_field(data: Any, expr: str) -> Any:
if HAS_JMESPATH:
return jmespath.search(expr, data)
if "[" in expr or "*" in expr:
_err(
f"jmespath is required for expression '{expr}'. "
f"Install with: pip install jmespath"
)
return _basic_dot_path(data, expr)
def _project_fields(data: Any, fields: list[str]) -> Any:
"""Run each field expr; if any returns a list, zip them into list-of-dicts."""
resolved: dict[str, Any] = {f: _resolve_field(data, f) for f in fields}
list_lengths = [len(v) for v in resolved.values() if isinstance(v, list)]
if not list_lengths:
return resolved
# All list values must be same length to zip cleanly.
if len(set(list_lengths)) > 1:
# Fallback: return the dict as-is so caller can inspect mismatches.
return resolved
n = list_lengths[0]
rows = []
for i in range(n):
row = {}
for f, v in resolved.items():
row[f] = v[i] if isinstance(v, list) else v
rows.append(row)
return rows
def _apply_slice(value: Any, limit: int | None, offset: int | None) -> Any:
if not isinstance(value, list):
return value
start = offset or 0
end = (start + limit) if limit is not None else None
return value[start:end]
def _format_output(value: Any, fmt: str) -> str:
if fmt == "json":
return json.dumps(value, ensure_ascii=False, indent=2)
if fmt == "jsonl":
if isinstance(value, list):
return "\n".join(json.dumps(item, ensure_ascii=False) for item in value)
return json.dumps(value, ensure_ascii=False)
if fmt in ("csv", "table"):
if not isinstance(value, list) or not value:
_err(f"--format {fmt} requires a non-empty list result")
if not all(isinstance(item, dict) for item in value):
_err(f"--format {fmt} requires list-of-objects, got list of {type(value[0]).__name__}")
keys: list[str] = []
for item in value:
for k in item.keys():
if k not in keys:
keys.append(k)
if fmt == "csv":
buf = io.StringIO()
writer = csv.DictWriter(buf, fieldnames=keys, extrasaction="ignore")
writer.writeheader()
for item in value:
writer.writerow({k: _stringify(item.get(k)) for k in keys})
return buf.getvalue().rstrip("\n")
# table: simple aligned columns
rows = [[_stringify(item.get(k)) for k in keys] for item in value]
widths = [len(k) for k in keys]
for row in rows:
for i, cell in enumerate(row):
widths[i] = max(widths[i], len(cell))
lines = [
" ".join(k.ljust(widths[i]) for i, k in enumerate(keys)),
" ".join("-" * widths[i] for i in range(len(keys))),
]
for row in rows:
lines.append(" ".join(row[i].ljust(widths[i]) for i in range(len(keys))))
return "\n".join(lines)
_err(f"Unknown --format: {fmt}")
return "" # unreachable
def _stringify(v: Any) -> str:
if v is None:
return ""
if isinstance(v, (dict, list)):
return json.dumps(v, ensure_ascii=False)
return str(v)
def cmd_read(args: argparse.Namespace) -> int:
if not args.path and not args.fields:
_err("read: either --path or --fields is required")
if args.path and args.fields:
_err("read: --path and --fields are mutually exclusive")
file_path = Path(args.file).expanduser().resolve()
data = _load_json(file_path)
if args.path:
result = _resolve_field(data, args.path)
else:
fields = [f.strip() for f in args.fields.split(",") if f.strip()]
if not fields:
_err("--fields parsed to empty list")
result = _project_fields(data, fields)
result = _apply_slice(result, args.limit, args.offset)
print(_format_output(result, args.format))
return 0
# ---------------------------------------------------------------------------
# CLI
# ---------------------------------------------------------------------------
def main() -> int:
parser = argparse.ArgumentParser(
prog="response_io.py",
description="Persist large skill API responses to disk and read fields on demand.",
)
sub = parser.add_subparsers(dest="cmd", required=True)
p_run = sub.add_parser(
"run",
help="Execute a main script and persist its stdout to a file; "
"print only a lightweight preview to stdout.",
)
p_run.add_argument("params", help="JSON params string passed verbatim to the main script (argv[1]).")
p_run.add_argument("--script", required=True, help="Path to the main script to execute, e.g. scripts/my_api.py")
p_run.add_argument("--out-dir", required=True, help="Directory to write the response file into (created if missing).")
p_run.add_argument("--label", default=None, help="Optional filename suffix; sanitized to safe filename characters.")
p_run.add_argument("--timeout", type=int, default=DEFAULT_TIMEOUT_SEC, help=f"Subprocess timeout in seconds (default: {DEFAULT_TIMEOUT_SEC}).")
p_run.set_defaults(func=cmd_run)
p_read = sub.add_parser(
"read",
help="Extract specific fields from a previously persisted response file.",
)
p_read.add_argument("file", help="Path to the persisted JSON response file.")
g = p_read.add_mutually_exclusive_group()
g.add_argument("--path", default=None, help="JMESPath expression, e.g. 'data[*].{asin: asin, title: title}'.")
g.add_argument("--fields", default=None, help="Comma-separated field paths, e.g. 'data[*].asin,data[*].title'.")
p_read.add_argument("--limit", type=int, default=None, help="Take at most N items (when result is a list).")
p_read.add_argument("--offset", type=int, default=None, help="Skip the first M items (when result is a list).")
p_read.add_argument("--format", choices=["json", "jsonl", "csv", "table"], default="json", help="Output format (default: json).")
p_read.set_defaults(func=cmd_read)
args = parser.parse_args()
return args.func(args)
if __name__ == "__main__":
sys.exit(main())