inference

Documentation

Overview

Perform inference on the service

Index

• Variables
• type Inference
  • func New(tp elastictransport.Interface) *Inference
  • func (r Inference) Do(providedCtx context.Context) (*Response, error)
  • func (r *Inference) ErrorTrace(errortrace bool) *Inference
  • func (r *Inference) FilterPath(filterpaths ...string) *Inference
  • func (r *Inference) Header(key, value string) *Inference
  • func (r *Inference) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Inference) Human(human bool) *Inference
  • func (r *Inference) Input(inputs ...string) *Inference
  • func (r Inference) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Inference) Pretty(pretty bool) *Inference
  • func (r *Inference) Query(query string) *Inference
  • func (r *Inference) Raw(raw io.Reader) *Inference
  • func (r *Inference) Request(req *Request) *Inference
  • func (r *Inference) TaskSettings(tasksettings json.RawMessage) *Inference
  • func (r *Inference) TaskType(tasktype string) *Inference
  • func (r *Inference) Timeout(duration string) *Inference
• type NewInference
  • func NewInferenceFunc(tp elastictransport.Interface) NewInference
• 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

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 Inference

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

func New

func New(tp elastictransport.Interface) *Inference

Perform inference on the service

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

func (Inference) Do

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

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

func (*Inference) ErrorTrace

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

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

func (*Inference) FilterPath

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

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

func (*Inference) Header

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

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

func (*Inference) HttpRequest

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

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

func (*Inference) Human

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

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

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

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

func (Inference) Perform

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

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

func (*Inference) Pretty

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

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

func (*Inference) Query

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

Query Query input, required for rerank task. Not required for other tasks. API name: query

func (*Inference) Raw

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

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

func (*Inference) Request

func (r *Inference) Request(req *Request) *Inference

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

func (*Inference) TaskSettings

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

TaskSettings Optional task settings API name: task_settings

func (*Inference) TaskType

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

TaskType The task type API Name: tasktype

func (*Inference) Timeout

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

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

type NewInference

type NewInference func(inferenceid string) *Inference

NewInference type alias for index.

func NewInferenceFunc

func NewInferenceFunc(tp elastictransport.Interface) NewInference

NewInferenceFunc returns a new instance of Inference 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"`
	// Query Query input, required for rerank task.
	// Not required for other tasks.
	Query *string `json:"query,omitempty"`
	// TaskSettings Optional task settings
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
}

Request holds the request body struct for the package inference

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/inference/inference/InferenceRequest.ts#L26-L66

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 struct {
	Completion         []types.CompletionResult        `json:"completion,omitempty"`
	Rerank             []types.RankedDocument          `json:"rerank,omitempty"`
	SparseEmbedding    []types.SparseEmbeddingResult   `json:"sparse_embedding,omitempty"`
	TextEmbedding      []types.TextEmbeddingResult     `json:"text_embedding,omitempty"`
	TextEmbeddingBytes []types.TextEmbeddingByteResult `json:"text_embedding_bytes,omitempty"`
}

Response holds the response body struct for the package inference

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/inference/inference/InferenceResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response