QVAC-17317 doc: write API ref SDK v0.9.0#1632
Merged
Merged
Conversation
Preview deployments for qvac-docs-staging ⚡️
Commit: Deployment ID: Static site name: |
Contributor
Tier-based Approval Status |
NamelsKing
approved these changes
Apr 16, 2026
Proletter
pushed a commit
that referenced
this pull request
May 24, 2026
* doc: api v0.9 manually written * doc: SDK - api reference - v0.9.0
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.
Objective
Create a new API reference for SDK v0.9.0.
Scope
Delta between API v0.8.0 and v0.9.0:
New functions:
finetune()— Fine-tuning support with three overloads:run(returnsFinetuneHandlewith progress streaming),stop, andgetStatediffusion()— Image generation via Stable Diffusion models, with progress streaming andDiffusionClientParams(includesSamplingMethodandSchedulerenums)suspend()— Suspend the SDK server lifecycleresume()— Resume a suspended SDK serverheartbeat()— Health check with optionaldelegateparameter, returnsHeartbeatResponsedefineDuplexHandler()— Define bidirectional plugin handlers with request/response schemasRemoved functions:
ping()— Removed from the public APIModified functions:
embed()— Return type changed fromPromise<number[]>toPromise<{ embedding: number[]; stats?: EmbedStats }>(and array variant accordingly). NewEmbedStatstype withtotalTime,tokensPerSecond,totalTokens,backendDevicecompletion()— AddedbackendDevicefield ("cpu" | "gpu" | undefined) toCompletionStatsNew errors:
LIFECYCLE_SUSPEND_FAILED(code 53600)LIFECYCLE_RESUME_FAILED(code 53601)Updated error scopes:
INVALID_RESPONSE_TYPE— Now also thrown byfinetune(),heartbeat(),resume(),suspend(); no longer thrown byping()STREAM_ENDED_WITHOUT_RESPONSE— Now also thrown byfinetune()