mirror of
https://github.com/mudler/LocalAI.git
synced 2026-11-06 04:23:15 -05:00
Ettore Di Giacinto
c1dd87e0d5
An add-on that keeps resources can now ask the host for a read tool that lists the ones the caller may use, by declaring capabilities.resources.list. The declaration names the tool and, optionally, the key of the result array. It needs manifest API 2 and must not reuse the name of a tool the add-on declares. Assisted-by: Claude Code:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
63 lines
2.0 KiB
Go
63 lines
2.0 KiB
Go
// SPDX-License-Identifier: MIT
|
|
package contract
|
|
|
|
import (
|
|
"fmt"
|
|
"slices"
|
|
)
|
|
|
|
// MinResourceListAPI is the first manifest API version that knows the
|
|
// resource listing declaration. A manifest that declares one must accept it.
|
|
const MinResourceListAPI uint64 = 2
|
|
|
|
// MaxListedResources bounds the entries of the listing the host builds. The
|
|
// answer says when it is cut short.
|
|
const MaxListedResources = 100
|
|
|
|
// DefaultResourceListItems is the key of the result array when the add-on
|
|
// names none.
|
|
const DefaultResourceListItems = "resources"
|
|
|
|
// ResourceList declares that the host offers a read tool listing the
|
|
// resources of the add-on the caller may use. The add-on writes no code for
|
|
// it: the host builds the tool from its own record of the grants. The model
|
|
// then finds the IDs that every tool of a resource takes.
|
|
type ResourceList struct {
|
|
// Tool is the name of the tool, in the form of any tool name. It must not
|
|
// name a tool the add-on declares.
|
|
Tool string `json:"tool"`
|
|
// Items is the key of the result array. It defaults to
|
|
// DefaultResourceListItems.
|
|
Items string `json:"items,omitempty"`
|
|
}
|
|
|
|
// ItemsKey returns the key of the result array.
|
|
func (l ResourceList) ItemsKey() string {
|
|
if l.Items == "" {
|
|
return DefaultResourceListItems
|
|
}
|
|
return l.Items
|
|
}
|
|
|
|
func validateResourceList(c Capabilities, api VersionRange) error {
|
|
if c.Resources == nil || c.Resources.List == nil {
|
|
return nil
|
|
}
|
|
l := c.Resources.List
|
|
if api.Max < MinResourceListAPI {
|
|
return fmt.Errorf("resources list needs api %d", MinResourceListAPI)
|
|
}
|
|
if !namespace.MatchString(l.Tool) || (l.Items != "" && !toolPropertyName.MatchString(l.Items)) {
|
|
return fmt.Errorf("invalid resources list")
|
|
}
|
|
if slices.Contains(c.Tools, l.Tool) || slices.Contains(c.AdminTools, l.Tool) {
|
|
return fmt.Errorf("resources list tool %q is also a declared tool", l.Tool)
|
|
}
|
|
for _, d := range c.ToolDefinitions {
|
|
if d.Name == l.Tool {
|
|
return fmt.Errorf("resources list tool %q is also a declared tool", l.Tool)
|
|
}
|
|
}
|
|
return nil
|
|
}
|