explaindataframeanalytics

package
v8.17.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 17, 2024 License: Apache-2.0 Imports: 12 Imported by: 4

Documentation

Overview

Explain data frame analytics config. This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided: * which fields are included or not in the analysis and why, * how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation.

Index

Constants

This section is empty.

Variables

View Source 
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 ExplainDataFrameAnalytics 

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

func New 

func New(tp elastictransport.Interface) *ExplainDataFrameAnalytics

Explain data frame analytics config. This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided: * which fields are included or not in the analysis and why, * how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation.

http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html

func (*ExplainDataFrameAnalytics) AllowLazyStart added in v8.9.0 

func (r *ExplainDataFrameAnalytics) AllowLazyStart(allowlazystart bool) *ExplainDataFrameAnalytics

AllowLazyStart Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node. API name: allow_lazy_start

func (*ExplainDataFrameAnalytics) Analysis added in v8.9.0 

func (r *ExplainDataFrameAnalytics) Analysis(analysis *types.DataframeAnalysisContainer) *ExplainDataFrameAnalytics

Analysis The analysis configuration, which contains the information necessary to perform one of the following types of analysis: classification, outlier detection, or regression. API name: analysis

func (*ExplainDataFrameAnalytics) AnalyzedFields added in v8.9.0 

func (r *ExplainDataFrameAnalytics) AnalyzedFields(analyzedfields *types.DataframeAnalysisAnalyzedFields) *ExplainDataFrameAnalytics

AnalyzedFields Specify includes and/or excludes patterns to select which fields will be included in the analysis. The patterns specified in excludes are applied last, therefore excludes takes precedence. In other words, if the same field is specified in both includes and excludes, then the field will not be included in the analysis. API name: analyzed_fields

func (*ExplainDataFrameAnalytics) Description added in v8.9.0 

func (r *ExplainDataFrameAnalytics) Description(description string) *ExplainDataFrameAnalytics

Description A description of the job. API name: description

func (*ExplainDataFrameAnalytics) Dest added in v8.9.0 

func (r *ExplainDataFrameAnalytics) Dest(dest *types.DataframeAnalyticsDestination) *ExplainDataFrameAnalytics

Dest The destination configuration, consisting of index and optionally results_field (ml by default). API name: dest

func (ExplainDataFrameAnalytics) Do 

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

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

func (*ExplainDataFrameAnalytics) ErrorTrace added in v8.14.0 

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

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

func (*ExplainDataFrameAnalytics) FilterPath added in v8.14.0 

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

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

func (*ExplainDataFrameAnalytics) Header 

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

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

func (*ExplainDataFrameAnalytics) HttpRequest 

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

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

func (*ExplainDataFrameAnalytics) Human added in v8.14.0 

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

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 (*ExplainDataFrameAnalytics) Id 

func (r *ExplainDataFrameAnalytics) Id(id string) *ExplainDataFrameAnalytics

Id Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. API Name: id

func (*ExplainDataFrameAnalytics) MaxNumThreads added in v8.9.0 

func (r *ExplainDataFrameAnalytics) MaxNumThreads(maxnumthreads int) *ExplainDataFrameAnalytics

MaxNumThreads The maximum number of threads to be used by the analysis. Using more threads may decrease the time necessary to complete the analysis at the cost of using more CPU. Note that the process may use additional threads for operational functionality other than the analysis itself. API name: max_num_threads

func (*ExplainDataFrameAnalytics) ModelMemoryLimit added in v8.9.0 

func (r *ExplainDataFrameAnalytics) ModelMemoryLimit(modelmemorylimit string) *ExplainDataFrameAnalytics

ModelMemoryLimit The approximate maximum amount of memory resources that are permitted for analytical processing. If your `elasticsearch.yml` file contains an `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create data frame analytics jobs that have `model_memory_limit` values greater than that setting. API name: model_memory_limit

func (ExplainDataFrameAnalytics) Perform added in v8.7.0 

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

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

func (*ExplainDataFrameAnalytics) Pretty added in v8.14.0 

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

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

func (*ExplainDataFrameAnalytics) Raw 

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

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

func (*ExplainDataFrameAnalytics) Request 

func (r *ExplainDataFrameAnalytics) Request(req *Request) *ExplainDataFrameAnalytics

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

func (*ExplainDataFrameAnalytics) Source added in v8.9.0 

func (r *ExplainDataFrameAnalytics) Source(source *types.DataframeAnalyticsSource) *ExplainDataFrameAnalytics

Source The configuration of how to source the analysis data. It requires an index. Optionally, query and _source may be specified. API name: source

type NewExplainDataFrameAnalytics 

type NewExplainDataFrameAnalytics func() *ExplainDataFrameAnalytics

NewExplainDataFrameAnalytics type alias for index.

func NewExplainDataFrameAnalyticsFunc 

func NewExplainDataFrameAnalyticsFunc(tp elastictransport.Interface) NewExplainDataFrameAnalytics

NewExplainDataFrameAnalyticsFunc returns a new instance of ExplainDataFrameAnalytics 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 {

	// AllowLazyStart Specifies whether this job can start when there is insufficient machine
	// learning node capacity for it to be immediately assigned to a node.
	AllowLazyStart *bool `json:"allow_lazy_start,omitempty"`
	// Analysis The analysis configuration, which contains the information necessary to
	// perform one of the following types of analysis: classification, outlier
	// detection, or regression.
	Analysis *types.DataframeAnalysisContainer `json:"analysis,omitempty"`
	// AnalyzedFields Specify includes and/or excludes patterns to select which fields will be
	// included in the analysis. The patterns specified in excludes are applied
	// last, therefore excludes takes precedence. In other words, if the same
	// field is specified in both includes and excludes, then the field will not
	// be included in the analysis.
	AnalyzedFields *types.DataframeAnalysisAnalyzedFields `json:"analyzed_fields,omitempty"`
	// Description A description of the job.
	Description *string `json:"description,omitempty"`
	// Dest The destination configuration, consisting of index and optionally
	// results_field (ml by default).
	Dest *types.DataframeAnalyticsDestination `json:"dest,omitempty"`
	// MaxNumThreads The maximum number of threads to be used by the analysis. Using more
	// threads may decrease the time necessary to complete the analysis at the
	// cost of using more CPU. Note that the process may use additional threads
	// for operational functionality other than the analysis itself.
	MaxNumThreads *int `json:"max_num_threads,omitempty"`
	// ModelMemoryLimit The approximate maximum amount of memory resources that are permitted for
	// analytical processing. If your `elasticsearch.yml` file contains an
	// `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to
	// create data frame analytics jobs that have `model_memory_limit` values
	// greater than that setting.
	ModelMemoryLimit *string `json:"model_memory_limit,omitempty"`
	// Source The configuration of how to source the analysis data. It requires an
	// index. Optionally, query and _source may be specified.
	Source *types.DataframeAnalyticsSource `json:"source,omitempty"`
}

Request holds the request body struct for the package explaindataframeanalytics

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts#L30-L108

func NewRequest added in v8.5.0 

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0 

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

FromJSON allows to load an arbitrary json into the request structure

type Response added in v8.7.0 

type Response struct {

	// FieldSelection An array of objects that explain selection for each field, sorted by the
	// field names.
	FieldSelection []types.DataframeAnalyticsFieldSelection `json:"field_selection"`
	// MemoryEstimation An array of objects that explain selection for each field, sorted by the
	// field names.
	MemoryEstimation types.DataframeAnalyticsMemoryEstimation `json:"memory_estimation"`
}

Response holds the response body struct for the package explaindataframeanalytics

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsResponse.ts#L25-L32

func NewResponse added in v8.7.0 

func NewResponse() *Response

NewResponse returns a Response

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.