mcpserver

type Caller struct {
	// Name labels the caller in the run's request log.
	Name string
	// CanRun is whether the caller's role may start a workflow run (Editor or
	// Administrator). Reading is open to every role.
	CanRun bool
	// MayAccess reports whether the caller may see workflows in vhost.
	MayAccess func(vhost string) bool
}

type ModelSource interface {
	ListModels(ctx context.Context, vhost string) ([]storage.MLModel, error)
	Predict(ctx context.Context, vhost, name string, rows []map[string]any) ([]map[string]any, error)
	// Recommend calls a recommendation model, on the same path as REST, and
	// returns the answer's recommendation_id with it.
	Recommend(ctx context.Context, vhost, name string, req RecommendArgs) ([]recommend.Item, string, error)
	// RecommendScenario is a scenario call ("for", "period", "rules"), on
	// the path of POST .../recommend.
	RecommendScenario(ctx context.Context, vhost, name string, req RecommendArgs) (ScenarioAnswer, error)
}

type ModelTool struct {
	// Name is predict_<model>, or predict_<model>__<vhost> when the caller
	// can reach two vhosts exposing a model of that name.
	Name        string
	VHost       string
	Model       string
	Description string
	// InputSchema has one property per feature, typed where the type is
	// known, all required; a model that declares no features takes any
	// object as its one row.
	InputSchema map[string]any
	// Recommend marks a recommendation model's tool, recommend_<model>,
	// called with RecommendTool rather than PredictTool.
	Recommend bool
	// contains filtered or unexported fields
}

type PredictResult struct {
	Model      string         `json:"model"`
	VHost      string         `json:"vhost"`
	Prediction map[string]any `json:"prediction"`
}

type RecommendArgs struct {
	User        any                `json:"user,omitempty"`
	Item        any                `json:"item,omitempty"`
	For         *ScenarioFor       `json:"for,omitempty"`
	Territory   any                `json:"territory,omitempty"`
	Period      *ScenarioPeriod    `json:"period,omitempty"`
	WithinDays  int                `json:"within_days,omitempty"`
	K           int                `json:"k,omitempty"`
	Rules       []recommend.Rule   `json:"rules,omitempty"`
	ExcludeSeen *bool              `json:"exclude_seen,omitempty"`
	Stock       map[string]float64 `json:"stock,omitempty"`
}

type RecommendResult struct {
	Model            string             `json:"model"`
	VHost            string             `json:"vhost"`
	RecommendationID string             `json:"recommendation_id"`
	Items            []recommend.Item   `json:"items,omitempty"`
	Results          []recommend.Result `json:"results,omitempty"`
}

type RunResult struct {
	// ID is the id of the message the input became.
	ID string `json:"id"`
	// Status is "dispatched" for a workflow that does not reply, "pending"
	// when the wait ran out before the workflow finished, and otherwise what
	// the workflow did: delivered, completed, filtered, dead_lettered or
	// failed.
	Status string `json:"status"`
	Error  string `json:"error,omitempty"`
	// Record is the message as the workflow left it, when it replied.
	Record any `json:"record,omitempty"`
}

type ScenarioAnswer struct {
	RecommendationID string
	Results          []recommend.Result
}

type ScenarioFor struct {
	Customer     any   `json:"customer,omitempty"`
	Customers    []any `json:"customers,omitempty"`
	Product      any   `json:"product,omitempty"`
	Salesman     any   `json:"salesman,omitempty"`
	Territory    any   `json:"territory,omitempty"`
	AllCustomers bool  `json:"all_customers,omitempty"`
	Segment      any   `json:"segment,omitempty"`
	Size         any   `json:"size,omitempty"`
	Brand        any   `json:"brand,omitempty"`
	Subcategory  any   `json:"subcategory,omitempty"`
}

type ScenarioPeriod struct {
	From string `json:"from"`
	To   string `json:"to,omitempty"`
}

type Service struct {
	Store Store
	// Wake starts a parked workflow whose source has no listener, and reports
	// whether it started one. Optional.
	Wake func(ctx context.Context, resourceType, path string) bool
	// Models is the model registry the predict_<model> tools call. Optional:
	// without it there are no model tools.
	Models ModelSource
}

type Store interface {
	ListWorkflows(ctx context.Context, filter storage.CommonFilter) ([]storage.Workflow, int, error)
	GetWorkflow(ctx context.Context, id string) (storage.Workflow, error)
	GetSource(ctx context.Context, id string) (storage.Source, error)
	CreateWebhookRequest(ctx context.Context, req storage.WebhookRequest) error
}

type WorkflowStatus struct {
	ID        string `json:"id"`
	Name      string `json:"name"`
	VHost     string `json:"vhost,omitempty"`
	Active    bool   `json:"active"`
	Status    string `json:"status,omitempty"`
	Processed uint64 `json:"processed"`
	Errors    uint64 `json:"errors"`
	Lag       uint64 `json:"lag"`
}

type WorkflowSummary struct {
	ID     string `json:"id"`
	Name   string `json:"name"`
	VHost  string `json:"vhost,omitempty"`
	Active bool   `json:"active"`
	Status string `json:"status,omitempty"`
	// Runnable is whether run_workflow can deliver input to it.
	Runnable bool `json:"runnable"`
	// RepliesWithResult is whether run_workflow waits for and returns what
	// the workflow did, rather than only confirming the input was queued.
	RepliesWithResult bool `json:"replies_with_result"`
}