mirror of
https://github.com/mudler/LocalAI.git
synced 2026-11-04 03:24:43 -05:00
* chore(backends): remove the liquid-audio Python backend The backend targets liquid-audio, which loads LFM2 checkpoints only. Remove its directory, the gallery file and the LFM2.5-Audio model entries, the library and generated backend gallery entries, the backend matrix and CI job, the Makefile targets and the golden test fixtures that listed it. Assisted-by: Claude:claude-haiku-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * refactor(config): drop liquid-audio from capabilities, importers and UI With the liquid-audio backend gone, remove its capability entry, its importer, its artifact-gate entry and the realtime_audio heuristic that only matched that backend. realtime_audio is now set only through known_usecases. Update the Talk and fine-tuning pages, the docs and the swagger text that named the backend. Assisted-by: Claude:claude-haiku-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * chore(llama-cpp): bump llama.cpp to e486a4b5 Move the llama.cpp pin to e486a4b559617dc88bf79978996f6c670b6bbc9d, the master head of 2026-10-28. It contains the LFM3-Audio support (ggml-org/llama.cpp#31257) and the realtime server split (ggml-org/llama.cpp#31269). The score task patch is regenerated against the new pin. It applies with git apply and with patch -p1, with no offset and no fuzz. Its hunks in server-task.h and server-context.cpp were rebased by hand next to SERVER_TASK_TYPE_REALTIME and the control dispatch. The C++ backend was built on CPU for this change: the llama, mtmd and server-context libraries and the grpc-server binary link. Assisted-by: Claude:claude-haiku-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(llama-cpp): compile server-realtime.cpp into grpc-server server-context.cpp includes server-realtime.h, and its realtime slot type is defined in server-realtime.cpp. Upstream compiles that file into the server library. The gRPC server is one translation unit, so it must include the file too, or the link fails. The include is guarded by __has_include. Forks that predate the realtime split do not ship the file, so they keep building as before. Assisted-by: Claude:claude-haiku-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * chore(llama-cpp): probe realtime and TTS voice support in prepare.sh prepare.sh writes llama_compat.h from probes on the checkout. Add two: LOCALAI_HAS_REALTIME (SERVER_TASK_TYPE_REALTIME in server-task.h) and LOCALAI_HAS_TTS_VOICE (set_voice in mtmd-helper.h). The probes let the gRPC server choose the realtime and voice code paths per checkout, so forks without them keep compiling. Assisted-by: Claude:claude-haiku-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(llama-cpp): advertise speech recognition and speech-to-speech llama-cpp now registers the AudioTranscription and AudioToAudioStream RPCs, with the transcript and realtime_audio usecases. The default usecase stays chat, so a plain GGUF is still a chat model. The backend implements the RPCs in a follow-up change; until then the calls return UNIMPLEMENTED. Assisted-by: Claude:claude-haiku-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(config): add pipeline.any_to_any for speech-to-speech models A realtime_audio model that serves the whole speech loop itself sets pipeline.any_to_any. The flag is off by default, so chained pipelines and existing realtime_audio configs are unchanged. The realtime_audio heuristic stays explicit: a llama-cpp model is never a Talk-page model unless known_usecases says so. Assisted-by: Claude:claude-haiku-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(config): read the audio encoder and speech-to-speech projector flags Add HasAudioEncoderProjector for clip.has_audio_encoder and HasSpeechToSpeechProjector, which requires the LFM3 audio encoder family together with the gen-audio decoder. Qwen3-TTS sets both encoder flags too, so the flags alone cannot tell it apart from LFM3. Assisted-by: Claude:claude-haiku-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(importer): import LFM3-Audio projectors as speech-to-speech An mmproj that carries the LFM3 audio encoder and the gen-audio decoder now imports with known_usecases realtime_audio, chat, transcript and tts, pipeline.any_to_any: true, the parallel:2 option and the tokenizer template. Other gen-audio projectors keep the TTS-only result, Qwen3-TTS included. The probe runs against a local HTTP server in the tests. Assisted-by: Claude:claude-haiku-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(llama-cpp): named-voice TTS and the LFM3 ASR prompt Models without a speaker reference (LFM3-Audio) take a named voice through their "tts" chat template instead of a reference file. The request is validated with needs_reference=false, the prompt is rendered with common_chat_get_tts_prompt(), and the voice is set on the gen-audio input. Qwen3-TTS Base keeps the reference-file rule. The branch is guarded by LOCALAI_HAS_TTS_VOICE, so forks without named voices keep the old behaviour. Transcription takes its prompt from common_chat_get_asr_prompt(). LFM3 gets a system turn that names the language and an empty user turn. Qwen3-ASR's preset is unchanged: fixed user text, no system turn, and a caller prompt is still appended after a newline. The preset call is guarded by a new LOCALAI_HAS_ASR_PRESET probe. The pure parts sit in tts_request_options.h and transcription_prompt.h, with standalone tests run by backend/cpp/run-unit-tests.sh. Add the test-extra-backend-llama-cpp-lfm3 target. It runs the tts, ttsstream and transcription specs against LFM3-Audio GGUF weights. It is a manual run and is not wired into CI. Assisted-by: Claude:claude-haiku-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(e2e): mock AudioToAudioStream and pending realtime S2S specs The mock backend serves AudioToAudioStream deterministically: session created, commit with RMS, a tool call on the first turn with tools, then transcript pieces and paced 24 kHz tone frames, with response.cancel ending a reply as cancelled. The realtime S2S specs cover the mock and real-weights variants. They skip until the /v1/realtime S2S path lands, so the mock suite stays green in CI. Assisted-by: Claude:claude-haiku-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(llama-cpp): speech-to-speech AudioToAudioStream on the realtime slot Implement AudioToAudioStream on upstream's realtime slot, so a model that answers after the audio (LFM3-Audio) can hold a conversation over the existing duplex RPC. The proto schema does not change: tools travel in the config, tool calls leave as function_call_arguments.done and tool results arrive as a function_call_output item. realtime_session.h keeps what needs no model: the turn text derived from the chat template (with a tool turn), the conversation state, a filter that keeps <tool_call> blocks out of the transcript and drops audio produced inside them, and the translation of slot results into events. grpc-server.cpp wires it to the slot with control tasks and parses calls with the parser the chat template selects. The unit test uses a fake renderer. A ctest-only check renders the real LFM3 template and compares the slot text with the full render. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(gallery): add the LFM3-Audio-2B entries Two llama-cpp entries for LiquidAI/LFM3-Audio-2B-GGUF, the Q4_K_M default (lfm3-audio-2b) and the Q8_0 build (lfm3-audio-2b-q8), both with the Q8_0 audio projector. Each declares pipeline.any_to_any and the realtime_audio, chat, transcript and tts usecases the importer writes for an LFM3 projector, with parallel:2 and the tokenizer template. The Q4 entry lists the Q8 one as a variant. File sizes and sha256 come from the Hugging Face API for the pinned repo revision. Speaker reference files and the VAD model are not part of the entries: VAD stays optional. Assisted-by: Claude:claude-haiku-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs: describe LFM3-Audio speech-to-speech and its gallery entries Adds a speech-to-speech section to the Realtime API page (any_to_any configuration, VAD versus manual commit, tools, transcripts, barge-in, limits), a pipeline.any_to_any row, a llama.cpp speech-to-speech row in the compatibility table, and LFM3-Audio mentions on the TTS and ASR pages. The feature is marked experimental: the behaviour follows the backend session contract and has not been run with real weights. Assisted-by: Claude:claude-haiku-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(realtime): run any-to-any models on AudioToAudioStream A realtime_audio model with pipeline.any_to_any now opens one duplex stream to the backend and keeps it for the session, replacing the "any-to-any models not implemented" branch. The chained pipeline is unchanged. The endpoint forwards input audio (with a pre-roll from speech start when a VAD model is set, otherwise every chunk and a client commit), sends response.create, and turns the backend's events into the usual realtime events: audio and transcript deltas, tool calls through the existing function_call items, and a single response.done. A function call output is forwarded before the next response. Barge-in sends response.cancel ahead of the new speech and stops forwarding audio at once. The user's speech is transcribed on the side and reported on the user item; a failure there does not touch the response. Server VAD is on only when pipeline.vad is set. Classifier mode, compaction, streaming.llm, voice gating, sound detection and semantic_vad are rejected for these models. The mock backend now matches the llama.cpp contract (session.updated, the cancel error when idle) and its VAD reports the loud stretches of the audio, so the S2S e2e specs run a VAD turn. The specs are enabled. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(e2e): add the real-weights realtime S2S variant and the gRPC s2s spec The realtime S2S specs now check reply audio on real models: duration, loudness, clipping, and keywords found in the model transcript or in a separate ASR of the output audio. run-realtime-lfm3.sh stages the llama-cpp and sherpa-onnx backends, the LFM3-Audio files and the sherpa VAD, ASR and TTS models, then runs the real variant. It is manual and never part of CI: `make test-realtime` still filters out real-models. The backend suite gains an s2s capability (spoken turn, tool call, tool result, spoken answer over AudioToAudioStream) and optional TTS duration and RMS bounds plus a transcript keyword check, all enabled for test-extra-backend-llama-cpp-lfm3. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(e2e): expect the idle-cancel error from the mock S2S The mock now answers a response.cancel with no reply running with response_cancel_not_active, as the llama.cpp backend does. The cancel spec still treated that cancel as a no-op and read the error as extra data after the stream ended. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(talk): show any-to-any models as one speech-to-speech model /api/pipeline-models lists a pipeline.any_to_any model with any_to_any set and its optional VAD. A realtime_audio model that is not any-to-any is listed only when it has the four pipeline slots, since the session takes the chained path for it. The Talk page shows a speech-to-speech model as one model: no four-slot view, the VAD slot only when a VAD model is set, and the female and male voices offered. Without a VAD model the server does not detect turns, so the page offers Done speaking, which sends input_audio_buffer.commit and then response.create. Text-only replies stream through response.output_text.delta and .done. self_contained stays in the response for clients built before any_to_any. Assisted-by: Claude:claude-haiku-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(realtime): refuse a llama-cpp realtime model without pipeline.any_to_any llama.cpp has no VAD, transcription or TTS RPCs, so filling the empty pipeline slots with the model name failed later with UNIMPLEMENTED. Fail at session start and name the missing setting instead. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(realtime): hold manual-commit S2S audio until the commit In manual-commit mode the endpoint streamed every appended chunk to the backend, so input_audio_buffer.clear only emptied the Go buffer while the model kept the audio, and idle audio filled its context between turns. Keep the audio in the input buffer and send it, behind pending text and tool-result items, when the client commits or asks for a response. Frames and controls now go through one ordered write queue, so no gRPC send happens under the audio buffer lock. A tool result created while a VAD turn is open is refused with a clear error. When the stream ends outside a response the session reports it and closes, and a bare EOF from Send reports the status that Recv holds. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(e2e): drop the S2S readiness gate and stale comments The gate was always true. Some comments referred to work items that readers of the repository cannot see. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs(realtime): add the liquid-audio migration note and the clear semantics Say that the Python liquid-audio backend is gone, which gallery entries replace it and that LFM2.5-Audio has no replacement. Describe what input_audio_buffer.clear drops for speech-to-speech sessions now that manual-commit audio is held back until the commit. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(talk): do not promise turn detection when no VAD model is set The idle note said the server notices when you stop talking. A speech-to-speech model without a VAD model needs Done speaking, so the note now says that. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(e2e): make the mock S2S backend keep the llama-cpp session limits The mock accepted what the real backend refuses and hid two endpoint bugs. It now treats output_modalities from the config as a fixed session mode and picks the default per response from the tools set at that time. A fixed text plus audio mode with tools reads the tool call out loud. After the first commit or message, session.update of instructions, voice or tools is an error that does not belong to a response, committing an empty buffer is an error, and response.create while a reply runs is refused. Errors of a refused response.create carry response_scoped in their meta. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(realtime): leave the S2S output mode to the backend unless the client sets one The stream config sent text plus audio when the session had no tools yet. The llama-cpp backend keeps a mode from the config as a fixed session mode, and tools added later by session.update never cleared it. The model then read tool calls out loud. Send output_modalities only when the client chose them. The backend picks the default of each response from the tools it has when the response starts. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(llama-cpp): mark the realtime errors that answer a response.create The error event now carries response_scoped: true when it ends the request for a response (a refused response.create, a failed commit made by it, or a stream failure). Other errors, such as a refused session.update or a commit of an empty buffer, are not about a response and one that runs keeps generating. The client needs the difference to know whether a response.done is still coming. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(realtime): end an S2S response only on the errors that belong to it Every backend error ended the response in flight, although the backend also reports errors about other things (a refused session.update, a commit of an empty buffer) and goes on generating. The rest of the reply was lost and the next response.create met either a refusal or the leftover events of the old reply. End the response only on an error marked response_scoped, forward the others to the client and keep waiting for response.done. Drop the events buffered by an earlier response when a new one starts, and skip the commit of a turn that forwarded no audio. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(realtime): run the S2S input transcription detached from the commit slot The commit waited for the side transcription of the user audio while it held the commit slot, and response.create waits for that slot. The ASR latency was added before every reply, and on a backend with few slots a busy ASR task could stall the reply. The model already has the audio, so run the transcription detached under the session context and release the slot at once. The transcript is still reported on the user item. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(realtime): do not pin the place of the input transcript in the S2S order The transcript of the user audio is reported on the side and may land before or after the first response events. Check the order of the response events without it. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(realtime): stop an S2S reader leak and a cancel that waits on the write queue The reader waited on a channel it closes itself when the events buffer was full, so it outlived the session after a turn ended on an error or timed out. It now also stops when the session closes. Stopping a response sent the cancel through the write queue and waited for it before the grace timer started. With backpressure on the stream the wait never ended and nothing read the events meanwhile. The timer now starts first and the cancel is only queued. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(realtime): let a chained pipeline run without a VAD model A pipeline that names no pipeline.vad failed to build, because the VAD slot was always loaded, and a new session still started with server_vad. The slot is now optional for chained pipelines as it already is for any-to-any models: the session starts with turn detection off and the client commits each turn. Turning server_vad on for such a session is refused, and a switch to a pipeline without a VAD drops turn detection. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(gallery): add LFM3-Audio VAD and chained-pipeline entries Add lfm3-audio-2b-vad and -q8-vad (any-to-any with silero-vad-ggml as the turn detector), and lfm3-audio-2b-pipeline, -pipeline-vad and the -q8 forms (the model chained through its own transcription, chat and speech slots, with and without the VAD). The gallery has no dependencies between models, so the VAD entries state that silero-vad-ggml must be installed first. Drop the variants list from lfm3-audio-2b: it let the installer pick the larger Q8 build on any host with enough memory, so a plain install of the Q4 entry did not get Q4. All entries are now independent. Tests cover the entry shapes, the single-build install and their acceptance by the realtime endpoint. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(e2e): run the realtime specs for any-to-any and chained shapes The realtime specs covered one any-to-any model with a VAD. They now run for any-to-any and for a chained pipeline, each with and without a VAD, on the mock backend in CI. VAD-less shapes also check that turn detection starts off and that server_vad is refused. The manual real-weights script writes one config per shape that mirrors the gallery entries and runs the four shapes in turn (LFM3_MATRIX picks a subset). Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs(realtime): document the LFM3-Audio VAD and chained-pipeline entries List the eight LFM3-Audio gallery entries, explain that silero-vad-ggml must be installed before the -vad entries, describe the chained pipeline on one model and the behaviour of a pipeline without a VAD, and describe the shape matrix of the e2e specs. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(realtime): wait for the detached input transcription in the S2S specs The input transcription runs in its own goroutine, so the transcription completed and failed events can arrive after the response ends. Poll for them instead of reading the event list right after the response. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(realtime): release the S2S stream before running server-side tool calls A response held the stream slot until it returned, and it ran the tool calls from inside that scope. A server-side tool starts a follow-up response on the same stream, which then waited for the slot its parent still held, so the client never got response.done. Run the tool calls once the slot is free; the event order is unchanged. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(realtime): end an S2S session whose stream dies, and stop queuing after close A stream that died during a response left the session open: later requests failed one by one and VAD frames kept being forwarded. The response now ends the session through the transport, and enqueue drops requests once the session is closed so the write queue cannot grow. The writer is now the only caller of Send and of CloseSend. close() used to call CloseSend while the writer could be inside Send, which gRPC does not allow. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(realtime): close the open S2S turn when the VAD stops Switching turn detection to manual in the middle of a VAD turn left the turn forwarding, and the next client commit sent the whole buffer a second time. Stopping the VAD now commits the forwarded audio on the backend and drops it from the input buffer. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(realtime): keep a tool result pending while an S2S user turn is open The check that refuses a tool result during a user turn ran when the item arrived, but the item was forwarded later, and the result was marked as sent before the backend took it. If the user spoke in between, the backend refused it and it was never retried. The result is now claimed and queued under the audio lock only when no turn is open, and otherwise stays pending for the next commit or response. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(talk): empty the input buffer for models without a VAD Without voice detection the microphone fills the server's input buffer for the whole session, so Done speaking committed idle silence and the echo of the previous reply. Clear the buffer when the session starts and when a reply ends. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(importer): keep an existing parallel option on LFM3-Audio imports The speech-to-speech import added parallel:2 even when the options already carried another parallel value. Use the same check as the hardware defaults, which also covers n_parallel. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(talk): list chained pipelines that have no VAD /api/pipeline-models required a VAD for a chained pipeline, so the VAD-less LFM3-Audio pipeline entries never showed up on the Talk page. Any pipeline with transcription, LLM and speech slots now qualifies. The Talk page treats every model without a VAD as manual-turn, and the session sheet says so for chained pipelines too. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * chore(llama-cpp): bump llama.cpp to 0ac1a7fd Move the llama.cpp pin to 0ac1a7fd35c127a18c0cbc6c57d12e256a6a385b, the master head of 2026-10-29. It contains tool calls in the realtime server (ggml-org/llama.cpp#31287). The score task patch is regenerated so that it applies with no offset and no fuzz. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(functions): keep a null tool argument null A tagged parameter whose text was "null" came out as an empty string: unmarshalling JSON null into a string succeeds and leaves it empty, so the value was taken for a string. Check the first byte of the JSON value instead. A parameter with the text "null" now becomes JSON null, as in llama.cpp. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(functions): add an lfm3 XML format preset The LFM3 chat template writes a call as <tool_call>, <function=NAME>, one <parameter=KEY> block per argument, then the closing tags. The qwen3-coder format has the same shape and auto-detection already found it, but xml_format_preset: lfm3 was not a known name. Add the preset, with tests for one call, a call without arguments, two calls, string and non-string values (numbers, booleans, null, arrays, objects), a call between text, and unfinished input. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(realtime): parse tool calls with the chat template, as upstream Since ggml-org/llama.cpp#31287 the realtime server handles tools with the parser and grammar of the chat template. Do the same in the speech-to-speech stream instead of a hard-coded tag filter and a parse of the whole text at the end. - Each response gets a common_chat_session with the tools of the session and parallel calls. Its grammar and preserved tokens go into the sampling of the response, so the slot keeps the call tokens in the text and constrains the call. - The text of the response is fed to the session piece by piece (task_result_state::update_chat_msg). Content deltas become the transcript; tool-call deltas are collected into one function_call_arguments.done per call at the end. Audio after the start of a call is dropped. - A tool_choice of auto, none or required is accepted in the params of the config, in session.update and in response.create, with the response overriding the session. - The tool turn is derived from a conversation in which the assistant called a tool, like upstream, not from a plain reply. - response.done carries raw_text, everything the model wrote with the call markup, for a caller that parses it another way. If the parser throws, the rest of the response is content and the raw text is the way out. ToolCallFilter is no longer used and goes in the next commit. The unit tests cover the splitter contract (content, call deltas, the final piece, whole characters only). realtime_chat_check feeds LFM3-format text through the session in pieces of 1, 7 and all bytes and checks the call, the transcript and the grammar. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * refactor(realtime): drop the tool-call text filter The parser of the chat template now splits content from tool calls, so ToolCallFilter, which looked for the literal <tool_call> tags, has no caller. Remove it with its tests. Every case it covered (a call between text, split tags, several calls, an unfinished call, text after a call) is handled by the parser, and realtime_chat_check runs the LFM3 format through it in pieces of different sizes. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(realtime): fall back to the raw text for S2S tool calls For an any-to-any model, the calls the backend parsed still win. When there are none and the request had tools, parse the raw text that response.done now carries the way the chained pipeline parses the text of its LLM (CleanupLLMResult, ParseFunctionCall, ParseTextContent), so a call format the backend parser does not know can still be served with function.xml_format_preset or the other function settings of the model. The content around the calls replaces the streamed transcript only if the config captures it, as in the chained path. Also pass tool_choice to the backend: the session mode with the stream config and with session.update, and the mode of a response.create override with that event. A named function cannot be forced, so it is not sent. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(e2e): carry raw_text in the mock S2S response.done Match the llama-cpp session: with tools set, response.done has raw_text, the call markup of the LFM3 template for a tool turn and the transcript for any other reply. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(functions): parse tool blocks that have text between them The iterative XML parser stopped at the first scope block that was preceded by text, so "<tool_call>A</tool_call> then <tool_call>B" gave one call. Skip text between blocks once a call was found; text before the first block still ends the parse as before. Blocks that follow each other, or only whitespace, already worked. Tests cover three calls back to back and with text between them, with the lfm3 preset and with auto-detection. They also pin the current reading of argument values: the parser has no tool schema, so a value such as 42 or true is read as JSON even when the schema types it as a string. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(gallery): read LFM3-Audio tool calls with the lfm3 preset Set function.xml_format_preset: lfm3 on the eight LFM3-Audio-2B entries and in the config the importer writes for a speech-to-speech projector, so the server parses the call format of the LFM3 chat template when the backend returns no call (and in the chained pipeline entries, which use the regular chat path). gallery/index.yaml is regenerated from the library. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs(realtime): describe how S2S tool calls are read Replace the description of the hard-coded tag filter with the parser and grammar of the chat template, tool_choice, and the raw-text fallback in the server. Document function.xml_format_preset, and set it in the real-weights e2e model configs like the gallery entries do. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(functions): keep earlier calls when a later block does not parse After a valid call, text that holds the opening tag again (a prose mention, a markdown example, a malformed second block) made the parser treat it as a new block, fail, and return no calls at all. Remember the state after each complete block and fall back to it when a later one fails: the calls found so far are kept, parsing stops there and the remaining text stays in the content. Text skipped between two valid blocks now goes to the content instead of being dropped, so StripToolCallMarkup keeps it. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(realtime): do not drop audio after a tool call started In mixed mode the speech for text written before a call can still be pending when the call starts, so dropping every audio frame after the first call delta cut the speech while its transcript was sent. The llama.cpp server never drops audio when it reads a result; do the same. If a model speaks the call markup aloud, that is model behaviour to observe on real weights, not something to filter here. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(realtime): flush held-back text when a response is cancelled The parser got is_partial=true on a cancelled response, so text it held back (a possible start of a tag) never reached the transcript. The llama.cpp server parses a cancelled response with is_partial=false; do the same. A cancelled response still makes no tool call. The path where the parser throws already sends the text as content and needs no change. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(realtime): stop the fake S2S stream from sending after Close The barge-in spec failed now and then with a data race and "send on closed channel": its script pushes audio from a goroutine, and the session closes the stream while that goroutine still runs. A push now does nothing once the stream is closed, and Close waits for a push in flight. The production close order is right: the writer closes the stream only after it stops sending. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(realtime): align the S2S tool-call fallback with the backend Four gaps in how the Go side reads the tool calls of an any-to-any reply: - With tool_choice none (the response value wins over the session value) the backend builds no tool parser, yet the raw-text fallback still turned a call the model wrote into a function_call item. Skip it. - Without a capture regex the fallback never cleaned the transcript, so the stored item and transcript.done kept the raw call markup. When the call is XML, use the text left after the markup is cut out; a reply that is only a call now has an empty transcript. - A named function as tool_choice mapped to nothing, so the backend kept the previous mode. Refuse it with an error in session.update and response.create. - A response-level tools list changed what the fallback looked for, but the backend only has the tools of the session. Use those in both. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs(realtime): say how S2S tool_choice and response tools behave Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(e2e): use the real llama-cpp backend in the real realtime run The suite always registered the mock backend under the name llama-cpp, so a run with REALTIME_S2S_MODEL set never reached the llama-cpp backend found in REALTIME_BACKENDS_PATH. Register the mock only when that run is off. The real run converts the input audio with ffmpeg. Check for it in the suite and in run-realtime-lfm3.sh before any download or backend start, with a message that says what to install, and list it as a prerequisite in the script header and the Makefile target. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(realtime): cover the tools path of a client session.update to the S2S backend A tool call that never came back from an any-to-any model raised the question whether the tools of the session reach the backend at all. Add a spec that sends the session.update of the real-weights e2e (flat Responses API tool, no session type) and checks that the backend gets the tool in the chat-completions form. Log the number of tools sent when the stream opens and when a session.update carries them, so a run log shows it without reading the wire. The "No tools received" line of the llama-cpp backend does not show it: the server prints it for the input transcription request, which has no tools by design. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(e2e): interrupt the chained pipeline reply while it is in flight With unary stages, the default of the lfm3 pipeline gallery entries, the chained pipeline synthesizes the whole reply and sends it as one audio delta right before response.done. The barge-in spec waited for that delta and then rendered the interruption with the TTS, so the first response was already done when the speech started and ended completed instead of cancelled. Real runs on a GPU showed it with both quantizations. For a pipeline, start the interruption at response.created, which comes before the LLM and TTS stages. Render the interruption audio before the first utterance is sent, so nothing sits between the reply and the interruption. The any-to-any shape still waits for the first audio delta, which that backend streams while it generates. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(e2e): accept a number word and its homophone in the spoken-answer check The check that the reply audio says what the transcript says needs a shared word of 4+ letters. A short answer failed it: the model wrote "Four" and the ASR heard "for". Compare numbers in one spoken form, so digits, number words and their homophones match each other. A homophone only counts when the other text has the number itself, so "for" on both sides still shares nothing and the check does not pass on a stop word. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(llama-cpp): ask LFM3-Audio for function calls when a realtime session has tools The default system prompt of a realtime session was "Respond with interleaved text and audio." whatever the tools. Under that prompt LFM3-Audio answers in words ("I'll check the weather ...") and never writes the call. The model card, and the llama.cpp realtime example client, use "Respond with function calls, and interleaved text and audio." when the session has tools, and the model then calls the tool. Pick the default by the tools of the session, and treat the plain default that the LocalAI server sends back as no choice: it follows the tools too, also when they arrive with a session.update before the first audio. A prompt the client wrote is kept as it is. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(realtime): transcribe the input of an any-to-any turn between responses The input transcript of a speech-to-speech turn ran at the same time as the reply, on the same model. llama.cpp serves both from one context: the realtime slot wants embeddings on, the chat slot of the transcript wants them off, and each flip makes it reserve its compute buffers again. In a GB10 run that was two reserves of about 175 ms per step, the reply fell to 2.6 tokens per second and the transcript to 380 ms per token, until the transcript was done. When pipeline.transcription is the model of the stream, run the transcript after the response, or before one that is not started yet, and keep responses out while it runs. A separate transcription model still runs in parallel. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(realtime): send the input transcript of an any-to-any turn before its reply The previous change moved the same-model transcript after the response. A client that reads until response.done then never saw conversation.item.input_audio_transcription.completed: the transcript was made (the log shows it) but sent after the end of the window. Run it in line with the commit instead. A VAD turn transcribes and then responds. A client response.create already waits for the commit slot, so it starts once the transcript is out. The transcript event now comes before any output of the response of its turn, for a manual commit and for a VAD turn, and never overlaps the response on the llama.cpp context. A transcription model of its own still runs in parallel. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(realtime): transcribe the input of an any-to-any model only when asked The stream answers from the audio, so the transcript of the input is for the client only. On the model of the stream it is costly: llama.cpp serves the transcript request and the realtime stream from one context and rebuilds its compute buffers on every step while both are active. On a GB10 that was 26 to 29 reserves of about 175 ms per turn, against 0 to 1 on the llama.cpp server, and the reply ran at a few tokens per second. An any-to-any model no longer fills pipeline.transcription with its own name. Without it the session does not transcribe the input; with another model it does, in parallel with the reply; with the model itself named it does, before the reply. The reply transcript always comes from the stream. The gallery entries set none, so they get the fast path. The mock configs and run-realtime-lfm3.sh name a transcription model, so the real-weights spec still covers the input transcript. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(realtime): end a response as cancelled when a barge-in lands during the LLM call The chained pipeline cancels the response context on a barge-in. When that happens while the model is generating, the backend call fails with the context error, and the response ended as failed: an error event and no response.done. A client that waits for the terminal of the interrupted response then waits forever. On a GB10 the q4 model answered before the barge-in arrived, so only the slower q8 model showed it: the spec read events for 30 s and timed out. When the context is cancelled, a failed Predict call or a failed result is a cancel, as the TTS step and the streamed LLM path already treat it. The response ends with response.done{cancelled} and no error. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(e2e): wait for the input transcript that comes from a model of its own An any-to-any model now gets its input transcript from a separate ASR that runs next to the reply. The reply is often over first, so a spec that stops reading at response.done saw no transcript in the VAD shape. Keep reading, up to 30 s, until the transcript arrives. The contract is that it comes, not when. Add a guard spec for what the input transcription is handed: the whole turn, in a WAV that says the rate it was recorded at (the session rate for a client commit, 16 kHz for a VAD turn). Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(e2e): check the errors of Close in the realtime specs golangci-lint (errcheck) flagged the unchecked Close of the websocket connections, the response body and the fake stream. Use the `defer func() { _ = x.Close() }()` form the other e2e specs use. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(e2e): write the mock S2S specs with Ginkgo and drop the env read forbidigo only allows Ginkgo/Gomega specs and no os.Getenv outside the sanctioned places. Convert the mock S2S tests to Describe/It with a suite bootstrap (the package had none), with the same 11 cases. The mock no longer reads MOCK_S2S_FRAMES: only these specs set it, so the reply length is a package variable they change per spec and restore afterwards. Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> --------- Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Co-authored-by: Ettore Di Giacinto <mudler@localai.io>
525 lines
25 KiB
Go
525 lines
25 KiB
Go
package config
|
|
|
|
import (
|
|
"slices"
|
|
"strings"
|
|
|
|
. "github.com/onsi/ginkgo/v2"
|
|
. "github.com/onsi/gomega"
|
|
)
|
|
|
|
var _ = Describe("BackendCapabilities", func() {
|
|
It("every backend declares possible/default usecases and gRPC methods", func() {
|
|
for name, cap := range BackendCapabilities {
|
|
Expect(cap.PossibleUsecases).NotTo(BeEmpty(), "backend %q has no possible usecases", name)
|
|
Expect(cap.DefaultUsecases).NotTo(BeEmpty(), "backend %q has no default usecases", name)
|
|
Expect(cap.GRPCMethods).NotTo(BeEmpty(), "backend %q has no gRPC methods", name)
|
|
}
|
|
})
|
|
|
|
It("default usecases are a subset of possible usecases", func() {
|
|
for name, cap := range BackendCapabilities {
|
|
for _, d := range cap.DefaultUsecases {
|
|
Expect(cap.PossibleUsecases).To(ContainElement(d), "backend %q: default %q not in possible %v", name, d, cap.PossibleUsecases)
|
|
}
|
|
}
|
|
})
|
|
|
|
It("every backend's possible usecases map to a known FLAG_*", func() {
|
|
allFlags := GetAllModelConfigUsecases()
|
|
for name, cap := range BackendCapabilities {
|
|
for _, u := range cap.PossibleUsecases {
|
|
info, ok := UsecaseInfoMap[u]
|
|
Expect(ok).To(BeTrue(), "backend %q: usecase %q not in UsecaseInfoMap", name, u)
|
|
flagName := "FLAG_" + strings.ToUpper(u)
|
|
if _, ok := allFlags[flagName]; ok {
|
|
continue
|
|
}
|
|
// Some usecase names don't transform exactly to FLAG_<UPPER>; fall back to flag value lookup.
|
|
found := false
|
|
for _, flag := range allFlags {
|
|
if flag == info.Flag {
|
|
found = true
|
|
break
|
|
}
|
|
}
|
|
Expect(found).To(BeTrue(), "backend %q: usecase %q flag %d not in GetAllModelConfigUsecases", name, u, info.Flag)
|
|
}
|
|
}
|
|
})
|
|
|
|
It("every UsecaseInfoMap entry has a non-zero flag and a gRPC method", func() {
|
|
for name, info := range UsecaseInfoMap {
|
|
Expect(info.Flag).NotTo(Equal(FLAG_ANY), "usecase %q has FLAG_ANY (zero) — should have a real flag", name)
|
|
Expect(info.GRPCMethod).NotTo(BeEmpty(), "usecase %q has no gRPC method", name)
|
|
}
|
|
})
|
|
})
|
|
|
|
var _ = Describe("GetBackendCapability", func() {
|
|
It("advertises diffusers sound generation", func() {
|
|
capability := GetBackendCapability("diffusers")
|
|
Expect(capability.GRPCMethods).To(ContainElement(MethodSoundGeneration))
|
|
Expect(capability.PossibleUsecases).To(ContainElement(UsecaseSoundGeneration))
|
|
})
|
|
|
|
It("returns the capability for a known backend", func() {
|
|
cap := GetBackendCapability("llama-cpp")
|
|
Expect(cap).NotTo(BeNil())
|
|
Expect(cap.PossibleUsecases).To(ContainElement("chat"))
|
|
})
|
|
|
|
It("normalizes hyphenated names so llama.cpp resolves to llama-cpp", func() {
|
|
Expect(GetBackendCapability("llama.cpp")).NotTo(BeNil())
|
|
})
|
|
|
|
It("returns nil for unknown backends", func() {
|
|
Expect(GetBackendCapability("nonexistent")).To(BeNil())
|
|
})
|
|
|
|
// The gallery ships one concrete image per hardware capability behind a
|
|
// meta name, and an operator may pin any of them in a model's `backend:`.
|
|
// An exact-match-only lookup silently treated every one of them as an
|
|
// unknown backend, which cost vulkan-localvqe the 16 kHz mono fold its AEC
|
|
// needs and would cost a pinned audio-cpp variant its voice-cloning
|
|
// contract. Same class as #10945.
|
|
It("resolves a pinned hardware variant to its meta backend", func() {
|
|
for _, name := range []string{"cpu-localvqe", "vulkan-localvqe", "metal-localvqe"} {
|
|
capability := GetBackendCapability(name)
|
|
Expect(capability).NotTo(BeNil(), "pinned variant %q must resolve", name)
|
|
Expect(capability.PossibleUsecases).To(ContainElement(UsecaseAudioTransform), name)
|
|
}
|
|
})
|
|
|
|
It("resolves a pinned variant that also carries a release channel", func() {
|
|
for _, name := range []string{
|
|
"cuda12-audio-cpp", "cuda13-audio-cpp-development",
|
|
"metal-audio-cpp", "cpu-audio-cpp-development",
|
|
"cuda13-nvidia-l4t-arm64-llama-cpp", "intel-sycl-f16-llama-cpp",
|
|
"metal-darwin-arm64-llama-cpp", "nvidia-l4t-arm64-llama-cpp",
|
|
"rocm-llama-cpp-development", "intel-llama-cpp",
|
|
} {
|
|
Expect(GetBackendCapability(name)).NotTo(BeNil(), "pinned variant %q must resolve", name)
|
|
}
|
|
})
|
|
|
|
It("does not invent a capability for a name that only looks like a variant", func() {
|
|
Expect(GetBackendCapability("cpu-nonexistent")).To(BeNil())
|
|
Expect(GetBackendCapability("vulkan-")).To(BeNil())
|
|
})
|
|
|
|
// Stripping is a fallback, never a rewrite: a backend registered under its
|
|
// own name keeps its own entry even if that name starts with a prefix.
|
|
It("prefers an exact match over the stripped one", func() {
|
|
BackendCapabilities["cpu-exact-match-probe"] = BackendCapability{
|
|
PossibleUsecases: []string{UsecaseChat},
|
|
Description: "test fixture",
|
|
}
|
|
BackendCapabilities["exact-match-probe"] = BackendCapability{
|
|
PossibleUsecases: []string{UsecaseTTS},
|
|
Description: "test fixture",
|
|
}
|
|
DeferCleanup(func() {
|
|
delete(BackendCapabilities, "cpu-exact-match-probe")
|
|
delete(BackendCapabilities, "exact-match-probe")
|
|
})
|
|
|
|
capability := GetBackendCapability("cpu-exact-match-probe")
|
|
Expect(capability).NotTo(BeNil())
|
|
Expect(capability.PossibleUsecases).To(Equal([]string{UsecaseChat}))
|
|
})
|
|
})
|
|
|
|
// nemo-speech-cpp fronts four model families from one server, and its
|
|
// PossibleUsecases is their union. The entry has to stay in step with what
|
|
// docs/content/features/nemo-speech-cpp.md tells operators to put in
|
|
// known_usecases: nothing validates known_usecases against PossibleUsecases, so
|
|
// a flag the docs recommend and the map omits fails silently, and the place it
|
|
// surfaces is the gallery. GET /api/backends/usecases is derived from this list
|
|
// and greys out the filters missing from it, so a recommended-but-unlisted flag
|
|
// hides the very models it was recommended for.
|
|
var _ = Describe("nemo-speech-cpp capabilities", func() {
|
|
It("advertises every usecase its four families serve", func() {
|
|
capability := GetBackendCapability("nemo-speech-cpp")
|
|
Expect(capability).NotTo(BeNil())
|
|
Expect(capability.PossibleUsecases).To(ContainElements(
|
|
UsecaseTranscript, UsecaseDiarization, UsecaseTTS,
|
|
UsecaseCompletion, UsecaseChat))
|
|
})
|
|
|
|
// Chat is the translation family's usecase, and it needs both Predict RPCs:
|
|
// /v1/chat/completions streams through PredictStream and answers
|
|
// non-streaming requests through Predict.
|
|
It("backs the chat usecase with the RPCs chat actually drives", func() {
|
|
capability := GetBackendCapability("nemo-speech-cpp")
|
|
Expect(capability.GRPCMethods).To(ContainElements(MethodPredict, MethodPredictStream))
|
|
})
|
|
|
|
// Defaults stay conservative: a bare `backend: nemo-speech-cpp` with no
|
|
// known_usecases is overwhelmingly an ASR model, and every other family is
|
|
// expected to pin its own flags.
|
|
It("still defaults to transcript alone", func() {
|
|
Expect(DefaultUsecasesForBackendCap("nemo-speech-cpp")).To(Equal([]string{UsecaseTranscript}))
|
|
})
|
|
})
|
|
|
|
var _ = Describe("MLX embedding capabilities", func() {
|
|
It("does not advertise RPCs that the backends return as unimplemented", func() {
|
|
for _, name := range []string{"mlx", "mlx-distributed", "mlx-vlm"} {
|
|
capability := GetBackendCapability(name)
|
|
Expect(capability).NotTo(BeNil())
|
|
Expect(capability.GRPCMethods).ToNot(ContainElement(MethodEmbedding), name)
|
|
Expect(capability.PossibleUsecases).ToNot(ContainElement(UsecaseEmbeddings), name)
|
|
}
|
|
})
|
|
})
|
|
|
|
// audio-cpp advertises voice cloning from the backend itself and ships
|
|
// audio-cpp-chatterbox, whose family serves cloning and NOT plain TTS, so a
|
|
// reference clip is the only way to use it. Without a capability entry
|
|
// VoiceCloningForModel returns nil before it ever reads the model's own
|
|
// tts.voice_cloning override, so `voice: "profile:<id>"` was refused with a 400
|
|
// for every audio-cpp model and no model YAML could rescue it.
|
|
var _ = Describe("audio-cpp capabilities", func() {
|
|
It("is registered", func() {
|
|
Expect(GetBackendCapability("audio-cpp")).NotTo(BeNil())
|
|
})
|
|
|
|
It("advertises the RPCs its families actually serve", func() {
|
|
capability := GetBackendCapability("audio-cpp")
|
|
Expect(capability.GRPCMethods).To(ContainElements(
|
|
MethodTTS, MethodTTSStream, MethodAudioTranscription,
|
|
MethodVAD, MethodDiarize, MethodSoundGeneration, MethodAudioTransform))
|
|
Expect(capability.PossibleUsecases).To(ContainElements(
|
|
UsecaseTTS, UsecaseTranscript, UsecaseVAD, UsecaseDiarization,
|
|
UsecaseSoundGeneration, UsecaseAudioTransform))
|
|
})
|
|
|
|
It("carries the reference-audio contract, for pinned variants too", func() {
|
|
for _, name := range []string{"audio-cpp", "cuda12-audio-cpp", "metal-audio-cpp"} {
|
|
cloning := VoiceCloningForModel(&ModelConfig{Backend: name})
|
|
Expect(cloning).NotTo(BeNil(), "%q must reach the backend with a profile voice", name)
|
|
Expect(cloning.AcceptedAudioFormats).To(ContainElement("audio/wav"))
|
|
}
|
|
})
|
|
|
|
// The families audio-cpp reaches through AudioTransform are separation and
|
|
// conversion, which refuse any rate but their checkpoint's own.
|
|
It("does not ask for the 16 kHz mono fold", func() {
|
|
Expect(AudioTransformRequiresMono16kInput("audio-cpp")).To(BeFalse())
|
|
})
|
|
})
|
|
|
|
// The fold to 16 kHz mono in /audio/transform is opt-IN. It used to be
|
|
// unconditional, which made source separation unreachable through the HTTP
|
|
// API: htdemucs and mel_band_roformer refuse any rate but their checkpoint's
|
|
// own and separate using the stereo image, so every such request died with an
|
|
// INTERNAL raised inside the engine while the same call over gRPC worked.
|
|
var _ = Describe("AudioTransformRequiresMono16kInput", func() {
|
|
It("folds for localvqe, whose AEC is trained on 16 kHz mono", func() {
|
|
Expect(AudioTransformRequiresMono16kInput("localvqe")).To(BeTrue())
|
|
})
|
|
|
|
// Pinned gallery variants are the same engine and must fold identically.
|
|
// They did not: the lookup was exact-match only, so vulkan-localvqe was an
|
|
// unknown backend, lost the fold that used to be unconditional, and started
|
|
// failing inside LocalVQE. The usecase gate is no substitute, because
|
|
// BuildFilteredFirstAvailableDefaultModel returns early once the client
|
|
// names a model explicitly.
|
|
It("folds for every pinned localvqe variant the gallery ships", func() {
|
|
Expect(AudioTransformRequiresMono16kInput("cpu-localvqe")).To(BeTrue())
|
|
Expect(AudioTransformRequiresMono16kInput("vulkan-localvqe")).To(BeTrue())
|
|
Expect(AudioTransformRequiresMono16kInput("metal-localvqe")).To(BeTrue())
|
|
})
|
|
|
|
It("does not fold for a backend that has not asked for it", func() {
|
|
// Registered, and deliberately NOT folding: its separation and
|
|
// conversion families refuse any rate but their checkpoint's own.
|
|
Expect(AudioTransformRequiresMono16kInput("audio-cpp")).To(BeFalse())
|
|
Expect(AudioTransformRequiresMono16kInput("nonexistent")).To(BeFalse())
|
|
Expect(AudioTransformRequiresMono16kInput("")).To(BeFalse())
|
|
})
|
|
|
|
It("is claimed by no other registered backend", func() {
|
|
for name, capability := range BackendCapabilities {
|
|
if name == "localvqe" {
|
|
continue
|
|
}
|
|
Expect(capability.AudioTransformInputMono16k).To(BeFalse(),
|
|
"backend %q asks for the 16 kHz mono fold; that has to be a deliberate, documented need", name)
|
|
}
|
|
})
|
|
})
|
|
|
|
var _ = Describe("VoiceCloningForModel", func() {
|
|
voiceCloningSetting := func(enabled bool) *bool { return &enabled }
|
|
|
|
DescribeTable("advertises only compatible model variants",
|
|
func(cfg ModelConfig, expected bool) {
|
|
Expect(VoiceCloningForModel(&cfg) != nil).To(Equal(expected))
|
|
},
|
|
Entry("Qwen C++ Base", ModelConfig{Name: "qwen3-tts-cpp-0.6b-base", Backend: "qwen3-tts-cpp"}, true),
|
|
Entry("Qwen C++ CustomVoice", ModelConfig{Name: "qwen3-tts-cpp-customvoice", Backend: "qwen3-tts-cpp"}, false),
|
|
Entry("VibeVoice realtime 0.5B", ModelConfig{Name: "vibevoice-cpp-0.5b", Backend: "vibevoice-cpp"}, false),
|
|
Entry("VibeVoice 1.5B", ModelConfig{Name: "vibevoice-1.5b", Backend: "vibevoice-cpp"}, true),
|
|
Entry("F5 through CrispASR", ModelConfig{Name: "f5-tts-crispasr", Backend: "crispasr"}, true),
|
|
Entry("ASR through CrispASR", ModelConfig{Name: "parakeet-crispasr", Backend: "crispasr"}, false),
|
|
Entry("VoxCPM", ModelConfig{Name: "voxcpm-1.5", Backend: "voxcpm"}, true),
|
|
Entry("unsupported Piper", ModelConfig{Name: "piper", Backend: "piper"}, false),
|
|
Entry("typed custom opt-in", ModelConfig{Name: "private-build", Backend: "qwen3-tts-cpp", TTSConfig: TTSConfig{VoiceCloning: voiceCloningSetting(true)}}, true),
|
|
Entry("typed opt-out", ModelConfig{Name: "voxcpm-1.5", Backend: "voxcpm", TTSConfig: TTSConfig{VoiceCloning: voiceCloningSetting(false)}}, false),
|
|
Entry("typed setting wins over compatibility option", ModelConfig{Name: "private-build", Backend: "qwen3-tts-cpp", TTSConfig: TTSConfig{VoiceCloning: voiceCloningSetting(true)}, Options: []string{"voice_cloning:false"}}, true),
|
|
Entry("legacy option custom opt-in", ModelConfig{Name: "private-build", Backend: "qwen3-tts-cpp", Options: []string{"voice_cloning:true"}}, true),
|
|
Entry("legacy option opt-out", ModelConfig{Name: "voxcpm-1.5", Backend: "voxcpm", Options: []string{"voice_cloning=false"}}, false),
|
|
)
|
|
|
|
// A pinned gallery variant must reach the SAME per-backend rule as the meta
|
|
// name, in both directions. Resolving the capability by stripping the prefix
|
|
// while still keying the model-variant switch on the pinned spelling made
|
|
// every variant fall through to the permissive default: cuda12-vibevoice-cpp
|
|
// advertised cloning for the realtime 0.5B model, which cannot do it, and
|
|
// /v1/audio/speech accepted a profile: voice it had to fail on in the backend
|
|
// instead of rejecting it with a 400.
|
|
DescribeTable("resolves the model-variant rule through pinned gallery variants",
|
|
func(cfg ModelConfig, expected bool) {
|
|
Expect(VoiceCloningForModel(&cfg) != nil).To(Equal(expected))
|
|
},
|
|
Entry("cuda12-vibevoice-cpp 0.5B stays unsupported", ModelConfig{Name: "vibevoice-cpp-0.5b", Backend: "cuda12-vibevoice-cpp"}, false),
|
|
Entry("cuda12-vibevoice-cpp 1.5B stays supported", ModelConfig{Name: "vibevoice-1.5b", Backend: "cuda12-vibevoice-cpp"}, true),
|
|
Entry("metal-coqui tacotron2 stays unsupported", ModelConfig{Name: "tacotron2-en", Backend: "metal-coqui"}, false),
|
|
Entry("metal-coqui xtts stays supported", ModelConfig{Name: "xtts-v2", Backend: "metal-coqui"}, true),
|
|
Entry("cuda12-crispasr ASR stays unsupported", ModelConfig{Name: "parakeet-asr", Backend: "cuda12-crispasr"}, false),
|
|
Entry("cuda12-crispasr F5 stays supported", ModelConfig{Name: "f5-tts-crispasr", Backend: "cuda12-crispasr"}, true),
|
|
Entry("cpu-qwen3-tts-cpp CustomVoice stays unsupported", ModelConfig{Name: "qwen3-tts-flash", Backend: "cpu-qwen3-tts-cpp"}, false),
|
|
Entry("cpu-qwen3-tts-cpp Base stays supported", ModelConfig{Name: "qwen3-tts-cpp-0.6b-base", Backend: "cpu-qwen3-tts-cpp"}, true),
|
|
Entry("release channel suffix too", ModelConfig{Name: "vibevoice-cpp-0.5b", Backend: "vibevoice-cpp-development"}, false),
|
|
Entry("pinned audio-cpp keeps its unconditional cloning", ModelConfig{Name: "audio-cpp-chatterbox", Backend: "cuda12-audio-cpp"}, true),
|
|
)
|
|
})
|
|
|
|
var _ = Describe("TTSVoicesForModel", func() {
|
|
It("returns the built-in Pocket TTS voice catalog", func() {
|
|
voices := TTSVoicesForModel(&ModelConfig{Name: "pocket", Backend: "pocket-tts"})
|
|
Expect(voices).To(ContainElement(TTSVoice{Name: "alba", Language: "en_US", Gender: "female"}))
|
|
Expect(voices).To(ContainElement(TTSVoice{Name: "giovanni", Language: "it_IT", Gender: "male"}))
|
|
})
|
|
|
|
It("resolves the catalog for pinned backend variants", func() {
|
|
voices := TTSVoicesForModel(&ModelConfig{Name: "pocket", Backend: "cuda12-pocket-tts"})
|
|
Expect(voices).To(ContainElement(TTSVoice{Name: "alba", Language: "en_US", Gender: "female"}))
|
|
})
|
|
|
|
It("prefers model-specific voice metadata", func() {
|
|
configured := []TTSVoice{{Name: "custom", Language: "en_GB"}}
|
|
voices := TTSVoicesForModel(&ModelConfig{
|
|
Backend: "pocket-tts",
|
|
TTSConfig: TTSConfig{Voices: configured},
|
|
})
|
|
Expect(voices).To(Equal(configured))
|
|
})
|
|
})
|
|
|
|
// llama.cpp serves Qwen3-TTS as well as the text LLMs it is known for, so the
|
|
// backend has to advertise TTS. That advertisement is what makes narrowing
|
|
// mandatory: the per-backend switch in VoiceCloningForModel ends in a
|
|
// permissive default, so an unnarrowed llama-cpp entry would offer
|
|
// reference-audio cloning on every GGUF chat model in the gallery.
|
|
var _ = Describe("llama-cpp TTS capabilities", func() {
|
|
It("advertises the TTS RPCs and usecase", func() {
|
|
capability := GetBackendCapability("llama-cpp")
|
|
Expect(capability).NotTo(BeNil())
|
|
Expect(capability.GRPCMethods).To(ContainElements(MethodTTS, MethodTTSStream))
|
|
Expect(capability.PossibleUsecases).To(ContainElement(UsecaseTTS))
|
|
})
|
|
|
|
// The gallery filter and the model importer both read DefaultUsecases, and a
|
|
// bare GGUF served by llama.cpp is a chat model, not a TTS model.
|
|
It("keeps chat as its only default usecase", func() {
|
|
Expect(GetBackendCapability("llama-cpp").DefaultUsecases).To(Equal([]string{UsecaseChat}))
|
|
})
|
|
|
|
ttsModel := func(backend string) ModelConfig {
|
|
cfg := ModelConfig{Name: "qwen3-tts-llamacpp", Backend: backend}
|
|
cfg.KnownUsecaseStrings = []string{"tts"}
|
|
cfg.syncKnownUsecasesFromString()
|
|
return cfg
|
|
}
|
|
|
|
It("resolves voice cloning for a model that declares the TTS usecase", func() {
|
|
cfg := ttsModel("llama-cpp")
|
|
cloning := VoiceCloningForModel(&cfg)
|
|
Expect(cloning).NotTo(BeNil())
|
|
Expect(cloning.AcceptedAudioFormats).To(ContainElement("audio/wav"))
|
|
})
|
|
|
|
// The spec that constrains the fix. Every one of these is an ordinary
|
|
// llama.cpp text model, and none of them may be offered in the Voice
|
|
// Library or accept a localai://voice-profiles/... reference.
|
|
DescribeTable("never resolves voice cloning for an ordinary llama.cpp model",
|
|
func(cfg ModelConfig) {
|
|
Expect(VoiceCloningForModel(&cfg)).To(BeNil())
|
|
},
|
|
Entry("plain chat model", ModelConfig{Name: "qwen3-8b", Backend: "llama-cpp"}),
|
|
Entry("auto-detected GGUF with no backend pinned", ModelConfig{Name: "mistral-7b"}),
|
|
Entry("a vision model with an mmproj", ModelConfig{Name: "gemma-3-12b", Backend: "llama-cpp", LLMConfig: LLMConfig{MMProj: "mmproj-gemma-3-12b.gguf"}}),
|
|
Entry("a chat model whose name happens to say base", ModelConfig{Name: "llama-3.1-8b-base", Backend: "llama-cpp"}),
|
|
Entry("a pinned hardware variant", ModelConfig{Name: "qwen3-8b", Backend: "cuda12-llama-cpp"}),
|
|
)
|
|
|
|
// A declared-TTS model must keep its contract through the pinned gallery
|
|
// variants an operator can put in `backend:`, the same way vibevoice-cpp
|
|
// and crispasr do.
|
|
DescribeTable("resolves through pinned gallery variants",
|
|
func(backend string) {
|
|
cfg := ttsModel(backend)
|
|
Expect(VoiceCloningForModel(&cfg)).NotTo(BeNil())
|
|
},
|
|
Entry("cuda12", "cuda12-llama-cpp"),
|
|
Entry("vulkan", "vulkan-llama-cpp"),
|
|
Entry("metal darwin arm64", "metal-darwin-arm64-llama-cpp"),
|
|
Entry("development channel", "llama-cpp-development"),
|
|
)
|
|
|
|
// tts.voice_cloning is the documented escape hatch for a custom build. It
|
|
// only ever reaches the operator once the backend carries the contract at
|
|
// all, which is precisely what the unregistered entry prevented.
|
|
It("still honours an explicit opt-out on a declared-TTS model", func() {
|
|
cfg := ttsModel("llama-cpp")
|
|
disabled := false
|
|
cfg.TTSConfig.VoiceCloning = &disabled
|
|
Expect(VoiceCloningForModel(&cfg)).To(BeNil())
|
|
})
|
|
})
|
|
|
|
var _ = Describe("IsValidUsecaseForBackend", func() {
|
|
It("accepts a backend's declared usecases", func() {
|
|
Expect(IsValidUsecaseForBackend("piper", "tts")).To(BeTrue())
|
|
})
|
|
|
|
It("rejects usecases outside a backend's possible set", func() {
|
|
Expect(IsValidUsecaseForBackend("piper", "chat")).To(BeFalse())
|
|
})
|
|
|
|
It("is permissive for unknown backends", func() {
|
|
Expect(IsValidUsecaseForBackend("unknown", "anything")).To(BeTrue())
|
|
})
|
|
})
|
|
|
|
var _ = Describe("IsLlamaCppBackend", func() {
|
|
DescribeTable("classifies a backend name",
|
|
func(backend string, expected bool) {
|
|
Expect(IsLlamaCppBackend(backend)).To(Equal(expected))
|
|
},
|
|
Entry("meta name", "llama-cpp", true),
|
|
Entry("dotted spelling", "llama.cpp", true),
|
|
Entry("auto-detect (empty)", "", true),
|
|
Entry("development channel", "llama-cpp-development", true),
|
|
Entry("quantization channel", "llama-cpp-quantization", true),
|
|
Entry("vulkan variant", "vulkan-llama-cpp", true),
|
|
Entry("cuda 12 variant", "cuda12-llama-cpp", true),
|
|
Entry("cuda 13 variant", "cuda13-llama-cpp", true),
|
|
Entry("jetson variant", "cuda13-nvidia-l4t-arm64-llama-cpp", true),
|
|
Entry("rocm variant", "rocm-llama-cpp", true),
|
|
Entry("metal variant", "metal-llama-cpp", true),
|
|
Entry("intel sycl f16 variant", "intel-sycl-f16-llama-cpp", true),
|
|
Entry("intel sycl f32 variant", "intel-sycl-f32-llama-cpp", true),
|
|
Entry("cpu variant", "cpu-llama-cpp", true),
|
|
Entry("variant on the development channel", "rocm-llama-cpp-development", true),
|
|
Entry("darwin quantization variant", "metal-darwin-arm64-llama-cpp-quantization", true),
|
|
// ik-llama.cpp is a distinct engine that merely shares the suffix.
|
|
Entry("ik-llama-cpp", "ik-llama-cpp", false),
|
|
Entry("ik-llama-cpp development", "ik-llama-cpp-development", false),
|
|
Entry("cpu ik-llama-cpp", "cpu-ik-llama-cpp", false),
|
|
Entry("cpu ik-llama-cpp development", "cpu-ik-llama-cpp-development", false),
|
|
Entry("vllm", "vllm", false),
|
|
Entry("mlx", "mlx", false),
|
|
Entry("whisper", "whisper", false),
|
|
Entry("bark-cpp", "bark-cpp", false),
|
|
)
|
|
})
|
|
|
|
var _ = Describe("AllBackendNames", func() {
|
|
It("returns 30+ backends in sorted order", func() {
|
|
names := AllBackendNames()
|
|
Expect(len(names)).To(BeNumerically(">=", 30))
|
|
Expect(slices.IsSorted(names)).To(BeTrue())
|
|
})
|
|
})
|
|
|
|
var _ = Describe("Upscale backend declaration", func() {
|
|
It("maps upscale to its dedicated RPC and advertises SD GGML support", func() {
|
|
info := UsecaseInfoMap[UsecaseUpscale]
|
|
Expect(info.Flag).To(Equal(FLAG_UPSCALE))
|
|
Expect(info.GRPCMethod).To(Equal(MethodUpscaleImage))
|
|
cap := GetBackendCapability("stablediffusion-ggml")
|
|
Expect(cap.GRPCMethods).To(ContainElement(MethodUpscaleImage))
|
|
Expect(cap.PossibleUsecases).To(ContainElement(UsecaseUpscale))
|
|
Expect(cap.DefaultUsecases).NotTo(ContainElement(UsecaseUpscale))
|
|
})
|
|
})
|
|
|
|
var _ = Describe("GEM-X motion capability", func() {
|
|
It("discovers motion without advertising animation generation", func() {
|
|
Expect(DefaultUsecasesForBackendCap("gemxcpp")).To(Equal([]string{UsecaseMotion}))
|
|
cfg := &ModelConfig{Backend: "gemxcpp"}
|
|
Expect(cfg.HasUsecases(FLAG_MOTION)).To(BeTrue())
|
|
Expect(cfg.HasUsecases(FLAG_3D_ANIMATION)).To(BeFalse())
|
|
Expect(cfg.HasUsecases(FLAG_DECISIONS)).To(BeFalse())
|
|
decisions := FLAG_DECISIONS
|
|
Expect((&ModelConfig{Backend: "vllm-cpp", KnownUsecases: &decisions}).HasUsecases(FLAG_MOTION)).To(BeFalse())
|
|
Expect(FLAG_MOTION & FLAG_DECISIONS).To(BeZero())
|
|
Expect((&ModelConfig{Backend: "llama-cpp"}).HasUsecases(FLAG_MOTION)).To(BeFalse())
|
|
})
|
|
})
|
|
|
|
var _ = Describe("timestral forecast capability", func() {
|
|
It("discovers forecast on the backend and keeps the model out of chat", func() {
|
|
Expect(DefaultUsecasesForBackendCap("timestral-cpp")).To(Equal([]string{UsecaseForecast}))
|
|
cfg := &ModelConfig{Backend: "timestral-cpp"}
|
|
Expect(cfg.HasUsecases(FLAG_FORECAST)).To(BeTrue())
|
|
Expect(cfg.HasUsecases(FLAG_CHAT)).To(BeFalse())
|
|
Expect(cfg.HasUsecases(FLAG_COMPLETION)).To(BeFalse())
|
|
Expect(cfg.HasUsecases(FLAG_EMBEDDINGS)).To(BeFalse())
|
|
Expect(cfg.HasUsecases(FLAG_DEPTH)).To(BeFalse())
|
|
Expect(cfg.Capabilities()).To(ContainElement(UsecaseForecast))
|
|
Expect(cfg.Capabilities()).NotTo(ContainElement(UsecaseChat))
|
|
})
|
|
|
|
It("keeps chat models and other backends out of forecast", func() {
|
|
Expect((&ModelConfig{Backend: "llama-cpp"}).HasUsecases(FLAG_FORECAST)).To(BeFalse())
|
|
chat := &ModelConfig{Backend: "timestral-cpp"}
|
|
chat.TemplateConfig.UseTokenizerTemplate = true
|
|
Expect(chat.HasUsecases(FLAG_CHAT)).To(BeFalse(), "a timestral model never serves text")
|
|
})
|
|
|
|
It("maps the usecase to its flag, RPC and string form", func() {
|
|
info := UsecaseInfoMap[UsecaseForecast]
|
|
Expect(info.Flag).To(Equal(FLAG_FORECAST))
|
|
Expect(info.GRPCMethod).To(Equal(MethodForecast))
|
|
Expect(GetAllModelConfigUsecases()).To(HaveKeyWithValue("FLAG_FORECAST", FLAG_FORECAST))
|
|
flags := GetUsecasesFromYAML([]string{"forecast"})
|
|
Expect(flags).NotTo(BeNil())
|
|
Expect(*flags).To(Equal(FLAG_FORECAST))
|
|
})
|
|
})
|
|
|
|
// LFM3-Audio runs through llama.cpp for speech recognition and for the
|
|
// speech-to-speech loop, so the llama-cpp entry advertises both RPCs. Its
|
|
// default stays chat: a bare GGUF is still a chat model.
|
|
var _ = Describe("llama-cpp speech and realtime capabilities", func() {
|
|
It("advertises the transcription and audio-to-audio RPCs", func() {
|
|
capability := GetBackendCapability("llama-cpp")
|
|
Expect(capability).NotTo(BeNil())
|
|
Expect(capability.GRPCMethods).To(ContainElements(MethodAudioTranscription, MethodAudioToAudioStream))
|
|
})
|
|
|
|
It("accepts the transcript and realtime_audio usecases", func() {
|
|
Expect(IsValidUsecaseForBackend("llama-cpp", UsecaseTranscript)).To(BeTrue())
|
|
Expect(IsValidUsecaseForBackend("llama-cpp", UsecaseRealtimeAudio)).To(BeTrue())
|
|
})
|
|
|
|
It("keeps chat as its only default usecase", func() {
|
|
Expect(GetBackendCapability("llama-cpp").DefaultUsecases).To(Equal([]string{UsecaseChat}))
|
|
})
|
|
})
|