puttrainedmodeldefinitionpart

package
v8.11.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 27, 2023 License: Apache-2.0 Imports: 11 Imported by: 4

Documentation

Overview

Creates part of a trained model definition

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 NewPutTrainedModelDefinitionPart

type NewPutTrainedModelDefinitionPart func(modelid, part string) *PutTrainedModelDefinitionPart

NewPutTrainedModelDefinitionPart type alias for index.

func NewPutTrainedModelDefinitionPartFunc

func NewPutTrainedModelDefinitionPartFunc(tp elastictransport.Interface) NewPutTrainedModelDefinitionPart

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

type PutTrainedModelDefinitionPart

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

func (*PutTrainedModelDefinitionPart) Definition added in v8.9.0

Definition The definition part for the model. Must be a base64 encoded string. API name: definition

func (PutTrainedModelDefinitionPart) Do

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

func (*PutTrainedModelDefinitionPart) Header

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

func (*PutTrainedModelDefinitionPart) HttpRequest

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

func (PutTrainedModelDefinitionPart) Perform added in v8.7.0

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

func (*PutTrainedModelDefinitionPart) Raw

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*PutTrainedModelDefinitionPart) Request

Request allows to set the request property with the appropriate payload.

func (*PutTrainedModelDefinitionPart) TotalDefinitionLength added in v8.9.0

func (r *PutTrainedModelDefinitionPart) TotalDefinitionLength(totaldefinitionlength int64) *PutTrainedModelDefinitionPart

TotalDefinitionLength The total uncompressed definition length in bytes. Not base64 encoded. API name: total_definition_length

func (*PutTrainedModelDefinitionPart) TotalParts added in v8.9.0

TotalParts The total number of parts that will be uploaded. Must be greater than 0. API name: total_parts

type Request

type Request struct {

	// Definition The definition part for the model. Must be a base64 encoded string.
	Definition string `json:"definition"`
	// TotalDefinitionLength The total uncompressed definition length in bytes. Not base64 encoded.
	TotalDefinitionLength int64 `json:"total_definition_length"`
	// TotalParts The total number of parts that will be uploaded. Must be greater than 0.
	TotalParts int `json:"total_parts"`
}

Request holds the request body struct for the package puttrainedmodeldefinitionpart

https://github.com/elastic/elasticsearch-specification/blob/5fea44e006349579bf3561a82e997002e5716117/specification/ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartRequest.ts#L24-L57

func NewRequest added in v8.5.0

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response added in v8.7.0

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 puttrainedmodeldefinitionpart

https://github.com/elastic/elasticsearch-specification/blob/5fea44e006349579bf3561a82e997002e5716117/specification/ml/put_trained_model_definition_part/MlPutTrainedModelDefinitionPartResponse.ts#L22-L24

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL