Documentation

lmstudio icon
App
Python SDK
TS/JS SDK
CLI Reference

Integrations

Custom Status Report

Feature In Beta

Plugin support is currently in private beta. Join the beta here.

Depending on the task, the prompt preprocessor may take some time to complete, for example, it may need to fetch some data from the internet or perform some heavy computation. In such cases, you can report the status of the preprocessing using ctl.setStatus.

const status = ctl.createStatus({
  status: "loading",
  text: "Preprocessing.",
});

You can update the status at any time by calling status.setState.

status.setState({
  status: "done",
  text: "Preprocessing done.",
})

You can even add sub status to the status:

const subStatus = status.addSubStatus({
  status: "loading",
  text: "I am a sub status."
});

This page's source is available on GitHub