Documentation
¶
Overview ¶
Perform inference on a model
Index ¶
- Variables
- type Inference
- func (r Inference) Do(providedCtx context.Context) (*Response, error)
- func (r *Inference) Header(key, value string) *Inference
- func (r *Inference) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Inference) Input(inputs ...string) *Inference
- func (r Inference) Perform(providedCtx context.Context) (*http.Response, error)
- 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
- type NewInference
- type Request
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type Inference ¶
type Inference struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Inference
Perform inference on a model
https://www.elastic.co/guide/en/elasticsearch/reference/current/post-inference-api.html
func (Inference) Do ¶
Do runs the request through the transport, handle the response and returns a inference.Response
func (*Inference) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Inference) Input ¶
Input Text input to the model. Either a string or an array of strings. API name: input
func (Inference) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Inference) Raw ¶
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 ¶
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
type NewInference ¶
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 Text input to the model.
// 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 inference
func (*Request) UnmarshalJSON ¶ added in v8.12.1
type Response ¶
type Response struct {
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
Source Files