Documentation
¶
Overview ¶
Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types of machine learning features. This has been designed for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present.
Index ¶
- Variables
- type EvaluateDataFrame
- func (r EvaluateDataFrame) Do(providedCtx context.Context) (*Response, error)
- func (r *EvaluateDataFrame) ErrorTrace(errortrace bool) *EvaluateDataFrame
- func (r *EvaluateDataFrame) Evaluation(evaluation types.DataframeEvaluationContainerVariant) *EvaluateDataFrame
- func (r *EvaluateDataFrame) FilterPath(filterpaths ...string) *EvaluateDataFrame
- func (r *EvaluateDataFrame) Header(key, value string) *EvaluateDataFrame
- func (r *EvaluateDataFrame) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *EvaluateDataFrame) Human(human bool) *EvaluateDataFrame
- func (r *EvaluateDataFrame) Index(indexname string) *EvaluateDataFrame
- func (r EvaluateDataFrame) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *EvaluateDataFrame) Pretty(pretty bool) *EvaluateDataFrame
- func (r *EvaluateDataFrame) Query(query types.QueryVariant) *EvaluateDataFrame
- func (r *EvaluateDataFrame) Raw(raw io.Reader) *EvaluateDataFrame
- func (r *EvaluateDataFrame) Request(req *Request) *EvaluateDataFrame
- type NewEvaluateDataFrame
- type Request
- type Response
Constants ¶
This section is empty.
Variables ¶
var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")
ErrBuildPath is returned in case of missing parameters within the build of the request.
Functions ¶
This section is empty.
Types ¶
type EvaluateDataFrame ¶
type EvaluateDataFrame struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *EvaluateDataFrame
Evaluate data frame analytics.
The API packages together commonly used evaluation metrics for various types of machine learning features. This has been designed for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present.
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-evaluate-data-frame
func (EvaluateDataFrame) Do ¶
func (r EvaluateDataFrame) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a evaluatedataframe.Response
func (*EvaluateDataFrame) ErrorTrace ¶
func (r *EvaluateDataFrame) ErrorTrace(errortrace bool) *EvaluateDataFrame
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*EvaluateDataFrame) Evaluation ¶
func (r *EvaluateDataFrame) Evaluation(evaluation types.DataframeEvaluationContainerVariant) *EvaluateDataFrame
Defines the type of evaluation you want to perform. API name: evaluation
func (*EvaluateDataFrame) FilterPath ¶
func (r *EvaluateDataFrame) FilterPath(filterpaths ...string) *EvaluateDataFrame
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*EvaluateDataFrame) Header ¶
func (r *EvaluateDataFrame) Header(key, value string) *EvaluateDataFrame
Header set a key, value pair in the EvaluateDataFrame headers map.
func (*EvaluateDataFrame) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*EvaluateDataFrame) Human ¶
func (r *EvaluateDataFrame) Human(human bool) *EvaluateDataFrame
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
func (*EvaluateDataFrame) Index ¶
func (r *EvaluateDataFrame) Index(indexname string) *EvaluateDataFrame
Defines the `index` in which the evaluation will be performed. API name: index
func (EvaluateDataFrame) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*EvaluateDataFrame) Pretty ¶
func (r *EvaluateDataFrame) Pretty(pretty bool) *EvaluateDataFrame
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*EvaluateDataFrame) Query ¶
func (r *EvaluateDataFrame) Query(query types.QueryVariant) *EvaluateDataFrame
A query clause that retrieves a subset of data from the source index. API name: query
func (*EvaluateDataFrame) Raw ¶
func (r *EvaluateDataFrame) Raw(raw io.Reader) *EvaluateDataFrame
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*EvaluateDataFrame) Request ¶
func (r *EvaluateDataFrame) Request(req *Request) *EvaluateDataFrame
Request allows to set the request property with the appropriate payload.
type NewEvaluateDataFrame ¶
type NewEvaluateDataFrame func() *EvaluateDataFrame
NewEvaluateDataFrame type alias for index.
func NewEvaluateDataFrameFunc ¶
func NewEvaluateDataFrameFunc(tp elastictransport.Interface) NewEvaluateDataFrame
NewEvaluateDataFrameFunc returns a new instance of EvaluateDataFrame with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Request ¶
type Request struct {
// Evaluation Defines the type of evaluation you want to perform.
Evaluation types.DataframeEvaluationContainer `json:"evaluation"`
// Index Defines the `index` in which the evaluation will be performed.
Index string `json:"index"`
// Query A query clause that retrieves a subset of data from the source index.
Query *types.Query `json:"query,omitempty"`
}
Request holds the request body struct for the package evaluatedataframe
func (*Request) UnmarshalJSON ¶
type Response ¶
type Response struct {
// Classification Evaluation results for a classification analysis.
// It outputs a prediction that identifies to which of the classes each document
// belongs.
Classification *types.DataframeClassificationSummary `json:"classification,omitempty"`
// OutlierDetection Evaluation results for an outlier detection analysis.
// It outputs the probability that each document is an outlier.
OutlierDetection *types.DataframeOutlierDetectionSummary `json:"outlier_detection,omitempty"`
// Regression Evaluation results for a regression analysis which outputs a prediction of
// values.
Regression *types.DataframeRegressionSummary `json:"regression,omitempty"`
}
Response holds the response body struct for the package evaluatedataframe
Source Files