You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 5b66958
Browse filesBrowse the repository at this point in the historyBrowse files
docs(sdk): resync the corrected reference; contain its tables and endpoint paths at phone width
Review findings on #1106 (nik13). The pages are resynced from futureagi-sdk
3269d58, where the generator was fixed: ref-aware example values (dashboards
query shows an object for time_range), error imports from @future-agi/sdk/platform,
no TypeScript strictResponses claim. Nothing was edited by hand here.
Phone width: every generated table now sits in <div class="sdk-ref-table">,
styled in global.css as a bounded horizontal scroller (max-width 100%,
overflow-x auto), so a long identifier scrolls inside the table instead of
widening the page; h3/h4 may break inside a single long identifier; and the
ApiEndpoint badge lets a long path wrap (min-w-0, overflow-wrap: anywhere),
which was the other source of document overflow. Nothing is clipped.
scripts/sdk-reference-mobile.cjs (part of test:integrations:browser, so it runs
in pr-checks after the preview starts) loads every page of the reference group
at a 390 px viewport and fails if the document scrolls horizontally, if a table
is outside .sdk-ref-table, or if any heading, cell or code block starts left of
the viewport. Locally: 34 pages fit 390 px (annotation-queues was 536 px,
prompts 402 px, prompt models 425 px before).
description: "The 8 response models returned by the account resources of the Future AGI Python and TypeScript SDKs, with every field and its type."
4
4
---
5
5
6
-
The models returned by `client.account`, `client.workspaces`, `client.usage`, importable from `fi.platform.models` (Python) and `@future-agi/sdk/platform/models` (TypeScript). Types are language-neutral: `string[]` is a Python `list[str]` and a TypeScript `string[]`, and a type named after another model links to that model. Parsing is tolerant by default: a response that leaves a field out or adds one never breaks a call, and `strict_responses=True` (Python) or `strictResponses: true` (TypeScript) rejects a response that misses a field the contract requires (see the [overview](/docs/sdk/reference#strict-mode)).
6
+
The models returned by `client.account`, `client.workspaces`, `client.usage`, importable from `fi.platform.models` (Python) and `@future-agi/sdk/platform/models` (TypeScript). Types are language-neutral: `string[]` is a Python `list[str]` and a TypeScript `string[]`, and a type named after another model links to that model. Parsing is tolerant by default: a response that leaves a field out or adds one never breaks a call. In Python, `Client(strict_responses=True)`rejects a response that misses a field the contract requires (see the [overview](/docs/sdk/reference#strict-mode)); TypeScript has no strict mode.
description: "The 30 response models returned by the annotation resources of the Future AGI Python and TypeScript SDKs, with every field and its type."
4
4
---
5
5
6
-
The models returned by `client.annotation_queues`, `client.annotations`, `client.scores`, importable from `fi.platform.models` (Python) and `@future-agi/sdk/platform/models` (TypeScript). Types are language-neutral: `string[]` is a Python `list[str]` and a TypeScript `string[]`, and a type named after another model links to that model. Parsing is tolerant by default: a response that leaves a field out or adds one never breaks a call, and `strict_responses=True` (Python) or `strictResponses: true` (TypeScript) rejects a response that misses a field the contract requires (see the [overview](/docs/sdk/reference#strict-mode)).
6
+
The models returned by `client.annotation_queues`, `client.annotations`, `client.scores`, importable from `fi.platform.models` (Python) and `@future-agi/sdk/platform/models` (TypeScript). Types are language-neutral: `string[]` is a Python `list[str]` and a TypeScript `string[]`, and a type named after another model links to that model. Parsing is tolerant by default: a response that leaves a field out or adds one never breaks a call. In Python, `Client(strict_responses=True)`rejects a response that misses a field the contract requires (see the [overview](/docs/sdk/reference#strict-mode)); TypeScript has no strict mode.
0 commit comments