# 图表生成与编辑

根据数据绘制可用于发表的图表，再通过后续指令进行修改。

来源：https://scifig.ai/zh/docs/api/charts

## 表单字段

`POST /charts/generations` 接受 `multipart/form-data`。所需权限范围：`figures:generate`。

| 字段 | 类型 | 必填 | 默认值 | 规则 |
| --- | --- | --- | --- | --- |
| data | file | 是 | — | CSV、TSV、TXT、XLSX 或 XLS，最大 8 MB，需包含表头行；CSV、TSV 和 TXT 的分隔符（逗号、制表符或分号）会自动识别 |
| request | string | 是 | — | 用自然语言描述需要绘制的内容；1–16,000 个字符 |
| chart_types | string | 否 | 根据数据选择 | 逗号分隔的值或 JSON 数组；参阅下方列表 |
| journal_style | string | 否 | `default` | `default`、`nature`、`science`、`cell`、`plos` 或 `acs` |
| figure_width | string | 否 | `double` | `single`、`onehalf` 或 `double` 栏宽；PLOS 和 ACS 不支持 `onehalf` |
| color_palette | string | 否 | `okabe_ito` | `okabe_ito`、`wong`、`tol_bright`、`tol_muted`、`nature`、`science`、`nejm`、`lancet` 或 `jama` |
| sheet_name | string | 适用于包含多个工作表的工作簿 | — | 从 XLSX 或 XLS 文件中用于绘图的工作表（1–255 个字符） |

## 数据错误

- 创建任何内容前，先使用与网站相同的解析器解析数据。无法读取的数据返回 `400 INVALID_REQUEST`，带有 `details.field = data` 和 `details.reason` 中的解析错误代码（例如 `DATACHART_CSV_INVALID`、`DATACHART_TOO_MANY_ROWS`）；不会运行任务或扣积分。
- 工作簿包含多个工作表却未指定 `sheet_name` 时，返回 `400 INVALID_REQUEST`（`DATACHART_WORKSHEET_REQUIRED`），并在 `details.sheet_names` 中列出工作表名称；请带上 `sheet_name` 重发请求。不存在的 `sheet_name` 返回 `DATACHART_WORKSHEET_INVALID`，同样包含 `details.sheet_names`。
- 列表之外的文件类型返回 `UNSUPPORTED_DATA_FORMAT`；超过大小限制的文件返回 `DATA_FILE_TOO_LARGE`。
- 每个新数据文件计入网站的上传额度；超出后返回 `429 RATE_LIMITED`（`UPLOAD_RATE_LIMITED` 或 `UPLOAD_DAILY_LIMIT_REACHED`）。相同密钥重试不会再次计入。

## 图表类型

`bar`, `line`, `scatter`, `dot`, `frequency_dot`, `pie`, `nested_pie`, `timeseries`, `waterfall`, `stacked_area`, `radar`, `boxplot`, `violin`, `histogram`, `density`, `raincloud`, `beeswarm`, `qq`, `ogive`, `ecdf`, `ridgeline`, `regression`, `errorbar`, `correlation`, `bland_altman`, `funnel`, `standard_curve`, `bubble`, `hexbin`, `paired_dot`, `volcano`, `kaplan_meier`, `forest`, `roc`, `manhattan`, `ma_plot`, `enrichment`, `dose_response`, `growth_curve`, `enzyme_kinetics`, `precision_recall`, `calibration_curve`, `confusion_matrix`, `heatmap`, `dendrogram`, `upset`, `sankey`, `stem_leaf`, `calendar_heatmap`

## 输出与积分

每张图表 100 积分。成功任务包含同一图表的 PNG、PDF、TIFF 和 EPS 输出，尺寸匹配期刊栏宽。每个输出携带 `editor_url`，可在网站的 DataChart 对话中打开该图表。

## 编辑

`POST /charts/edits` 接受 JSON `{"job": "<chart job id>", "instruction": "..."}`，修改该任务生成的图表，保留数据、图表类型、期刊样式和配色。`instruction` 为 1–16,000 个字符。与工作台一样，消耗 100 积分。

- 任务必须属于你的图表任务，否则返回 `400 INVALID_REQUEST`（`JOB_NOT_FOUND`）。任务失败时，返回 `400 INVALID_REQUEST`（`JOB_NOT_SUCCEEDED`）。
- 任务仍在运行时，返回 `409 REVISION_CONFLICT`、`details.reason = PARENT_JOB_RUNNING` 和 `Retry-After`。此情况可以重试：等任务完成后，使用相同请求和相同密钥重发。
- 与工作台一样，只有最新版本可以编辑。请编辑同一版本链中最新的任务；旧版本返回 `409 REVISION_CONFLICT`（`NOT_LATEST_REVISION`），包括网站已生成新版本，或同一版本的其他编辑先被接纳的情况。
- 一次只能进行一个编辑：当前版本的编辑仍在运行时，另一个编辑返回 `409 REVISION_CONFLICT`（`EDIT_IN_PROGRESS`）。请等待正在运行的任务，再编辑它的结果。
- 网站中按旧图表格式创建的图表无法通过 API 继续编辑，返回 `400 INVALID_REQUEST`（`JOB_NOT_EDITABLE`）。
- 通过 API 进行的编辑会出现在网站同一个 DataChart 对话中。

## cURL

```bash
curl -X POST https://scifig.ai/api/v1/charts/generations \
  -H "Authorization: Bearer $SCIFIG_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Prefer: wait=25" \
  -F "data=@measurements.csv" \
  -F "request=Box plot of response by group with individual points" \
  -F "journal_style=nature"
```

## JavaScript

```javascript
import { readFile } from 'node:fs/promises';

const form = new FormData();
form.set('data', new Blob([await readFile('measurements.csv')]), 'measurements.csv');
form.set('request', 'Box plot of response by group with individual points');
form.set('journal_style', 'nature');

const response = await fetch('https://scifig.ai/api/v1/charts/generations', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SCIFIG_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    Prefer: 'wait=25',
  },
  body: form,
});
const result = await response.json();
console.log(response.status, result);
```

## Python

```python
import os
import uuid

import requests

headers = {
    "Authorization": f"Bearer {os.environ['SCIFIG_API_KEY']}",
    "Idempotency-Key": str(uuid.uuid4()),
    "Prefer": "wait=25",
}
response = requests.post(
    "https://scifig.ai/api/v1/charts/generations",
    headers=headers,
    files={"data": open("measurements.csv", "rb")},
    data={"request": "Box plot of response by group with individual points", "journal_style": "nature"},
    timeout=60,
)
print(response.status_code, response.json())
```