Documentation
¶
Overview ¶
Perform text embedding inference on the service
Index ¶
- Variables
- type NewTextEmbedding
- type Request
- type Response
- type TextEmbedding
- func (r TextEmbedding) Do(providedCtx context.Context) (*Response, error)
- func (r *TextEmbedding) ErrorTrace(errortrace bool) *TextEmbedding
- func (r *TextEmbedding) FilterPath(filterpaths ...string) *TextEmbedding
- func (r *TextEmbedding) Header(key, value string) *TextEmbedding
- func (r *TextEmbedding) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *TextEmbedding) Human(human bool) *TextEmbedding
- func (r *TextEmbedding) Input(inputs ...string) *TextEmbedding
- func (r TextEmbedding) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *TextEmbedding) Pretty(pretty bool) *TextEmbedding
- func (r *TextEmbedding) Raw(raw io.Reader) *TextEmbedding
- func (r *TextEmbedding) Request(req *Request) *TextEmbedding
- func (r *TextEmbedding) TaskSettings(tasksettings json.RawMessage) *TextEmbedding
- func (r *TextEmbedding) Timeout(duration string) *TextEmbedding
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 NewTextEmbedding ¶
type NewTextEmbedding func(inferenceid string) *TextEmbedding
NewTextEmbedding type alias for index.
func NewTextEmbeddingFunc ¶
func NewTextEmbeddingFunc(tp elastictransport.Interface) NewTextEmbedding
NewTextEmbeddingFunc returns a new instance of TextEmbedding 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 textembedding
func (*Request) UnmarshalJSON ¶
type Response ¶
type Response struct {
AdditionalTextEmbeddingInferenceResultProperty map[string]json.RawMessage `json:"-"`
TextEmbedding []types.TextEmbeddingResult `json:"text_embedding,omitempty"`
TextEmbeddingBits []types.TextEmbeddingByteResult `json:"text_embedding_bits,omitempty"`
TextEmbeddingBytes []types.TextEmbeddingByteResult `json:"text_embedding_bytes,omitempty"`
}
Response holds the response body struct for the package textembedding
type TextEmbedding ¶
type TextEmbedding struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *TextEmbedding
Perform text embedding inference on the service
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference
func (TextEmbedding) Do ¶
func (r TextEmbedding) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a textembedding.Response
func (*TextEmbedding) ErrorTrace ¶
func (r *TextEmbedding) ErrorTrace(errortrace bool) *TextEmbedding
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*TextEmbedding) FilterPath ¶
func (r *TextEmbedding) FilterPath(filterpaths ...string) *TextEmbedding
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*TextEmbedding) Header ¶
func (r *TextEmbedding) Header(key, value string) *TextEmbedding
Header set a key, value pair in the TextEmbedding headers map.
func (*TextEmbedding) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*TextEmbedding) Human ¶
func (r *TextEmbedding) Human(human bool) *TextEmbedding
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 (*TextEmbedding) Input ¶
func (r *TextEmbedding) Input(inputs ...string) *TextEmbedding
Inference input. Either a string or an array of strings. API name: input
func (TextEmbedding) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*TextEmbedding) Pretty ¶
func (r *TextEmbedding) Pretty(pretty bool) *TextEmbedding
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*TextEmbedding) Raw ¶
func (r *TextEmbedding) Raw(raw io.Reader) *TextEmbedding
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*TextEmbedding) Request ¶
func (r *TextEmbedding) Request(req *Request) *TextEmbedding
Request allows to set the request property with the appropriate payload.
func (*TextEmbedding) TaskSettings ¶
func (r *TextEmbedding) TaskSettings(tasksettings json.RawMessage) *TextEmbedding
Optional task settings API name: task_settings
func (*TextEmbedding) Timeout ¶
func (r *TextEmbedding) Timeout(duration string) *TextEmbedding
Timeout Specifies the amount of time to wait for the inference request to complete. API name: timeout
Source Files