deletemodel

Documentation

Overview

Delete model in the Inference API

Index

• Variables
• type DeleteModel
  • func New(tp elastictransport.Interface) *DeleteModel
  • func (r DeleteModel) Do(providedCtx context.Context) (*Response, error)
  • func (r *DeleteModel) Header(key, value string) *DeleteModel
  • func (r *DeleteModel) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r DeleteModel) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r DeleteModel) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *DeleteModel) TaskType(tasktype string) *DeleteModel
• type NewDeleteModel
  • func NewDeleteModelFunc(tp elastictransport.Interface) NewDeleteModel
• 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 DeleteModel

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

func New

func New(tp elastictransport.Interface) *DeleteModel

Delete model in the Inference API

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

func (DeleteModel) Do

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

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

func (*DeleteModel) Header

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

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

func (*DeleteModel) HttpRequest

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

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

func (DeleteModel) IsSuccess

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

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

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

func (*DeleteModel) TaskType

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

TaskType The task type API Name: tasktype

type NewDeleteModel

type NewDeleteModel func(inferenceid string) *DeleteModel

NewDeleteModel type alias for index.

func NewDeleteModelFunc

func NewDeleteModelFunc(tp elastictransport.Interface) NewDeleteModel

NewDeleteModelFunc returns a new instance of DeleteModel 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 {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package deletemodel

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/inference/delete_model/DeleteModelResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response