Documentation
¶
Overview ¶
Create an Amazon SageMaker inference endpoint.
Create an inference endpoint to perform an inference task with the `amazon_sagemaker` service.
Index ¶
- Variables
- type NewPutAmazonsagemaker
- type PutAmazonsagemaker
- func (r *PutAmazonsagemaker) ChunkingSettings(chunkingsettings types.InferenceChunkingSettingsVariant) *PutAmazonsagemaker
- func (r PutAmazonsagemaker) Do(providedCtx context.Context) (*Response, error)
- func (r *PutAmazonsagemaker) ErrorTrace(errortrace bool) *PutAmazonsagemaker
- func (r *PutAmazonsagemaker) FilterPath(filterpaths ...string) *PutAmazonsagemaker
- func (r *PutAmazonsagemaker) Header(key, value string) *PutAmazonsagemaker
- func (r *PutAmazonsagemaker) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PutAmazonsagemaker) Human(human bool) *PutAmazonsagemaker
- func (r PutAmazonsagemaker) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PutAmazonsagemaker) Pretty(pretty bool) *PutAmazonsagemaker
- func (r *PutAmazonsagemaker) Raw(raw io.Reader) *PutAmazonsagemaker
- func (r *PutAmazonsagemaker) Request(req *Request) *PutAmazonsagemaker
- func (r *PutAmazonsagemaker) Service(service amazonsagemakerservicetype.AmazonSageMakerServiceType) *PutAmazonsagemaker
- func (r *PutAmazonsagemaker) ServiceSettings(servicesettings types.AmazonSageMakerServiceSettingsVariant) *PutAmazonsagemaker
- func (r *PutAmazonsagemaker) TaskSettings(tasksettings types.AmazonSageMakerTaskSettingsVariant) *PutAmazonsagemaker
- func (r *PutAmazonsagemaker) Timeout(duration string) *PutAmazonsagemaker
- 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 NewPutAmazonsagemaker ¶
type NewPutAmazonsagemaker func(tasktype, amazonsagemakerinferenceid string) *PutAmazonsagemaker
NewPutAmazonsagemaker type alias for index.
func NewPutAmazonsagemakerFunc ¶
func NewPutAmazonsagemakerFunc(tp elastictransport.Interface) NewPutAmazonsagemaker
NewPutAmazonsagemakerFunc returns a new instance of PutAmazonsagemaker with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type PutAmazonsagemaker ¶
type PutAmazonsagemaker struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *PutAmazonsagemaker
Create an Amazon SageMaker inference endpoint.
Create an inference endpoint to perform an inference task with the `amazon_sagemaker` service.
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-amazonsagemaker
func (*PutAmazonsagemaker) ChunkingSettings ¶
func (r *PutAmazonsagemaker) ChunkingSettings(chunkingsettings types.InferenceChunkingSettingsVariant) *PutAmazonsagemaker
The chunking configuration object. API name: chunking_settings
func (PutAmazonsagemaker) Do ¶
func (r PutAmazonsagemaker) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a putamazonsagemaker.Response
func (*PutAmazonsagemaker) ErrorTrace ¶
func (r *PutAmazonsagemaker) ErrorTrace(errortrace bool) *PutAmazonsagemaker
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*PutAmazonsagemaker) FilterPath ¶
func (r *PutAmazonsagemaker) FilterPath(filterpaths ...string) *PutAmazonsagemaker
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*PutAmazonsagemaker) Header ¶
func (r *PutAmazonsagemaker) Header(key, value string) *PutAmazonsagemaker
Header set a key, value pair in the PutAmazonsagemaker headers map.
func (*PutAmazonsagemaker) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PutAmazonsagemaker) Human ¶
func (r *PutAmazonsagemaker) Human(human bool) *PutAmazonsagemaker
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 (PutAmazonsagemaker) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PutAmazonsagemaker) Pretty ¶
func (r *PutAmazonsagemaker) Pretty(pretty bool) *PutAmazonsagemaker
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*PutAmazonsagemaker) Raw ¶
func (r *PutAmazonsagemaker) Raw(raw io.Reader) *PutAmazonsagemaker
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*PutAmazonsagemaker) Request ¶
func (r *PutAmazonsagemaker) Request(req *Request) *PutAmazonsagemaker
Request allows to set the request property with the appropriate payload.
func (*PutAmazonsagemaker) Service ¶
func (r *PutAmazonsagemaker) Service(service amazonsagemakerservicetype.AmazonSageMakerServiceType) *PutAmazonsagemaker
The type of service supported for the specified task type. In this case, `amazon_sagemaker`. API name: service
func (*PutAmazonsagemaker) ServiceSettings ¶
func (r *PutAmazonsagemaker) ServiceSettings(servicesettings types.AmazonSageMakerServiceSettingsVariant) *PutAmazonsagemaker
Settings used to install the inference model. These settings are specific to the `amazon_sagemaker` service and `service_settings.api` you specified. API name: service_settings
func (*PutAmazonsagemaker) TaskSettings ¶
func (r *PutAmazonsagemaker) TaskSettings(tasksettings types.AmazonSageMakerTaskSettingsVariant) *PutAmazonsagemaker
Settings to configure the inference task. These settings are specific to the task type and `service_settings.api` you specified. API name: task_settings
func (*PutAmazonsagemaker) Timeout ¶
func (r *PutAmazonsagemaker) Timeout(duration string) *PutAmazonsagemaker
Timeout Specifies the amount of time to wait for the inference endpoint to be created. API name: timeout
type Request ¶
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, // `amazon_sagemaker`. Service amazonsagemakerservicetype.AmazonSageMakerServiceType `json:"service"` // ServiceSettings Settings used to install the inference model. // These settings are specific to the `amazon_sagemaker` service and // `service_settings.api` you specified. ServiceSettings types.AmazonSageMakerServiceSettings `json:"service_settings"` // TaskSettings Settings to configure the inference task. // These settings are specific to the task type and `service_settings.api` you // specified. TaskSettings *types.AmazonSageMakerTaskSettings `json:"task_settings,omitempty"` }
Request holds the request body struct for the package putamazonsagemaker
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 tasktypeamazonsagemaker.TaskTypeAmazonSageMaker `json:"task_type"` }
Response holds the response body struct for the package putamazonsagemaker