DEV-1833: Align app dictation JS API documentation - #296
Merged
inna-bieshulia merged 1 commit intoSep 4, 2026
Conversation
inna-bieshulia
merged commit Sep 4, 2026
1d47bfa
into
projects/DEV-1833-app-dictation-js-api
3 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fliplet.AI.transcribeAudio(audio, options)documentation with the completed runtime contract forBlobandFileinputs.{ text }response, 25 MiB inclusive limit, accepted MIME types, optional-undefinedsemantics, cancellation, timeout, provider-handoff billing, and error handling.MediaRecorderexample with microphone cleanup and cancellation.aiProviderfrom the documented AI API contract and update model-only Gemini examples.Jira
DEV-1833
Related API PR
Fliplet/fliplet-api#8586
Acceptance mapping
docs/API/core/ai.mdmatches the implemented API for input types, model selection, MIME support, exact limit, cancellation/deadline behavior, charging after provider handoff, response shape, and cleanup.undefinedoptional values use defaults; invalid explicit values reject.{ text }; provider usage remains internal for metering.llms-full.txtand V3 library catalog reflect the canonical page.QA sample before documentation deployment
Until this PR is merged and published, QA must copy the runnable sample from
docs/API/core/ai.mdat this PR's pinned head SHA,683d3d59e2e0b6ec196338506800b1bcf627ded5. The live developer documentation is not a valid source for the updated sample until deployment is verified.Add that exact sample to the V3 QA app and test real microphone record/stop,
result.textrendering, microphone release on success/failure/recording cancellation/upload cancellation, and the deployed API behavior from #8586.Verification
From an archive of the final source tree:
npm run test:unit— 163 passed, 0 failed.node bin/build-agent-indexes.mjs --strict— passed.bundle exec jekyll build— passed; only unrelated existing Liquid warnings remain.node bin/copy-md-siblings.mjsand source/rendered comparisons — passed.aiProviderreferences.git diff --checkpasses and the worktree is clean.Merge and publication gate
This PR targets the DEV-1833 project branch as requested. Do not publish the documentation until API PR #8586 has been deployed to production and the served core asset has been verified. Until then, QA should continue using this PR as the sample-code source.