mirror of
https://github.com/mudler/LocalAI.git
synced 2026-08-02 03:20:12 -04:00
* feat(ced): sketch sound-classification backend (CED audio tagger) Wires ced.cpp (CED, 527-class AudioSet sound-event tagger; baby cry, footsteps, glass, alarms, dog bark) into LocalAI as a Go/purego backend. SKETCH (backend skeleton real; core REST wiring + CI/gallery is a checklist in DESIGN.md): - backend/backend.proto: new SoundDetection rpc + SoundClass messages (run `make protogen-go` to regenerate pkg/grpc/proto). - backend/go/ced: main.go (purego dlopen libced.so + ced_capi.h), goced.go (Ced gRPC backend: Load + SoundDetection), Makefile (clone-at-pin CED_VERSION, ggml static-PIC shared build), run.sh, package.sh, .gitignore. - DESIGN.md: REST /v1/audio/classification wiring (handler/route/capability registration checklist), gallery/index + CI registration, and a scoping note for the realtime/websocket live-recognition path (sliding-window classify over the existing ws transport + voicegate; the ced C-API per-PCM entry point is already window-friendly). Backend code does not compile until protogen-go regenerates the pb types and a libced.so is built (Makefile clones+builds it). Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ced): REST /v1/audio/classification endpoint + capability registration Wires the ced sound-event classification backend (AudioSet audio tagger) end to end through the REST surface, mirroring the transcription path. - Handler: core/http/endpoints/openai/sound_classification.go parses the multipart audio upload, temp-files it, resolves the model config and calls the SoundDetection RPC; returns {model, detections[]} JSON. - Backend wrapper: core/backend/sound_classification.go (ModelSoundDetection) loads the model and normalizes the proto response into schema types. - Schema: core/schema/sound_classification.go (SoundClassificationResult). - gRPC layer: SoundDetection wired through the LocalAI wrapper (interface, Backend client, Client, embed, server, base default) so the loader-typed client exposes the RPC; proto regenerated via make protogen-go. - Route: POST /v1/audio/classification (+ /audio/classification alias) with the audio/multipart default-model middleware in routes/openai.go. - Capability surfaces: swagger @Tags/@Router on the handler; FLAG_SOUND_ CLASSIFICATION usecase flag + UsecaseSoundClassification + UsecaseInfoMap + GuessUsecases + ModalityGroups + GetAllModelConfigUsecases; meta usecase option; /api/instructions audio area updated; auth RouteFeatureRegistry + FeatureAudioClassification (APIFeatures, default ON) + FeatureMetas; UI usecaseFilters, capabilities.js CAP_SOUND_CLASSIFICATION, Models.jsx filter + i18n; docs page features/audio-classification.md + whats-new + crosslink. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ced): realtime sound-event detection over the websocket API When a realtime pipeline configures a sound-classification model, each VAD-committed utterance (the same window the transcription path produces) is also run through the CED sound-event classifier and the scored AudioSet tags are emitted as a new server event. No new backend rpc is needed: the SoundDetection gRPC method already exists on this branch. - config: add Pipeline.SoundDetection (yaml/json sound_detection,omitempty) beside Transcription/VAD. - realtime: add Model.SoundDetection(ctx, audio, topK, threshold) to the ModelInterface; implement it on wrappedModel and transcriptOnlyModel by calling backend.ModelSoundDetection with the session's sound-classification model config (mirrors how Transcribe dispatches). Load the optional config in newModel / newTranscriptionOnlyModel; nil config keeps it additive. - types: add ConversationItemSoundDetectionEvent (item_id, content_index, detections[]{label,score,index}) with type conversation.item.sound_detection, its ServerEventType constant and MarshalJSON, mirroring the transcription completed event. - realtime: add emitSoundDetection (unary path: classify the committed window, build the event, t.SendEvent) and wire it at the utterance-commit hook right after emitTranscription; gated on session.SoundDetectionEnabled (resolved from Pipeline.SoundDetection at session setup, defaults top_k=5, threshold=0). Its error is logged via xlog but never aborts the turn. - test: Ginkgo specs for emitSoundDetection (tags emitted, empty detections, classifier error) plus a SoundDetection method on the fakeModel double. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(ced): implement SoundDetection in nodes backend test doubles The SoundDetection method added to the grpc backend interface left two test doubles (fakeBackendClient, fakeGRPCBackend) incomplete, so core/services/nodes failed to compile under `go vet`/`go test` (go build missed it: the doubles live in _test.go). Add the method to both, mirroring their existing Detect mock. Repairs CI for the nodes package. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ced): decouple realtime sound detection from VAD (sound-only sessions) Sound-event detection must activate on sounds, not speech, so it no longer runs through the voice VAD/transcription path. A sound-detection-only pipeline (sound_detection set, no transcription/LLM) now: - is accepted by prepareRealtimeConfig (sound_detection counts as a pipeline stage), - builds a lightweight model via newSoundDetectionOnlyModel (no VAD/STT/LLM/TTS loaded), and - defaults the session to turn_detection none (no VAD) with no transcription stage, so the client drives windowing via input_audio_buffer.commit (option A: client-side sliding window). The per-PCM C-API already supports arbitrary windows. commitUtterance gains a sound-only branch: it emits the conversation.item.sound_detection event (scored AudioSet tags) and stops - no transcription, no LLM response. generateResponse is now guarded on a transcription stage being present, so a sound-only turn never invokes the LLM. Existing transcription/VAD sessions are unchanged (additive). Added a commitUtterance sound-only Ginkgo spec asserting it emits the sound event and neither transcribes nor generates a response. go vet + golangci-lint (new-from-merge-base) clean; openai suite green. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ced): register sound-classification backend in gallery + CI Mechanical backend-image registration for the ced sound-event classifier, mirroring the parakeet-cpp Go/purego backend everywhere it is wired up. - .github/backend-matrix.yml: add the ced build matrix, field-for-field copies of the parakeet-cpp entries (cpu amd64/arm64, cublas cuda 12/13 amd64, l4t cuda-13 arm64, l4t-jetpack cuda-12 arm64, sycl f32/f16, vulkan amd64/arm64, rocm hipblas, and the metal darwin entry), changing only backend and tag-suffix. dockerfile stays ./backend/Dockerfile.golang. - backend/index.yaml: add the &ced meta anchor (capabilities map per platform) plus ced-development and the per-arch image entries, each uri/mirror tag-suffix matching the matrix exactly. The model gallery (GGUF) entry is intentionally deferred pending the HuggingFace publish (TODO note inline). - scripts/changed-backends.js: add an explicit item.backend === "ced" branch in inferBackendPath mapping to backend/go/ced/, same mechanism and ordering as the parakeet-cpp branch (before the generic golang fallthrough). - .github/workflows/bump_deps.yaml: register mudler/ced.cpp -> CED_VERSION in backend/go/ced/Makefile so the daily bot bumps the pin. - swagger/{docs.go,swagger.json,swagger.yaml}: regenerated via make swagger so the existing /v1/audio/classification annotations land in the generated spec. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ced): server-side windowing for realtime sound detection (option B) Adds an optional server-driven sliding-window classifier so a sound-only realtime client only has to stream audio (no input_audio_buffer.commit): - Pipeline.sound_detection_window_ms / sound_detection_hop_ms config knobs. When both > 0 on a sound-only session, the server classifies the last window of streamed audio every hop and emits a conversation.item.sound_ detection event; the input buffer is trimmed to one window so a long stream stays bounded. When unset, the session stays client-driven (option A). Runs independent of VAD (sound events are not speech). - handleSoundWindow (ticker) + classifySoundWindow (one tick, extracted so it is unit-testable) + writeWindowWAV, which declares the true InputSampleRate (NewWAVHeaderWithRate) so the classifier resamples correctly. Goroutine is started after toggleVAD and torn down with the session (close + wg.Wait). - Register pipeline.sound_detection (+window_ms/hop_ms) in the config meta registry; the earlier realtime commit added pipeline.sound_detection without a registry entry, failing TestAllFieldsHaveRegistryEntries. This fixes that and covers the two new knobs. Tests: classifySoundWindow emits an event + trims the buffer to one window, no-ops on too-little audio; writeWindowWAV declares the given sample rate. go build/vet + golangci-lint (new-from-merge-base) clean; config + openai suites green. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ced): add ced-base GGUF model gallery entries (f16 + q8_0) The ced-base weights are now published at mudler/ced-base-gguf (Apache-2.0, converted from mispeech/ced-base). Adds gallery/ced.yaml (backend: ced + known_usecases: sound_classification) and two gallery/index.yaml entries (ced-base-f16 default, ced-base-q8 smallest) with sha256-pinned files, and removes the now-resolved TODO from backend/index.yaml. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ced): add tiny/mini/small GGUF model gallery entries Publishes the rest of the CED family (same architecture, metadata-driven port verified end-to-end on ced-tiny) to mudler/ced-{tiny,mini,small}-gguf and adds their f16 + q8_0 gallery entries: ced-tiny (5.5M, edge/Pi-class) f16 11MB / q8_0 6MB ced-mini (9.6M) f16 19MB / q8_0 11MB ced-small (22M) f16 42MB / q8_0 23MB All sha256-pinned. ced-base remains the accuracy default. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * chore(ced): point gallery entries at the consolidated mudler/ced-gguf repo All CED quantizations (tiny/mini/small/base, f16/q8_0) now live in a single HuggingFace repo, mudler/ced-gguf, instead of per-model repos. Repoint the 8 gallery model entries' urls + file uris accordingly. sha256 and filenames are unchanged. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * chore(ced): bump CED_VERSION to the short-clip fix Pin the ced backend to ced.cpp 99c6ed3, which fixes a crash on any clip shorter than target_length (~10.11s): time_pos_embed was added at its full 63-frame grid instead of being sliced to the clip's actual time grid, tripping ggml_can_repeat in ggml_add. Surfaced by the live realtime e2e (sub-10s windows) and gated with a short-clip parity test upstream. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs(ced): list ced.cpp as a LocalAI-team engine + backend-guide directive - README.md: add ced.cpp to the "native C/C++/GGML engines developed and maintained by the LocalAI project" table. - docs/content/features/backends.md: add a Sound Classification backend category (sound-event classification / audio tagging) listing ced.cpp. - .agents/adding-backends.md: add a "Documenting the backend" section and two verification-checklist items requiring new backends to be documented in the backends.md category list, and in-house native engines to be added to the README maintained-engines table. This directive was missing. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * chore(ced): repin CED_VERSION to the v0.1.0 release commit ced.cpp history was squashed into a single release commit (tagged v0.1.0), so the previous pin (99c6ed3) no longer exists upstream. Pin to c04ac14, the v0.1.0 release commit, so the backend builds against a commit that exists. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(ced): silence gosec G304/G103 + govet unsafeptr on audited paths - sound_classification.go: os.Create(dst) where dst = temp dir + path.Base of the upload (no traversal). #nosec G304, matching the depth-anything-cpp handler. - goced.go: reading a NUL-terminated C string from a libced-owned buffer. #nosec G103 (gosec) + //nolint:govet (golangci-lint's unsafeptr check), since the uintptr is a C-owned malloc'd buffer, not Go-GC memory. 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>
445 lines
22 KiB
Go
445 lines
22 KiB
Go
package routes
|
|
|
|
import (
|
|
"github.com/labstack/echo/v4"
|
|
"github.com/mudler/LocalAI/core/application"
|
|
"github.com/mudler/LocalAI/core/config"
|
|
"github.com/mudler/LocalAI/core/http/endpoints/localai"
|
|
mcpTools "github.com/mudler/LocalAI/core/http/endpoints/mcp"
|
|
"github.com/mudler/LocalAI/core/http/middleware"
|
|
"github.com/mudler/LocalAI/core/schema"
|
|
"github.com/mudler/LocalAI/core/services/galleryop"
|
|
"github.com/mudler/LocalAI/core/services/monitoring"
|
|
"github.com/mudler/LocalAI/core/templates"
|
|
"github.com/mudler/LocalAI/internal"
|
|
"github.com/mudler/LocalAI/pkg/model"
|
|
echoswagger "github.com/swaggo/echo-swagger"
|
|
)
|
|
|
|
func RegisterLocalAIRoutes(router *echo.Echo,
|
|
requestExtractor *middleware.RequestExtractor,
|
|
cl *config.ModelConfigLoader,
|
|
ml *model.ModelLoader,
|
|
appConfig *config.ApplicationConfig,
|
|
galleryService *galleryop.GalleryService,
|
|
opcache *galleryop.OpCache,
|
|
evaluator *templates.Evaluator,
|
|
app *application.Application,
|
|
adminMiddleware echo.MiddlewareFunc,
|
|
mcpJobsMw echo.MiddlewareFunc,
|
|
mcpMw echo.MiddlewareFunc) {
|
|
|
|
router.GET("/swagger/*", echoswagger.EchoWrapHandler(func(c *echoswagger.Config) {
|
|
c.URLs = []string{"doc.json"}
|
|
}))
|
|
|
|
// LocalAI API endpoints
|
|
if !appConfig.DisableGalleryEndpoint {
|
|
// Import model page
|
|
router.GET("/import-model", func(c echo.Context) error {
|
|
return c.Render(200, "views/model-editor", map[string]any{
|
|
"Title": "LocalAI - Import Model",
|
|
"BaseURL": middleware.BaseURL(c),
|
|
"Version": internal.PrintableVersion(),
|
|
"DisableRuntimeSettings": appConfig.DisableRuntimeSettings,
|
|
})
|
|
}, adminMiddleware)
|
|
|
|
// Edit model page
|
|
router.GET("/models/edit/:name", localai.GetEditModelPage(cl, appConfig), adminMiddleware)
|
|
modelGalleryEndpointService := localai.CreateModelGalleryEndpointService(appConfig.Galleries, appConfig.BackendGalleries, appConfig.SystemState, galleryService, cl)
|
|
router.POST("/models/apply", modelGalleryEndpointService.ApplyModelGalleryEndpoint(), adminMiddleware)
|
|
router.POST("/models/delete/:name", modelGalleryEndpointService.DeleteModelGalleryEndpoint(), adminMiddleware)
|
|
|
|
router.GET("/models/available", modelGalleryEndpointService.ListModelFromGalleryEndpoint(appConfig.SystemState), adminMiddleware)
|
|
router.GET("/models/galleries", modelGalleryEndpointService.ListModelGalleriesEndpoint(), adminMiddleware)
|
|
router.GET("/models/jobs/:uuid", modelGalleryEndpointService.GetOpStatusEndpoint(), adminMiddleware)
|
|
router.GET("/models/jobs", modelGalleryEndpointService.GetAllStatusEndpoint(), adminMiddleware)
|
|
|
|
backendGalleryEndpointService := localai.CreateBackendEndpointService(
|
|
appConfig.BackendGalleries,
|
|
appConfig.SystemState,
|
|
galleryService,
|
|
app.UpgradeChecker())
|
|
router.POST("/backends/apply", backendGalleryEndpointService.ApplyBackendEndpoint(appConfig.SystemState), adminMiddleware)
|
|
router.POST("/backends/delete/:name", backendGalleryEndpointService.DeleteBackendEndpoint(), adminMiddleware)
|
|
router.GET("/backends", backendGalleryEndpointService.ListBackendsEndpoint(), adminMiddleware)
|
|
router.GET("/backends/available", backendGalleryEndpointService.ListAvailableBackendsEndpoint(appConfig.SystemState), adminMiddleware)
|
|
router.GET("/backends/known", backendGalleryEndpointService.ListKnownBackendsEndpoint(appConfig.SystemState), adminMiddleware)
|
|
router.GET("/backends/galleries", backendGalleryEndpointService.ListBackendGalleriesEndpoint(), adminMiddleware)
|
|
router.GET("/backends/jobs/:uuid", backendGalleryEndpointService.GetOpStatusEndpoint(), adminMiddleware)
|
|
router.GET("/backends/upgrades", backendGalleryEndpointService.GetUpgradesEndpoint(), adminMiddleware)
|
|
router.POST("/backends/upgrades/check", backendGalleryEndpointService.CheckUpgradesEndpoint(), adminMiddleware)
|
|
router.POST("/backends/upgrade/:name", backendGalleryEndpointService.UpgradeBackendEndpoint(), adminMiddleware)
|
|
// Custom model import endpoint
|
|
router.POST("/models/import", localai.ImportModelEndpoint(cl, appConfig), adminMiddleware)
|
|
|
|
// URI model import endpoint
|
|
router.POST("/models/import-uri", localai.ImportModelURIEndpoint(cl, appConfig, galleryService, opcache), adminMiddleware)
|
|
|
|
// Custom model edit endpoint
|
|
router.POST("/models/edit/:name", localai.EditModelEndpoint(cl, ml, appConfig), adminMiddleware)
|
|
|
|
// List model aliases endpoint
|
|
router.GET("/api/aliases", localai.ListAliasesEndpoint(cl), adminMiddleware)
|
|
|
|
// Toggle model enable/disable endpoint
|
|
router.PUT("/models/toggle-state/:name/:action", localai.ToggleStateModelEndpoint(cl, ml, appConfig), adminMiddleware)
|
|
|
|
// Toggle model pinned status endpoint
|
|
router.PUT("/models/toggle-pinned/:name/:action", localai.TogglePinnedModelEndpoint(cl, appConfig, func() {
|
|
app.SyncPinnedModelsToWatchdog()
|
|
}), adminMiddleware)
|
|
|
|
// Reload models endpoint
|
|
router.POST("/models/reload", localai.ReloadModelsEndpoint(cl, appConfig), adminMiddleware)
|
|
}
|
|
|
|
detectionHandler := localai.DetectionEndpoint(cl, ml, appConfig)
|
|
router.POST("/v1/detection",
|
|
detectionHandler,
|
|
requestExtractor.BuildFilteredFirstAvailableDefaultModel(config.BuildUsecaseFilterFn(config.FLAG_DETECTION)),
|
|
requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.DetectionRequest) }))
|
|
|
|
depthHandler := localai.DepthEndpoint(cl, ml, appConfig)
|
|
router.POST("/v1/depth",
|
|
depthHandler,
|
|
requestExtractor.BuildFilteredFirstAvailableDefaultModel(config.BuildUsecaseFilterFn(config.FLAG_DEPTH)),
|
|
requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.DepthRequest) }))
|
|
|
|
// Face recognition endpoints
|
|
faceMw := []echo.MiddlewareFunc{
|
|
requestExtractor.BuildFilteredFirstAvailableDefaultModel(config.BuildUsecaseFilterFn(config.FLAG_FACE_RECOGNITION)),
|
|
}
|
|
router.POST("/v1/face/verify",
|
|
localai.FaceVerifyEndpoint(cl, ml, appConfig),
|
|
append(faceMw, requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.FaceVerifyRequest) }))...)
|
|
router.POST("/v1/face/analyze",
|
|
localai.FaceAnalyzeEndpoint(cl, ml, appConfig),
|
|
append(faceMw, requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.FaceAnalyzeRequest) }))...)
|
|
router.POST("/v1/face/embed",
|
|
localai.FaceEmbedEndpoint(cl, ml, appConfig),
|
|
append(faceMw, requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.FaceEmbedRequest) }))...)
|
|
router.POST("/v1/face/register",
|
|
localai.FaceRegisterEndpoint(cl, ml, appConfig, app.FaceRegistry()),
|
|
append(faceMw, requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.FaceRegisterRequest) }))...)
|
|
router.POST("/v1/face/identify",
|
|
localai.FaceIdentifyEndpoint(cl, ml, appConfig, app.FaceRegistry()),
|
|
append(faceMw, requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.FaceIdentifyRequest) }))...)
|
|
// Forget does not load a face model — it only needs the registry.
|
|
router.POST("/v1/face/forget", localai.FaceForgetEndpoint(app.FaceRegistry()))
|
|
|
|
// Voice (speaker) recognition endpoints
|
|
voiceMw := []echo.MiddlewareFunc{
|
|
requestExtractor.BuildFilteredFirstAvailableDefaultModel(config.BuildUsecaseFilterFn(config.FLAG_SPEAKER_RECOGNITION)),
|
|
}
|
|
router.POST("/v1/voice/verify",
|
|
localai.VoiceVerifyEndpoint(cl, ml, appConfig),
|
|
append(voiceMw, requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.VoiceVerifyRequest) }))...)
|
|
router.POST("/v1/voice/analyze",
|
|
localai.VoiceAnalyzeEndpoint(cl, ml, appConfig),
|
|
append(voiceMw, requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.VoiceAnalyzeRequest) }))...)
|
|
router.POST("/v1/voice/embed",
|
|
localai.VoiceEmbedEndpoint(cl, ml, appConfig),
|
|
append(voiceMw, requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.VoiceEmbedRequest) }))...)
|
|
router.POST("/v1/voice/register",
|
|
localai.VoiceRegisterEndpoint(cl, ml, appConfig, app.VoiceRegistry()),
|
|
append(voiceMw, requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.VoiceRegisterRequest) }))...)
|
|
router.POST("/v1/voice/identify",
|
|
localai.VoiceIdentifyEndpoint(cl, ml, appConfig, app.VoiceRegistry()),
|
|
append(voiceMw, requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.VoiceIdentifyRequest) }))...)
|
|
// Forget does not load a voice model — it only needs the registry.
|
|
router.POST("/v1/voice/forget", localai.VoiceForgetEndpoint(app.VoiceRegistry()))
|
|
|
|
ttsHandler := localai.TTSEndpoint(cl, ml, appConfig)
|
|
router.POST("/tts",
|
|
ttsHandler,
|
|
requestExtractor.BuildFilteredFirstAvailableDefaultModel(config.BuildUsecaseFilterFn(config.FLAG_TTS)),
|
|
requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.TTSRequest) }))
|
|
|
|
// audio transform (echo cancellation, noise suppression, voice conversion, etc.)
|
|
audioTransformHandler := localai.AudioTransformEndpoint(cl, ml, appConfig)
|
|
audioTransformMiddleware := []echo.MiddlewareFunc{
|
|
middleware.TraceMiddleware(app),
|
|
requestExtractor.BuildFilteredFirstAvailableDefaultModel(config.BuildUsecaseFilterFn(config.FLAG_AUDIO_TRANSFORM)),
|
|
requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.AudioTransformRequest) }),
|
|
}
|
|
router.POST("/audio/transformations", audioTransformHandler, audioTransformMiddleware...)
|
|
router.POST("/audio/transform", audioTransformHandler, audioTransformMiddleware...)
|
|
|
|
// audio transform streaming WS (sits before the request-extractor pipeline —
|
|
// the upgrade is handled by the endpoint itself).
|
|
router.GET("/audio/transformations/stream",
|
|
localai.AudioTransformStreamEndpoint(app),
|
|
middleware.TraceMiddleware(app))
|
|
|
|
vadHandler := localai.VADEndpoint(cl, ml, appConfig)
|
|
vadNodeHeader := middleware.ExposeNodeHeader(appConfig)
|
|
router.POST("/vad",
|
|
vadHandler,
|
|
vadNodeHeader,
|
|
requestExtractor.BuildFilteredFirstAvailableDefaultModel(config.BuildUsecaseFilterFn(config.FLAG_VAD)),
|
|
requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.VADRequest) }))
|
|
router.POST("/v1/vad",
|
|
vadHandler,
|
|
vadNodeHeader,
|
|
requestExtractor.BuildFilteredFirstAvailableDefaultModel(config.BuildUsecaseFilterFn(config.FLAG_VAD)),
|
|
requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.VADRequest) }))
|
|
|
|
// Stores
|
|
router.POST("/stores/set", localai.StoresSetEndpoint(ml, appConfig))
|
|
router.POST("/stores/delete", localai.StoresDeleteEndpoint(ml, appConfig))
|
|
router.POST("/stores/get", localai.StoresGetEndpoint(ml, appConfig))
|
|
router.POST("/stores/find", localai.StoresFindEndpoint(ml, appConfig))
|
|
|
|
if !appConfig.DisableMetrics {
|
|
router.GET("/metrics", localai.LocalAIMetricsEndpoint(), adminMiddleware)
|
|
}
|
|
|
|
videoHandler := localai.VideoEndpoint(cl, ml, appConfig)
|
|
router.POST("/video",
|
|
videoHandler,
|
|
requestExtractor.BuildFilteredFirstAvailableDefaultModel(config.BuildUsecaseFilterFn(config.FLAG_VIDEO)),
|
|
requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.VideoRequest) }))
|
|
|
|
// Backend Statistics Module
|
|
// TODO: Should these use standard middlewares? Refactor later, they are extremely simple.
|
|
backendMonitorService := monitoring.NewBackendMonitorService(ml, cl, appConfig) // Split out for now
|
|
router.GET("/backend/monitor", localai.BackendMonitorEndpoint(backendMonitorService), adminMiddleware)
|
|
router.POST("/backend/shutdown", localai.BackendShutdownEndpoint(backendMonitorService), adminMiddleware)
|
|
// The v1/* urls are exactly the same as above - makes local e2e testing easier if they are registered.
|
|
router.GET("/v1/backend/monitor", localai.BackendMonitorEndpoint(backendMonitorService), adminMiddleware)
|
|
router.POST("/v1/backend/shutdown", localai.BackendShutdownEndpoint(backendMonitorService), adminMiddleware)
|
|
|
|
// Traces and backend logs (monitoring)
|
|
router.GET("/api/traces", localai.GetAPITracesEndpoint(), adminMiddleware)
|
|
router.POST("/api/traces/clear", localai.ClearAPITracesEndpoint(), adminMiddleware)
|
|
router.GET("/api/backend-traces", localai.GetBackendTracesEndpoint(), adminMiddleware)
|
|
router.POST("/api/backend-traces/clear", localai.ClearBackendTracesEndpoint(), adminMiddleware)
|
|
// Backend logs — standalone only (distributed mode uses node-proxied routes)
|
|
if !appConfig.Distributed.Enabled {
|
|
router.GET("/api/backend-logs", localai.ListBackendLogsEndpoint(ml), adminMiddleware)
|
|
router.GET("/api/backend-logs/:modelId", localai.GetBackendLogsEndpoint(ml), adminMiddleware)
|
|
router.POST("/api/backend-logs/:modelId/clear", localai.ClearBackendLogsEndpoint(ml), adminMiddleware)
|
|
router.GET("/ws/backend-logs/:modelId", localai.BackendLogsWebSocketEndpoint(ml), adminMiddleware)
|
|
}
|
|
|
|
// p2p
|
|
router.GET("/api/p2p", localai.ShowP2PNodes(appConfig), adminMiddleware)
|
|
router.GET("/api/p2p/token", localai.ShowP2PToken(appConfig), adminMiddleware)
|
|
|
|
// Score (logprob over candidate continuations) — admin-only smoke-test
|
|
// surface for the gRPC Score primitive. Production consumers should
|
|
// use application.ScorerFactory() directly rather than HTTP.
|
|
router.POST("/api/score", localai.ScoreEndpoint(cl, ml, appConfig), adminMiddleware)
|
|
|
|
router.GET("/version", func(c echo.Context) error {
|
|
return c.JSON(200, struct {
|
|
Version string `json:"version"`
|
|
}{Version: internal.PrintableVersion()})
|
|
})
|
|
|
|
// Agent discovery endpoint
|
|
router.GET("/.well-known/localai.json", func(c echo.Context) error {
|
|
monitoringRoutes := map[string]string{
|
|
"metrics": "/metrics",
|
|
"backend_monitor": "/backend/monitor",
|
|
"backend_shutdown": "/backend/shutdown",
|
|
"system": "/system",
|
|
"version": "/version",
|
|
"traces": "/api/traces",
|
|
"traces_clear": "/api/traces/clear",
|
|
"backend_traces": "/api/backend-traces",
|
|
"backend_traces_clear": "/api/backend-traces/clear",
|
|
}
|
|
if !appConfig.Distributed.Enabled {
|
|
monitoringRoutes["backend_logs"] = "/api/backend-logs"
|
|
monitoringRoutes["backend_logs_model"] = "/api/backend-logs/:modelId"
|
|
monitoringRoutes["backend_logs_clear"] = "/api/backend-logs/:modelId/clear"
|
|
monitoringRoutes["backend_logs_ws"] = "/ws/backend-logs/:modelId"
|
|
} else {
|
|
monitoringRoutes["node_backend_logs"] = "/api/nodes/:id/backend-logs"
|
|
monitoringRoutes["node_backend_logs_model"] = "/api/nodes/:id/backend-logs/:modelId"
|
|
monitoringRoutes["node_backend_logs_ws"] = "/ws/nodes/:id/backend-logs/:modelId"
|
|
}
|
|
return c.JSON(200, map[string]any{
|
|
"version": internal.PrintableVersion(),
|
|
// Flat endpoint list for backwards compatibility
|
|
"endpoints": map[string]any{
|
|
"models": "/v1/models",
|
|
"chat_completions": "/v1/chat/completions",
|
|
"completions": "/v1/completions",
|
|
"embeddings": "/v1/embeddings",
|
|
"config_metadata": "/api/models/config-metadata",
|
|
"config_json": "/api/models/config-json/:name",
|
|
"config_patch": "/api/models/config-json/:name",
|
|
"autocomplete": "/api/models/config-metadata/autocomplete/:provider",
|
|
"vram_estimate": "/api/models/vram-estimate",
|
|
"tts": "/tts",
|
|
"transcription": "/v1/audio/transcriptions",
|
|
"image_generation": "/v1/images/generations",
|
|
"swagger": "/swagger/index.html",
|
|
"instructions": "/api/instructions",
|
|
},
|
|
// Categorized endpoint groups for structured discovery
|
|
"endpoint_groups": map[string]any{
|
|
"openai_compatible": map[string]string{
|
|
"models": "/v1/models",
|
|
"chat_completions": "/v1/chat/completions",
|
|
"completions": "/v1/completions",
|
|
"embeddings": "/v1/embeddings",
|
|
"transcription": "/v1/audio/transcriptions",
|
|
"diarization": "/v1/audio/diarization",
|
|
"sound_classification": "/v1/audio/classification",
|
|
"image_generation": "/v1/images/generations",
|
|
},
|
|
"config_management": map[string]string{
|
|
"config_metadata": "/api/models/config-metadata",
|
|
"config_json": "/api/models/config-json/:name",
|
|
"config_patch": "/api/models/config-json/:name",
|
|
"autocomplete": "/api/models/config-metadata/autocomplete/:provider",
|
|
"vram_estimate": "/api/models/vram-estimate",
|
|
},
|
|
"model_management": map[string]string{
|
|
"list_gallery": "/models/available",
|
|
"install": "/models/apply",
|
|
"delete": "/models/delete/:name",
|
|
"edit": "/models/edit/:name",
|
|
"import": "/models/import",
|
|
"reload": "/models/reload",
|
|
"list_aliases": "/api/aliases",
|
|
},
|
|
"ai_functions": map[string]string{
|
|
"tts": "/tts",
|
|
"vad": "/vad",
|
|
"video": "/video",
|
|
"detection": "/v1/detection",
|
|
"tokenize": "/v1/tokenize",
|
|
},
|
|
"monitoring": monitoringRoutes,
|
|
"mcp": map[string]string{
|
|
"chat_completions": "/v1/mcp/chat/completions",
|
|
"servers": "/v1/mcp/servers/:model",
|
|
"prompts": "/v1/mcp/prompts/:model",
|
|
"resources": "/v1/mcp/resources/:model",
|
|
},
|
|
"p2p": map[string]string{
|
|
"nodes": "/api/p2p",
|
|
"token": "/api/p2p/token",
|
|
},
|
|
"agents": map[string]string{
|
|
"tasks": "/api/agent/tasks",
|
|
"jobs": "/api/agent/jobs",
|
|
"execute": "/api/agent/jobs/execute",
|
|
},
|
|
"settings": map[string]string{
|
|
"get": "/api/settings",
|
|
"update": "/api/settings",
|
|
},
|
|
"stores": map[string]string{
|
|
"set": "/stores/set",
|
|
"get": "/stores/get",
|
|
"find": "/stores/find",
|
|
"delete": "/stores/delete",
|
|
},
|
|
"docs": map[string]string{
|
|
"swagger": "/swagger/index.html",
|
|
"instructions": "/api/instructions",
|
|
},
|
|
},
|
|
"capabilities": map[string]bool{
|
|
"config_metadata": true,
|
|
"config_patch": true,
|
|
"vram_estimate": true,
|
|
"mcp": !appConfig.DisableMCP,
|
|
"agents": appConfig.AgentPool.Enabled,
|
|
"p2p": appConfig.P2PToken != "",
|
|
"tracing": true,
|
|
},
|
|
})
|
|
})
|
|
|
|
// API instructions for agent discovery (no auth — agents should discover these without credentials)
|
|
router.GET("/api/instructions", localai.ListAPIInstructionsEndpoint())
|
|
router.GET("/api/instructions/:name", localai.GetAPIInstructionEndpoint())
|
|
|
|
router.GET("/api/features", func(c echo.Context) error {
|
|
return c.JSON(200, map[string]bool{
|
|
"agents": appConfig.AgentPool.Enabled,
|
|
"mcp": !appConfig.DisableMCP,
|
|
"fine_tuning": true,
|
|
"quantization": true,
|
|
"distributed": appConfig.Distributed.Enabled,
|
|
"localai_assistant": !appConfig.DisableLocalAIAssistant && app.LocalAIAssistant() != nil,
|
|
})
|
|
})
|
|
|
|
router.GET("/system", localai.SystemInformations(ml, appConfig), adminMiddleware)
|
|
|
|
// misc
|
|
tokenizeHandler := localai.TokenizeEndpoint(cl, ml, appConfig)
|
|
router.POST("/v1/tokenize",
|
|
tokenizeHandler,
|
|
requestExtractor.BuildFilteredFirstAvailableDefaultModel(config.BuildUsecaseFilterFn(config.FLAG_TOKENIZE)),
|
|
requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.TokenizeRequest) }))
|
|
|
|
// MCP endpoint - supports both streaming and non-streaming modes
|
|
// Note: streaming mode is NOT compatible with the OpenAI apis. We have a set which streams more states.
|
|
if evaluator != nil && !appConfig.DisableMCP {
|
|
var mcpNATS mcpTools.MCPNATSClient
|
|
if d := app.Distributed(); d != nil {
|
|
mcpNATS = d.Nats
|
|
}
|
|
mcpStreamHandler := localai.MCPEndpoint(cl, ml, evaluator, appConfig, mcpNATS)
|
|
mcpStreamMiddleware := []echo.MiddlewareFunc{
|
|
requestExtractor.BuildFilteredFirstAvailableDefaultModel(config.BuildUsecaseFilterFn(config.FLAG_CHAT)),
|
|
requestExtractor.SetModelAndConfig(func() schema.LocalAIRequest { return new(schema.OpenAIRequest) }),
|
|
func(next echo.HandlerFunc) echo.HandlerFunc {
|
|
return func(c echo.Context) error {
|
|
if err := requestExtractor.SetOpenAIRequest(c); err != nil {
|
|
return err
|
|
}
|
|
return next(c)
|
|
}
|
|
},
|
|
}
|
|
router.POST("/v1/mcp/chat/completions", mcpStreamHandler, mcpStreamMiddleware...)
|
|
router.POST("/mcp/v1/chat/completions", mcpStreamHandler, mcpStreamMiddleware...)
|
|
router.POST("/mcp/chat/completions", mcpStreamHandler, mcpStreamMiddleware...)
|
|
|
|
// MCP server listing endpoint
|
|
router.GET("/v1/mcp/servers/:model", localai.MCPServersEndpoint(cl, appConfig, mcpNATS), mcpMw)
|
|
|
|
// MCP prompts endpoints
|
|
router.GET("/v1/mcp/prompts/:model", localai.MCPPromptsEndpoint(cl, appConfig), mcpMw)
|
|
router.POST("/v1/mcp/prompts/:model/:prompt", localai.MCPGetPromptEndpoint(cl, appConfig), mcpMw)
|
|
|
|
// MCP resources endpoints
|
|
router.GET("/v1/mcp/resources/:model", localai.MCPResourcesEndpoint(cl, appConfig), mcpMw)
|
|
router.POST("/v1/mcp/resources/:model/read", localai.MCPReadResourceEndpoint(cl, appConfig), mcpMw)
|
|
|
|
// CORS proxy for client-side MCP connections
|
|
router.GET("/api/cors-proxy", localai.CORSProxyEndpoint(appConfig), mcpMw)
|
|
router.POST("/api/cors-proxy", localai.CORSProxyEndpoint(appConfig), mcpMw)
|
|
router.OPTIONS("/api/cors-proxy", localai.CORSProxyOptionsEndpoint())
|
|
}
|
|
|
|
// Agent job routes (MCP CI Jobs — requires MCP to be enabled)
|
|
if app != nil && app.AgentJobService() != nil && !appConfig.DisableMCP {
|
|
router.POST("/api/agent/tasks", localai.CreateTaskEndpoint(app), mcpJobsMw)
|
|
router.PUT("/api/agent/tasks/:id", localai.UpdateTaskEndpoint(app), mcpJobsMw)
|
|
router.DELETE("/api/agent/tasks/:id", localai.DeleteTaskEndpoint(app), mcpJobsMw)
|
|
router.GET("/api/agent/tasks", localai.ListTasksEndpoint(app), mcpJobsMw)
|
|
router.GET("/api/agent/tasks/:id", localai.GetTaskEndpoint(app), mcpJobsMw)
|
|
|
|
router.POST("/api/agent/jobs/execute", localai.ExecuteJobEndpoint(app), mcpJobsMw)
|
|
router.GET("/api/agent/jobs/:id", localai.GetJobEndpoint(app), mcpJobsMw)
|
|
router.GET("/api/agent/jobs", localai.ListJobsEndpoint(app), mcpJobsMw)
|
|
router.POST("/api/agent/jobs/:id/cancel", localai.CancelJobEndpoint(app), mcpJobsMw)
|
|
router.DELETE("/api/agent/jobs/:id", localai.DeleteJobEndpoint(app), mcpJobsMw)
|
|
|
|
router.POST("/api/agent/tasks/:name/execute", localai.ExecuteTaskByNameEndpoint(app), mcpJobsMw)
|
|
}
|
|
|
|
}
|