Struct elasticsearch::ml::MlGetTrainedModels

pub struct MlGetTrainedModels<'a, 'b> { /* private fields */ }

Builder for the Ml Get Trained Models API

Retrieves configuration information for a trained inference model.

Implementations

impl<'a, 'b> MlGetTrainedModels<'a, 'b>

pub fn new(transport: &'a Transport, parts: MlGetTrainedModelsParts<'b>) -> Self

Creates a new instance of MlGetTrainedModels with the specified API parts

pub fn allow_no_match(self, allow_no_match: bool) -> Self

Whether to ignore if a wildcard expression matches no trained models. (This includes _all string or when no trained models have been specified)

pub fn decompress_definition(self, decompress_definition: bool) -> Self

Should the model definition be decompressed into valid JSON or returned in a custom compressed format. Defaults to true.

pub fn error_trace(self, error_trace: bool) -> Self

Include the stack trace of returned errors.

pub fn exclude_generated(self, exclude_generated: bool) -> Self

Omits fields that are illegal to set on model PUT

pub fn filter_path(self, filter_path: &'b [&'b str]) -> Self

A comma-separated list of filters used to reduce the response.

pub fn from(self, from: i32) -> Self

skips a number of trained models

pub fn header(self, key: HeaderName, value: HeaderValue) -> Self

Adds a HTTP header

pub fn human(self, human: bool) -> Self

Return human readable values for statistics.

pub fn include(self, include: &'b str) -> Self

A comma-separate list of fields to optionally include. Valid options are ‘definition’ and ‘total_feature_importance’. Default is none.

pub fn include_model_definition(self, include_model_definition: bool) -> Self

Should the full model definition be included in the results. These definitions can be large. So be cautious when including them. Defaults to false.

pub fn pretty(self, pretty: bool) -> Self

Pretty format the returned JSON response.

pub fn request_timeout(self, timeout: Duration) -> Self

Sets a request timeout for this API call.

The timeout is applied from when the request starts connecting until the response body has finished.

pub fn size(self, size: i32) -> Self

specifies a max number of trained models to get

pub fn source(self, source: &'b str) -> Self

The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

pub fn tags(self, tags: &'b [&'b str]) -> Self

A comma-separated list of tags that the model must have.

pub async fn send(self) -> Result<Response, Error>

Creates an asynchronous call to the Ml Get Trained Models API that can be awaited

Trait Implementations

impl<'a, 'b> Clone for MlGetTrainedModels<'a, 'b>

fn clone(&self) -> MlGetTrainedModels<'a, 'b>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, 'b> Debug for MlGetTrainedModels<'a, 'b>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.