Documentation Index
Fetch the complete documentation index at: https://arkor-92aeef0e-eng-736.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
infer
Inside onCheckpoint, the SDK hands you a function called infer. Calling it runs an inference request against the just-saved checkpoint and returns a raw Response. This is the path that lets you evaluate a half-trained model before the full run finishes.
stream: false if you want a single JSON body instead:
infer is only available on CheckpointContext. There is no top-level export of it; the callback argument scopes the call to the right job and step automatically.
Common scenarios
- Sanity check. Compare step-50 and step-100 outputs against a fixed prompt.
- Constrain output to a JSON schema. Pass
responseFormat: { type: "json_schema", json_schema: { name, schema, strict: true } }; the response body’schoices[0].message.contentis a JSON string you canJSON.parseinto a typed object. See the Structured outputs and function calling recipe. - Call a function. Pass
tools+toolChoiceso the model can request a tool call from inside the checkpoint check. Same recipe as above. - Custom early-stopping. Combine with
abortSignal+cancel()to stop a run that has gone off the rails. See the Early stopping recipe. - Live preview. Forward the checkpoint output to Slack or your own review queue.
Reference
For the fullInferArgs shape, the streaming-vs-JSON tradeoffs, the SSE frame format, the constraints on retargeting, and pointers for decoding the SSE delta stream, see the infer reference.