sparseembedding

Documentation

Overview

Perform sparse embedding inference on the service

Index

• Variables
• type NewSparseEmbedding
  • func NewSparseEmbeddingFunc(tp elastictransport.Interface) NewSparseEmbedding
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• type Response
  • func NewResponse() Response
• type SparseEmbedding
  • func New(tp elastictransport.Interface) *SparseEmbedding
  • func (r SparseEmbedding) Do(providedCtx context.Context) (Response, error)
  • func (r *SparseEmbedding) ErrorTrace(errortrace bool) *SparseEmbedding
  • func (r *SparseEmbedding) FilterPath(filterpaths ...string) *SparseEmbedding
  • func (r *SparseEmbedding) Header(key, value string) *SparseEmbedding
  • func (r *SparseEmbedding) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *SparseEmbedding) Human(human bool) *SparseEmbedding
  • func (r *SparseEmbedding) Input(inputs ...string) *SparseEmbedding
  • func (r SparseEmbedding) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *SparseEmbedding) Pretty(pretty bool) *SparseEmbedding
  • func (r *SparseEmbedding) Raw(raw io.Reader) *SparseEmbedding
  • func (r *SparseEmbedding) Request(req *Request) *SparseEmbedding
  • func (r *SparseEmbedding) TaskSettings(tasksettings json.RawMessage) *SparseEmbedding
  • func (r *SparseEmbedding) Timeout(duration string) *SparseEmbedding

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 NewSparseEmbedding

type NewSparseEmbedding func(inferenceid string) *SparseEmbedding

NewSparseEmbedding type alias for index.

func NewSparseEmbeddingFunc

func NewSparseEmbeddingFunc(tp elastictransport.Interface) NewSparseEmbedding

NewSparseEmbeddingFunc returns a new instance of SparseEmbedding 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 {

	// Input Inference input.
	// Either a string or an array of strings.
	Input []string `json:"input"`
	// TaskSettings Optional task settings
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
}

Request holds the request body struct for the package sparseembedding

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/inference/sparse_embedding/SparseEmbeddingRequest.ts#L25-L63

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

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

type Response

type Response []types.SparseEmbeddingResult

func NewResponse

func NewResponse() Response

NewResponse returns a Response

type SparseEmbedding

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

func New

func New(tp elastictransport.Interface) *SparseEmbedding

Perform sparse embedding inference on the service

https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference

func (SparseEmbedding) Do

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

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

func (*SparseEmbedding) ErrorTrace

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

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

func (*SparseEmbedding) FilterPath

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

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

func (*SparseEmbedding) Header

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

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

func (*SparseEmbedding) HttpRequest

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

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

func (*SparseEmbedding) Human

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

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 (*SparseEmbedding) Input

func (r *SparseEmbedding) Input(inputs ...string) *SparseEmbedding

Inference input. Either a string or an array of strings. API name: input

func (SparseEmbedding) Perform

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

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

func (*SparseEmbedding) Pretty

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

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

func (*SparseEmbedding) Raw

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

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

func (*SparseEmbedding) Request

func (r *SparseEmbedding) Request(req *Request) *SparseEmbedding

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

func (*SparseEmbedding) TaskSettings

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

Optional task settings API name: task_settings

func (*SparseEmbedding) Timeout

func (r *SparseEmbedding) Timeout(duration string) *SparseEmbedding

Timeout Specifies the amount of time to wait for the inference request to complete. API name: timeout