Skip to content

documented remaining endpoints #524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mudler merged 2 commits into from
Oct 7, 2023
Merged

documented remaining endpoints #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92a761c
documented remaining endpoints
paynejacob Jun 5, 2023
81621de
swagger init
paynejacob Jun 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package api
import (
"errors"

_ "github.com/go-skynet/LocalAI/docs/swagger"
_ "github.com/go-skynet/LocalAI/docs"
model "github.com/go-skynet/LocalAI/pkg/model"
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/cors"
Expand Down
27 changes: 27 additions & 0 deletions api/openai.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,22 @@ func chatEndpoint(cm ConfigMerger, debug bool, loader *model.ModelLoader, thread
}
}

// OpenAI CHAT API endpoint for editing model parameters
// editEndpoint mimics the /edits endpoint for local models
// @Summary Modify model parameters
// @Description Alter model parameters for text completion models.
// @Tags Chat
// @Accept json
// @Produce json
// @Param model body string true "Define which model to modify."
// @Param instruction body string true "Define the initial prompt for the model."
// @Param input body string true "Initial input prompt for model."
// @Param stop body string true "Define stop words for the model to reply after."
// @Success 200 {object} OpenAIResponse
// @Failure 400 {object} APIError
// @Failure 401 {object} APIError
// @Failure 500 {object} APIError
// @Router /edits [post]
func editEndpoint(cm ConfigMerger, debug bool, loader *model.ModelLoader, threads, ctx int, f16 bool) func(c *fiber.Ctx) error {
return func(c *fiber.Ctx) error {
config, input, err := readConfig(cm, c, loader, debug, threads, ctx, f16)
Expand Down Expand Up @@ -487,6 +503,17 @@ func editEndpoint(cm ConfigMerger, debug bool, loader *model.ModelLoader, thread
}
}

// OpenAI CHAT API endpoint for listing loaded models
// listModels mimics the /models endpoint for listing loaded local models
// @Summary Get a list of all currently loaded models
// @Description List all currently loaded models.
// @Tags Chat
// @Produce json
// @Success 200 {object} OpenAIResponse
// @Failure 400 {object} APIError
// @Failure 401 {object} APIError
// @Failure 500 {object} APIError
// @Router /models [get]
func listModels(loader *model.ModelLoader, cm ConfigMerger) func(ctx *fiber.Ctx) error {
return func(c *fiber.Ctx) error {
models, err := loader.ListModels()
Expand Down
Loading