mirror of
https://github.com/mudler/LocalAI.git
synced 2026-10-28 09:08:54 -04:00
* feat(config): let model aliases carry an opt-in profile block An alias can now act as a profile of its target through an explicit `profile:` block carrying system_prompt, mcp (remote/stdio servers, plus the new mcp.auto) and the new client_tools. ResolveAlias applies only that block on top of a copy of the target, while Name, Model, Backend and the persisted revision stay the target's. The loader key is therefore unchanged and every profile runs on the target's backend process; today a persona needs a separate model config, which loads the weights a second time. The block is opt-in so existing aliases never change: top-level fields on an alias stay ignored, and an alias without a profile block resolves to exactly the target. A profile block on a non-alias config is rejected. A profile with its own MCP servers caches its sessions under the alias name (MCPSessionKey), because the cache slot keyed on the target's name is invalidated whenever its config hash changes and two server sets would tear each other's sessions down. mcp.auto enables all configured servers on /v1/chat/completions when the request does not name any in metadata.mcp_servers, which plain OpenAI clients cannot send. client_tools: drop discards client tools and tool_choice before the request is merged (chat completions, responses, Anthropic messages), so only the model's own MCP tools are offered. Both keys work on any model and inside an alias's profile block. Refs #12548 Assisted-by: Claude Code:claude-opus-5-5 Signed-off-by: Stefan Walcz <stefan.walcz@walcz.de> * fix(openai): only auto-enable model MCP when MCP is enabled and permitted mcp.auto turns a plain /v1/chat/completions request into a server-side MCP request. It now applies the same controls as the dedicated MCP routes before any server is selected: the instance switch (LOCALAI_DISABLE_MCP) and, with auth on, the caller's "mcp" feature, checked with auth.HasFeatureAccess against the auth database that the chat route now passes to ChatEndpoint. A denied request is answered as a plain chat, without contacting a server or adding tools, rather than rejected: the client did not ask for MCP, it only reached a model that offers it. Endpoint specs drive ChatEndpoint against a counting MCP fixture server: MCP disabled and a user with chat but without mcp see no tools and no connection; MCP enabled and a user with mcp get the fixture tool. The user specs need the auth build tag (SQLite auth database). Assisted-by: Claude Code:claude-opus-5-5 Signed-off-by: Stefan Walcz <stefan.walcz@walcz.de> * fix(mcp): resolve profile aliases in the MCP discovery endpoints GET /v1/mcp/servers/:model, /v1/mcp/prompts/:model and /v1/mcp/resources/:model looked the model up with GetModelConfig, which returns the alias stub. A profile alias carries its servers in its profile block, so the stub has none of its own and the endpoints reported an empty list for an alias whose chat requests do use tools. Resolve the alias the way the request middleware does before reading the MCP config, and open the sessions under MCPSessionKey so discovery shares the profile's session cache slot instead of tearing down the target's. Assisted-by: Claude Code:claude-opus-5-5 Signed-off-by: Stefan Walcz <stefan.walcz@walcz.de> * feat(config): opt-in evidence check for profile aliases A profile with server-side MCP tools (profile.mcp, mcp.auto) runs its tools on the server and returns only the answer text. On the next turn the client sends the history back without those tool calls and results, and the model then tends to skip the tool and answer from nothing. In a measurement on a follow-up question, 0 of 12 turns called the tool and the answers carried invented numbers (e.g. "0" where the true value was 9); with the tool trail kept in the history the tool was called 12 of 12 times. A prompt instruction does not reliably prevent this, so the check sits at the output. New profile keys: profile: evidence_check: numbers: true # enables the check note: "..." # optional, defaults to an English note Rule, per request and stateless: when the check is on, no MCP tool call succeeded on the server during this request (a call that returned an error delivers no evidence and does not count), and the final answer contains a number (\b\d+([.,]\d+)?\b) that occurs in none of the request's input (the profile's system prompt and every message as received, before compression), the note is appended after a blank line. "3,5" and "3.5" count as the same number. In a streamed response the note is one extra content delta before the finish chunk. Choices that hand tool calls to the client are not checked. The setting is only read from a profile block, so plain models and aliases behave as before; a note without numbers: true is rejected at validation. Tests (Ginkgo): the number rule (invented number, number from the input, no numbers, comma/dot decimals, system prompt as evidence, tool ran), the overlay into the resolved config with plain alias, target and a top-level key as counter-checks, validation, and ChatEndpoint specs on a stubbed backend for both paths: note on an invented number, none for a number from the request, none for a profile without the check, none after a successful MCP tool call against an in-process MCP server, and the note again after a failed tool call (arguments that are not JSON). Assisted-by: Claude Code:claude-opus-5-5 Signed-off-by: Stefan Walcz <stefan.walcz@walcz.de> --------- Signed-off-by: Stefan Walcz <stefan.walcz@walcz.de>
918 lines
30 KiB
Go
918 lines
30 KiB
Go
package middleware
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"net/http"
|
|
"strconv"
|
|
"strings"
|
|
|
|
"github.com/google/uuid"
|
|
"github.com/labstack/echo/v4"
|
|
"github.com/mudler/LocalAI/core/config"
|
|
"github.com/mudler/LocalAI/core/schema"
|
|
"github.com/mudler/LocalAI/core/services/failover"
|
|
"github.com/mudler/LocalAI/core/services/galleryop"
|
|
"github.com/mudler/LocalAI/core/templates"
|
|
"github.com/mudler/LocalAI/pkg/diagnostics"
|
|
"github.com/mudler/LocalAI/pkg/distributedhdr"
|
|
"github.com/mudler/LocalAI/pkg/model"
|
|
"github.com/mudler/LocalAI/pkg/utils"
|
|
"github.com/mudler/xlog"
|
|
)
|
|
|
|
type correlationIDKeyType string
|
|
|
|
// CorrelationIDKey to track request across process boundary
|
|
const CorrelationIDKey correlationIDKeyType = "correlationID"
|
|
|
|
type RequestExtractor struct {
|
|
modelConfigLoader *config.ModelConfigLoader
|
|
modelLoader *model.ModelLoader
|
|
applicationConfig *config.ApplicationConfig
|
|
failover *failover.Manager
|
|
}
|
|
|
|
func NewRequestExtractor(modelConfigLoader *config.ModelConfigLoader, modelLoader *model.ModelLoader, applicationConfig *config.ApplicationConfig) *RequestExtractor {
|
|
return &RequestExtractor{
|
|
modelConfigLoader: modelConfigLoader,
|
|
modelLoader: modelLoader,
|
|
applicationConfig: applicationConfig,
|
|
}
|
|
}
|
|
|
|
// getRequestContext returns the request context, adding optional diagnostics
|
|
// once and retaining them on the request for subsequent middleware and retries.
|
|
func (re *RequestExtractor) getRequestContext(c echo.Context) context.Context {
|
|
ctx := c.Request().Context()
|
|
if re.applicationConfig == nil || re.applicationConfig.DiagnosticsRecorder == nil {
|
|
return ctx
|
|
}
|
|
observed := re.applicationConfig.DiagnosticsRecorder.Request(ctx)
|
|
if observed != ctx {
|
|
c.SetRequest(c.Request().WithContext(observed))
|
|
c.Response().Header().Set(diagnostics.HeaderDiagnosticID, diagnostics.RequestID(observed))
|
|
}
|
|
return observed
|
|
}
|
|
|
|
const CONTEXT_LOCALS_KEY_MODEL_NAME = "MODEL_NAME"
|
|
const CONTEXT_LOCALS_KEY_LOCALAI_REQUEST = "LOCALAI_REQUEST"
|
|
const CONTEXT_LOCALS_KEY_MODEL_CONFIG = "MODEL_CONFIG"
|
|
|
|
// TODO: Refactor to not return error if unchanged
|
|
func (re *RequestExtractor) setModelNameFromRequest(c echo.Context) {
|
|
ctx := re.getRequestContext(c)
|
|
model, ok := c.Get(CONTEXT_LOCALS_KEY_MODEL_NAME).(string)
|
|
if ok && model != "" {
|
|
return
|
|
}
|
|
model = c.Param("model")
|
|
|
|
if model == "" {
|
|
model = c.QueryParam("model")
|
|
}
|
|
|
|
// Check FormValue for multipart/form-data requests (e.g., /v1/images/inpainting)
|
|
if model == "" {
|
|
model = c.FormValue("model")
|
|
}
|
|
|
|
if model == "" {
|
|
// Set model from bearer token, if available
|
|
auth := c.Request().Header.Get("Authorization")
|
|
bearer := strings.TrimPrefix(auth, "Bearer ")
|
|
if bearer != "" && bearer != auth {
|
|
end := diagnostics.Begin(ctx, diagnostics.PhaseBearerLookup)
|
|
// Exact-name check: a configured name or one file in the models
|
|
// directory. It never enumerates the directory.
|
|
exists := galleryop.CheckExactModelExists(re.modelConfigLoader, re.modelLoader, bearer)
|
|
end(diagnosticOutcome(ctx, false), 0)
|
|
if exists {
|
|
model = bearer
|
|
}
|
|
}
|
|
}
|
|
|
|
c.Set(CONTEXT_LOCALS_KEY_MODEL_NAME, model)
|
|
}
|
|
|
|
func (re *RequestExtractor) BuildConstantDefaultModelNameMiddleware(defaultModelName string) echo.MiddlewareFunc {
|
|
return func(next echo.HandlerFunc) echo.HandlerFunc {
|
|
return func(c echo.Context) (err error) {
|
|
finish := re.beginExtraction(c)
|
|
defer func() { finish(err) }()
|
|
re.setModelNameFromRequest(c)
|
|
localModelName, ok := c.Get(CONTEXT_LOCALS_KEY_MODEL_NAME).(string)
|
|
if !ok || localModelName == "" {
|
|
c.Set(CONTEXT_LOCALS_KEY_MODEL_NAME, defaultModelName)
|
|
xlog.Debug("context local model name not found, setting to default", "defaultModelName", defaultModelName)
|
|
}
|
|
finish(nil)
|
|
return next(c)
|
|
}
|
|
}
|
|
}
|
|
|
|
func (re *RequestExtractor) BuildFilteredFirstAvailableDefaultModel(filterFn config.ModelConfigFilterFn) echo.MiddlewareFunc {
|
|
return func(next echo.HandlerFunc) echo.HandlerFunc {
|
|
return func(c echo.Context) (err error) {
|
|
finish := re.beginExtraction(c)
|
|
defer func() { finish(err) }()
|
|
re.setModelNameFromRequest(c)
|
|
localModelName := c.Get(CONTEXT_LOCALS_KEY_MODEL_NAME).(string)
|
|
if localModelName != "" { // Don't overwrite existing values
|
|
finish(nil)
|
|
return next(c)
|
|
}
|
|
|
|
ctx := c.Request().Context()
|
|
end := diagnostics.Begin(ctx, diagnostics.PhaseDefaultListing)
|
|
// A filter that rejects unconfigured files (every usecase filter)
|
|
// gains nothing from reading the models directory, so skip it.
|
|
policy := galleryop.SKIP_IF_CONFIGURED
|
|
if !config.FilterMayMatchLooseFiles(filterFn) {
|
|
policy = galleryop.SKIP_ALWAYS
|
|
}
|
|
modelNames, err := galleryop.ListModelsContext(ctx, re.modelConfigLoader, re.modelLoader, filterFn, policy)
|
|
end(diagnosticOutcome(ctx, err != nil), len(modelNames))
|
|
if err != nil {
|
|
xlog.Error("non-fatal error calling ListModels during SetDefaultModelNameToFirstAvailable()", "error", err)
|
|
finish(err)
|
|
return next(c)
|
|
}
|
|
|
|
if len(modelNames) == 0 {
|
|
xlog.Warn("SetDefaultModelNameToFirstAvailable used with no matching models installed")
|
|
// This is non-fatal - making it so was breaking the case of direct installation of raw models
|
|
// return errors.New("this endpoint requires at least one model to be installed")
|
|
finish(nil)
|
|
return next(c)
|
|
}
|
|
|
|
c.Set(CONTEXT_LOCALS_KEY_MODEL_NAME, modelNames[0])
|
|
xlog.Debug("context local model name not found, setting to the first model", "first model name", modelNames[0])
|
|
finish(nil)
|
|
return next(c)
|
|
}
|
|
}
|
|
}
|
|
|
|
// TODO: If context and cancel above belong on all methods, move that part of above into here!
|
|
// Otherwise, it's in its own method below for now
|
|
func (re *RequestExtractor) SetModelAndConfig(initializer func() schema.LocalAIRequest) echo.MiddlewareFunc {
|
|
return re.setModelAndConfig(initializer, nil)
|
|
}
|
|
|
|
// SetModelAndConfigWithDefault defers legacy model discovery until binding has
|
|
// established that the request has no model. Binding stays inside each retry.
|
|
func (re *RequestExtractor) SetModelAndConfigWithDefault(initializer func() schema.LocalAIRequest, filter config.ModelConfigFilterFn) echo.MiddlewareFunc {
|
|
fallback := re.BuildFilteredFirstAvailableDefaultModel(filter)(func(echo.Context) error { return nil })
|
|
return re.setModelAndConfig(initializer, fallback)
|
|
}
|
|
|
|
func (re *RequestExtractor) setModelAndConfig(initializer func() schema.LocalAIRequest, fallback echo.HandlerFunc) echo.MiddlewareFunc {
|
|
return func(next echo.HandlerFunc) echo.HandlerFunc {
|
|
retry := re.failoverRetry(func(c echo.Context) (err error) {
|
|
finish := re.beginExtraction(c)
|
|
defer func() { finish(err) }()
|
|
input := initializer()
|
|
if input == nil {
|
|
return echo.NewHTTPError(http.StatusBadRequest, "unable to initialize body")
|
|
}
|
|
if err := c.Bind(input); err != nil {
|
|
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("failed parsing request body: %v", err))
|
|
}
|
|
|
|
if input.ModelName(nil) == "" && fallback != nil {
|
|
if err := fallback(c); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
// If this request doesn't have an associated model name, fetch it from earlier in the middleware chain
|
|
if input.ModelName(nil) == "" {
|
|
localModelName, ok := c.Get(CONTEXT_LOCALS_KEY_MODEL_NAME).(string)
|
|
if ok && localModelName != "" {
|
|
xlog.Debug("overriding empty model name in request body with value found earlier in middleware chain", "context localModelName", localModelName)
|
|
input.ModelName(&localModelName)
|
|
}
|
|
}
|
|
|
|
modelName := input.ModelName(nil)
|
|
// Ollama-compat /api/tags appends ":latest" to untagged names.
|
|
// Strip it for lookup so the listed name works on /api/chat,
|
|
// /v1/chat/completions, and the other model-bearing endpoints.
|
|
if strings.HasSuffix(modelName, ":latest") {
|
|
modelName = strings.TrimSuffix(modelName, ":latest")
|
|
}
|
|
ctx := c.Request().Context()
|
|
endConfig := diagnostics.Begin(ctx, diagnostics.PhaseConfigLoadDefaults)
|
|
cfg, err := re.modelConfigLoader.LoadModelConfigFileByNameDefaultOptions(modelName, re.applicationConfig)
|
|
endConfig(diagnosticOutcome(ctx, err != nil), 0)
|
|
|
|
if err != nil {
|
|
xlog.Warn("Model Configuration File not found", "model", modelName, "error", err)
|
|
} else if cfg.Model == "" && modelName != "" {
|
|
xlog.Debug("config does not include model, using input", "input.ModelName", modelName)
|
|
cfg.Model = modelName
|
|
}
|
|
|
|
// If a model name was specified, verify it actually exists before proceeding.
|
|
// Check both configured models and loose model files in the model path.
|
|
// Skip the check for HuggingFace model IDs (contain "/") since backends
|
|
// like diffusers may download these on the fly.
|
|
if modelName != "" && !strings.Contains(modelName, "/") {
|
|
endLookup := diagnostics.Begin(ctx, diagnostics.PhaseBodyLookup)
|
|
exists, existsErr := galleryop.CheckRequestModelExistsContext(ctx, re.modelConfigLoader, re.modelLoader, modelName)
|
|
endLookup(diagnosticOutcome(ctx, existsErr != nil || !exists), 0)
|
|
if existsErr == nil && !exists {
|
|
return c.JSON(http.StatusNotFound, schema.ErrorResponse{
|
|
Error: &schema.APIError{
|
|
Message: fmt.Sprintf("model %q not found. To see available models, call GET /v1/models", modelName),
|
|
Code: http.StatusNotFound,
|
|
Type: "invalid_request_error",
|
|
},
|
|
})
|
|
}
|
|
}
|
|
|
|
// Resolve a model alias to its target before the disabled check and
|
|
// before storing MODEL_CONFIG, so every modality (chat, embeddings,
|
|
// tts, image, ...) inherits redirection. The response keeps echoing
|
|
// the alias name (input.ModelName is left unchanged); usage accounting
|
|
// records requested=alias / served=target.
|
|
if cfg != nil && cfg.IsAlias() {
|
|
endAlias := diagnostics.Begin(ctx, diagnostics.PhaseAliasResolution)
|
|
resolved, _, aliasErr := re.modelConfigLoader.ResolveAlias(cfg)
|
|
endAlias(diagnosticOutcome(ctx, aliasErr != nil), 0)
|
|
if aliasErr != nil {
|
|
return c.JSON(http.StatusBadRequest, schema.ErrorResponse{
|
|
Error: &schema.APIError{
|
|
Message: aliasErr.Error(),
|
|
Code: http.StatusBadRequest,
|
|
Type: "invalid_request_error",
|
|
},
|
|
})
|
|
}
|
|
c.Set(ContextKeyRequestedModel, modelName)
|
|
c.Set(ContextKeyServedModel, resolved.Name)
|
|
cfg = resolved
|
|
}
|
|
|
|
// A failover chain resolves to one of its targets, like an alias.
|
|
// failoverRetry re-runs this middleware for the next target.
|
|
if cfg != nil && cfg.IsFailover() {
|
|
resolved, fErr := re.resolveFailover(c, modelName, cfg)
|
|
if fErr != nil {
|
|
return c.JSON(http.StatusServiceUnavailable, schema.ErrorResponse{
|
|
Error: &schema.APIError{
|
|
Message: fErr.Error(),
|
|
Code: http.StatusServiceUnavailable,
|
|
Type: "failover_unavailable",
|
|
},
|
|
})
|
|
}
|
|
cfg = resolved
|
|
} else {
|
|
stopFailoverRecording(c)
|
|
}
|
|
|
|
// Check if the model is disabled
|
|
if cfg != nil && cfg.IsDisabled() {
|
|
return c.JSON(http.StatusForbidden, schema.ErrorResponse{
|
|
Error: &schema.APIError{
|
|
Message: fmt.Sprintf("model %q is disabled and cannot be loaded. Enable it via the System page or API to use it.", modelName),
|
|
Code: http.StatusForbidden,
|
|
Type: "model_disabled",
|
|
},
|
|
})
|
|
}
|
|
|
|
c.Set(CONTEXT_LOCALS_KEY_LOCALAI_REQUEST, input)
|
|
c.Set(CONTEXT_LOCALS_KEY_MODEL_CONFIG, cfg)
|
|
|
|
finish(nil)
|
|
return next(c)
|
|
})
|
|
return func(c echo.Context) error {
|
|
// Retries restore the entry request, so attach its observation before
|
|
// failover captures it. Extraction spans remain per attempt above.
|
|
re.getRequestContext(c)
|
|
return retry(c)
|
|
}
|
|
}
|
|
}
|
|
|
|
func (re *RequestExtractor) SetOpenAIRequest(c echo.Context) (err error) {
|
|
finish := re.beginExtraction(c)
|
|
defer func() { finish(err) }()
|
|
input, ok := c.Get(CONTEXT_LOCALS_KEY_LOCALAI_REQUEST).(*schema.OpenAIRequest)
|
|
if !ok || input.Model == "" {
|
|
return echo.ErrBadRequest
|
|
}
|
|
|
|
cfg, ok := c.Get(CONTEXT_LOCALS_KEY_MODEL_CONFIG).(*config.ModelConfig)
|
|
if !ok || cfg == nil {
|
|
return echo.ErrBadRequest
|
|
}
|
|
|
|
// Extract or generate the correlation ID
|
|
correlationID := c.Request().Header.Get("X-Correlation-ID")
|
|
if correlationID == "" {
|
|
correlationID = uuid.New().String()
|
|
}
|
|
c.Response().Header().Set("X-Correlation-ID", correlationID)
|
|
|
|
// Use the request context directly - Echo properly supports context cancellation!
|
|
// No need for workarounds like handleConnectionCancellation
|
|
reqCtx := re.getRequestContext(c)
|
|
c1, cancel := context.WithCancel(re.applicationConfig.Context)
|
|
|
|
// Cancel when request context is cancelled (client disconnects)
|
|
go func() {
|
|
select {
|
|
case <-reqCtx.Done():
|
|
cancel()
|
|
case <-c1.Done():
|
|
// Already cancelled
|
|
}
|
|
}()
|
|
|
|
// Add the correlation ID to the new context
|
|
ctxWithCorrelationID := context.WithValue(c1, CorrelationIDKey, correlationID)
|
|
ctxWithCorrelationID = distributedhdr.Inherit(ctxWithCorrelationID, reqCtx)
|
|
ctxWithCorrelationID = diagnostics.Inherit(ctxWithCorrelationID, reqCtx)
|
|
|
|
input.Context = ctxWithCorrelationID
|
|
input.Cancel = cancel
|
|
|
|
// Router inputs must be classified before any candidate-specific media fetch.
|
|
if cfg.HasRouter() {
|
|
return nil
|
|
}
|
|
|
|
err = mergeOpenAIRequestAndModelConfig(cfg, input)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if cfg.Model == "" {
|
|
xlog.Debug("replacing empty cfg.Model with input value", "input.Model", input.Model)
|
|
cfg.Model = input.Model
|
|
}
|
|
|
|
c.Set(CONTEXT_LOCALS_KEY_LOCALAI_REQUEST, input)
|
|
c.Set(CONTEXT_LOCALS_KEY_MODEL_CONFIG, cfg)
|
|
|
|
return nil
|
|
}
|
|
|
|
// extractToolChoiceFunctionName parses a tool_choice map and returns the
|
|
// specific function name. Accepts both the OpenAI-spec nested shape
|
|
// ({type:function, function:{name:...}}) and the legacy/Anthropic-compat
|
|
// flat shape ({type:function, name:...}); the nested form wins when both
|
|
// are present. Returns "" for malformed input or when the shape names a
|
|
// mode rather than a specific tool.
|
|
func extractToolChoiceFunctionName(m map[string]any) string {
|
|
tcType, ok := m["type"].(string)
|
|
if !ok || tcType != "function" {
|
|
return ""
|
|
}
|
|
if fn, ok := m["function"].(map[string]any); ok {
|
|
if n, ok := fn["name"].(string); ok && n != "" {
|
|
return n
|
|
}
|
|
}
|
|
if n, ok := m["name"].(string); ok {
|
|
return n
|
|
}
|
|
return ""
|
|
}
|
|
|
|
func mergeOpenAIRequestAndModelConfig(config *config.ModelConfig, input *schema.OpenAIRequest) error {
|
|
// Discard client tools before anything below derives functions or a forced
|
|
// tool_choice from them; the model's own MCP tools are injected later.
|
|
if config.DropsClientTools() {
|
|
input.Tools = nil
|
|
input.Functions = nil
|
|
input.ToolsChoice = nil
|
|
input.FunctionCall = nil
|
|
}
|
|
if input.Echo {
|
|
config.Echo = input.Echo
|
|
}
|
|
if input.TopK != nil {
|
|
config.TopK = input.TopK
|
|
}
|
|
if input.TopP != nil {
|
|
config.TopP = input.TopP
|
|
}
|
|
if input.MinP != nil {
|
|
config.MinP = input.MinP
|
|
}
|
|
|
|
if input.Backend != "" {
|
|
config.Backend = input.Backend
|
|
}
|
|
|
|
if input.ClipSkip != 0 {
|
|
config.Diffusers.ClipSkip = input.ClipSkip
|
|
}
|
|
|
|
if input.NegativePromptScale != 0 {
|
|
config.NegativePromptScale = input.NegativePromptScale
|
|
}
|
|
|
|
if input.NegativePrompt != "" {
|
|
config.NegativePrompt = input.NegativePrompt
|
|
}
|
|
|
|
if input.RopeFreqBase != 0 {
|
|
config.RopeFreqBase = input.RopeFreqBase
|
|
}
|
|
|
|
if input.RopeFreqScale != 0 {
|
|
config.RopeFreqScale = input.RopeFreqScale
|
|
}
|
|
|
|
if input.Grammar != "" {
|
|
config.Grammar = input.Grammar
|
|
}
|
|
|
|
if input.Temperature != nil {
|
|
config.Temperature = input.Temperature
|
|
}
|
|
|
|
// Resolve the effective reasoning effort (request overrides the model config
|
|
// default), store it so gRPCPredictOpts forwards it to the backend as the
|
|
// reasoning_effort chat_template_kwarg (what gpt-oss / LFM2.5 read), and map
|
|
// it onto the enable_thinking toggle. "none" disables thinking (the #10072
|
|
// use case); a level enables it unless the config already disabled reasoning
|
|
// (an operator's explicit disable wins over a request asking to think).
|
|
config.ApplyReasoningEffort(input.ReasoningEffort)
|
|
|
|
// Forward the client's request metadata so chat-template kwargs set per-request
|
|
// (enable_thinking, reasoning_effort, preserve_thinking, ...) reach the backend
|
|
// and override the model's reasoning-config defaults. See gRPCPredictOpts.
|
|
if len(input.Metadata) > 0 {
|
|
config.RequestMetadata = input.Metadata
|
|
}
|
|
|
|
// Collapse the modern max_completion_tokens alias into the
|
|
// legacy Maxtokens field so downstream code reads exactly one.
|
|
// MaxCompletionTokens wins on conflict — it's the canonical
|
|
// name per OpenAI's deprecation guidance, and a client that
|
|
// took the trouble to send it intends that value. Clearing
|
|
// the sibling prevents both names from being emitted if input
|
|
// is re-marshaled (cloud-proxy passthrough).
|
|
if input.MaxCompletionTokens != nil {
|
|
input.Maxtokens = input.MaxCompletionTokens
|
|
input.MaxCompletionTokens = nil
|
|
}
|
|
if input.Maxtokens != nil {
|
|
config.Maxtokens = input.Maxtokens
|
|
}
|
|
|
|
if input.ResponseFormat != nil {
|
|
switch responseFormat := input.ResponseFormat.(type) {
|
|
case string:
|
|
config.ResponseFormat = responseFormat
|
|
case map[string]any:
|
|
config.ResponseFormatMap = responseFormat
|
|
}
|
|
}
|
|
|
|
switch stop := input.Stop.(type) {
|
|
case string:
|
|
if stop != "" {
|
|
config.StopWords = append(config.StopWords, stop)
|
|
}
|
|
case []any:
|
|
for _, pp := range stop {
|
|
if s, ok := pp.(string); ok {
|
|
config.StopWords = append(config.StopWords, s)
|
|
}
|
|
}
|
|
}
|
|
|
|
if len(input.Tools) > 0 {
|
|
for _, tool := range input.Tools {
|
|
input.Functions = append(input.Functions, tool.Function)
|
|
}
|
|
}
|
|
|
|
if input.ToolsChoice != nil {
|
|
// OpenAI tool_choice has three valid shapes plus one tolerated
|
|
// non-spec form seen in the wild:
|
|
//
|
|
// 1. string mode: "auto" | "none" | "required"
|
|
// 2. specific tool: {"type":"function", "function":{"name":"..."}} (current spec)
|
|
// 3. legacy: {"type":"function", "name":"..."} (older / Anthropic-compat)
|
|
// 4. double-encoded: "{\"type\":\"function\", ...}" (some clients serialize the object)
|
|
//
|
|
// The pre-#9559 code unmarshalled the string case through
|
|
// json.Unmarshal([]byte(content), &functions.Tool{}), which:
|
|
// - failed for plain string modes (so "required" / "none" were
|
|
// silently ignored and tools stayed enabled regardless), but
|
|
// - happened to handle shape 4 by accident.
|
|
// It also could not parse shape 3 because functions.Tool has no
|
|
// flat top-level Name field.
|
|
//
|
|
// Mirror the parsing pattern from MergeOpenResponsesConfig (#9509),
|
|
// route results through the existing input.FunctionCall string/map
|
|
// dispatch downstream (see the switch on input.FunctionCall in this
|
|
// same function), and preserve the shape-4 fallback so non-spec
|
|
// clients don't silently break. Tracked in #9508; sibling fix in #9526.
|
|
switch content := input.ToolsChoice.(type) {
|
|
case string:
|
|
// "auto" is the default and needs no override. "none" and "required"
|
|
// both reach SetFunctionCallString via the input.FunctionCall string
|
|
// branch below; ShouldUseFunctions() then returns false for "none"
|
|
// (tools disabled) and true for "required" (mode engaged).
|
|
//
|
|
// If the string looks like a JSON object, try shape 4 first: parse
|
|
// it as a tool_choice map and use the resulting name. Falling back
|
|
// to mode-string handling when the parse yields no usable name keeps
|
|
// genuinely-malformed input from accidentally engaging a mode.
|
|
if content == "" || content == "auto" {
|
|
break
|
|
}
|
|
if strings.HasPrefix(strings.TrimSpace(content), "{") {
|
|
var nested map[string]any
|
|
if err := json.Unmarshal([]byte(content), &nested); err == nil {
|
|
if name := extractToolChoiceFunctionName(nested); name != "" {
|
|
input.FunctionCall = map[string]any{"name": name}
|
|
break
|
|
}
|
|
}
|
|
}
|
|
input.FunctionCall = content
|
|
case map[string]any:
|
|
if name := extractToolChoiceFunctionName(content); name != "" {
|
|
input.FunctionCall = map[string]any{"name": name}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Decode each request's message content
|
|
imgIndex, vidIndex, audioIndex := 0, 0, 0
|
|
for i, m := range input.Messages {
|
|
nrOfImgsInMessage := 0
|
|
nrOfVideosInMessage := 0
|
|
nrOfAudiosInMessage := 0
|
|
|
|
switch content := m.Content.(type) {
|
|
case string:
|
|
input.Messages[i].StringContent = content
|
|
case []any, []schema.Content:
|
|
c, typed := content.([]schema.Content)
|
|
if !typed {
|
|
dat, err := json.Marshal(content)
|
|
if err != nil {
|
|
return fmt.Errorf("message content: %w", err)
|
|
}
|
|
if err := json.Unmarshal(dat, &c); err != nil {
|
|
return fmt.Errorf("message content: %w", err)
|
|
}
|
|
}
|
|
|
|
textContent := ""
|
|
// we will template this at the end
|
|
|
|
CONTENT:
|
|
for _, pp := range c {
|
|
switch pp.Type {
|
|
case "text":
|
|
textContent += pp.Text
|
|
//input.Messages[i].StringContent = pp.Text
|
|
case "video", "video_url":
|
|
// Decode content as base64 either if it's an URL or base64 text
|
|
base64, err := utils.GetContentURIAsBase64(pp.VideoURL.URL)
|
|
if err != nil {
|
|
xlog.Error("Failed encoding video", "error", err)
|
|
continue CONTENT
|
|
}
|
|
input.Messages[i].StringVideos = append(input.Messages[i].StringVideos, base64) // TODO: make sure that we only return base64 stuff
|
|
vidIndex++
|
|
nrOfVideosInMessage++
|
|
case "audio_url", "audio":
|
|
// Decode content as base64 either if it's an URL or base64 text
|
|
base64, err := utils.GetContentURIAsBase64(pp.AudioURL.URL)
|
|
if err != nil {
|
|
xlog.Error("Failed encoding audio", "error", err)
|
|
continue CONTENT
|
|
}
|
|
input.Messages[i].StringAudios = append(input.Messages[i].StringAudios, base64) // TODO: make sure that we only return base64 stuff
|
|
audioIndex++
|
|
nrOfAudiosInMessage++
|
|
case "input_audio":
|
|
// TODO: make sure that we only return base64 stuff
|
|
input.Messages[i].StringAudios = append(input.Messages[i].StringAudios, pp.InputAudio.Data)
|
|
audioIndex++
|
|
nrOfAudiosInMessage++
|
|
case "image_url", "image":
|
|
// Decode content as base64 either if it's an URL or base64 text
|
|
base64, err := utils.GetContentURIAsBase64(pp.ImageURL.URL)
|
|
if err != nil {
|
|
xlog.Error("Failed encoding image", "error", err)
|
|
continue CONTENT
|
|
}
|
|
|
|
input.Messages[i].StringImages = append(input.Messages[i].StringImages, base64) // TODO: make sure that we only return base64 stuff
|
|
|
|
imgIndex++
|
|
nrOfImgsInMessage++
|
|
}
|
|
}
|
|
|
|
// When the backend handles templating itself (UseTokenizerTemplate),
|
|
// it also injects media markers server-side (see
|
|
// oaicompat_chat_params_parse in llama.cpp). Emitting our own markers
|
|
// here would double-mark them and downstream consumers ignore
|
|
// StringContent in that path anyway, so just pass through plain text.
|
|
if config.TemplateConfig.UseTokenizerTemplate {
|
|
input.Messages[i].StringContent = textContent
|
|
} else {
|
|
input.Messages[i].StringContent, _ = templates.TemplateMultiModal(config.TemplateConfig.Multimodal, templates.MultiModalOptions{
|
|
TotalImages: imgIndex,
|
|
TotalVideos: vidIndex,
|
|
TotalAudios: audioIndex,
|
|
ImagesInMessage: nrOfImgsInMessage,
|
|
VideosInMessage: nrOfVideosInMessage,
|
|
AudiosInMessage: nrOfAudiosInMessage,
|
|
}, textContent)
|
|
}
|
|
}
|
|
}
|
|
|
|
if input.RepeatPenalty != 0 {
|
|
config.RepeatPenalty = input.RepeatPenalty
|
|
}
|
|
|
|
if input.FrequencyPenalty != 0 {
|
|
config.FrequencyPenalty = input.FrequencyPenalty
|
|
}
|
|
|
|
if input.PresencePenalty != 0 {
|
|
config.PresencePenalty = input.PresencePenalty
|
|
}
|
|
|
|
if input.Keep != 0 {
|
|
config.Keep = input.Keep
|
|
}
|
|
|
|
if input.Batch != 0 {
|
|
config.Batch = input.Batch
|
|
}
|
|
|
|
if input.IgnoreEOS {
|
|
config.IgnoreEOS = input.IgnoreEOS
|
|
}
|
|
|
|
if input.Seed != nil {
|
|
config.Seed = input.Seed
|
|
}
|
|
|
|
if input.TypicalP != nil {
|
|
config.TypicalP = input.TypicalP
|
|
}
|
|
|
|
xlog.Debug("input.Input", "input", fmt.Sprintf("%+v", input.Input))
|
|
|
|
switch inputs := input.Input.(type) {
|
|
case string:
|
|
if inputs != "" {
|
|
config.InputStrings = append(config.InputStrings, inputs)
|
|
}
|
|
case []any:
|
|
for _, pp := range inputs {
|
|
switch i := pp.(type) {
|
|
case string:
|
|
config.InputStrings = append(config.InputStrings, i)
|
|
case []any:
|
|
tokens := []int{}
|
|
inputStrings := []string{}
|
|
for _, ii := range i {
|
|
switch ii := ii.(type) {
|
|
case int:
|
|
tokens = append(tokens, ii)
|
|
case float64:
|
|
tokens = append(tokens, int(ii))
|
|
case string:
|
|
inputStrings = append(inputStrings, ii)
|
|
default:
|
|
xlog.Error("Unknown input type", "type", fmt.Sprintf("%T", ii))
|
|
}
|
|
}
|
|
config.InputToken = append(config.InputToken, tokens)
|
|
config.InputStrings = append(config.InputStrings, inputStrings...)
|
|
}
|
|
}
|
|
}
|
|
|
|
// Per-request Go-side pooling override for /v1/embeddings (LocalAI
|
|
// extension) — copy-if-set onto the per-request config like the Input
|
|
// handling above; the embeddings endpoint validates the merged values.
|
|
if input.Pooling != "" {
|
|
config.Pooling = input.Pooling
|
|
// The config's default half-life belongs to its own decayed_mean
|
|
// default. A request that overrides the scheme without sending its
|
|
// own half-life must not inherit it, or the merged pair (e.g.
|
|
// "mean" + 256) fails validation through no fault of the client.
|
|
// (literal because the `config` parameter shadows the package;
|
|
// this is config.PoolingDecayedMean)
|
|
if input.PoolingHalfLifeTokens == 0 && input.Pooling != "decayed_mean" {
|
|
config.PoolingHalfLifeTokens = 0
|
|
}
|
|
}
|
|
if input.PoolingHalfLifeTokens != 0 {
|
|
config.PoolingHalfLifeTokens = input.PoolingHalfLifeTokens
|
|
}
|
|
|
|
// Can be either a string or an object
|
|
switch fnc := input.FunctionCall.(type) {
|
|
case string:
|
|
if fnc != "" {
|
|
config.SetFunctionCallString(fnc)
|
|
}
|
|
case map[string]any:
|
|
var name string
|
|
n, exists := fnc["name"]
|
|
if exists {
|
|
nn, e := n.(string)
|
|
if e {
|
|
name = nn
|
|
}
|
|
}
|
|
config.SetFunctionCallNameString(name)
|
|
}
|
|
|
|
switch p := input.Prompt.(type) {
|
|
case string:
|
|
config.PromptStrings = append(config.PromptStrings, p)
|
|
case []any:
|
|
for _, pp := range p {
|
|
if s, ok := pp.(string); ok {
|
|
config.PromptStrings = append(config.PromptStrings, s)
|
|
}
|
|
}
|
|
}
|
|
|
|
// If a quality was defined as number, convert it to step
|
|
if input.Quality != "" {
|
|
q, err := strconv.Atoi(input.Quality)
|
|
if err == nil {
|
|
config.Step = q
|
|
}
|
|
}
|
|
|
|
if valid, err := config.Validate(); !valid {
|
|
// The base config validated at load time, so a post-merge failure
|
|
// can only come from request-supplied fields: surface it as a 400
|
|
// with the underlying cause rather than an opaque 500.
|
|
xlog.Warn("post-merge validation failed",
|
|
"model", config.Name, "err", err,
|
|
"inputPooling", input.Pooling, "cfgPooling", config.Pooling,
|
|
"cfgHalfLife", config.PoolingHalfLifeTokens, "options", config.Options)
|
|
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("unable to validate configuration after merging: %v", err))
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (re *RequestExtractor) SetOpenResponsesRequest(c echo.Context) (err error) {
|
|
finish := re.beginExtraction(c)
|
|
defer func() { finish(err) }()
|
|
input, ok := c.Get(CONTEXT_LOCALS_KEY_LOCALAI_REQUEST).(*schema.OpenResponsesRequest)
|
|
if !ok || input.Model == "" {
|
|
return echo.ErrBadRequest
|
|
}
|
|
|
|
// Convert input items to Messages (this will be done in the endpoint handler)
|
|
// We store the input in the request for the endpoint to process
|
|
cfg, ok := c.Get(CONTEXT_LOCALS_KEY_MODEL_CONFIG).(*config.ModelConfig)
|
|
if !ok || cfg == nil {
|
|
return echo.ErrBadRequest
|
|
}
|
|
|
|
// Extract or generate the correlation ID (Open Responses uses x-request-id)
|
|
correlationID := c.Request().Header.Get("x-request-id")
|
|
if correlationID == "" {
|
|
correlationID = uuid.New().String()
|
|
}
|
|
c.Response().Header().Set("x-request-id", correlationID)
|
|
|
|
// Use the request context directly - Echo properly supports context cancellation!
|
|
reqCtx := re.getRequestContext(c)
|
|
c1, cancel := context.WithCancel(re.applicationConfig.Context)
|
|
|
|
// Cancel when request context is cancelled (client disconnects)
|
|
go func() {
|
|
select {
|
|
case <-reqCtx.Done():
|
|
cancel()
|
|
case <-c1.Done():
|
|
// Already cancelled
|
|
}
|
|
}()
|
|
|
|
// Add the correlation ID to the new context
|
|
ctxWithCorrelationID := context.WithValue(c1, CorrelationIDKey, correlationID)
|
|
ctxWithCorrelationID = distributedhdr.Inherit(ctxWithCorrelationID, reqCtx)
|
|
ctxWithCorrelationID = diagnostics.Inherit(ctxWithCorrelationID, reqCtx)
|
|
|
|
input.Context = ctxWithCorrelationID
|
|
input.Cancel = cancel
|
|
|
|
err = MergeOpenResponsesConfig(cfg, input)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if cfg.Model == "" {
|
|
xlog.Debug("replacing empty cfg.Model with input value", "input.Model", input.Model)
|
|
cfg.Model = input.Model
|
|
}
|
|
|
|
c.Set(CONTEXT_LOCALS_KEY_LOCALAI_REQUEST, input)
|
|
c.Set(CONTEXT_LOCALS_KEY_MODEL_CONFIG, cfg)
|
|
|
|
return nil
|
|
}
|
|
|
|
// MergeOpenResponsesConfig merges request parameters into the model configuration.
|
|
func MergeOpenResponsesConfig(config *config.ModelConfig, input *schema.OpenResponsesRequest) error {
|
|
if config.DropsClientTools() {
|
|
input.Tools = nil
|
|
input.ToolChoice = nil
|
|
}
|
|
// Temperature
|
|
if input.Temperature != nil {
|
|
config.Temperature = input.Temperature
|
|
}
|
|
|
|
// TopP
|
|
if input.TopP != nil {
|
|
config.TopP = input.TopP
|
|
}
|
|
|
|
// MaxOutputTokens -> Maxtokens
|
|
if input.MaxOutputTokens != nil {
|
|
config.Maxtokens = input.MaxOutputTokens
|
|
}
|
|
|
|
// Convert tools to functions - this will be handled in the endpoint handler
|
|
// We just validate that tools are present if needed
|
|
|
|
// Handle tool_choice
|
|
if input.ToolChoice != nil {
|
|
switch tc := input.ToolChoice.(type) {
|
|
case string:
|
|
// "auto", "required", or "none"
|
|
if tc == "required" {
|
|
config.SetFunctionCallString("required")
|
|
} else if tc == "none" {
|
|
// Don't use tools - handled in endpoint
|
|
}
|
|
// "auto" is default - let model decide
|
|
case map[string]any:
|
|
// Specific tool. OpenAI spec nests the function name under "function":
|
|
// {"type":"function", "function":{"name":"..."}}
|
|
// Legacy/Anthropic-compat form puts it at the top level:
|
|
// {"type":"function", "name":"..."}
|
|
// The old code only handled the legacy shape AND used the wrong
|
|
// setter (SetFunctionCallString writes the mode field; the
|
|
// specific-function name lives in a separate field read by
|
|
// ShouldCallSpecificFunction / FunctionToCall). Net effect: a
|
|
// correctly-formed OpenAI tool_choice never engaged grammar-based
|
|
// forcing, the model got the tools but no selection hint, and
|
|
// streamed raw JSON as delta.content instead of delta.tool_calls.
|
|
if tcType, ok := tc["type"].(string); ok && tcType == "function" {
|
|
var name string
|
|
if fn, ok := tc["function"].(map[string]any); ok {
|
|
if n, ok := fn["name"].(string); ok {
|
|
name = n
|
|
}
|
|
}
|
|
if name == "" {
|
|
if n, ok := tc["name"].(string); ok {
|
|
name = n
|
|
}
|
|
}
|
|
if name != "" {
|
|
config.SetFunctionCallNameString(name)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if valid, err := config.Validate(); !valid {
|
|
// The base config validated at load time, so a post-merge failure
|
|
// can only come from request-supplied fields: surface it as a 400
|
|
// with the underlying cause rather than an opaque 500.
|
|
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("unable to validate configuration after merging: %v", err))
|
|
}
|
|
return nil
|
|
}
|