putmodel

Documentation

Overview

Configure a model for use in the Inference API

Index

• Variables
• type NewPutModel
  • func NewPutModelFunc(tp elastictransport.Interface) NewPutModel
• type PutModel
  • func New(tp elastictransport.Interface) *PutModel
  • func (r PutModel) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutModel) ErrorTrace(errortrace bool) *PutModel
  • func (r *PutModel) FilterPath(filterpaths ...string) *PutModel
  • func (r *PutModel) Header(key, value string) *PutModel
  • func (r *PutModel) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutModel) Human(human bool) *PutModel
  • func (r PutModel) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutModel) Pretty(pretty bool) *PutModel
  • func (r *PutModel) Raw(raw io.Reader) *PutModel
  • func (r *PutModel) Request(req *Request) *PutModel
  • func (r *PutModel) Service(service string) *PutModel
  • func (r *PutModel) ServiceSettings(servicesettings json.RawMessage) *PutModel
  • func (r *PutModel) TaskSettings(tasksettings json.RawMessage) *PutModel
  • func (r *PutModel) TaskType(tasktype string) *PutModel
• type Request
  • func NewRequest() *Request
• 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 NewPutModel

type NewPutModel func(inferenceid string) *PutModel

NewPutModel type alias for index.

func NewPutModelFunc

func NewPutModelFunc(tp elastictransport.Interface) NewPutModel

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

type PutModel

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

func New

func New(tp elastictransport.Interface) *PutModel

Configure a model for use in the Inference API

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

func (PutModel) Do

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

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

func (*PutModel) ErrorTrace

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

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

func (*PutModel) FilterPath

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

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

func (*PutModel) Header

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

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

func (*PutModel) HttpRequest

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

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

func (*PutModel) Human

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

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 (PutModel) Perform

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

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

func (*PutModel) Pretty

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

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

func (*PutModel) Raw

func (r *PutModel) Raw(raw io.Reader) *PutModel

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

func (*PutModel) Request

func (r *PutModel) Request(req *Request) *PutModel

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

func (*PutModel) Service

func (r *PutModel) Service(service string) *PutModel

Service The service type API name: service

func (*PutModel) ServiceSettings

func (r *PutModel) ServiceSettings(servicesettings json.RawMessage) *PutModel

ServiceSettings Settings specific to the service API name: service_settings

func (*PutModel) TaskSettings

func (r *PutModel) TaskSettings(tasksettings json.RawMessage) *PutModel

TaskSettings Task settings specific to the service and model API name: task_settings

func (*PutModel) TaskType

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

TaskType The task type API Name: tasktype

type Request

type Request = types.ModelConfig

Request holds the request body struct for the package putmodel

https://github.com/elastic/elasticsearch-specification/blob/07bf82537a186562d8699685e3704ea338b268ef/specification/inference/put_model/PutModelRequest.ts#L25-L44

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

type Response

type Response struct {

	// ModelId The model Id
	ModelId string `json:"model_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and model
	TaskSettings json.RawMessage `json:"task_settings"`
	// TaskType The model's task type
	TaskType tasktype.TaskType `json:"task_type"`
}

Response holds the response body struct for the package putmodel

https://github.com/elastic/elasticsearch-specification/blob/07bf82537a186562d8699685e3704ea338b268ef/specification/inference/put_model/PutModelResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response