Documentation
¶
Overview ¶
Create a AI21 inference endpoint.
Create an inference endpoint to perform an inference task with the `ai21` service.
Index ¶
- Variables
- type NewPutAi21
- type PutAi21
- func (r PutAi21) Do(providedCtx context.Context) (*Response, error)
- func (r *PutAi21) ErrorTrace(errortrace bool) *PutAi21
- func (r *PutAi21) FilterPath(filterpaths ...string) *PutAi21
- func (r *PutAi21) Header(key, value string) *PutAi21
- func (r *PutAi21) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PutAi21) Human(human bool) *PutAi21
- func (r PutAi21) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PutAi21) Pretty(pretty bool) *PutAi21
- func (r *PutAi21) Raw(raw io.Reader) *PutAi21
- func (r *PutAi21) Request(req *Request) *PutAi21
- func (r *PutAi21) Service(service ai21servicetype.Ai21ServiceType) *PutAi21
- func (r *PutAi21) ServiceSettings(servicesettings types.Ai21ServiceSettingsVariant) *PutAi21
- func (r *PutAi21) Timeout(duration string) *PutAi21
- 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 NewPutAi21 ¶
NewPutAi21 type alias for index.
func NewPutAi21Func ¶
func NewPutAi21Func(tp elastictransport.Interface) NewPutAi21
NewPutAi21Func returns a new instance of PutAi21 with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type PutAi21 ¶
type PutAi21 struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *PutAi21
Create a AI21 inference endpoint.
Create an inference endpoint to perform an inference task with the `ai21` service.
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-ai21
func (PutAi21) Do ¶
Do runs the request through the transport, handle the response and returns a putai21.Response
func (*PutAi21) ErrorTrace ¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*PutAi21) FilterPath ¶
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*PutAi21) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PutAi21) Human ¶
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_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 (PutAi21) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PutAi21) Pretty ¶
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*PutAi21) 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 (*PutAi21) Service ¶
func (r *PutAi21) Service(service ai21servicetype.Ai21ServiceType) *PutAi21
The type of service supported for the specified task type. In this case, `ai21`. API name: service
func (*PutAi21) ServiceSettings ¶
func (r *PutAi21) ServiceSettings(servicesettings types.Ai21ServiceSettingsVariant) *PutAi21
Settings used to install the inference model. These settings are specific to the `ai21` service. API name: service_settings
type Request ¶
type Request struct {
// Service The type of service supported for the specified task type. In this case,
// `ai21`.
Service ai21servicetype.Ai21ServiceType `json:"service"`
// ServiceSettings Settings used to install the inference model. These settings are specific to
// the `ai21` service.
ServiceSettings types.Ai21ServiceSettings `json:"service_settings"`
}
Request holds the request body struct for the package putai21
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 tasktypeai21.TaskTypeAi21 `json:"task_type"`
}
Response holds the response body struct for the package putai21
Source Files