Documentation
¶
Overview ¶
Creates part of a trained model definition
Index ¶
- Variables
- type NewPutTrainedModelDefinitionPart
- type PutTrainedModelDefinitionPart
- func (r PutTrainedModelDefinitionPart) Do(ctx context.Context) (*http.Response, error)
- func (r *PutTrainedModelDefinitionPart) Header(key, value string) *PutTrainedModelDefinitionPart
- func (r *PutTrainedModelDefinitionPart) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PutTrainedModelDefinitionPart) ModelId(v string) *PutTrainedModelDefinitionPart
- func (r *PutTrainedModelDefinitionPart) Part(v string) *PutTrainedModelDefinitionPart
- func (r *PutTrainedModelDefinitionPart) Raw(raw json.RawMessage) *PutTrainedModelDefinitionPart
- func (r *PutTrainedModelDefinitionPart) Request(req *Request) *PutTrainedModelDefinitionPart
- type Request
- type RequestBuilder
- func (rb *RequestBuilder) Build() *Request
- func (rb *RequestBuilder) Definition(definition string) *RequestBuilder
- func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
- func (rb *RequestBuilder) TotalDefinitionLength(totaldefinitionlength int64) *RequestBuilder
- func (rb *RequestBuilder) TotalParts(totalparts int) *RequestBuilder
Constants ¶
This section is empty.
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.
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 New ¶
func New(tp elastictransport.Interface) *PutTrainedModelDefinitionPart
Creates part of a trained model definition
func (*PutTrainedModelDefinitionPart) Header ¶
func (r *PutTrainedModelDefinitionPart) Header(key, value string) *PutTrainedModelDefinitionPart
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) ModelId ¶
func (r *PutTrainedModelDefinitionPart) ModelId(v string) *PutTrainedModelDefinitionPart
ModelId The unique identifier of the trained model. API Name: modelid
func (*PutTrainedModelDefinitionPart) Part ¶
func (r *PutTrainedModelDefinitionPart) Part(v string) *PutTrainedModelDefinitionPart
Part The definition part number. When the definition is loaded for inference the definition parts are streamed in the order of their part number. The first part must be `0` and the final part must be `total_parts - 1`. API Name: part
func (*PutTrainedModelDefinitionPart) Raw ¶
func (r *PutTrainedModelDefinitionPart) Raw(raw json.RawMessage) *PutTrainedModelDefinitionPart
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 ¶
func (r *PutTrainedModelDefinitionPart) Request(req *Request) *PutTrainedModelDefinitionPart
Request allows to set the request property with the appropriate payload.
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
type RequestBuilder ¶
type RequestBuilder struct {
// contains filtered or unexported fields
}
RequestBuilder is the builder API for the puttrainedmodeldefinitionpart.Request
func NewRequestBuilder ¶
func NewRequestBuilder() *RequestBuilder
NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder
func (*RequestBuilder) Build ¶
func (rb *RequestBuilder) Build() *Request
Build finalize the chain and returns the Request struct.
func (*RequestBuilder) Definition ¶
func (rb *RequestBuilder) Definition(definition string) *RequestBuilder
func (*RequestBuilder) FromJSON ¶
func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
FromJSON allows to load an arbitrary json into the request structure
func (*RequestBuilder) TotalDefinitionLength ¶
func (rb *RequestBuilder) TotalDefinitionLength(totaldefinitionlength int64) *RequestBuilder
func (*RequestBuilder) TotalParts ¶
func (rb *RequestBuilder) TotalParts(totalparts int) *RequestBuilder
Source Files