Administration

Skills, context, profiles, local models and deployment administration. These helpers require their matching advertised backend extension.

Choose your client · Reliability · All public exports

DesktopAdministration

DesktopAdministration(client: AsyncHermesDesktop)

client instance-attribute

client = client

providers instance-attribute

providers = DesktopProviders(client)

models instance-attribute

models = DesktopModelAdministration(client)

local_models instance-attribute

local_models = DesktopLocalModels(client)

memory instance-attribute

memory = DesktopMemory(client)

profiles instance-attribute

profiles = DesktopProfileTransfer(client)

channels instance-attribute

channels = DesktopChannels(client)

AsyncDeployment

AsyncDeployment(client: AsyncHermesDesktop)

client instance-attribute

client = client

identity async

identity() -> DeploymentIdentity

AsyncProfileImports

AsyncProfileImports(
    transport: ExtensionTransport, *, profile: str
)

review async

review(export_id: str) -> ProfileImportReview

inventory async

inventory() -> ProfileImportInventory

operation async

operation(request_id: str) -> ProfileImportReceipt

start async

start(
    *,
    request_id: str,
    export_id: str,
    revision: str,
    name: str,
) -> ProfileImportReceipt

AsyncProfileArchives

AsyncProfileArchives(
    transport: ExtensionTransport, *, profile: str
)

begin async

begin(
    *,
    request_id: str,
    filename: str,
    size_bytes: int,
    revision: str,
) -> ProfileArchiveUpload

status async

status(request_id: str) -> ProfileArchiveUpload

append async

append(
    request_id: str, *, offset: int, data_base64: str
) -> ProfileArchiveUpload

complete async

complete(request_id: str) -> ProfileImportReview

ProfileArchiveUpload

Bases: TypedDict

id instance-attribute

id: str

profileId instance-attribute

profileId: str

filename instance-attribute

filename: str

sizeBytes instance-attribute

sizeBytes: int

receivedBytes instance-attribute

receivedBytes: int

revision instance-attribute

revision: str

status instance-attribute

status: Literal['uploading', 'completed']

ProfileImportInventory

Bases: TypedDict

profileId instance-attribute

profileId: str

imports instance-attribute

imports: list[ProfileImportReceipt]

externalUploadSupported instance-attribute

externalUploadSupported: bool

ProfileImportReceipt

Bases: TypedDict

id instance-attribute

id: str

profileId instance-attribute

profileId: str

exportId instance-attribute

exportId: str

targetProfileId instance-attribute

targetProfileId: str

kind instance-attribute

kind: Literal['import']

status instance-attribute

status: Literal[
    "pending",
    "running",
    "completed",
    "failed",
    "uncertain",
    "interrupted",
    "rejected",
]

parked instance-attribute

parked: bool

exitCode instance-attribute

exitCode: int

ProfileImportReview

Bases: TypedDict

profileId instance-attribute

profileId: str

exportId instance-attribute

exportId: str

revision instance-attribute

revision: str

filename instance-attribute

filename: str

sizeBytes instance-attribute

sizeBytes: int

fileCount instance-attribute

fileCount: int

externalUploadSupported instance-attribute

externalUploadSupported: bool

AsyncSkillAdministration

AsyncSkillAdministration(
    transport: ExtensionTransport, *, profile: str
)

change async

change(
    skill_id: str,
    *,
    revision: str,
    kind: Literal["update", "uninstall"],
    request_id: str,
) -> InstalledSkillReceipt

AsyncSkillDocuments

AsyncSkillDocuments(
    transport: ExtensionTransport, *, profile: str
)

list async

list(skill_id: str, *, path: str = '') -> list[SkillFile]

read async

read(skill_id: str, *, path: str) -> SkillDocument

write async

write(
    skill_id: str, *, path: str, revision: str, content: str
) -> SkillDocument

remove async

remove(
    skill_id: str,
    *,
    path: str,
    revision: str,
    request_id: str,
) -> SkillFileRemoval

SkillFile

Bases: TypedDict

path instance-attribute

path: str

name instance-attribute

name: str

isDirectory instance-attribute

isDirectory: bool

sizeBytes instance-attribute

sizeBytes: int

modifiedAtMs instance-attribute

modifiedAtMs: float

AsyncSkillReviews

AsyncSkillReviews(
    transport: ExtensionTransport, *, profile: str
)

review async

review(resource: str) -> SkillReview

install async

install(
    resource: str,
    *,
    review_id: str,
    request_id: str,
    accepted: bool,
) -> SkillActionReceipt

operation async

operation(request_id: str) -> SkillActionReceipt

SkillFinding

Bases: TypedDict

severity instance-attribute

severity: str

description instance-attribute

description: str

SkillReview

Bases: TypedDict

id instance-attribute

id: str

profileId instance-attribute

profileId: str

resourceId instance-attribute

resourceId: str

policy instance-attribute

policy: Literal['allow', 'ask', 'block']

summary instance-attribute

summary: str

reason instance-attribute

reason: str

findings instance-attribute

findings: list[SkillFinding]

expiresAt instance-attribute

expiresAt: float

bundleHash instance-attribute

bundleHash: str

AsyncAuxiliaryAdministration

AsyncAuxiliaryAdministration(
    transport: ExtensionTransport, *, profile: str
)

tasks async

tasks() -> list[AuxiliaryTask]

change async

change(
    task: str,
    *,
    revision: str,
    request_id: str,
    provider: str,
    model: str,
    effort: str | None,
    confirmed: bool = False,
) -> AuxiliaryReceipt

operation async

operation(request_id: str) -> AuxiliaryReceipt

AsyncMemoryBackends

AsyncMemoryBackends(
    transport: ExtensionTransport, *, profile: str
)

inventory async

inventory() -> dict[str, Any]

schema async

schema(
    resource: str,
    *,
    surface: MemoryBackendSurface = "native",
) -> dict[str, Any]

change async

change(
    resource: str,
    kind: MemoryBackendAction,
    *,
    revision: str,
    request_id: str,
    values: dict[str, Any] | None = None,
    surface: MemoryBackendSurface = "native",
    confirmed: bool = False,
) -> MemoryBackendReceipt

operation async

operation(request_id: str) -> MemoryBackendReceipt

AsyncLocalModelAdministration

AsyncLocalModelAdministration(
    transport: ExtensionTransport, *, profile: str
)

inventory async

inventory() -> LocalModelInventory

change async

change(
    kind: LocalModelAction,
    resource_id: str,
    *,
    request_id: str,
    revision: str | None = None,
    profile_revision: str | None = None,
) -> LocalModelReceipt

operation async

operation(request_id: str) -> LocalModelReceipt

AsyncSessionContexts

AsyncSessionContexts(desktop: AsyncHermesDesktop)

desktop instance-attribute

desktop = desktop

list async

list(*, limit: int = 30) -> list[ContextSession]