mltrainedmodels

Documentation

Overview

Gets configuration and usage information about inference trained models.

Index

• Variables
• type MlTrainedModels
  • func New(tp elastictransport.Interface) *MlTrainedModels
  • func (r *MlTrainedModels) AllowNoMatch(allownomatch bool) *MlTrainedModels
  • func (r *MlTrainedModels) Bytes(bytes bytes.Bytes) *MlTrainedModels
  • func (r MlTrainedModels) Do(ctx context.Context) (Response, error)
  • func (r *MlTrainedModels) From(from int) *MlTrainedModels
  • func (r *MlTrainedModels) H(cattrainedmodelscolumns ...cattrainedmodelscolumn.CatTrainedModelsColumn) *MlTrainedModels
  • func (r *MlTrainedModels) Header(key, value string) *MlTrainedModels
  • func (r *MlTrainedModels) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r MlTrainedModels) IsSuccess(ctx context.Context) (bool, error)
  • func (r *MlTrainedModels) ModelId(modelid string) *MlTrainedModels
  • func (r MlTrainedModels) Perform(ctx context.Context) (*http.Response, error)
  • func (r *MlTrainedModels) S(cattrainedmodelscolumns ...cattrainedmodelscolumn.CatTrainedModelsColumn) *MlTrainedModels
  • func (r *MlTrainedModels) Size(size int) *MlTrainedModels
• type NewMlTrainedModels
  • func NewMlTrainedModelsFunc(tp elastictransport.Interface) NewMlTrainedModels
• 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 MlTrainedModels

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

func New

func New(tp elastictransport.Interface) *MlTrainedModels

Gets configuration and usage information about inference trained models.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/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(ctx context.Context) (Response, error)

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

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) HttpRequest

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

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

func (MlTrainedModels) IsSuccess

func (r MlTrainedModels) IsSuccess(ctx 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) ModelId

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

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

func (MlTrainedModels) Perform

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

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

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

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

type Response []types.TrainedModelsRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response