Files
LocalAI/pkg/addons/contract
Ettore Di Giacinto 4ba1b7b2bd feat(addons): move connector file bytes by handle
A connector add-on that declares files.transfer no longer carries file
bytes in the connector envelope. The host puts a random handle in the
request of the op media (write) or send_file (read), and the add-on
streams the file with two new host operations, connector.file.put and
connector.file.get, in chunks of at most 256 KiB.

The process that runs the add-on registers the handle when the call
arrives and ends it when the call returns. A handle is bound to the
add-on, so another add-on gets the same answer as for an unknown
handle. An unfinished inbound file is dropped with its partial bytes,
and a handle with no call for two minutes expires. Inbound bytes go
to the blob store of the workspace, outbound bytes come from it, so a
cluster needs the shared object store and no shared disk. The file is
never held in memory. The host overwrites the size and hash of an
inbound file with its own record.

The change is additive: the field files.transfer needs manifest API 2,
a kind without it keeps the inline path and its 1 MiB cap, and the host
never sends it a handle. A call that carries a handle may run up to 15
minutes. The ceiling of a file also stays under the largest file of a
workspace.

Assisted-by: Claude:claude-sonnet-5-5 go test
2026-11-03 15:54:45 +00:00
..

Typed addon contract

ParseManifest is the strict v1 parser used by staging and package verification. Unknown fields, duplicate keys, invalid declarations, and unsupported compatibility ranges fail validation. The typed declarations remain additive strict v1 fields, not a new protocol version.

  • capabilities.ui.homeCommands names installed pages, never tools or install actions.
  • capabilities.executionProvider names execution tools and one declared UI-only read status tool.
  • capabilities.hostOperations.required and .optional request exact operation names, never grants.
  • capabilities.network declares the egress policy of the commands an add-on runs (kind egress-check, a title, preset titles). It attaches the network-policy host control and needs manifest api 2.

ValidHostOp validates syntax only. The host's registered vocabulary determines support. Administrator policy and request admission remain authoritative, including for optional operations. Status is advisory; an isolation report does not prove network enforcement or authorize execution.

See the addon guide for JSON examples, bounds, collision rules, lifecycle behavior, policy migration, and old-host staging refusal. Old hosts must retain the old package when an extension-bearing upgrade is refused. Release maintainers select the minimum supporting release and the duration of any legacy package support.

Typed owner observations currently support local-owner JSON selections only. Named-user and SQL selections remain unavailable and fail closed; they are not completed scope.

Optional model actions

capabilities.ui.modelActions maps a model capability to a declared page:

{"modelActions":[{"capability":"FLAG_IMAGE","page":"studio","path":"images"}]}

capability and page are required. path is an optional nonempty relative suffix. There is one mapping per capability per addon, at most 27 mappings. The SDK route bounds apply to page/path: 256 ASCII characters, eight segments, and 1–64 characters per segment from [A-Za-z0-9._~-], excluding . and ... Absolute paths, URLs, queries, fragments, percent encoding and backslashes fail. Unknown, duplicate and noncanonical keys fail strict parsing.

The exact vocabulary is ModelActionCapabilities(): all concrete flags in config.GetAllModelConfigUsecases() except native FLAG_CHAT and FLAG_COMPLETION and aggregate FLAG_LLM. FLAG_ANY is not a concrete flag. A core/config parity test guards this list without importing core into contract. Declarations carry no priorities, labels, permissions or model query templates. Apps exposes a cloned typed list only through its existing installed UI view; unavailable UI omission is unchanged. Protocol registration uses the same contract.Capabilities, and verifies exact equality including these actions.

Studio owns image/video/TTS/sound destinations; Talk owns transcription at its existing landing page; Face and Voice own face/speaker recognition respectively. Talk does not currently consume a selected-model query value. Its pipeline and landing semantics remain unchanged. Frontend dispatch and route cleanup are a separate milestone; this contract alone does not change model Open behavior.

The allowed capability strings are:

FLAG_EDIT FLAG_EMBEDDINGS FLAG_RERANK FLAG_IMAGE FLAG_TRANSCRIPT FLAG_TTS
FLAG_SOUND_GENERATION FLAG_TOKENIZE FLAG_VAD FLAG_VIDEO FLAG_DETECTION
FLAG_VISION FLAG_FACE_RECOGNITION FLAG_SPEAKER_RECOGNITION FLAG_AUDIO_TRANSFORM
FLAG_DIARIZATION FLAG_SOUND_CLASSIFICATION FLAG_REALTIME_AUDIO FLAG_SCORE
FLAG_DEPTH FLAG_TOKEN_CLASSIFY FLAG_3D FLAG_3D_ANIMATION FLAG_DECISIONS
FLAG_UPSCALE FLAG_MOTION FLAG_FORECAST

Context files

capabilities.contextFiles names up to three small index files (one for each scope: user, agent, channel) that the host loads into the prompt of a chat. It needs manifest api 2.

{"contextFiles":[{"scope":"user","path":"Memory/index.md"},{"scope":"agent","path":"Memory/agents/{agent}/index.md","cap":1024}]}

Every path lies under Memory/, ends in .md and holds no parent segment. An agent path holds {agent} once and a channel path holds {channel} once; the host fills them from the chat, never from the model. cap lowers the 2 KiB index cap; it cannot raise it. The add-on declares and the host reads: the add-on gains no access to the files.