mirror of
https://github.com/mudler/LocalAI.git
synced 2026-10-28 17:18:49 -04:00
* fix(http): stop listing the models directory on embeddings and bearer requests Every embeddings request read the whole models directory before the body was parsed, even when the body named its model. On a network-backed models directory this cost seconds per request. Embeddings now binds the body first and looks up a default model only when the body has none, like chat. The pre-bind default lookup and the gpt-4o constant default are gone from that route. The first-available default lookup skips the directory when the filter cannot accept an unconfigured file. Every usecase filter rejects files without a config, so the scan never added results for them. Match-all, nil and name filters keep the scan. The bearer token check is now an exact test: a configured name, or one stat of that name in the models directory. The value is a literal, not a regular expression, and a name that is not a local relative path never matches a file. Assisted-by: Claude Code:claude-haiku-5-5 * perf(config): cache GGUF header reads for model defaults Model defaults re-parsed the GGUF header on every SetDefaults call, which runs per request and at startup reload. Put a bounded LRU in front of the parser, keyed by absolute path and validated by size and modification time. The cached value is a snapshot of the fields the defaults use, not the parser output. A changed size or mtime is a miss. Missing files and parse errors are not cached, so the existing fallback is unchanged. LOCALAI_DISABLE_GUESSING, the empty-path guard, the alias early return, the panic recovery and the context-size default are all kept in front of the cache. Assisted-by: Claude:claude-haiku-5-5 * test(http): cover listing-free default lookup on every usecase route Assisted-by: Claude Code:claude-haiku-5-5 * feat(config): persist the GGUF header cache per instance The header cache kept parsed GGUF results only in memory, so every restart parsed each model file again before its defaults were known. Write the cache to a per-instance file in the data path and load it at startup. A restarted frontend with a fixed instance ID starts warm. The file is versioned and records the estimator inputs (gguf-parser version, candidate contexts, auto context size, offload count). A mismatch on any of them makes the file ignored. Each entry keeps path, size and mtime, so a changed model file is a miss on load. Writes run on one background saver, debounced, through a temp file and rename. The entry bound applies to the file as well. Without a data path the cache stays in memory only. Documented as a per-instance exception in the model configuration docs. Assisted-by: Claude:claude-haiku-5-5 * docs(embeddings): document model selection and the no-model error Assisted-by: Claude Code:claude-haiku-5-5 * refactor(config): split the header cache into a generic cache The GGUF header cache mixed two things: the mechanics (bounded LRU keyed by path and identity, per-instance file, debounced atomic save, tolerant load) and the GGUF fields. Move the mechanics into headerCache[S], driven by a headerCacheSpec[S] that names the file prefix, schema, fingerprint, parser and the snapshot encode/decode pair. The GGUF cache becomes one instance of it. File names, the identity check, LRU size, debounce, atomic write and the corruption handling are unchanged. The on-disk JSON keeps the "estimator" key so existing files still load. Assisted-by: Claude Code:claude-haiku-5-5 * feat(config): share one GGUF header cache file between frontends Every frontend used to write its own header cache file, named after its instance ID, so a header read by one frontend was never reused by another. The cache now uses one file, header-cache.json, in the data path, for all frontends and for standalone mode. The instance ID no longer changes the file name. Frontends share the file in three ways. A save first merges the file's entries in, so one frontend's write does not drop another's entries. A miss reloads the file when its modification time has changed, and a hit never reads it. Writes go to a temp file that is renamed into place, so a reader never sees a partial file. Two frontends saving at the same moment can still drop each other's last entries. That costs one re-parse, never a wrong value, because every entry is checked against its model file before use. The shared file is valid only when every frontend mounts the same data volume. The distributed-mode and model-configuration docs state this mode and its volume limit. Assisted-by: Claude:claude-haiku-5-5 * feat(config): give an instance ID its own header cache file Assisted-by: Claude Code:claude-haiku-5-5 * style(config): gofmt the distributed config struct Assisted-by: Claude Code:claude-haiku-5-5 --------- Co-authored-by: Ettore Di Giacinto <mudler@localai.io>
906 lines
30 KiB
Go
906 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 {
|
|
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 {
|
|
// 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
|
|
}
|