The highest tagged major version is
Documentation
¶
Overview ¶
Update an inference endpoint.
Modify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `task_type`.
IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.
Index ¶
- Variables
- type NewUpdate
- type Request
- type Response
- type Update
- func (r *Update) ChunkingSettings(chunkingsettings *types.InferenceChunkingSettings) *Update
- func (r Update) Do(providedCtx context.Context) (*Response, error)
- func (r *Update) ErrorTrace(errortrace bool) *Update
- func (r *Update) FilterPath(filterpaths ...string) *Update
- func (r *Update) Header(key, value string) *Update
- func (r *Update) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Update) Human(human bool) *Update
- func (r Update) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Update) Pretty(pretty bool) *Update
- func (r *Update) Raw(raw io.Reader) *Update
- func (r *Update) Request(req *Request) *Update
- func (r *Update) Service(service string) *Update
- func (r *Update) ServiceSettings(servicesettings json.RawMessage) *Update
- func (r *Update) TaskSettings(tasksettings json.RawMessage) *Update
- func (r *Update) TaskType(tasktype string) *Update
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 NewUpdate ¶
NewUpdate type alias for index.
func NewUpdateFunc ¶
func NewUpdateFunc(tp elastictransport.Interface) NewUpdate
NewUpdateFunc returns a new instance of Update with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Request ¶
type Request = types.InferenceEndpoint
Request holds the request body struct for the package update
type Response ¶
type Response struct {
// ChunkingSettings Chunking configuration object
ChunkingSettings *types.InferenceChunkingSettings `json:"chunking_settings,omitempty"`
// InferenceId The inference Id
InferenceId string `json:"inference_id"`
// Service The service type
Service string `json:"service"`
// ServiceSettings Settings specific to the service
ServiceSettings json.RawMessage `json:"service_settings"`
// TaskSettings Task settings specific to the service and task type
TaskSettings json.RawMessage `json:"task_settings,omitempty"`
// TaskType The task type
TaskType tasktype.TaskType `json:"task_type"`
}
Response holds the response body struct for the package update
type Update ¶
type Update struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Update
Update an inference endpoint.
Modify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `task_type`.
IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.
https://www.elastic.co/guide/en/elasticsearch/reference/current/update-inference-api.html
func (*Update) ChunkingSettings ¶
func (r *Update) ChunkingSettings(chunkingsettings *types.InferenceChunkingSettings) *Update
ChunkingSettings Chunking configuration object API name: chunking_settings
func (Update) Do ¶
Do runs the request through the transport, handle the response and returns a update.Response
func (*Update) ErrorTrace ¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Update) FilterPath ¶
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Update) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Update) Human ¶
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 (Update) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Update) Pretty ¶
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*Update) 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 (*Update) ServiceSettings ¶
func (r *Update) ServiceSettings(servicesettings json.RawMessage) *Update
ServiceSettings Settings specific to the service API name: service_settings
func (*Update) TaskSettings ¶
func (r *Update) TaskSettings(tasksettings json.RawMessage) *Update
TaskSettings Task settings specific to the service and task type API name: task_settings
Source Files