gettrainedmodelsstats

Documentation

Overview

Get trained models usage info. You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.

Index

• Variables
• type GetTrainedModelsStats
  • func New(tp elastictransport.Interface) *GetTrainedModelsStats
  • func (r *GetTrainedModelsStats) AllowNoMatch(allownomatch bool) *GetTrainedModelsStats
  • func (r GetTrainedModelsStats) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetTrainedModelsStats) ErrorTrace(errortrace bool) *GetTrainedModelsStats
  • func (r *GetTrainedModelsStats) FilterPath(filterpaths ...string) *GetTrainedModelsStats
  • func (r *GetTrainedModelsStats) From(from int) *GetTrainedModelsStats
  • func (r *GetTrainedModelsStats) Header(key, value string) *GetTrainedModelsStats
  • func (r *GetTrainedModelsStats) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetTrainedModelsStats) Human(human bool) *GetTrainedModelsStats
  • func (r GetTrainedModelsStats) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetTrainedModelsStats) ModelId(modelid string) *GetTrainedModelsStats
  • func (r GetTrainedModelsStats) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetTrainedModelsStats) Pretty(pretty bool) *GetTrainedModelsStats
  • func (r *GetTrainedModelsStats) Size(size int) *GetTrainedModelsStats
• type NewGetTrainedModelsStats
  • func NewGetTrainedModelsStatsFunc(tp elastictransport.Interface) NewGetTrainedModelsStats
• 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 GetTrainedModelsStats

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

func New

func New(tp elastictransport.Interface) *GetTrainedModelsStats

Get trained models usage info. You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.

https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html

func (*GetTrainedModelsStats) AllowNoMatch

func (r *GetTrainedModelsStats) AllowNoMatch(allownomatch bool) *GetTrainedModelsStats

AllowNoMatch Specifies what to do when the request:

- Contains wildcard expressions and there are no models that match. - Contains the _all string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches.

If true, it returns an empty array when there are no matches and the subset of results when there are partial matches. API name: allow_no_match

func (GetTrainedModelsStats) Do

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

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

func (*GetTrainedModelsStats) ErrorTrace

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

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

func (*GetTrainedModelsStats) FilterPath

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

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

func (*GetTrainedModelsStats) From

func (r *GetTrainedModelsStats) From(from int) *GetTrainedModelsStats

From Skips the specified number of models. API name: from

func (*GetTrainedModelsStats) Header

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

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

func (*GetTrainedModelsStats) HttpRequest

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

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

func (*GetTrainedModelsStats) Human

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

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 (GetTrainedModelsStats) IsSuccess

func (r GetTrainedModelsStats) IsSuccess(providedCtx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (*GetTrainedModelsStats) ModelId

func (r *GetTrainedModelsStats) ModelId(modelid string) *GetTrainedModelsStats

ModelId The unique identifier of the trained model or a model alias. It can be a comma-separated list or a wildcard expression. API Name: modelid

func (GetTrainedModelsStats) Perform

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

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

func (*GetTrainedModelsStats) Pretty

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

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

func (*GetTrainedModelsStats) Size

func (r *GetTrainedModelsStats) Size(size int) *GetTrainedModelsStats

Size Specifies the maximum number of models to obtain. API name: size

type NewGetTrainedModelsStats

type NewGetTrainedModelsStats func() *GetTrainedModelsStats

NewGetTrainedModelsStats type alias for index.

func NewGetTrainedModelsStatsFunc

func NewGetTrainedModelsStatsFunc(tp elastictransport.Interface) NewGetTrainedModelsStats

NewGetTrainedModelsStatsFunc returns a new instance of GetTrainedModelsStats with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Response

type Response struct {

	// Count The total number of trained model statistics that matched the requested ID
	// patterns. Could be higher than the number of items in the trained_model_stats
	// array as the size of the array is restricted by the supplied size parameter.
	Count int `json:"count"`
	// TrainedModelStats An array of trained model statistics, which are sorted by the model_id value
	// in ascending order.
	TrainedModelStats []types.TrainedModelStats `json:"trained_model_stats"`
}

Response holds the response body struct for the package gettrainedmodelsstats

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsResponse.ts#L23-L33

func NewResponse

func NewResponse() *Response

NewResponse returns a Response