Spaces:
Sleeping
Sleeping
File size: 1,437 Bytes
fda8fb3 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 | # API And Product Behavior
## Auth Model
- If `REQUIRE_AUTH=true`, analysis endpoints require Hugging Face sign-in.
- Sessions are scoped to user identity.
- One user cannot fetch another user’s session or export.
## Session Model
Statuses:
- `queued`
- `generating`
- `answer_ready`
- `analyzing`
- `completed`
- `failed`
Sessions are ephemeral for current running instance.
## Endpoints
### `GET /healthz`
Returns:
- model name
- device preference
- dtype preference
- auth requirement
- queue limits
- CUDA / MPS availability
### `GET /api/me`
Returns current auth state plus login/logout URLs.
### `POST /api/warmup`
Loads model with current runtime policy and returns:
- resolved device
- resolved dtype
- model attribution capability
### `POST /api/analyze`
Direct synchronous analysis call. Good for trusted programmatic use, not best path for UI.
### `GET /api/sessions`
List current user’s recent sessions on current instance.
### `POST /api/sessions`
Create async session job.
Queue protections:
- global queue cap
- per-user active-job cap
### `GET /api/sessions/{id}`
Return session summary.
### `GET /api/sessions/{id}/result`
Return session summary + full analysis if ready.
### Export
- `GET /api/sessions/{id}/export.json`
- `GET /api/sessions/{id}/export.csv`
JSON contains session + analysis payload.
CSV contains top edges:
- `source_sentence_idx`
- `target_sentence_idx`
- `score`
|