getmodel

Documentation

Overview

Get a model in the Inference API

Index

• Variables
• type GetModel
  • func New(tp elastictransport.Interface) *GetModel
  • func (r GetModel) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetModel) ErrorTrace(errortrace bool) *GetModel
  • func (r *GetModel) FilterPath(filterpaths ...string) *GetModel
  • func (r *GetModel) Header(key, value string) *GetModel
  • func (r *GetModel) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetModel) Human(human bool) *GetModel
  • func (r GetModel) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetModel) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetModel) Pretty(pretty bool) *GetModel
  • func (r *GetModel) TaskType(tasktype string) *GetModel
• type NewGetModel
  • func NewGetModelFunc(tp elastictransport.Interface) NewGetModel
• 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 GetModel

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

func New

func New(tp elastictransport.Interface) *GetModel

Get a model in the Inference API

https://www.elastic.co/guide/en/elasticsearch/reference/current/get-inference-api.html

func (GetModel) Do

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

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

func (*GetModel) ErrorTrace

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

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

func (*GetModel) FilterPath

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

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

func (*GetModel) Header

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

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

func (*GetModel) HttpRequest

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

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

func (*GetModel) Human

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

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 (GetModel) IsSuccess

func (r GetModel) 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 (GetModel) Perform

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

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

func (*GetModel) Pretty

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

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

func (*GetModel) TaskType

func (r *GetModel) TaskType(tasktype string) *GetModel

TaskType The task type API Name: tasktype

type NewGetModel

type NewGetModel func(inferenceid string) *GetModel

NewGetModel type alias for index.

func NewGetModelFunc

func NewGetModelFunc(tp elastictransport.Interface) NewGetModel

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

type Response

type Response struct {
	Models []types.ModelConfigContainer `json:"models"`
}

Response holds the response body struct for the package getmodel

https://github.com/elastic/elasticsearch-specification/blob/07bf82537a186562d8699685e3704ea338b268ef/specification/inference/get_model/GetModelResponse.ts#L22-L26

func NewResponse

func NewResponse() *Response

NewResponse returns a Response