SciFig

API-Referenz

Texterkennung

Erkennen Sie Textbeschriftungen in einem Bild, bevor Sie sie mit einer `replace_text`-Bearbeitung ändern.

Als Markdown anzeigen

Anfrage und Antwort#

POST /images/text-detections mit {"image": "<file_id>"} und einem Idempotency-Key. Erforderlicher Berechtigungsbereich: figures:generate. Kostenlos. Die synchrone Antwort lautet 200:

{
  "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 sind in Lesereihenfolge angeordnet; corners enthält die Pixelkoordinaten jeder Beschriftung im Bild.
  • Eine Wiederholung mit demselben Schlüssel gibt dieselbe Erkennung zurück, ohne sie erneut auszuführen. Derselbe Schlüssel mit einem anderen Bild führt zu 409 IDEMPOTENCY_CONFLICT.
  • Texterkennungen teilen sich mit der Website das Kontolimit von 20 je 15 Minuten. Bei Überschreitung lautet die Antwort 429 RATE_LIMITED.
  • Übergeben Sie die id mit demselben Bild an eine replace_text-Bearbeitung. Sie funktioniert nur für dieses Bild und Ihr Konto.
  • Das Bild ist eine PNG-, JPEG- oder WebP-file_id. Ein vorübergehender Fehler der Texterkennung führt zu 503 SERVICE_UNAVAILABLE mit Retry-After: Wiederholen Sie die Anfrage mit demselben Schlüssel. Eine ausgeführte Erkennung ohne Ergebnis führt zu 502 TASK_FAILED und TEXT_DETECTION_FAILED: Senden Sie sie mit einem neuen Schlüssel erneut.

cURL#

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#

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#

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())