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) Header(key, value string) *PutTrainedModelAlias
  • func (r *PutTrainedModelAlias) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r PutTrainedModelAlias) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r PutTrainedModelAlias) Perform(providedCtx context.Context) (*http.Response, error)
  • 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) 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) 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) 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/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/ml/put_trained_model_alias/MlPutTrainedModelAliasResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response