pub struct StartSessionOptions {
pub session_id: Option<String>,
pub workspace_root: Option<String>,
pub workspace_roots: Option<Vec<String>>,
pub model_id: Option<String>,
pub provider_id: Option<String>,
pub approval_mode: Option<ApprovalMode>,
pub config: Option<SessionConfig>,
pub permission_profile: Option<String>,
pub require_permission_profile: bool,
pub recovery_mode: Option<RecoveryMode>,
}Expand description
Options for MuseClient::start_session. A field left None takes the
server’s default, except the workspace: with neither workspace_root nor
workspace_roots set, the session has no workspace.
Fields§
§session_id: Option<String>The new session’s id; the server mints one when None. This never
opens an existing session: an id the host already holds or has reserved
is refused.
workspace_root: Option<String>The session’s working folder, as an absolute path.
workspace_roots: Option<Vec<String>>The session’s workspace roots, as absolute paths; the first one is the
working folder. When workspace_root is also set, both must name the
same folder.
model_id: Option<String>The starting model.
provider_id: Option<String>The starting provider.
approval_mode: Option<ApprovalMode>The starting approval mode, one the host’s configuration defines.
config: Option<SessionConfig>Per-session configuration.
permission_profile: Option<String>The permission profile to start under, by id; the host’s default
applies when None. The host may still commit another profile, so set
require_permission_profile to refuse a start that did not apply it.
require_permission_profile: boolWhen true, MuseClient::start_session proves the host committed
permission_profile before returning the session: from the start
result, else from one session/read. Any other committed profile, or
none reported, fails with
MuseError::PermissionProfileNotApplied.
Setting it without permission_profile is refused before anything is
sent. This flag is never sent to the host.
recovery_mode: Option<RecoveryMode>Whether the session is built with recovery on or off; the host’s
default applies when None.