rerank

Documentation

Overview

Perform reranking inference on the service

Index

• Variables
• type NewRerank
  • func NewRerankFunc(tp elastictransport.Interface) NewRerank
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• type Rerank
  • func New(tp elastictransport.Interface) *Rerank
  • func (r Rerank) Do(providedCtx context.Context) (Response, error)
  • func (r *Rerank) ErrorTrace(errortrace bool) *Rerank
  • func (r *Rerank) FilterPath(filterpaths ...string) *Rerank
  • func (r *Rerank) Header(key, value string) *Rerank
  • func (r *Rerank) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Rerank) Human(human bool) *Rerank
  • func (r *Rerank) Input(inputs ...string) *Rerank
  • func (r Rerank) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Rerank) Pretty(pretty bool) *Rerank
  • func (r *Rerank) Query(query string) *Rerank
  • func (r *Rerank) Raw(raw io.Reader) *Rerank
  • func (r *Rerank) Request(req *Request) *Rerank
  • func (r *Rerank) TaskSettings(tasksettings json.RawMessage) *Rerank
  • func (r *Rerank) Timeout(duration string) *Rerank
• 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 NewRerank

type NewRerank func(inferenceid string) *Rerank

NewRerank type alias for index.

func NewRerankFunc

func NewRerankFunc(tp elastictransport.Interface) NewRerank

NewRerankFunc returns a new instance of Rerank 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 The text on which you want to perform the inference task.
	// It can be a single string or an array.
	//
	// > info
	// > Inference endpoints for the `completion` task type currently only support a
	// single string as input.
	Input []string `json:"input"`
	// Query Query input.
	Query string `json:"query"`
	// TaskSettings Task settings for the individual inference request.
	// These settings are specific to the task type you specified and override the
	// task settings specified when initializing the service.
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
}

Request holds the request body struct for the package rerank

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/inference/rerank/RerankRequest.ts#L25-L72

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 Rerank

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

func New

func New(tp elastictransport.Interface) *Rerank

Perform reranking inference on the service

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

func (Rerank) Do

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

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

func (*Rerank) ErrorTrace

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

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

func (*Rerank) FilterPath

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

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

func (*Rerank) Header

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

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

func (*Rerank) HttpRequest

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

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

func (*Rerank) Human

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

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

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

Input The text on which you want to perform the inference task. It can be a single string or an array.

> info > Inference endpoints for the `completion` task type currently only support a single string as input. API name: input

func (Rerank) Perform

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

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

func (*Rerank) Pretty

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

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

func (*Rerank) Query

func (r *Rerank) Query(query string) *Rerank

Query Query input. API name: query

func (*Rerank) Raw

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

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

func (*Rerank) Request

func (r *Rerank) Request(req *Request) *Rerank

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

func (*Rerank) TaskSettings

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

TaskSettings Task settings for the individual inference request. These settings are specific to the task type you specified and override the task settings specified when initializing the service. API name: task_settings

func (*Rerank) Timeout

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

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

type Response

type Response []types.RankedDocument

func NewResponse

func NewResponse() Response

NewResponse returns a Response