infertrainedmodel

Documentation

Overview

Evaluate a trained model.

Index

• Variables
• type InferTrainedModel
  • func New(tp elastictransport.Interface) *InferTrainedModel
  • func (r InferTrainedModel) Do(providedCtx context.Context) (*Response, error)
  • func (r *InferTrainedModel) Docs(docs ...map[string]json.RawMessage) *InferTrainedModel
  • func (r *InferTrainedModel) ErrorTrace(errortrace bool) *InferTrainedModel
  • func (r *InferTrainedModel) FilterPath(filterpaths ...string) *InferTrainedModel
  • func (r *InferTrainedModel) Header(key, value string) *InferTrainedModel
  • func (r *InferTrainedModel) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *InferTrainedModel) Human(human bool) *InferTrainedModel
  • func (r *InferTrainedModel) InferenceConfig(inferenceconfig *types.InferenceConfigUpdateContainer) *InferTrainedModel
  • func (r InferTrainedModel) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *InferTrainedModel) Pretty(pretty bool) *InferTrainedModel
  • func (r *InferTrainedModel) Raw(raw io.Reader) *InferTrainedModel
  • func (r *InferTrainedModel) Request(req *Request) *InferTrainedModel
  • func (r *InferTrainedModel) Timeout(duration string) *InferTrainedModel
• type NewInferTrainedModel
  • func NewInferTrainedModelFunc(tp elastictransport.Interface) NewInferTrainedModel
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• 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 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/current/infer-trained-model.html

func (InferTrainedModel) Do

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

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

func (*InferTrainedModel) Docs

func (r *InferTrainedModel) Docs(docs ...map[string]json.RawMessage) *InferTrainedModel

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. API name: docs

func (*InferTrainedModel) ErrorTrace

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

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

func (*InferTrainedModel) FilterPath

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

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

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) Human

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

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 (*InferTrainedModel) InferenceConfig

func (r *InferTrainedModel) InferenceConfig(inferenceconfig *types.InferenceConfigUpdateContainer) *InferTrainedModel

InferenceConfig The inference configuration updates to apply on the API call API name: inference_config

func (InferTrainedModel) Perform

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

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

func (*InferTrainedModel) Pretty

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

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

func (*InferTrainedModel) Raw

func (r *InferTrainedModel) Raw(raw io.Reader) *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(duration 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]json.RawMessage `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/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/infer_trained_model/MlInferTrainedModelRequest.ts#L27-L60

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

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

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {
	InferenceResults []types.InferenceResponseResult `json:"inference_results"`
}

Response holds the response body struct for the package infertrainedmodel

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/infer_trained_model/MlInferTrainedModelResponse.ts#L22-L26

func NewResponse

func NewResponse() *Response

NewResponse returns a Response