puttrainedmodelalias

Documentation

Overview

Creates a new model alias (or reassigns an existing one) to refer to the trained model

Index

• Variables
• type NewPutTrainedModelAlias
  • func NewPutTrainedModelAliasFunc(tp elastictransport.Interface) NewPutTrainedModelAlias
• type PutTrainedModelAlias
  • func New(tp elastictransport.Interface) *PutTrainedModelAlias
  • func (r PutTrainedModelAlias) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutTrainedModelAlias) ErrorTrace(errortrace bool) *PutTrainedModelAlias
  • func (r *PutTrainedModelAlias) FilterPath(filterpaths ...string) *PutTrainedModelAlias
  • func (r *PutTrainedModelAlias) Header(key, value string) *PutTrainedModelAlias
  • func (r *PutTrainedModelAlias) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutTrainedModelAlias) Human(human bool) *PutTrainedModelAlias
  • func (r PutTrainedModelAlias) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r PutTrainedModelAlias) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutTrainedModelAlias) Pretty(pretty bool) *PutTrainedModelAlias
  • func (r *PutTrainedModelAlias) Reassign(reassign bool) *PutTrainedModelAlias
• 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 NewPutTrainedModelAlias

type NewPutTrainedModelAlias func(modelid, modelalias string) *PutTrainedModelAlias

NewPutTrainedModelAlias type alias for index.

func NewPutTrainedModelAliasFunc

func NewPutTrainedModelAliasFunc(tp elastictransport.Interface) NewPutTrainedModelAlias

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

type PutTrainedModelAlias

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

func New

func New(tp elastictransport.Interface) *PutTrainedModelAlias

Creates a new model alias (or reassigns an existing one) to refer to the trained model

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

func (PutTrainedModelAlias) Do

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

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

func (*PutTrainedModelAlias) ErrorTrace

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

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

func (*PutTrainedModelAlias) FilterPath

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

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

func (*PutTrainedModelAlias) Header

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

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

func (*PutTrainedModelAlias) HttpRequest

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

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

func (*PutTrainedModelAlias) Human

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

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

func (r PutTrainedModelAlias) 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 (PutTrainedModelAlias) Perform

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

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

func (*PutTrainedModelAlias) Pretty

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

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

func (*PutTrainedModelAlias) Reassign

func (r *PutTrainedModelAlias) Reassign(reassign bool) *PutTrainedModelAlias

Reassign Specifies whether the alias gets reassigned to the specified trained model if it is already assigned to a different model. If the alias is already assigned and this parameter is false, the API returns an error. API name: reassign

type Response

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package puttrainedmodelalias

https://github.com/elastic/elasticsearch-specification/blob/07bf82537a186562d8699685e3704ea338b268ef/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response