Skip to content

Documentation coverage audit

Audited on 2026-10-15 against all 128 pages in the provider's documentation index, including concepts, primitives, patterns, cookbooks, HTTP reference, Python/JavaScript SDK references, and changelogs. The live OpenAPI has two operations: GET /v1/models and POST /v1/systemone; both are implemented. The linked source pages remain authoritative for current model limits and behavior.

Evidence and boundaries

Capability .NET surface Regression evidence
All documented question/answer types Noul, Choice, Score, Box; QuestionSet and grouped answers Tests.Transport.cs, Tests.Images.cs
Text/object/array state and arbitrary nested JSON values JsonContent.Parse/FromNode/Create with source-generated metadata Tests.Structure.cs, Examples/StructuredState.cs
Text/object/array/null instructions and all criteria positions JsonContent, NoulCriteria, ChoiceQuestion.FromCriteria, ScoreQuestion.FromCriteria AdvancedStructurePreservesEveryEntryShapeAndStructuredScoreLegends
Full field nesting limit, with room for request/response envelopes 64 content levels; envelope allowance SixtyFourLevelsRemainValidInsideRequestAndResponseEnvelopes
Structured Score legends and replay ScoreAnswer.Legend, RawJson, FromHttpResponse Tests.Structure.cs
Images, reference placement, multipart/base64, retries ImageAsset, RequestOptions.Images Tests.Images.cs
Model aliases, discovery, response version model argument, Models.ListAsync, SystemOneResponse.Model Examples/ListModels.cs; live example requires credentials
Experimental long context RequestOptions.EnableLongContext or default headers CompressionAndLongContextSurviveRetries
Request compression RequestCompression.Gzip/None; JSON and multipart; 1 KiB threshold Tests.RequestFeatures.cs
Nullable/missing usage counts Usage.InputTokens/OutputTokens; preserved raw JSON Tests.Usage.cs
Status errors, retry-after/backoff, cancellation Exceptions, RetryPolicy, CancellationToken Tests.Transport.cs, Tests.RequestFeatures.cs, Tests.Contract.cs
Raw/future questions and responses RawQuestion, RawAnswer, ExtraBody, RawJson GeneratedTransportPreservesKnownAndFutureUnionValues; Tests.Contract.cs
Named/custom response projections QuestionSet handles and caller JsonTypeInfo Tests.Projection.cs, Tests.Images.cs, NativeAotSmoke
Confidence routing, normalized composition, taxonomy traversal Existing answer properties plus application code CriteriaFactoriesSupportTaxonomyWalkAndOrderedRubrics; Tests.Meai.cs
Bounded fan-out, multiple states, DI, transport injection QuestionSet, SystemOneManyAsync, ITypeSafeClient, HttpClient Examples/BatchStates.cs, Tests.Meai.cs
Logging and telemetry ILoggerFactory, ActivitySource, Meter Client implementation; no payload logging
Trimming/NativeAOT Source-generated serialization; no reflection-based content factories NativeAotSmoke; CI trimming checks

Tests are local HTTP contract fixtures. They establish serialization, parsing, and composition behavior; they do not establish provider accuracy, live image acceptance, cost/latency claims, all cookbook datasets, or production acceptance. Credentialed examples skip when credentials are absent. Model limits, pricing, legal terms, and benchmarks are provider facts, not SDK features to hard-code.

Runtime differences

Celeris's compatible System One endpoint is supported by an explicit provider profile, separate from this TypeSafe documentation audit. Typed Celeris options, explanations, image translation, and provider-specific validation are covered by Tests.Celeris.cs, Tests.CelerisDiscovery.cs, and the native smoke program. Tests.HostedProviders.cs covers the additional decision-provider adapters. See the provider guide; compatibility is scoped to the documented System One surface and is not proof of live provider acceptance. The separately sourced hosted-provider inventory records compatibility and gaps for the wider JevBench cloud roster.

  • .NET uses documented gzip compression on request; it does not bundle Node/Python's native zstd runtime. Compression defaults to none and can be overridden per call.
  • Image uploads use an explicit reference-to-asset map. Python inline objects and JavaScript tagged templates have the same wire capability through ImageAsset.Reference and RequestOptions.Images; their language syntax is not reproduced.
  • Synchronous and asynchronous .NET APIs use tasks, CancellationToken, IDisposable, HttpClient and DI rather than Python event loops or JavaScript promises/fetch/browser guards.
  • ILoggerFactory controls logs; environment log-level setup and raw body logging from the other SDKs are not copied. Request/response payloads remain out of SDK logs.
  • Retry defaults and .NET option replacement differ from JS partial objects. A total retry budget is configurable and can be disabled explicitly.
  • Score probability/legend keys retain the wire's string indices; enum helpers provide typed levels. Python's integer-key dictionaries are a language adaptation.
  • Nullable token counts follow the SDK references, although the current OpenAPI still declares integers. A handwritten compatibility converter preserves the original JSON without editing generated code. The generated raw client follows its OpenAPI schema when used independently.
  • Cookbook applications combine the SDK with caller-owned extraction, storage, ranking, UI, calendar math, or external models. The SDK supplies the TypeSafe calls and data needed for those workflows; it does not install or execute those applications or agent skills.

Cookbook mappings

Cookbook Supported composition
Function calling Choice/Noul, typed handles; application validates and dispatches closed-set arguments
Skill suggestion Score/Choice, distributions; application ranks candidates and performs the second pass
Guardrails for LLMs Mixed Noul/Score, MEAI guardrail policies and caller-selected thresholds
Double-checking citations Structured state and Choice; application locates source spans
Classifying RAG passages Mixed named questions; application filters and assembles passages
Simple memory system Structured state, Noul and sequential requests; application persists memories
Hierarchical classification Structured Choice criteria, full probabilities and sequential/parallel requests; application walks or beams the tree
Classification using confidence Choice confidence; application chooses leaf versus parent category
Twitch chat filter Mixed questions, SystemOneManyAsync concurrency; application renders filtering decisions
SDE cascade Structured instructions/Noul criteria; application calls extraction and escalation models
Date extraction Choice/Noul closed sets; application performs calendar arithmetic
Pre-parsed value extraction Choice over candidate labels; application parses and normalizes verbatim spans
Structure recovery Noul/Choice plus two sequential requests; application renders Markdown
Re-ranking Score/Noul and bounded batches; application sorts candidate passages
Line-by-line search Structured line maps, Choice and Noul; application resolves chosen IDs
Knowledge graph entity alignment Structured pairs, Score plus Noul; application thresholds and routes
Self-consistency: choices Choice distributions and confidence; application caches samples and defines abstention
Self-consistency: nouls Noul probabilities; application defines uncertainty bands
Parallel questions QuestionSet for one state and many mixed questions; application compares batches
Autoresearch feature discovery Mixed named questions and distributions; external model proposes features and application fits downstream models

Complete source inventory

Each indexed page is accounted for below. "Runtime reference" entries map to the capabilities and runtime differences above; "application pattern" entries use the cookbook mappings or ordinary composition over named answers. Documentation navigation, demos, agent installation, conceptual background, and legal material introduce no additional SDK endpoint.

Upstream page Coverage category
Introduction Core System One API, typed questions/answers and README
Quick start Core System One API, typed questions/answers and README
Jev with coding agents Background/external application; no additional SDK operation
Example use cases Background/external application; no additional SDK operation
System One Core System One API, typed questions/answers and README
State Advanced structure guide and Tests.Structure.cs
Primitives (Questions) Core System One API, typed questions/answers and README
Choice Core System One API, typed questions/answers and README
Score Core System One API, typed questions/answers and README
Noul Core System One API, typed questions/answers and README
Box Images and Box guide and Tests.Images.cs
Advanced: structure Advanced structure guide and Tests.Structure.cs
Images Images and Box guide and Tests.Images.cs
Confidence Application composition, answer distributions, MEAI adapters
How to build with TypeSafe Application composition, answer distributions, MEAI adapters
AI primer Background/external application; no additional SDK operation
Patterns Application composition, answer distributions, MEAI adapters
Speculative fan-out Application composition, answer distributions, MEAI adapters
Confidence-gated routing Application composition, answer distributions, MEAI adapters
Composite scoring Application composition, answer distributions, MEAI adapters
Intent routing Application composition, answer distributions, MEAI adapters
Cookbooks Application composition, answer distributions, MEAI adapters
Function calling Application pattern; see cookbook mapping
Skill suggestion Application pattern; see cookbook mapping
Guardrails for LLMs Application pattern; see cookbook mapping
Double-checking citations Application pattern; see cookbook mapping
Classifying RAG passages Application pattern; see cookbook mapping
Simple memory system Application pattern; see cookbook mapping
Hierarchical classification Application pattern; see cookbook mapping
Classification using confidence Application pattern; see cookbook mapping
Twitch chat filter Application pattern; see cookbook mapping
SDE cascade Application pattern; see cookbook mapping
Date extraction Application pattern; see cookbook mapping
Pre-parsed value extraction Application pattern; see cookbook mapping
Structure recovery Application pattern; see cookbook mapping
Re-ranking Application pattern; see cookbook mapping
Line-by-line search Application pattern; see cookbook mapping
Knowledge graph entity alignment Application pattern; see cookbook mapping
Self-consistency: choices Application pattern; see cookbook mapping
Self-consistency: nouls Application pattern; see cookbook mapping
Parallel questions Application pattern; see cookbook mapping
Autoresearch feature discovery Application pattern; see cookbook mapping
Demos Background/external application; no additional SDK operation
Smart home assistant demo Background/external application; no additional SDK operation
Models Models.ListAsync, model selection, long-context header; provider owns limits
API reference Both HTTP operations, request/answer types, errors, compression
Agent skill Background/external application; no additional SDK operation
Legal Background/external application; no additional SDK operation
Jev 1.13 jaggedness Background/external application; no additional SDK operation
Client SDKs SDK installation; NuGet package and README
TypeSafe Python SDK Runtime reference; .NET equivalents and differences above
Basic usage Runtime reference; .NET equivalents and differences above
Advanced usage Runtime reference; .NET equivalents and differences above
Changelog Runtime reference; .NET equivalents and differences above
API reference Runtime reference; .NET equivalents and differences above
Asynchronous client Runtime reference; .NET equivalents and differences above
Synchronous client Runtime reference; .NET equivalents and differences above
Questions Runtime reference; .NET equivalents and differences above
Assets Runtime reference; .NET equivalents and differences above
Answers and responses Runtime reference; .NET equivalents and differences above
Retries Runtime reference; .NET equivalents and differences above
Common types Runtime reference; .NET equivalents and differences above
Exceptions Runtime reference; .NET equivalents and differences above
Constants Runtime reference; .NET equivalents and differences above
JavaScript SDK Runtime reference; .NET equivalents and differences above
Changelog Runtime reference; .NET equivalents and differences above
API reference Runtime reference; .NET equivalents and differences above
Class: APIConnectionError Runtime reference; .NET equivalents and differences above
Class: APIError Runtime reference; .NET equivalents and differences above
Class: APIPromise Runtime reference; .NET equivalents and differences above
Class: APITimeoutError Runtime reference; .NET equivalents and differences above
Class: APIUserAbortError Runtime reference; .NET equivalents and differences above
Class: AuthenticationError Runtime reference; .NET equivalents and differences above
Class: BadRequestError Runtime reference; .NET equivalents and differences above
Class: Image Runtime reference; .NET equivalents and differences above
Class: InternalServerError Runtime reference; .NET equivalents and differences above
Class: NotFoundError Runtime reference; .NET equivalents and differences above
Class: PermissionDeniedError Runtime reference; .NET equivalents and differences above
Class: RateLimitError Runtime reference; .NET equivalents and differences above
Class: TypeSafeClient Runtime reference; .NET equivalents and differences above
Class: TypeSafeError Runtime reference; .NET equivalents and differences above
Class: UnprocessableEntityError Runtime reference; .NET equivalents and differences above
Interface: BoxCoordinates Runtime reference; .NET equivalents and differences above
Interface: BoxQuestion Runtime reference; .NET equivalents and differences above
Interface: BoxResponse Runtime reference; .NET equivalents and differences above
Interface: ChoiceQuestion Runtime reference; .NET equivalents and differences above
Interface: ChoiceResponse Runtime reference; .NET equivalents and differences above
Interface: Logger Runtime reference; .NET equivalents and differences above
Interface: ModelCard Runtime reference; .NET equivalents and differences above
Interface: Models Runtime reference; .NET equivalents and differences above
Interface: NoulQuestion Runtime reference; .NET equivalents and differences above
Interface: NoulResponse Runtime reference; .NET equivalents and differences above
Interface: Questions Runtime reference; .NET equivalents and differences above
Interface: RequestOptions Runtime reference; .NET equivalents and differences above
Interface: RetryPolicy Runtime reference; .NET equivalents and differences above
Interface: ScoreQuestion Runtime reference; .NET equivalents and differences above
Interface: ScoreResponse Runtime reference; .NET equivalents and differences above
Interface: SystemOneRequest Runtime reference; .NET equivalents and differences above
Interface: SystemOneResult Runtime reference; .NET equivalents and differences above
Interface: TextWithAssets Runtime reference; .NET equivalents and differences above
Interface: TypeSafeClientConfig Runtime reference; .NET equivalents and differences above
Interface: Usage Runtime reference; .NET equivalents and differences above
Interface: WithResponse Runtime reference; .NET equivalents and differences above
Type Alias: Asset Runtime reference; .NET equivalents and differences above
Type Alias: ChoiceCriteria Runtime reference; .NET equivalents and differences above
Type Alias: Compression Runtime reference; .NET equivalents and differences above
Type Alias: ContentValue Runtime reference; .NET equivalents and differences above
Type Alias: Description Runtime reference; .NET equivalents and differences above
Type Alias: EntryType Runtime reference; .NET equivalents and differences above
Type Alias: EnvVar Runtime reference; .NET equivalents and differences above
Type Alias: Fetch Runtime reference; .NET equivalents and differences above
Type Alias: JsonValue Runtime reference; .NET equivalents and differences above
Type Alias: LogLevel Runtime reference; .NET equivalents and differences above
Type Alias: Question Runtime reference; .NET equivalents and differences above
Type Alias: ResultFor Runtime reference; .NET equivalents and differences above
Type Alias: ScoreCriteria Runtime reference; .NET equivalents and differences above
Type Alias: ScoreLegend Runtime reference; .NET equivalents and differences above
Type Alias: ScoreOf Runtime reference; .NET equivalents and differences above
Type Alias: SentContent Runtime reference; .NET equivalents and differences above
Variable: ENV Runtime reference; .NET equivalents and differences above
Variable: LOG_LEVELS Runtime reference; .NET equivalents and differences above
Variable: noul Runtime reference; .NET equivalents and differences above
Variable: score Runtime reference; .NET equivalents and differences above
Variable: VERSION Runtime reference; .NET equivalents and differences above
Variable: withAssets Runtime reference; .NET equivalents and differences above
Function: box() Runtime reference; .NET equivalents and differences above
Function: choice() Runtime reference; .NET equivalents and differences above
Function: image() Runtime reference; .NET equivalents and differences above

Index snapshot SHA-256: 99f746d2570aa97898ad0e62042b9b5b703e54c3f1142ce4cf4b7ff15b5782ae.