evaluatedataframe

Documentation

Overview

Evaluates the data frame analytics for an annotated index.

Index

• Variables
• type EvaluateDataFrame
  • func New(tp elastictransport.Interface) *EvaluateDataFrame
  • func (r EvaluateDataFrame) Do(providedCtx context.Context) (*Response, error)
  • func (r *EvaluateDataFrame) ErrorTrace(errortrace bool) *EvaluateDataFrame
  • func (r *EvaluateDataFrame) Evaluation(evaluation *types.DataframeEvaluationContainer) *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.Query) *EvaluateDataFrame
  • func (r *EvaluateDataFrame) Raw(raw io.Reader) *EvaluateDataFrame
  • func (r *EvaluateDataFrame) Request(req *Request) *EvaluateDataFrame
• type NewEvaluateDataFrame
  • func NewEvaluateDataFrameFunc(tp elastictransport.Interface) NewEvaluateDataFrame
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• type Response
  • func NewResponse() *Response

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.

Types

type EvaluateDataFrame

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

func New

func New(tp elastictransport.Interface) *EvaluateDataFrame

Evaluates the data frame analytics for an annotated index.

https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html

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.DataframeEvaluationContainer) *EvaluateDataFrame

Evaluation 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

func (r *EvaluateDataFrame) HttpRequest(ctx context.Context) (*http.Request, error)

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

Index Defines the `index` in which the evaluation will be performed. API name: index

func (EvaluateDataFrame) Perform

func (r EvaluateDataFrame) Perform(providedCtx context.Context) (*http.Response, error)

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.Query) *EvaluateDataFrame

Query 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

https://github.com/elastic/elasticsearch-specification/blob/07bf82537a186562d8699685e3704ea338b268ef/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts#L25-L52

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

type Response

type Response struct {
	Classification   *types.DataframeClassificationSummary   `json:"classification,omitempty"`
	OutlierDetection *types.DataframeOutlierDetectionSummary `json:"outlier_detection,omitempty"`
	Regression       *types.DataframeRegressionSummary       `json:"regression,omitempty"`
}

Response holds the response body struct for the package evaluatedataframe

https://github.com/elastic/elasticsearch-specification/blob/07bf82537a186562d8699685e3704ea338b268ef/specification/ml/evaluate_data_frame/MlEvaluateDataFrameResponse.ts#L26-L33

func NewResponse

func NewResponse() *Response

NewResponse returns a Response