classificationbox

type Class struct {
	// ID is the class being predicted.
	ID string `json:"id,omitempty"`
	// Score is a numerical value indicating how this prediction relates
	// to other predictions.
	Score float64 `json:"score,omitempty"`
}

type ClassStats struct {
	// Name is the name of the class.
	Name string
	// Examples is the number of examples of this class that
	// the model has been taught.
	Examples int
}

type Client struct {
	// contains filtered or unexported fields
}

type Example struct {
	Class  string    `json:"class"`
	Inputs []Feature `json:"inputs"`
}

type Feature struct {
	// Key is the name of the Feature.
	Key string `json:"key"`
	// Value is the string value of this Feature.
	Value string `json:"value"`
	// Type is the type of the Feature.
	// Can be "number", "text", "keyword", "list", "image_url" or "image_base64"..
	Type string `json:"type"`
}

type Model struct {
	// ID is the ID of the model.
	ID string `json:"id,omitempty"`
	// Name is the human readable name of the Model.
	Name string `json:"name"`
	// Options are optional Model settings to adjust the behaviour
	// of this Model within Classificationbox.
	Options *ModelOptions `json:"options,omitempty"`
	// Classes are the classes that this model can learn.
	Classes []string `json:"classes,omitempty"`
}

type ModelOptions struct {
	// Ngrams describes the n-grams for text analysis.
	Ngrams int `json:"ngrams,omitempty"`
	// Skipgrams describes the skip-grams for the text analysis.
	Skipgrams int `json:"skipgrams,omitempty"`
}

type ModelStats struct {
	// Predictions is the number of predictions this model has made.
	Predictions int
	// Examples is the total number of examples this model has
	// been taught.
	Examples int
	// Classes is a list of statistics per class.
	Classes []ClassStats
}

type PredictRequest struct {
	// Limit sets the maximum number of classes that will be returned
	// in a prediction.
	Limit int `json:"limit"`
	// Inputs is a list of Feature objects that will be used when
	// making the prediction.
	Inputs []Feature `json:"inputs,omitempty"`
}

type PredictResponse struct {
	// Classes contains the predictions.
	Classes []Class `json:"classes,omitempty"`
}