# 圖表產生與編輯

根據資料繪製可用於發表的圖表，再透過後續指令進行修改。

來源：https://scifig.ai/zh-Hant/docs/api/charts

## 表單欄位

`POST /charts/generations` 接受 `multipart/form-data`。所需權限範圍：`figures:generate`。

| 欄位 | 類型 | 必填 | 預設值 | 規則 |
| --- | --- | --- | --- | --- |
| data | file | 是 | — | CSV、TSV、TXT、XLSX 或 XLS，最大 8 MB，需包含表頭行；CSV、TSV 和 TXT 的分隔符（逗號、Tab 字元或分號）會自動識別 |
| 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())
```