evaluationapi

type Authorization = string

type ErrorInformation struct {
	// Code Some unique error code.
	Code int32 `json:"code"`

	// Message Error message.
	Message string `json:"message"`
}

type Evaluations struct {
	// NumNegative number of negative evaluations.
	NumNegative int32 `json:"numNegative"`

	// NumNeutral number of neutral evaluations.
	NumNeutral int32 `json:"numNeutral"`

	// NumPositive Number of positive evaluations.
	NumPositive int32 `json:"numPositive"`
}

type GetEvaluationParams struct {
	// Authorization JWT token with authorization information.
	Authorization *Authorization `json:"Authorization,omitempty"`
}

type GetEvaluationResponse struct {
	// Evaluations Evaluation statistics.
	Evaluations Evaluations `json:"evaluations"`

	// Id Unique id of the evaluation.
	Id string `json:"id"`

	// Request Message.
	Request Message `json:"request"`

	// Response Message.
	Response Message `json:"response"`
}

type GetStatisticsParams struct {
	// Authorization JWT token with authorization information.
	Authorization *Authorization `json:"Authorization,omitempty"`
}

type GetStatisticsResponse struct {
	Scenarios *[]ScenarioStatistics `json:"scenarios,omitempty"`
}

type GinServerOptions struct {
	BaseURL      string
	Middlewares  []MiddlewareFunc
	ErrorHandler func(*gin.Context, error, int)
}

type Message struct {
	// Body e.g. E-Mail body. The actual message.
	Body string `json:"body"`

	// Date string containing the date when the email was received in ISO 8601 format.
	Date string `json:"date"`

	// From Name of the author.
	From string `json:"from"`

	// Subject e.g. E-Mail subject.
	Subject string `json:"subject"`
}

type MiddlewareFunc func(c *gin.Context)

type NameValuePair struct {
	// Name Name of the category.
	Name string `json:"name"`

	// Value Amout of rated question/response pairs in this category.
	Value int32 `json:"value"`
}

type PostEvaluationJSONRequestBody = PostEvaluationRequest

type PostEvaluationParams struct {
	// Authorization JWT token with authorization information.
	Authorization *Authorization `json:"Authorization,omitempty"`
}

type PostEvaluationRequest struct {
	EvaluationResult PostEvaluationRequestEvaluationResult `json:"evaluationResult"`

	// Id Unique id of the evaluation.
	Id string `json:"id"`
}

type PostEvaluationRequestEvaluationResult string

type RatingScore struct {
	// Max Maximum of rating Score.
	Max float32 `json:"max"`

	// Min Minimum of rating Score.
	Min float32 `json:"min"`

	// Value Rating score of the scenario.
	Value float32 `json:"value"`
}

type ScenarioStatistics struct {
	// Description The description of the Scenario.
	Description *string `json:"description,omitempty"`

	// Id Unique id of the evaluation.
	Id string `json:"id"`

	// Name The name of the Scenario
	Name               string          `json:"name"`
	ProgressStatistics []NameValuePair `json:"progressStatistics"`
	RatingScore        RatingScore     `json:"ratingScore"`
	ResultStatistics   []NameValuePair `json:"resultStatistics"`

	// SystemPrompt The used systemprompt for the scenario.
	SystemPrompt *string `json:"systemPrompt,omitempty"`

	// TotalResponseCount The amount of questions and response evaluated in this scenario.
	TotalResponseCount int32 `json:"totalResponseCount"`
}

type ServerInterface interface {
	// Gets the next message for evaluation.
	// (GET /evaluation)
	GetEvaluation(c *gin.Context, params GetEvaluationParams)
	// Posts the evaluation of the current evaluation response.
	// (POST /evaluation)
	PostEvaluation(c *gin.Context, params PostEvaluationParams)
	// Gets the statistics.
	// (GET /statistics)
	GetStatistics(c *gin.Context, params GetStatisticsParams)
}

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandler       func(*gin.Context, error, int)
}