The highest tagged major version isv9.
textembedding
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
- Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
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¶
typeNewTextEmbedding¶
type NewTextEmbedding func(inferenceidstring) *TextEmbedding
NewTextEmbedding type alias for index.
funcNewTextEmbeddingFunc¶
func NewTextEmbeddingFunc(tpelastictransport.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.
typeRequest¶
type Request struct {// Input Inference input.// Either a string or an array of strings.Input []string `json:"input"`// TaskSettings Optional task settingsTaskSettingsjson.RawMessage `json:"task_settings,omitempty"`}Request holds the request body struct for the package textembedding
func (*Request)UnmarshalJSON¶
typeResponse¶
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
typeTextEmbedding¶
type TextEmbedding struct {// contains filtered or unexported fields}funcNew¶
func New(tpelastictransport.Interface) *TextEmbedding
Perform text embedding inference on the service
https://www.elastic.co/guide/en/elasticsearch/reference/current/post-inference-api.html
func (TextEmbedding)Do¶
func (rTextEmbedding) Do(providedCtxcontext.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(errortracebool) *TextEmbedding
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen 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 responsereturned by Elasticsearch.API name: filter_path
func (*TextEmbedding)Header¶
func (r *TextEmbedding) Header(key, valuestring) *TextEmbedding
Header set a key, value pair in the TextEmbedding headers map.
func (*TextEmbedding)HttpRequest¶
HttpRequest returns the http.Request object built from thegiven parameters.
func (*TextEmbedding)Human¶
func (r *TextEmbedding) Human(humanbool) *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 humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human
func (*TextEmbedding)Input¶
func (r *TextEmbedding) Input(inputs ...string) *TextEmbedding
Input 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(prettybool) *TextEmbedding
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only usethis option for debugging only.API name: pretty
func (*TextEmbedding)Raw¶
func (r *TextEmbedding) Raw(rawio.Reader) *TextEmbedding
Raw takes a json payload as input which is then passed to the http.RequestIf 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(tasksettingsjson.RawMessage) *TextEmbedding
TaskSettings Optional task settingsAPI name: task_settings
func (*TextEmbedding)Timeout¶
func (r *TextEmbedding) Timeout(durationstring) *TextEmbedding
Timeout Specifies the amount of time to wait for the inference request to complete.API name: timeout
Source Files