estimatemodelmemory

package
v8.13.1 Latest Latest
Warning

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

Go to latest
Published: Apr 11, 2024 License: Apache-2.0 Imports: 11 Imported by: 3

Documentation

Overview

Estimates the model memory

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 EstimateModelMemory

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

func (*EstimateModelMemory) AnalysisConfig added in v8.9.0

func (r *EstimateModelMemory) AnalysisConfig(analysisconfig *types.AnalysisConfig) *EstimateModelMemory

AnalysisConfig For a list of the properties that you can specify in the `analysis_config` component of the body of this API. API name: analysis_config

func (EstimateModelMemory) Do

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

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

func (*EstimateModelMemory) Header

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

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

func (*EstimateModelMemory) HttpRequest

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

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

func (*EstimateModelMemory) MaxBucketCardinality added in v8.9.0

func (r *EstimateModelMemory) MaxBucketCardinality(maxbucketcardinality map[string]int64) *EstimateModelMemory

MaxBucketCardinality Estimates of the highest cardinality in a single bucket that is observed for influencer fields over the time period that the job analyzes data. To produce a good answer, values must be provided for all influencer fields. Providing values for fields that are not listed as `influencers` has no effect on the estimation. API name: max_bucket_cardinality

func (*EstimateModelMemory) OverallCardinality added in v8.9.0

func (r *EstimateModelMemory) OverallCardinality(overallcardinality map[string]int64) *EstimateModelMemory

OverallCardinality Estimates of the cardinality that is observed for fields over the whole time period that the job analyzes data. To produce a good answer, values must be provided for fields referenced in the `by_field_name`, `over_field_name` and `partition_field_name` of any detectors. Providing values for other fields has no effect on the estimation. It can be omitted from the request if no detectors have a `by_field_name`, `over_field_name` or `partition_field_name`. API name: overall_cardinality

func (EstimateModelMemory) Perform added in v8.7.0

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

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

func (*EstimateModelMemory) Raw

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

func (*EstimateModelMemory) Request

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

type NewEstimateModelMemory

type NewEstimateModelMemory func() *EstimateModelMemory

NewEstimateModelMemory type alias for index.

func NewEstimateModelMemoryFunc

func NewEstimateModelMemoryFunc(tp elastictransport.Interface) NewEstimateModelMemory

NewEstimateModelMemoryFunc returns a new instance of EstimateModelMemory 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 {

	// AnalysisConfig For a list of the properties that you can specify in the
	// `analysis_config` component of the body of this API.
	AnalysisConfig *types.AnalysisConfig `json:"analysis_config,omitempty"`
	// MaxBucketCardinality Estimates of the highest cardinality in a single bucket that is observed
	// for influencer fields over the time period that the job analyzes data.
	// To produce a good answer, values must be provided for all influencer
	// fields. Providing values for fields that are not listed as `influencers`
	// has no effect on the estimation.
	MaxBucketCardinality map[string]int64 `json:"max_bucket_cardinality,omitempty"`
	// OverallCardinality Estimates of the cardinality that is observed for fields over the whole
	// time period that the job analyzes data. To produce a good answer, values
	// must be provided for fields referenced in the `by_field_name`,
	// `over_field_name` and `partition_field_name` of any detectors. Providing
	// values for other fields has no effect on the estimation. It can be
	// omitted from the request if no detectors have a `by_field_name`,
	// `over_field_name` or `partition_field_name`.
	OverallCardinality map[string]int64 `json:"overall_cardinality,omitempty"`
}

Request holds the request body struct for the package estimatemodelmemory

https://github.com/elastic/elasticsearch-specification/blob/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L61

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 {
	ModelMemoryEstimate string `json:"model_memory_estimate"`
}

Response holds the response body struct for the package estimatemodelmemory

https://github.com/elastic/elasticsearch-specification/blob/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/ml/estimate_model_memory/MlEstimateModelMemoryResponse.ts#L20-L24

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL