Documentation
¶
Overview ¶
Retrieves usage information for trained inference models.
Index ¶
- Variables
- type GetTrainedModelsStats
- func (r *GetTrainedModelsStats) AllowNoMatch(allownomatch bool) *GetTrainedModelsStats
- func (r GetTrainedModelsStats) Do(providedCtx context.Context) (*Response, error)
- func (r *GetTrainedModelsStats) From(from int) *GetTrainedModelsStats
- func (r *GetTrainedModelsStats) Header(key, value string) *GetTrainedModelsStats
- func (r *GetTrainedModelsStats) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetTrainedModelsStats) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *GetTrainedModelsStats) ModelId(modelid string) *GetTrainedModelsStats
- func (r GetTrainedModelsStats) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetTrainedModelsStats) Size(size int) *GetTrainedModelsStats
- type NewGetTrainedModelsStats
- 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 GetTrainedModelsStats ¶
type GetTrainedModelsStats struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetTrainedModelsStats
Retrieves usage information for trained inference models.
https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html
func (*GetTrainedModelsStats) AllowNoMatch ¶
func (r *GetTrainedModelsStats) AllowNoMatch(allownomatch bool) *GetTrainedModelsStats
AllowNoMatch Specifies what to do when the request:
- Contains wildcard expressions and there are no models that match. - Contains the _all string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches.
If true, it returns an empty array when there are no matches and the subset of results when there are partial matches. API name: allow_no_match
func (GetTrainedModelsStats) Do ¶
func (r GetTrainedModelsStats) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a gettrainedmodelsstats.Response
func (*GetTrainedModelsStats) From ¶
func (r *GetTrainedModelsStats) From(from int) *GetTrainedModelsStats
From Skips the specified number of models. API name: from
func (*GetTrainedModelsStats) Header ¶
func (r *GetTrainedModelsStats) Header(key, value string) *GetTrainedModelsStats
Header set a key, value pair in the GetTrainedModelsStats headers map.
func (*GetTrainedModelsStats) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (GetTrainedModelsStats) IsSuccess ¶
func (r GetTrainedModelsStats) IsSuccess(providedCtx context.Context) (bool, error)
IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.
func (*GetTrainedModelsStats) ModelId ¶
func (r *GetTrainedModelsStats) ModelId(modelid string) *GetTrainedModelsStats
ModelId The unique identifier of the trained model or a model alias. It can be a comma-separated list or a wildcard expression. API Name: modelid
func (GetTrainedModelsStats) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetTrainedModelsStats) Size ¶
func (r *GetTrainedModelsStats) Size(size int) *GetTrainedModelsStats
Size Specifies the maximum number of models to obtain. API name: size
type NewGetTrainedModelsStats ¶
type NewGetTrainedModelsStats func() *GetTrainedModelsStats
NewGetTrainedModelsStats type alias for index.
func NewGetTrainedModelsStatsFunc ¶
func NewGetTrainedModelsStatsFunc(tp elastictransport.Interface) NewGetTrainedModelsStats
NewGetTrainedModelsStatsFunc returns a new instance of GetTrainedModelsStats with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶ added in v8.7.0
type Response struct {
// Count The total number of trained model statistics that matched the requested ID
// patterns. Could be higher than the number of items in the trained_model_stats
// array as the size of the array is restricted by the supplied size parameter.
Count int `json:"count"`
// TrainedModelStats An array of trained model statistics, which are sorted by the model_id value
// in ascending order.
TrainedModelStats []types.TrainedModelStats `json:"trained_model_stats"`
}
Response holds the response body struct for the package gettrainedmodelsstats
Source Files