revertmodelsnapshot

Documentation

Overview

Revert to a snapshot. The machine learning features react quickly to anomalous input, learning new behaviors in data. Highly anomalous input increases the variance in the models whilst the system learns whether this is a new step-change in behavior or a one-off event. In the case where this anomalous input is known to be a one-off, then it might be appropriate to reset the model state to a time before this event. For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure.

Index

• Variables
• type NewRevertModelSnapshot
  • func NewRevertModelSnapshotFunc(tp elastictransport.Interface) NewRevertModelSnapshot
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type RevertModelSnapshot
  • func New(tp elastictransport.Interface) *RevertModelSnapshot
  • func (r *RevertModelSnapshot) DeleteInterveningResults(deleteinterveningresults bool) *RevertModelSnapshot
  • func (r RevertModelSnapshot) Do(providedCtx context.Context) (*Response, error)
  • func (r *RevertModelSnapshot) ErrorTrace(errortrace bool) *RevertModelSnapshot
  • func (r *RevertModelSnapshot) FilterPath(filterpaths ...string) *RevertModelSnapshot
  • func (r *RevertModelSnapshot) Header(key, value string) *RevertModelSnapshot
  • func (r *RevertModelSnapshot) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *RevertModelSnapshot) Human(human bool) *RevertModelSnapshot
  • func (r RevertModelSnapshot) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *RevertModelSnapshot) Pretty(pretty bool) *RevertModelSnapshot
  • func (r *RevertModelSnapshot) Raw(raw io.Reader) *RevertModelSnapshot
  • func (r *RevertModelSnapshot) Request(req *Request) *RevertModelSnapshot

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 NewRevertModelSnapshot

type NewRevertModelSnapshot func(jobid, snapshotid string) *RevertModelSnapshot

NewRevertModelSnapshot type alias for index.

func NewRevertModelSnapshotFunc

func NewRevertModelSnapshotFunc(tp elastictransport.Interface) NewRevertModelSnapshot

NewRevertModelSnapshotFunc returns a new instance of RevertModelSnapshot 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 {

	// DeleteInterveningResults Refer to the description for the `delete_intervening_results` query
	// parameter.
	DeleteInterveningResults *bool `json:"delete_intervening_results,omitempty"`
}

Request holds the request body struct for the package revertmodelsnapshot

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ml/revert_model_snapshot/MlRevertModelSnapshotRequest.ts#L23-L70

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

type Response

type Response struct {
	Model types.ModelSnapshot `json:"model"`
}

Response holds the response body struct for the package revertmodelsnapshot

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ml/revert_model_snapshot/MlRevertModelSnapshotResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type RevertModelSnapshot

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

func New

func New(tp elastictransport.Interface) *RevertModelSnapshot

Revert to a snapshot. The machine learning features react quickly to anomalous input, learning new behaviors in data. Highly anomalous input increases the variance in the models whilst the system learns whether this is a new step-change in behavior or a one-off event. In the case where this anomalous input is known to be a one-off, then it might be appropriate to reset the model state to a time before this event. For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html

func (*RevertModelSnapshot) DeleteInterveningResults

func (r *RevertModelSnapshot) DeleteInterveningResults(deleteinterveningresults bool) *RevertModelSnapshot

DeleteInterveningResults Refer to the description for the `delete_intervening_results` query parameter. API name: delete_intervening_results

func (RevertModelSnapshot) Do

func (r RevertModelSnapshot) Do(providedCtx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a revertmodelsnapshot.Response

func (*RevertModelSnapshot) ErrorTrace

func (r *RevertModelSnapshot) ErrorTrace(errortrace bool) *RevertModelSnapshot

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*RevertModelSnapshot) FilterPath

func (r *RevertModelSnapshot) FilterPath(filterpaths ...string) *RevertModelSnapshot

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*RevertModelSnapshot) Header

func (r *RevertModelSnapshot) Header(key, value string) *RevertModelSnapshot

Header set a key, value pair in the RevertModelSnapshot headers map.

func (*RevertModelSnapshot) HttpRequest

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

HttpRequest returns the http.Request object built from the given parameters.

func (*RevertModelSnapshot) Human

func (r *RevertModelSnapshot) Human(human bool) *RevertModelSnapshot

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 (RevertModelSnapshot) Perform

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

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*RevertModelSnapshot) Pretty

func (r *RevertModelSnapshot) Pretty(pretty bool) *RevertModelSnapshot

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*RevertModelSnapshot) Raw

func (r *RevertModelSnapshot) Raw(raw io.Reader) *RevertModelSnapshot

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*RevertModelSnapshot) Request

func (r *RevertModelSnapshot) Request(req *Request) *RevertModelSnapshot

Request allows to set the request property with the appropriate payload.