Skip to content

Releases: ensoria/docai

1.0.0 Release Notes (Stable)

Choose a tag to compare

@ensoriaadmin ensoriaadmin released this 21 Jul 05:46

Scope:

  • Publication label: final Stable for tag v1.0.0.
  • Current tagged public release remains v1.0.0-rc.4 until the final tag is
    published.
  • Stable compatibility is limited to normative README.md text,
    fixtures/conformance/v1.0.0/, and the self-contained
    tools/check-conformance-fixtures.mjs.
  • No DocAI HTTP format, authoritative input, conformance contract, checker
    expectation, or projected client behavior changes from reviewed RC.4.

Evidence:

  • The full/compact stable corpus covers resources, workflows, webhooks,
    non-JSON representations, polymorphism, safe retry behavior, and the complete
    unknown / unsupported surface required by README section 9.1.
  • RC4-METADATA-REVIEW.md records focused review completion with no remaining
    stable blocker, wording issue, backlog item, or question.
  • The stable checker validates the corpus in isolation, including focused
    metadata and source-contract negative tests.
  • Existing required-target responses regrade successfully against the reviewed
    contract without new provider submission.
  • OpenAPI comparison evidence remains scoped to the evaluated 0.12.0 fixture,
    target models, task contracts, run dates, and grader policy.

Compatibility:

  • This is the first Stable DocAI HTTP compatibility release.
  • Implementers already targeting v1.0.0-rc.4 require no document-format or
    projected-client migration.
  • Candidate-only evidence paths do not create additional stable promises.
  • Recursive finite representation, public validator APIs, source-to-projection
    validator guarantees, hosted live-provider CI, translations, optional target
    requirements, normalized provider-cost claims, and expanded benchmarks are
    explicitly not promoted by 1.0.0.
  • Later changes must follow README section 3.1 compatibility and versioning
    rules; published tags must not be moved or recreated.

Required pre-tag validation:

  • node docai-http/tools/check-release-readiness.mjs.
  • git diff --check.
  • Confirm the final preparation changes only publication wording, release
    metadata, and review records relative to the reviewed RC.4 contract.
  • Confirm v1.0.0 does not already exist locally or on the release remote.

Publication notes:

  • Create annotated tag v1.0.0 at the reviewed stable-preparation commit.
  • Publish this section as the final release notes.
  • After publication, update current-release wording from v1.0.0-rc.4 to
    v1.0.0 in a separate commit without changing the tag.

1.0.0-rc.4 Release Notes (Release candidate)

Choose a tag to compare

@ensoriaadmin ensoriaadmin released this 21 Jul 05:07

Scope:

  • Publication label remains 1.0.0 release candidate, not final Stable.
  • Current tagged public release: v1.0.0-rc.3.
  • Release path: correct focused-fixture source identity, publish
    v1.0.0-rc.4, and repeat the focused metadata review before final v1.0.0.
  • The DocAI HTTP format, authoritative input content, and projected client
    contract do not change.

Corrections:

  • Adds source_revision: fixture-input-set-rc3-001 to every metadata-bearing
    focused snippet that references the versioned authoritative input set.
  • Restamps full, compact, and focused fixtures as the rc4-001 logical
    projection without changing the rc3-001 authoritative input revision.
  • Makes the stable checker enforce exact projection, profile generation,
    source, and source-revision identity for metadata-bearing focused snippets.
  • Adds focused and isolated negative tests for omitted source revisions.
  • Updates current-release wording after publication of v1.0.0-rc.3.

Evidence status:

  • Standard DocAI document semantics and authoritative input content are
    unchanged; only provenance metadata and checker evidence change.
  • Required-target responses may be regraded deterministically without provider
    submission because no task contract changed.
  • OpenAPI comparison records remain historical 0.12.0 evidence.

Required pre-tag validation:

  • node docai-http/tools/check-release-readiness.mjs.
  • git diff --check.
  • Confirm fixtures/conformance/v1.0.0/RC4-METADATA-REVIEW.md is ready for the
    post-publication focused review.

1.0.0-rc.3 Release Notes (Release candidate)

Choose a tag to compare

@ensoriaadmin ensoriaadmin released this 21 Jul 04:44

Scope:

  • Publication label remains 1.0.0 release candidate, not final Stable.
  • Current tagged public release: v1.0.0-rc.2.
  • Release path: complete authoritative source traceability, publish
    v1.0.0-rc.3, and repeat the focused source-provenance review before final
    v1.0.0.
  • The DocAI HTTP format and projected client contract do not change.

Corrections:

  • Adds the missing cart, payment, order, and document success response schemas
    and media types to the authoritative OpenAPI input.
  • Adds the POST /users Location response header, common/validation/inline
    error body schemas, request constraints/defaults, document metadata schema,
    and webhook metadata schema to the authoritative input set.
  • Adds error-field usage and webhook-header wire behavior that cannot be
    expressed structurally in OpenAPI to the pass-through behavior source.
  • Restamps the full, compact, and focused corpus as the rc3-001 logical
    projection and expands the traceability matrix and targeted checker gate.

Evidence status:

  • The standard DocAI document content is unchanged except for provenance stamps.
  • The prior required-target live records remain behaviorally applicable because
    no task contract changed; they are regraded deterministically against the
    current documents rather than resent to providers.
  • Deterministic context metrics and all release-readiness checks must be rerun
    before tagging.
  • OpenAPI comparison records remain historical 0.12.0 evidence.

Required pre-tag validation:

  • node docai-http/tools/check-release-readiness.mjs.
  • git diff --check.
  • Focused review of SOURCE-TRACEABILITY.md, the two complete source inputs,
    and the source-contract checker assertions.

1.0.0-rc.2 Release Notes (Release candidate)

Choose a tag to compare

@ensoriaadmin ensoriaadmin released this 21 Jul 03:52

Scope:

  • Publication label remains 1.0.0 release candidate, not final Stable.
  • Release path: correct the stable-boundary findings from v1.0.0-rc.1, publish
    v1.0.0-rc.2, and perform a focused regression review before final v1.0.0.
  • Compatibility scope under review remains normative README text,
    fixtures/conformance/v1.0.0/, and the self-contained
    tools/check-conformance-fixtures.mjs.

Corrections:

  • Aligns all conformance Type cells with the simple Type grammar and keeps enum
    values in constraints or meaning.
  • Uses logical DocAI field paths for structured XML and keeps XPath-like wire
    locations in meaning/prose.
  • Adds canonical Request same_as positive and negative coverage and separate
    Request/Response target parsing.
  • Makes the stable checker self-contained and verifies it in an isolated tree
    containing only the advertised compatibility boundary.
  • Adds an authoritative input-set manifest and pass-through behavior source for
    conventions, retry behavior, errors, workflows, webhooks, and multipart facts.
  • Defines the fixture API's Idempotency-Key wire and safe-retry contract,
    including ambiguous outcomes and corrected-input retries.
  • Makes token-budget sizing advisory and clarifies complete-set versus focused
    fixture evidence responsibilities.
  • Tightens the Stable label so it requires final review, final tag/publication,
    and the publication-label transition.

Evidence status:

  • Deterministic conformance and isolated-boundary checks cover the corrected
    corpus.
  • SEMANTIC-DRIFT-AUDIT.md records task-relevant differences from the evaluated
    0.12.0 corpus.
  • A separate fixtures/release-candidates/v1.0.0-rc.2/evaluations/ snapshot
    refreshes affected DocAI task evidence against corrected conformance context;
    all 15 required live task records and all 6 required-target deterministic
    token-load records pass. The early-payment-settlement fixture gap is corrected
    by independent payment/order state and no-recapture order association, which
    all three refreshed workflow records satisfy.
  • OpenAPI comparison records remain historical 0.12.0 evidence and are not
    presented as a comparison against the corrected rc.2 documents.

Required pre-tag validation:

  • node docai-http/tools/check-release-readiness.mjs.
  • git diff --check.
  • Any approved rc.2 evaluation refresh selected by the active release TODO.

Publication notes:

  • Do not call this release Stable.
  • Do not rewrite or move tagged v1.0.0-rc.1 evidence.
  • After v1.0.0-rc.2 is published, update current-tag wording while preserving
    the release-candidate label.

1.0.0-rc.1 Release Notes (Release candidate)

Choose a tag to compare

@ensoriaadmin ensoriaadmin released this 20 Jul 12:50

Scope:

  • Publication label: 1.0.0 release candidate, not final Stable.
  • Release path: publish v1.0.0-rc.1 before stable v1.0.0; tag stable
    v1.0.0 only after final RC review.
  • Compatibility scope under review for final stable: normative README text,
    fixtures/conformance/v1.0.0/, and tools/check-conformance-fixtures.mjs.
  • Explicitly non-promoted areas: final Stable publication, standalone public
    validator APIs, automated live-provider CI, translated README.ja.md, source-to-projection
    validator guarantees, normalized provider cost comparisons, optional live LLM
    target requirements, additional API/task benchmark claims, and recursive-schema
    finite representation support.

Evidence:

  • Stable conformance corpus: fixtures/conformance/v1.0.0/.
  • Stable conformance checker: node docai-http/tools/check-conformance-fixtures.mjs.
  • Stable conformance coverage: fixtures/conformance/v1.0.0/COVERAGE.md.
  • Source traceability audit: fixtures/conformance/v1.0.0/SOURCE-TRACEABILITY.md.
  • Semantic drift audit: fixtures/conformance/v1.0.0/SEMANTIC-DRIFT-AUDIT.md.
  • Token-saving conformance notes: fixtures/conformance/v1.0.0/TOKEN-SAVINGS.md.
  • Carried-forward LLM evaluation results: fixtures/complete-candidates/v0.12.0/evaluations/RESULTS.md.
  • Carried-forward OpenAPI comparison evidence: OPENAPI-COMPARISON-EVIDENCE.md.

Compatibility:

  • Version bump reason: v1.0.0-rc.1 switches the active specification version to
    1.0.0 and tests the intended first stable compatibility contract before the
    final stable tag.
  • Known compatibility limits: this publication is a release candidate, not final
    Stable; candidate-only evidence paths do not create stable compatibility
    promises by themselves.
  • Migration notes: implementers targeting the RC should use
    fixtures/conformance/v1.0.0/ and node docai-http/tools/check-conformance-fixtures.mjs.
    Implementers targeting historical pre-1.0 scopes may continue using the
    0.11.0 core corpus or the 0.12.0 complete-candidate corpus as appropriate.

Carried-forward evidence policy:

  • The 0.12.0 live LLM task evaluations, deterministic token-load records, and
    OpenAPI comparison records remain supporting evidence for v1.0.0-rc.1 because
    SEMANTIC-DRIFT-AUDIT.md found no standard document content drift after
    release-boundary metadata is normalized.
  • If final RC review changes standard document content beyond wording or metadata
    that preserves the stable contract, rerun deterministic checks and decide
    whether the affected live LLM or OpenAPI comparison evidence must be refreshed.

Required pre-tag validation:

  • node docai-http/tools/check-release-readiness.mjs.
  • git diff --check.
  • Rerun both immediately before tagging v1.0.0-rc.1.

Publication notes:

  • Do not call this release Stable.
  • Do not update the "current tagged public release" wording from v0.12.0 until
    v1.0.0-rc.1 is actually tagged and published.
  • If final review finds only wording or metadata issues that preserve the stable
    contract, fix them before tagging stable v1.0.0.
  • If final review finds compatibility-scope or conformance-content changes,
    update the evidence and consider publishing v1.0.0-rc.2 before stable v1.0.0.

0.12.0 Draft Release Notes (Complete-generator-ready candidate)

Choose a tag to compare

@ensoriaadmin ensoriaadmin released this 14 Jul 01:41

Scope:

  • Compatibility scope: the complete draft surface evidenced by fixtures/complete-candidates/v0.12.0/.
  • Newly promoted features: complete-surface generator readiness for the evidenced corpus, including the required full profile, matching compact profile, workflows, webhooks, non-JSON representation classes, polymorphic variants, selective convention loading, compact reductions, and complete-surface unknown / unsupported forms covered by the fixture corpus.
  • Explicitly non-promoted draft areas: stable compatibility, 1.0.0 conformance status, recursive-schema representation support, a standalone public validator package, automated live-provider CI, and README.ja.md.

Evidence:

  • Fixture corpus: fixtures/complete-candidates/v0.12.0/.
  • Complete-candidate checker: node docai-http/tools/check-complete-candidates.mjs.
  • Evaluation checker: node docai-http/tools/check-complete-evaluations.mjs.
  • OpenAPI comparison checker: node docai-http/tools/check-openapi-comparison.mjs.
  • Coverage notes: fixtures/complete-candidates/v0.12.0/COVERAGE.md.
  • LLM evaluation results: fixtures/complete-candidates/v0.12.0/evaluations/RESULTS.md.
  • OpenAPI comparison evidence: OPENAPI-COMPARISON-EVIDENCE.md.

Compatibility:

  • Version bump reason: 0.12.0 expands the advertised pre-1.0 implementation target from the 0.11.0 Compatibility Core to an evidenced complete-generator-ready candidate surface.
  • Known compatibility limits: this release is not stable, not 1.0.0, and not compatibility-stable for future versions. Stable compatibility guarantees still begin at 1.0.0.
  • Migration notes: implementers targeting only the 0.11.0 Compatibility Core may continue using the core fixture corpus; implementers targeting 0.12.0 should use the complete-candidates/v0.12.0 corpus and the complete-candidate checkers.

Pre-tag deterministic validation results:

  • node docai-http/tools/check-core-fixtures.mjs: passed.
  • node docai-http/tools/check-compact-candidates.mjs: passed.
  • node docai-http/tools/check-workflow-candidates.mjs: passed.
  • node docai-http/tools/check-webhook-candidates.mjs: passed.
  • node docai-http/tools/check-non-json-candidates.mjs: passed.
  • node docai-http/tools/check-polymorphism-candidates.mjs: passed.
  • node docai-http/tools/check-complete-candidates.mjs: passed.
  • node docai-http/tools/check-complete-evaluations.mjs: passed.
  • node docai-http/tools/check-openapi-comparison.mjs: passed.
  • git diff --check: passed.

Release automation:

  • No CI workflow is added for 0.12.0; this repository does not yet have a standard CI provider or task-runner surface.
  • The deterministic commands above remain the canonical pre-tag validation path for this release.
  • Live LLM provider evaluations are manually recorded evidence. They require provider credentials, cost controls, and human result review, and must not be treated as automatic CI gates.

Pre-tag review status:

  • docai-http/README.md describes 0.12.0 as a pre-1.0 complete-generator-ready candidate, not stable and not compatibility-stable.
  • The top-level README.md comparison summary is scoped to the evaluated fixture, target models, task contracts, and evidence file.
  • Release-label references across README.md, RELEASE.md, fixtures/README.md, COMPLETE-GENERATOR-READINESS.md, and CHANGELOG.md agree on the 0.12.0 Complete-generator-ready candidate label.
  • The active complete-candidate fixture paths and checker version expectations use fixtures/complete-candidates/v0.12.0/.
  • The evidenced complete-candidate corpus has source fixtures under fixtures/complete-candidates/v0.12.0/source/.
  • README.ja.md is explicitly excluded from 0.12.0 readiness work and deferred until after 1.0.0.

v0.11.0

v0.11.0 Pre-release
Pre-release

Choose a tag to compare

@ensoriaadmin ensoriaadmin released this 09 Jul 04:40
Draft - Compatibility Core

v0.0.1

v0.0.1 Pre-release
Pre-release

Choose a tag to compare

@ensoriaadmin ensoriaadmin released this 12 Jun 04:51
15e11b7
experimental