# 文字検出

`replace_text` 編集で変更する前に、画像内の文字ラベルを検出します。

出典：https://scifig.ai/ja/docs/api/text-detections

## リクエストとレスポンス

`{"image": "<file_id>"}` と `Idempotency-Key` を伴う `POST /images/text-detections`。必要なスコープ：`figures:generate`。無料です。同期処理で `200` を返します：

```json
{
  "id": "c222cd46-d923-4abf-aa28-cdc72ad06623",
  "object": "text_detection",
  "width": 2048,
  "height": 1536,
  "texts": [
    { "index": 0, "text": "Nucleus", "corners": [{ "x": 75, "y": 260 }, { "x": 241, "y": 260 }, { "x": 241, "y": 295 }, { "x": 75, "y": 295 }] }
  ]
}
```

- `texts` は読み順に並び、`corners` は画像内の各ラベルのピクセル座標です。
- 同じキーで再送すると、検出を再実行せずに同じ結果を返します。同じキーで別の画像を指定すると `409 IDEMPOTENCY_CONFLICT` を返します。
- 検出には、アカウントごとに 15 分間で 20 回というウェブサイト共通の制限が適用されます。超過すると `429 RATE_LIMITED` を返します。
- `id` と同じ画像を `replace_text` 編集に渡します。その画像と自分のアカウントでのみ使用できます。
- 画像には PNG、JPEG、WebP の `file_id` を指定します。文字認識サービスの一時的な障害は、`Retry-After` 付きの `503 SERVICE_UNAVAILABLE` を返すため、同じキーで再試行してください。検出が実行されたものの結果が得られなかった場合は `502 TASK_FAILED`（`TEXT_DETECTION_FAILED`）を返すため、新しいキーで再送してください。

## cURL

```bash
curl -X POST https://scifig.ai/api/v1/images/text-detections \
  -H "Authorization: Bearer $SCIFIG_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Prefer: wait=25" \
  -H "Content-Type: application/json" \
  -d '{
    "image": "<file_id>"
  }'
```

## JavaScript

```javascript
const response = await fetch('https://scifig.ai/api/v1/images/text-detections', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SCIFIG_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    Prefer: 'wait=25',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "image": "<file_id>"
  }),
});
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/images/text-detections",
    headers=headers,
    json={
        "image": "<file_id>"
    },
    timeout=60,
)
print(response.status_code, response.json())
```