mltrainedmodels

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: 13 Imported by: 4

Documentation

Overview

Get trained models. Returns configuration and usage information about inference trained models.

CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.

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 MlTrainedModels 

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

func New 

func New(tp elastictransport.Interface) *MlTrainedModels

Get trained models. Returns configuration and usage information about inference trained models.

CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.

https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html

func (*MlTrainedModels) AllowNoMatch 

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

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`, the API returns an empty array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches. API name: allow_no_match

func (*MlTrainedModels) Bytes 

func (r *MlTrainedModels) Bytes(bytes bytes.Bytes) *MlTrainedModels

Bytes The unit used to display byte values. API name: bytes

func (MlTrainedModels) Do 

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

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

func (*MlTrainedModels) ErrorTrace added in v8.14.0 

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

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

func (*MlTrainedModels) FilterPath added in v8.14.0 

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

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

func (*MlTrainedModels) Format added in v8.14.0 

func (r *MlTrainedModels) Format(format string) *MlTrainedModels

Format Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. API name: format

func (*MlTrainedModels) From 

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

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

func (*MlTrainedModels) H 

func (r *MlTrainedModels) H(cattrainedmodelscolumns ...cattrainedmodelscolumn.CatTrainedModelsColumn) *MlTrainedModels

H A comma-separated list of column names to display. API name: h

func (*MlTrainedModels) Header 

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

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

func (*MlTrainedModels) Help added in v8.14.0 

func (r *MlTrainedModels) Help(help bool) *MlTrainedModels

Help When set to `true` will output available columns. This option can't be combined with any other query string option. API name: help

func (*MlTrainedModels) HttpRequest 

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

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

func (*MlTrainedModels) Human added in v8.14.0 

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

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

func (r MlTrainedModels) 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 (*MlTrainedModels) Local added in v8.14.0 

func (r *MlTrainedModels) Local(local bool) *MlTrainedModels

Local If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. API name: local

func (*MlTrainedModels) MasterTimeout added in v8.14.0 

func (r *MlTrainedModels) MasterTimeout(duration string) *MlTrainedModels

MasterTimeout Period to wait for a connection to the master node. API name: master_timeout

func (*MlTrainedModels) ModelId 

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

ModelId A unique identifier for the trained model. API Name: modelid

func (MlTrainedModels) Perform added in v8.7.0 

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

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

func (*MlTrainedModels) Pretty added in v8.14.0 

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

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

func (*MlTrainedModels) S 

func (r *MlTrainedModels) S(cattrainedmodelscolumns ...cattrainedmodelscolumn.CatTrainedModelsColumn) *MlTrainedModels

S A comma-separated list of column names or aliases used to sort the response. API name: s

func (*MlTrainedModels) Size 

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

Size The maximum number of transforms to display. API name: size

func (*MlTrainedModels) V added in v8.14.0 

func (r *MlTrainedModels) V(v bool) *MlTrainedModels

V When set to `true` will enable verbose output. API name: v

type NewMlTrainedModels 

type NewMlTrainedModels func() *MlTrainedModels

NewMlTrainedModels type alias for index.

func NewMlTrainedModelsFunc 

func NewMlTrainedModelsFunc(tp elastictransport.Interface) NewMlTrainedModels

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

type Response added in v8.7.0 

type Response []types.TrainedModelsRecord

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.