reporting
Create and troubleshoot paperai 2.6.0 YAML reports in Markdown, CSV, or optional PDF annotation format, including generated columns and safe configuration validation.
- License 许可
- Apache-2.0
- 最近更新
- 2026-10-08
- Stars
- ★ 11
- Forks
- 3
01 前言 Front Matter
- name
- reporting
- license
- Apache 2.0
- metadata
- { "disco-role": "operating" }
- description
- Create and troubleshoot paperai 2.6.0 YAML reports in Markdown, CSV, or optional PDF annotation format, including generated columns and safe configuration validation.
- disable-model-invocation
- true
02 资源文件 5
- 参考文档references/api-reference.md4.6 KB
- 参考文档references/cli-reference.md3.0 KB
- 参考文档references/configuration.md7.5 KB
- 参考文档references/troubleshooting.md7.2 KB
- 参考文档references/workflows.md5.7 KB
03 SKILL.md 正文
Reporting
Use this route to turn an existing paperai corpus/index into a bounded report. Start with configuration for YAML and column semantics, workflows for staged runs, api-reference for Python calls, and cli-reference for the positional module CLI. Use troubleshooting before changing a model, corpus, or report definition.
Scope and routing
- Owns:
Task.load,Task.queries, one-levelTask.flatten, report YAML, standard/constant/generated columns,Execute.options/create/run, Markdown (md), CSV (csv), optional PDF annotation (ant), output naming,topn,threshold,indir,allsections,section,surround,matches,snippet, and column conversion helpers. - Requires: a model directory containing
articles.sqliteand a compatible saved txtai embeddings index. Use indexing for corpus schema, index construction, vector configuration, and compatibility. - Delegates: search syntax, score filtering, grouping, and highlight internals to querying. Do not use this route to repair SQLite, build embeddings, or ingest source PDFs.
Safe route
- Copy the minimal, standard-column YAML in configuration and replace every placeholder. Run the bundled the safe validator before loading a model; it parses YAML and checks shape only, without importing paperai, opening SQLite, or touching models.
- Confirm the model directory and database/index prerequisites. For
ant, also confirm a readable source directory and exact source basenames. - Run one narrow query with explicit
topnandmd. Add one generated field, thendtype/context controls, then switch to CSV or annotation. - Inspect output files with a Markdown/CSV parser and plan a fresh output directory or unique names: paperai opens outputs in write mode and does not prompt before replacement.
Fast facts
- Renderer values are exactly
md,csv, andant; missing render resolves to Markdown, while another value raisesValueError. - A task path writes beside the YAML. Its root
nameis the Markdown/master output stem. Markdown is<name>.md; CSV creates one<query-name>.csvper top-level query and removes its temporary<name>.csv; annotation writesannotations/<Source>and removes its temporary<name>.ant. - Standard columns are
Id,Date,Study,Study Link,Journal,Source,Entry, andMatches. Aconstantcolumn performs no model call. A generated column hasqueryand optionalquestion/controls. query: "*"enumerates all articles and can maketopnineffective. The query layer uses a default threshold of 0.25 when threshold is absent. Passtopnexplicitly: in 2.6.0Execute.optionsstores a missing value asNone, which can defeat the nominalReport.buildfallback of 50.section: trueexpands a match to the full same-named subsection; positivesurround: Nexpands to nearby stored section rows.sectionwins if both are set.matchescontrols context snippets per generated field, not article count.qais anExecute/CLI parameter but verified 2.6.0 filters it before RAG construction; set YAMLoptions.llmfor the effective RAG model selector.antadditionally requirestxtmarker, PDFs, and matchingSourcenames.
Keep long schemas, renderer details, workflows, and failure matrices in the linked references rather than expanding this router.
04 同仓库更多 Skills
obsidian-clipper-template-creator
Guide for creating templates for the Obsidian Web Clipper. Use when you want to create a new clipping template, understand available variables, or format clipped content.
obsidian-clipper-template-creator
Guide for creating templates for the Obsidian Web Clipper. Use when you want to create a new clipping template, understand available variables, or format clipped content.
python-api
Programmatic Object-Detection-Metrics API guidance for BoundingBox, BoundingBoxes, Evaluator, enums, coordinate conversion, AP/mAP semantics, and source-style import diagnostics.
file-evaluation
Folder-based PASCAL VOC AP/mAP evaluation from ground-truth and detection text files.
object-detection-metrics
Guides legacy Object-Detection-Metrics PASCAL VOC AP/mAP evaluation from detection text folders and direct Python API classes.
nx-workspace-patterns
Configure and optimize Nx monorepo workspaces. Use when setting up Nx, configuring project boundaries, optimizing build caching, or implementing affected commands.