provider

type InjectToken interface {
	// SetToken sets an access token to be used to authenticate a remote API.
	SetToken(token string)
}

type Loader interface {
	// Load loads the given model.
	Load(modelIdentifier string) (err error)
	// Unload unloads the given model.
	Unload(modelIdentifier string) (err error)
}

type Provider interface {
	// Available checks if the provider is ready to be used.
	// This might include checking for an installation or making sure an API access token is valid.
	Available(logger *log.Logger) (err error)
	// ID returns the unique ID of this provider.
	ID() (id string)
	// Models returns which models are available to be queried via this provider.
	Models() (models []model.Model, err error)
}

type Puller interface {
	// Pull downloads the given model.
	Pull(logger *log.Logger, modelIdentifier string) (err error)
}

type Query interface {
	// Query queries the provider with the given model name.
	Query(ctx context.Context, model model.Model, promptText string) (result *QueryResult, err error)
}

type QueryResult struct {
	// ResponseID holds the response ID.
	ResponseID string
	// Message holds the response message.
	Message string
	// Duration holds the duration of the result.
	Duration time.Duration
	// Usage holds the usage metrics of the query.
	Usage openai.Usage
}

type Service interface {
	// Start starts necessary background services to use this provider and returns a shutdown function.
	Start(logger *log.Logger) (shutdown func() (err error), err error)
}