mirror of
https://github.com/ollama/ollama.git
synced 2026-04-21 16:25:42 +02:00
9e190ac4d9
This commit implements a structured error response system for the Ollama API, replacing ad-hoc error handling and string parsing with proper error types and codes through a new ErrorResponse struct. Instead of relying on regex to parse error messages for SSH keys, the API now passes this data in a structured format with standardized fields for error messages, codes, and additional data. This structured approach makes the API more maintainable and reliable while improving the developer experience by enabling programmatic error handling, consistent error formats, and better error documentation.
75 lines
2.0 KiB
Go
75 lines
2.0 KiB
Go
package api
|
|
|
|
import (
|
|
"fmt"
|
|
"slices"
|
|
"strings"
|
|
)
|
|
|
|
const InvalidModelNameErrMsg = "invalid model name"
|
|
|
|
// API error responses
|
|
// ErrorCode represents a standardized error code identifier
|
|
type ErrorCode string
|
|
|
|
const (
|
|
ErrCodeUnknownKey ErrorCode = "unknown_key"
|
|
ErrCodeGeneral ErrorCode = "general" // Generic fallback error code
|
|
)
|
|
|
|
// ErrorResponse implements a structured error interface
|
|
type ErrorResponse struct {
|
|
Message string `json:"error"` // Human-readable error message, uses 'error' field name for backwards compatibility
|
|
Code ErrorCode `json:"code"` // Machine-readable error code for programmatic handling, not response code
|
|
Data map[string]any `json:"data"` // Additional error specific data, if any
|
|
}
|
|
|
|
func (e ErrorResponse) Error() string {
|
|
return e.Message
|
|
}
|
|
|
|
type ErrUnknownOllamaKey struct {
|
|
Message string
|
|
Key string
|
|
}
|
|
|
|
func (e ErrUnknownOllamaKey) Error() string {
|
|
return fmt.Sprintf("unauthorized: unknown ollama key %q", strings.TrimSpace(e.Key))
|
|
}
|
|
|
|
func (e *ErrUnknownOllamaKey) FormatUserMessage(localKeys []string) string {
|
|
// The user should only be told to add the key if it is the same one that exists locally
|
|
if slices.Index(localKeys, e.Key) == -1 {
|
|
return e.Message
|
|
}
|
|
|
|
return fmt.Sprintf(`%s
|
|
|
|
Your ollama key is:
|
|
%s
|
|
Add your key at:
|
|
https://ollama.com/settings/keys`, e.Message, e.Key)
|
|
}
|
|
|
|
// StatusError is an error with an HTTP status code and message,
|
|
// it is parsed on the client-side and not returned from the API
|
|
type StatusError struct {
|
|
StatusCode int // e.g. 200
|
|
Status string // e.g. "200 OK"
|
|
ErrorMessage string `json:"error"`
|
|
}
|
|
|
|
func (e StatusError) Error() string {
|
|
switch {
|
|
case e.Status != "" && e.ErrorMessage != "":
|
|
return fmt.Sprintf("%s: %s", e.Status, e.ErrorMessage)
|
|
case e.Status != "":
|
|
return e.Status
|
|
case e.ErrorMessage != "":
|
|
return e.ErrorMessage
|
|
default:
|
|
// this should not happen
|
|
return "something went wrong, please see the ollama server logs for details"
|
|
}
|
|
}
|