type NewPutCustom func(tasktype, custominferenceidstring) *PutCustom

funcNewPutCustomFunc¶

func NewPutCustomFunc(tpelastictransport.Interface)NewPutCustom

NewPutCustomFunc returns a new instance of PutCustom with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.

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

funcNew¶

func New(tpelastictransport.Interface) *PutCustom

Create a custom inference endpoint.

The custom service gives more control over how to interact with externalinference services that aren't explicitly supported through dedicatedintegrations.The custom service gives you the ability to define the headers, url, queryparameters, request body, and secrets.The custom service supports the template replacement functionality, whichenables you to define a template that can be replaced with the valueassociated with that key.Templates are portions of a string that start with `${` and end with `}`.The parameters `secret_parameters` and `task_settings` are checked for keysfor template replacement. Template replacement is supported in the `request`,`headers`, `url`, and `query_parameters`.If the definition (key) is not found for a template, an error message isreturned.In case of an endpoint definition like the following:```PUT _inference/text_embedding/test-text-embedding

{  "service": "custom",  "service_settings": {     "secret_parameters": {          "api_key": "<some api key>"     },     "url": "...endpoints.huggingface.cloud/v1/embeddings",     "headers": {         "Authorization": "Bearer ${api_key}",         "Content-Type": "application/json"     },     "request": "{\"input\": ${input}}",     "response": {         "json_parser": {             "text_embeddings":"$.data[*].embedding[*]"         }     }  }}

```To replace `${api_key}` the `secret_parameters` and `task_settings` arechecked for a key named `api_key`.

> info> Templates should not be surrounded by quotes.

Pre-defined templates:* `${input}` refers to the array of input strings that comes from the `input`field of the subsequent inference requests.* `${input_type}` refers to the input type translation values.* `${query}` refers to the query field used specifically for reranking tasks.* `${top_n}` refers to the `top_n` field available when performing rerankrequests.* `${return_documents}` refers to the `return_documents` field available whenperforming rerank requests.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-custom

func (*PutCustom)ChunkingSettings¶

func (r *PutCustom) ChunkingSettings(chunkingsettings *types.InferenceChunkingSettings) *PutCustom

ChunkingSettings The chunking configuration object.API name: chunking_settings

func (PutCustom)Do¶

func (rPutCustom) Do(providedCtxcontext.Context) (*Response,error)

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

func (*PutCustom)ErrorTrace¶

func (r *PutCustom) ErrorTrace(errortracebool) *PutCustom

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

func (*PutCustom)FilterPath¶

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

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

func (*PutCustom)Header¶

func (r *PutCustom) Header(key, valuestring) *PutCustom

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

func (*PutCustom)HttpRequest¶

func (r *PutCustom) HttpRequest(ctxcontext.Context) (*http.Request,error)

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

func (*PutCustom)Human¶

func (r *PutCustom) Human(humanbool) *PutCustom

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 (PutCustom)Perform¶

func (rPutCustom) Perform(providedCtxcontext.Context) (*http.Response,error)

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

func (*PutCustom)Pretty¶

func (r *PutCustom) Pretty(prettybool) *PutCustom

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

func (*PutCustom)Raw¶

func (r *PutCustom) Raw(rawio.Reader) *PutCustom

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

func (*PutCustom)Request¶

func (r *PutCustom) Request(req *Request) *PutCustom

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

func (*PutCustom)Service¶

func (r *PutCustom) Service(servicecustomservicetype.CustomServiceType) *PutCustom

Service The type of service supported for the specified task type. In this case,`custom`.API name: service

func (*PutCustom)ServiceSettings¶

func (r *PutCustom) ServiceSettings(servicesettings *types.CustomServiceSettings) *PutCustom

ServiceSettings Settings used to install the inference model.These settings are specific to the `custom` service.API name: service_settings

func (*PutCustom)TaskSettings¶

func (r *PutCustom) TaskSettings(tasksettings *types.CustomTaskSettings) *PutCustom

TaskSettings Settings to configure the inference task.These settings are specific to the task type you specified.API name: task_settings

type Request struct {// ChunkingSettings The chunking configuration object.ChunkingSettings *types.InferenceChunkingSettings `json:"chunking_settings,omitempty"`// Service The type of service supported for the specified task type. In this case,// `custom`.Servicecustomservicetype.CustomServiceType `json:"service"`// ServiceSettings Settings used to install the inference model.// These settings are specific to the `custom` service.ServiceSettingstypes.CustomServiceSettings `json:"service_settings"`// TaskSettings Settings to configure the inference task.// These settings are specific to the task type you specified.TaskSettings *types.CustomTaskSettings `json:"task_settings,omitempty"`}

funcNewRequest¶

func NewRequest() *Request

NewRequest returns a Request

func (*Request)FromJSON¶

func (r *Request) FromJSON(datastring) (*Request,error)

FromJSON allows to load an arbitrary json into the request structure

type Response struct {// ChunkingSettings Chunking configuration objectChunkingSettings *types.InferenceChunkingSettings `json:"chunking_settings,omitempty"`// InferenceId The inference IdInferenceIdstring `json:"inference_id"`// Service The service typeServicestring `json:"service"`// ServiceSettings Settings specific to the serviceServiceSettingsjson.RawMessage `json:"service_settings"`// TaskSettings Task settings specific to the service and task typeTaskSettingsjson.RawMessage `json:"task_settings,omitempty"`// TaskType The task typeTaskTypetasktypecustom.TaskTypeCustom `json:"task_type"`}

funcNewResponse¶

func NewResponse() *Response

NewResponse returns a Response