infertrainedmodel

Documentation

Overview

Evaluate a trained model.

Index

• Variables
• type InferTrainedModel
  • func New(tp elastictransport.Interface) *InferTrainedModel
  • func (r InferTrainedModel) Do(ctx context.Context) (*http.Response, error)
  • func (r *InferTrainedModel) Header(key, value string) *InferTrainedModel
  • func (r *InferTrainedModel) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *InferTrainedModel) ModelId(v string) *InferTrainedModel
  • func (r *InferTrainedModel) Raw(raw json.RawMessage) *InferTrainedModel
  • func (r *InferTrainedModel) Request(req *Request) *InferTrainedModel
  • func (r *InferTrainedModel) Timeout(value string) *InferTrainedModel
• type NewInferTrainedModel
  • func NewInferTrainedModelFunc(tp elastictransport.Interface) NewInferTrainedModel
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) Docs(value ...map[string]interface{}) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) InferenceConfig(inferenceconfig *types.InferenceConfigUpdateContainerBuilder) *RequestBuilder

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 InferTrainedModel

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

func New

func New(tp elastictransport.Interface) *InferTrainedModel

Evaluate a trained model.

https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html

func (InferTrainedModel) Do

func (r InferTrainedModel) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*InferTrainedModel) Header

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

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

func (*InferTrainedModel) HttpRequest

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

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

func (*InferTrainedModel) ModelId

func (r *InferTrainedModel) ModelId(v string) *InferTrainedModel

ModelId The unique identifier of the trained model. API Name: modelid

func (*InferTrainedModel) Raw

func (r *InferTrainedModel) Raw(raw json.RawMessage) *InferTrainedModel

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

func (*InferTrainedModel) Request

func (r *InferTrainedModel) Request(req *Request) *InferTrainedModel

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

func (*InferTrainedModel) Timeout

func (r *InferTrainedModel) Timeout(value string) *InferTrainedModel

Timeout Controls the amount of time to wait for inference results. API name: timeout

type NewInferTrainedModel

type NewInferTrainedModel func(modelid string) *InferTrainedModel

NewInferTrainedModel type alias for index.

func NewInferTrainedModelFunc

func NewInferTrainedModelFunc(tp elastictransport.Interface) NewInferTrainedModel

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

type Request

type Request struct {

	// Docs An array of objects to pass to the model for inference. The objects should
	// contain a fields matching your
	// configured trained model input. Typically, for NLP models, the field name is
	// `text_field`.
	// Currently, for NLP models, only a single value is allowed.
	Docs []map[string]interface{} `json:"docs"`

	// InferenceConfig The inference configuration updates to apply on the API call
	InferenceConfig *types.InferenceConfigUpdateContainer `json:"inference_config,omitempty"`
}

Request holds the request body struct for the package infertrainedmodel

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/ml/infer_trained_model/MlInferTrainedModelRequest.ts#L27-L59

type RequestBuilder

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

RequestBuilder is the builder API for the infertrainedmodel.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) Docs

func (rb *RequestBuilder) Docs(value ...map[string]interface{}) *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) InferenceConfig

func (rb *RequestBuilder) InferenceConfig(inferenceconfig *types.InferenceConfigUpdateContainerBuilder) *RequestBuilder