amber-go-sdk v2 User Guide

amber_client

import "github.com/boonlogic/amber-go-sdk"

Index

## func LoadCsvRecords

func LoadCsvRecords(csvFile string) ([]string, error)

utility function to create csv payloads given a csv data file. output will be one continuous string of comma separated values

## func PackCsvAsByteSlice

func PackCsvAsByteSlice(csv string) ([]byte, error)

## type AmberClient

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

### func NewAmberClientFromFile

func NewAmberClientFromFile(licenseId *string, licenseFile *string) (*AmberClient, error)

Create new AmberClient using Amber license file

### func NewAmberClientFromProfile

func NewAmberClientFromProfile(profile LicenseProfile) (*AmberClient, error)

Create new AmberClient given LicenseProfile structure

### func (*AmberClient) ConfigureFusion

func (a *AmberClient) ConfigureFusion(sensorId string, payload amberModels.PutConfigRequest) (*amberModels.PutConfigResponse, *amberModels.Error)

### func (*AmberClient) ConfigureSensor

func (a *AmberClient) ConfigureSensor(sensorId string, payload amberModels.PostConfigRequest) (*amberModels.PostConfigResponse, *amberModels.Error)

### func (*AmberClient) CreateSensor

func (a *AmberClient) CreateSensor(label string) (*amberModels.PostSensorResponse, *amberModels.Error)

### func (*AmberClient) DeleteSensor

func (a *AmberClient) DeleteSensor(sensorId string) *amberModels.Error

### func (*AmberClient) EnableLearning

func (a *AmberClient) EnableLearning(sensorId string, payload amberModels.PutConfigRequest) (*amberModels.PutConfigResponse, *amberModels.Error)

### func (*AmberClient) GetConfig

func (a *AmberClient) GetConfig(sensorId string) (*amberModels.GetConfigResponse, *amberModels.Error)

### func (*AmberClient) GetPretrainState

func (a *AmberClient) GetPretrainState(sensorId string) (*amberModels.GetPretrainResponse, *amberModels.Error)

### func (*AmberClient) GetRootCause

func (a *AmberClient) GetRootCause(sensorId string, clusterIds []int32, patterns [][]float32) (*amberModels.GetRootCauseResponse, *amberModels.Error)

### func (*AmberClient) GetSensor

func (a *AmberClient) GetSensor(sensorId string) (*amberModels.GetSensorResponse, *amberModels.Error)

### func (*AmberClient) GetStatus

func (a *AmberClient) GetStatus(sensorId string) (*amberModels.GetStatusResponse, *amberModels.Error)

### func (*AmberClient) GetVersion

func (a *AmberClient) GetVersion() (*amberModels.Version, *amberModels.Error)

### func (*AmberClient) ListSensors

func (a *AmberClient) ListSensors() (*amberModels.GetSensorsResponse, *amberModels.Error)

### func (*AmberClient) PostOutage

func (a *AmberClient) PostOutage(sensorId string) (*amberModels.PostOutageResponse, *amberModels.Error)

### func (*AmberClient) PretrainSensor

func (a *AmberClient) PretrainSensor(sensorId string, payload amberModels.PostPretrainRequest) (*amberModels.PostPretrainResponse, *amberModels.Error)

### func (*AmberClient) PretrainSensorXL

func (a *AmberClient) PretrainSensorXL(sensorId string, request amberModels.PostPretrainRequest) (*amberModels.PostPretrainResponse, *amberModels.Error)

### func (*AmberClient) SetCert

func (a *AmberClient) SetCert(cert string) error

### func (*AmberClient) SetProxy

func (a *AmberClient) SetProxy(proxy string) error

### func (*AmberClient) SetTimeout

func (a *AmberClient) SetTimeout(timeout int) error

### func (*AmberClient) SetVerify

func (a *AmberClient) SetVerify(value bool) error

### func (*AmberClient) StreamFusion

func (a *AmberClient) StreamFusion(sensorId string, payload amberModels.PutStreamRequest) (*amberModels.PutStreamResponse, *amberModels.Error)

### func (*AmberClient) StreamSensor

func (a *AmberClient) StreamSensor(sensorId string, payload amberModels.PostStreamRequest) (*amberModels.PostStreamResponse, *amberModels.Error)

### func (*AmberClient) UpdateLabel

func (a *AmberClient) UpdateLabel(sensorId string, label string) (*amberModels.PutSensorResponse, *amberModels.Error)

## type CustomRoundTripper

type CustomRoundTripper struct {
    Proxied http.RoundTripper
}

### func (CustomRoundTripper) RoundTrip

func (crt CustomRoundTripper) RoundTrip(req *http.Request) (res *http.Response, e error)

## type LicenseProfile

type LicenseProfile struct {
    Username    string `json:"username"`
    Password    string `json:"password"`
    Server      string `json:"server"`
    OauthServer string `json:"oauth-server"`
}

models

import "github.com/boonlogic/amber-go-sdk/v2/models"

Index

Constants

const (

    // DataSetRunResponseStatusNone captures enum value "None"
    DataSetRunResponseStatusNone string = "None"

    // DataSetRunResponseStatusError captures enum value "Error"
    DataSetRunResponseStatusError string = "Error"

    // DataSetRunResponseStatusTraining captures enum value "Training"
    DataSetRunResponseStatusTraining string = "Training"

    // DataSetRunResponseStatusTrained captures enum value "Trained"
    DataSetRunResponseStatusTrained string = "Trained"

    // DataSetRunResponseStatusTesting captures enum value "Testing"
    DataSetRunResponseStatusTesting string = "Testing"

    // DataSetRunResponseStatusTested captures enum value "Tested"
    DataSetRunResponseStatusTested string = "Tested"
)

const (

    // FeatureConfigFusionRuleSubmit captures enum value "submit"
    FeatureConfigFusionRuleSubmit string = "submit"

    // FeatureConfigFusionRuleNosubmit captures enum value "nosubmit"
    FeatureConfigFusionRuleNosubmit string = "nosubmit"
)

const (

    // PostPretrainRequestFormatCsv captures enum value "csv"
    PostPretrainRequestFormatCsv string = "csv"

    // PostPretrainRequestFormatB64float captures enum value "b64float"
    PostPretrainRequestFormatB64float string = "b64float"

    // PostPretrainRequestFormatPackedDashFloat captures enum value "packed-float"
    PostPretrainRequestFormatPackedDashFloat string = "packed-float"
)

const (

    // PretrainStatusStatusNone captures enum value "None"
    PretrainStatusStatusNone string = "None"

    // PretrainStatusStatusChunking captures enum value "Chunking"
    PretrainStatusStatusChunking string = "Chunking"

    // PretrainStatusStatusPretraining captures enum value "Pretraining"
    PretrainStatusStatusPretraining string = "Pretraining"

    // PretrainStatusStatusPretrained captures enum value "Pretrained"
    PretrainStatusStatusPretrained string = "Pretrained"
)

const (

    // PutDataRequestFusionRuleDefault captures enum value "default"
    PutDataRequestFusionRuleDefault string = "default"

    // PutDataRequestFusionRuleSubmit captures enum value "submit"
    PutDataRequestFusionRuleSubmit string = "submit"

    // PutDataRequestFusionRuleNosubmit captures enum value "nosubmit"
    PutDataRequestFusionRuleNosubmit string = "nosubmit"
)

## type AmberState

AmberState Current state of the model within the Amber state machine. One of: `Buffering`, `Autotuning`, `Learning`, `Monitoring`.

During `Buffering`, the model simply collects data which will be used to automatically fit its clustering parameters. During this stage no analytic results are returned. Once the model has collected `bufferSamples` input patterns, it transitions to `Autotuning`.

During `Autotuning`, the model continues to collect data while using the data from `Buffering` to automatically discover good values for the clustering parameters (`minVal`, `maxVal` and `percentVariation`). No analytic results are returned during this stage, which does not last longer than 200 requests. Once finished, the model is configured with the newly discovered parameters and trained using all data collected during `Buffering` and `Autotuning`. At that point the model transitions to `Learning`.

During `Learning`, the model starts returning analytic results while establishing a baseline for the expected number of anomalies per unit time. It also begins returning analytic results. During this phase the underlying asset should operate in a mostly compliant mode, even though the model is highly tolerant of anomalies that occur during `Learning` (i.e. an anomalous pattern encountered here will be considered just as anomalous during `Monitoring`). `Learning` transitions to `Monitoring` once any of the following requirements are met: - the model’s `sampleCount` surpasses `learningMaxSamples` - the model’s `clusterCount` surpasses `learningMaxClusters` - `learningRateNumerator` or fewer new clusters were created within the last `learningRateDenominator` samples.

During `Monitoring`, all learning stops and the model continues to return analytic results. The model will remain in `Monitoring` until it is either re-configured or `Learning` is enabled again using `PUT /config`.

swagger:model amberState

type AmberState string

const (

    // AmberStateBuffering captures enum value "Buffering"
    AmberStateBuffering AmberState = "Buffering"

    // AmberStateAutotuning captures enum value "Autotuning"
    AmberStateAutotuning AmberState = "Autotuning"

    // AmberStateLearning captures enum value "Learning"
    AmberStateLearning AmberState = "Learning"

    // AmberStateMonitoring captures enum value "Monitoring"
    AmberStateMonitoring AmberState = "Monitoring"
)

### func NewAmberState

func NewAmberState(value AmberState) *AmberState

### func (AmberState) ContextValidate

func (m AmberState) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this amber state based on context it is used

### func (AmberState) Validate

func (m AmberState) Validate(formats strfmt.Registry) error

Validate validates this amber state

## type AnalyticResults

AnalyticResults analytic results

swagger:model analyticResults

type AnalyticResults struct {

    // A binary array where 1 means a pattern was anomalous and 0 means normal. This value is derived by thresholding the `anomalyIndex`.
    AD  []uint16 `json:"AD"`

    // The number of anomalous patterns in the last `historyWindow` samples. Specifically, this is a moving-window sum of the `anomalyDetection` array with window length `historyWindow`.
    AH  []uint16 `json:"AH"`

    // Amber warning level at each sample, a measure of the compliance of recent behavior compared to behavior observed during `Learning`. This value is derived from `recentAnomalies` and a statistical model of expectations about the usual frequency of anomalies.
    // - `0`: OK
    // - `1`: asset changing
    // - `2`: asset critical
    AW  []uint16 `json:"AW"`

    // See Boon Docs.
    CS  []uint16 `json:"CS"`

    // The cluster to which each input pattern was assigned. The first pattern is assigned a `clusterId` of 1. Each pattern thereafter is either assigned to an existing cluster (if its distance from that cluster is less than `percentVariation`) or creates a new cluster (if its distance from all clusters exceeds `percentVariation`). The `clusterId` for each new cluster is the current maximum `clusterId` plus one. For example, a model with 10 clusters will have `clusterIds` 1-10, and the next new cluster will have `clusterId` 11.
    //
    // During `Monitoring`, the cluster model becomes frozen and no new clusters are formed. Patterns which cannot be assigned to any existing cluster will return a negative `clusterId`. These `clusterIds` start at -1 and decreasing strictly by 1 without repeating (they can be used for root cause analysis).
    ID  []int32 `json:"ID"`

    // See Boon Docs.
    NI  []uint16 `json:"NI"`

    // See Boon Docs.
    NS  []uint16 `json:"NS"`

    // See Boon Docs.
    NW  []float32 `json:"NW"`

    // See Boon Docs.
    OM  []float32 `json:"OM"`

    // An anomaly index that represents the probability within the model of getting that cluster. PI is scaled so that 0 is the most probable cluster (least anomalous) and values close to 1000 represent very improbable clusters, that is, that very rarely occurred during training.
    PI  []uint16 `json:"PI"`

    // An integer between 0 and 1000 giving a measure of how anomalous this pattern is compared to patterns seen in the past. Values closer to 0 represent patterns which are ordinary given the data seen so far on this model, while values closer to 1000 represent anomalous patterns. Patterns with a high `anomalyIndex` belong to clusters with relatively few patterns compared to the other clusters.
    RI  []uint16 `json:"RI"`

    // Exponentially smoothed `anomalyIndex` over the last 15 samples. The range remains between 0 and 1000.
    SI  []uint16 `json:"SI"`
}

### func (*AnalyticResults) ContextValidate

func (m *AnalyticResults) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this analytic results based on context it is used

### func (*AnalyticResults) MarshalBinary

func (m *AnalyticResults) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*AnalyticResults) UnmarshalBinary

func (m *AnalyticResults) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*AnalyticResults) Validate

func (m *AnalyticResults) Validate(formats strfmt.Registry) error

Validate validates this analytic results

## type AutotuneConfig

AutotuneConfig autotune config

swagger:model autotuneConfig

type AutotuneConfig struct {

    // percent variation
    PercentVariation *bool `json:"percentVariation,omitempty"`

    // range
    Range *bool `json:"range,omitempty"`
}

### func (*AutotuneConfig) ContextValidate

func (m *AutotuneConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this autotune config based on context it is used

### func (*AutotuneConfig) MarshalBinary

func (m *AutotuneConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*AutotuneConfig) UnmarshalBinary

func (m *AutotuneConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*AutotuneConfig) Validate

func (m *AutotuneConfig) Validate(formats strfmt.Registry) error

Validate validates this autotune config

## type ConfigResponse

ConfigResponse config response

swagger:model configResponse

type ConfigResponse struct {

    // autotuning
    Autotuning *AutotuneConfig `json:"autotuning,omitempty"`

    // features
    Features []*FeatureConfigResponse `json:"features"`

    // percent variation
    PercentVariation *PercentVariation `json:"percentVariation,omitempty"`

    // streaming window
    StreamingWindow StreamingWindow `json:"streamingWindow,omitempty"`

    // training
    Training *TrainingConfig `json:"training,omitempty"`
}

### func (*ConfigResponse) ContextValidate

func (m *ConfigResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this config response based on the context it is used

### func (*ConfigResponse) MarshalBinary

func (m *ConfigResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*ConfigResponse) UnmarshalBinary

func (m *ConfigResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*ConfigResponse) Validate

func (m *ConfigResponse) Validate(formats strfmt.Registry) error

Validate validates this config response

## type DataSetRunResponse

DataSetRunResponse data set run response

swagger:model dataSetRunResponse

type DataSetRunResponse struct {

    // features
    Features []*PresignedURL `json:"features"`

    // Error description
    Message string `json:"message,omitempty"`

    // progress
    Progress uint16 `json:"progress,omitempty"`

    // results
    Results []*PresignedURL `json:"results"`

    // status
    // Enum: [None Error Training Trained Testing Tested]
    Status *string `json:"status,omitempty"`

    // url used for downloading test data plus analytics
    TestingResultsURL string `json:"testingResultsUrl,omitempty"`
}

### func (*DataSetRunResponse) ContextValidate

func (m *DataSetRunResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this data set run response based on the context it is used

### func (*DataSetRunResponse) MarshalBinary

func (m *DataSetRunResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*DataSetRunResponse) UnmarshalBinary

func (m *DataSetRunResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*DataSetRunResponse) Validate

func (m *DataSetRunResponse) Validate(formats strfmt.Registry) error

Validate validates this data set run response

## type DeleteModelResponse

DeleteModelResponse delete model response

swagger:model deleteModelResponse

type DeleteModelResponse struct {
    Error
}

### func (*DeleteModelResponse) ContextValidate

func (m *DeleteModelResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this delete model response based on the context it is used

### func (*DeleteModelResponse) MarshalBinary

func (m *DeleteModelResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (DeleteModelResponse) MarshalJSON

func (m DeleteModelResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

### func (*DeleteModelResponse) UnmarshalBinary

func (m *DeleteModelResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*DeleteModelResponse) UnmarshalJSON

func (m *DeleteModelResponse) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

### func (*DeleteModelResponse) Validate

func (m *DeleteModelResponse) Validate(formats strfmt.Registry) error

Validate validates this delete model response

## type Error

Error error

swagger:model error

type Error struct {

    // HTTP status code.
    Code uint16 `json:"code,omitempty"`

    // Error description.
    Message string `json:"message,omitempty"`
}

### func (*Error) ContextValidate

func (m *Error) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error based on context it is used

### func (*Error) MarshalBinary

func (m *Error) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*Error) UnmarshalBinary

func (m *Error) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*Error) Validate

func (m *Error) Validate(formats strfmt.Registry) error

Validate validates this error

## type FeatureConfig

FeatureConfig feature config

swagger:model featureConfig

type FeatureConfig struct {

    // Inference policy for the fusion vector when using `PUT /data`. If `submit`, any `PUT /data` request that updates this feature will cause the fusion vector to be submitted for inference. If `nosubmit`, updates to this feature will not trigger a fusion vector inference.
    // Enum: [submit nosubmit]
    FusionRule *string `json:"fusionRule,omitempty"`

    // Number of seconds without an update before this feature's value is considered invalid.
    FusionTTL *uint64 `json:"fusionTTL,omitempty"`

    // Maximum expected value for this feature. `maxVal` can be left unset if it is not known at configuration time. In that case, data collected during the `Buffering` stage will be used to infer an optimal value during the `Autotuning` stage and it will be set to the autotuned value at the start of `Learning`.
    MaxVal float32 `json:"maxVal,omitempty"`

    // Minimum expected value for this feature. `minVal` can be left unset if it is not known at configuration time. In that case, data collected during the `Buffering` stage will be used to infer an optimal `minVal` during the `Autotuning` stage and it will be set to the autotuned value at the start of `Learning`.
    MinVal float32 `json:"minVal,omitempty"`

    // Name for this feature. Must be unique with respect to other features in the configuration. Regex: `^[A-Za-z0-9.:_-]{1,1024}$`.
    Name string `json:"name,omitempty"`

    // Weight of this feature relative to others, as an integer between 1 and 1000.
    // Maximum: 1000
    // Minimum: 1
    Weight uint16 `json:"weight,omitempty"`
}

### func (*FeatureConfig) ContextValidate

func (m *FeatureConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this feature config based on context it is used

### func (*FeatureConfig) MarshalBinary

func (m *FeatureConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*FeatureConfig) UnmarshalBinary

func (m *FeatureConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*FeatureConfig) Validate

func (m *FeatureConfig) Validate(formats strfmt.Registry) error

Validate validates this feature config

## type FeatureConfigResponse

FeatureConfigResponse feature config response

swagger:model featureConfigResponse

type FeatureConfigResponse struct {
    FeatureConfig

    // Whether `minVal` and `maxVal` have been set for this feature (through either configuration or autotuning). `minVal` and `maxVal` are undefined when this field is false.
    MinMaxDefined bool `json:"minMaxDefined,omitempty"`
}

### func (*FeatureConfigResponse) ContextValidate

func (m *FeatureConfigResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this feature config response based on the context it is used

### func (*FeatureConfigResponse) MarshalBinary

func (m *FeatureConfigResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (FeatureConfigResponse) MarshalJSON

func (m FeatureConfigResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

### func (*FeatureConfigResponse) UnmarshalBinary

func (m *FeatureConfigResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*FeatureConfigResponse) UnmarshalJSON

func (m *FeatureConfigResponse) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

### func (*FeatureConfigResponse) Validate

func (m *FeatureConfigResponse) Validate(formats strfmt.Registry) error

Validate validates this feature config response

## type FeatureRootCause

FeatureRootCause feature root cause

swagger:model featureRootCause

type FeatureRootCause struct {

    // Name of this feature.
    Name string `json:"name"`

    // Root cause of this feature relative to others, as a number between 0.0 and 1.0. 0.0 indicates no contribution to the anomaly index, while a value close to 1.0 means the present anomaly implicates this feature strongly.
    // Maximum: 1
    // Minimum: 0
    Value *float32 `json:"value"`
}

### func (*FeatureRootCause) ContextValidate

func (m *FeatureRootCause) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this feature root cause based on context it is used

### func (*FeatureRootCause) MarshalBinary

func (m *FeatureRootCause) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*FeatureRootCause) UnmarshalBinary

func (m *FeatureRootCause) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*FeatureRootCause) Validate

func (m *FeatureRootCause) Validate(formats strfmt.Registry) error

Validate validates this feature root cause

## type FusionFeature

FusionFeature fusion feature

swagger:model fusionFeature

type FusionFeature struct {

    // Name of this feature.
    // Required: true
    Name *string `json:"name"`

    // Current value.
    // Required: true
    Value *float32 `json:"value"`
}

### func (*FusionFeature) ContextValidate

func (m *FusionFeature) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this fusion feature based on context it is used

### func (*FusionFeature) MarshalBinary

func (m *FusionFeature) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*FusionFeature) UnmarshalBinary

func (m *FusionFeature) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*FusionFeature) Validate

func (m *FusionFeature) Validate(formats strfmt.Registry) error

Validate validates this fusion feature

## type GetModelDataSetRunResponse

GetModelDataSetRunResponse get model data set run response

swagger:model getModelDataSetRunResponse

type GetModelDataSetRunResponse struct {
    DataSetRunResponse
}

### func (*GetModelDataSetRunResponse) ContextValidate

func (m *GetModelDataSetRunResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get model data set run response based on the context it is used

### func (*GetModelDataSetRunResponse) MarshalBinary

func (m *GetModelDataSetRunResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (GetModelDataSetRunResponse) MarshalJSON

func (m GetModelDataSetRunResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

### func (*GetModelDataSetRunResponse) UnmarshalBinary

func (m *GetModelDataSetRunResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*GetModelDataSetRunResponse) UnmarshalJSON

func (m *GetModelDataSetRunResponse) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

### func (*GetModelDataSetRunResponse) Validate

func (m *GetModelDataSetRunResponse) Validate(formats strfmt.Registry) error

Validate validates this get model data set run response

## type GetModelsResponse

GetModelsResponse get models response

swagger:model getModelsResponse

type GetModelsResponse struct {

    // model list
    ModelList []*Model `json:"modelList"`
}

### func (*GetModelsResponse) ContextValidate

func (m *GetModelsResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get models response based on the context it is used

### func (*GetModelsResponse) MarshalBinary

func (m *GetModelsResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*GetModelsResponse) UnmarshalBinary

func (m *GetModelsResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*GetModelsResponse) Validate

func (m *GetModelsResponse) Validate(formats strfmt.Registry) error

Validate validates this get models response

## type GetNanoStatusResponse

GetNanoStatusResponse get nano status response

swagger:model getNanoStatusResponse

type GetNanoStatusResponse struct {
    NanoStatus
}

### func (*GetNanoStatusResponse) ContextValidate

func (m *GetNanoStatusResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get nano status response based on the context it is used

### func (*GetNanoStatusResponse) MarshalBinary

func (m *GetNanoStatusResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (GetNanoStatusResponse) MarshalJSON

func (m GetNanoStatusResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

### func (*GetNanoStatusResponse) UnmarshalBinary

func (m *GetNanoStatusResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*GetNanoStatusResponse) UnmarshalJSON

func (m *GetNanoStatusResponse) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

### func (*GetNanoStatusResponse) Validate

func (m *GetNanoStatusResponse) Validate(formats strfmt.Registry) error

Validate validates this get nano status response

## type GetPretrainResponse

GetPretrainResponse get pretrain response

swagger:model getPretrainResponse

type GetPretrainResponse struct {
    PretrainStatus
}

### func (*GetPretrainResponse) ContextValidate

func (m *GetPretrainResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get pretrain response based on the context it is used

### func (*GetPretrainResponse) MarshalBinary

func (m *GetPretrainResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (GetPretrainResponse) MarshalJSON

func (m GetPretrainResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

### func (*GetPretrainResponse) UnmarshalBinary

func (m *GetPretrainResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*GetPretrainResponse) UnmarshalJSON

func (m *GetPretrainResponse) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

### func (*GetPretrainResponse) Validate

func (m *GetPretrainResponse) Validate(formats strfmt.Registry) error

Validate validates this get pretrain response

## type GetRootCauseResponse

GetRootCauseResponse get root cause response

swagger:model getRootCauseResponse

type GetRootCauseResponse struct {

    // root cause list
    RootCauseList [][]*FeatureRootCause `json:"rootCauseList"`
}

### func (*GetRootCauseResponse) ContextValidate

func (m *GetRootCauseResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get root cause response based on the context it is used

### func (*GetRootCauseResponse) MarshalBinary

func (m *GetRootCauseResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*GetRootCauseResponse) UnmarshalBinary

func (m *GetRootCauseResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*GetRootCauseResponse) Validate

func (m *GetRootCauseResponse) Validate(formats strfmt.Registry) error

Validate validates this get root cause response

## type GetStatusResponse

GetStatusResponse get status response

swagger:model getStatusResponse

type GetStatusResponse struct {
    ModelStatus
}

### func (*GetStatusResponse) ContextValidate

func (m *GetStatusResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get status response based on the context it is used

### func (*GetStatusResponse) MarshalBinary

func (m *GetStatusResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (GetStatusResponse) MarshalJSON

func (m GetStatusResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

### func (*GetStatusResponse) UnmarshalBinary

func (m *GetStatusResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*GetStatusResponse) UnmarshalJSON

func (m *GetStatusResponse) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

### func (*GetStatusResponse) Validate

func (m *GetStatusResponse) Validate(formats strfmt.Registry) error

Validate validates this get status response

## type GetSummaryResponse

GetSummaryResponse Summary response

swagger:model getSummaryResponse

type GetSummaryResponse string

### func (GetSummaryResponse) ContextValidate

func (m GetSummaryResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this get summary response based on context it is used

### func (GetSummaryResponse) Validate

func (m GetSummaryResponse) Validate(formats strfmt.Registry) error

Validate validates this get summary response

## type GetVersionResponse

GetVersionResponse get version response

swagger:model getVersionResponse

type GetVersionResponse struct {

    // SHA-1 of `amber-store`.
    AmberStore string `json:"amber-store,omitempty"`

    // API version.
    APIVersion string `json:"api-version,omitempty"`

    // SHA-1 of `builder`.
    Builder string `json:"builder,omitempty"`

    // SHA-1 of `expert-api`.
    ExpertAPI string `json:"expert-api,omitempty"`

    // SHA-1 of `expert-common`.
    ExpertCommon string `json:"expert-common,omitempty"`

    // SHA-1 of `mongolia`.
    Mongolia string `json:"mongolia,omitempty"`

    // SHA-1 of `nano-secure`.
    NanoSecure string `json:"nano-secure,omitempty"`

    // Software release of server.
    Release string `json:"release,omitempty"`

    // SHA-1 of Swagger UI.
    SwaggerUI string `json:"swagger-ui,omitempty"`
}

### func (*GetVersionResponse) ContextValidate

func (m *GetVersionResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this get version response based on context it is used

### func (*GetVersionResponse) MarshalBinary

func (m *GetVersionResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*GetVersionResponse) UnmarshalBinary

func (m *GetVersionResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*GetVersionResponse) Validate

func (m *GetVersionResponse) Validate(formats strfmt.Registry) error

Validate validates this get version response

## type Model

Model model

swagger:model model

type Model struct {

    // Model creation time in ISO format.
    Created string `json:"created,omitempty"`

    // Unique identifier for model.
    ID  string `json:"id,omitempty"`

    // Free-form label for this model.
    Label string `json:"label,omitempty"`

    // Last time model was updated, in ISO format.
    Modified string `json:"modified,omitempty"`
}

### func (*Model) ContextValidate

func (m *Model) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this model based on context it is used

### func (*Model) MarshalBinary

func (m *Model) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*Model) UnmarshalBinary

func (m *Model) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*Model) Validate

func (m *Model) Validate(formats strfmt.Registry) error

Validate validates this model

## type ModelStatus

ModelStatus model status

swagger:model modelStatus

type ModelStatus struct {

    // Total number of clusters generated by patterns so far.
    ClusterCount uint64 `json:"clusterCount"`

    // Current Amber compliance score: a ranged measure of the compliance of recent behavior compared to behavior observed in `Learning`.
    // - `0`: asset critical
    // - `100`: OK
    // Maximum: 100
    // Minimum: 0
    ComplianceScore *uint16 `json:"complianceScore"`

    // Reason for learning being turned off.
    Graduation string `json:"graduation"`

    // Unix time stamp of the last posted stream data
    LastModified uint64 `json:"lastModified,omitempty"`

    // number of seconds since the last posted stream data
    LastModifiedDelta uint64 `json:"lastModifiedDelta,omitempty"`

    // Status description.
    Message string `json:"message"`

    // During `Buffering`, `Learning` and `Autotuning`: estimated progress through the current state as an integer percentage.
    //
    // During `Monitoring`: this field does not apply.
    // Maximum: 100
    // Minimum: 0
    Progress *uint16 `json:"progress"`

    // Total number of patterns processed since configuration.
    SampleCount uint64 `json:"sampleCount"`

    // state
    State AmberState `json:"state,omitempty"`

    // Current Amber warning level, a measure of the compliance of recent behavior compared to behavior observed `Learning`.
    // - `0`: OK
    // - `1`: asset changing
    // - `2`: asset critical
    // Enum: [0 1 2]
    WarningLevel uint16 `json:"warningLevel"`
}

### func (*ModelStatus) ContextValidate

func (m *ModelStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this model status based on the context it is used

### func (*ModelStatus) MarshalBinary

func (m *ModelStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*ModelStatus) UnmarshalBinary

func (m *ModelStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*ModelStatus) Validate

func (m *ModelStatus) Validate(formats strfmt.Registry) error

Validate validates this model status

## type NanoStatus

NanoStatus nano status

swagger:model nanoStatus

type NanoStatus struct {

    // anomaly indexes
    AnomalyIndexes []uint16 `json:"anomalyIndexes"`

    // anomaly threshold
    AnomalyThreshold uint16 `json:"anomalyThreshold,omitempty"`

    // Total number of clusters generated by patterns so far.
    ClusterCount uint64 `json:"clusterCount"`

    // cluster growth
    ClusterGrowth []uint64 `json:"clusterGrowth"`

    // cluster sizes
    ClusterSizes []uint64 `json:"clusterSizes"`

    // distance indexes
    DistanceIndexes []uint16 `json:"distanceIndexes"`

    // frequency indexes
    FrequencyIndexes []uint16 `json:"frequencyIndexes"`

    // pca
    Pca [][]float32 `json:"pca"`

    // Total number of patterns processed since configuration.
    SampleCount uint64 `json:"sampleCount"`

    // state
    State AmberState `json:"state,omitempty"`
}

### func (*NanoStatus) ContextValidate

func (m *NanoStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this nano status based on the context it is used

### func (*NanoStatus) MarshalBinary

func (m *NanoStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*NanoStatus) UnmarshalBinary

func (m *NanoStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*NanoStatus) Validate

func (m *NanoStatus) Validate(formats strfmt.Registry) error

Validate validates this nano status

## type PercentVariation

PercentVariation Granularity of the underlying cluster model used for anomaly detection. This is a number between 0.01 and 0.20 which is the distance threshold used to determine whether a pattern should be assigned to an existing cluster or create a new cluster of its own. All things held equal, a small `percentVariation` will segment a dataset into many clusters while a larger `percentVariation` will segment the dataset into fewer clusters.

`percentVariation` can be left unset if it is not known at configuration time. In that case, data collected during the `Buffering` stage will be used to infer an optimal `percentVariation` during the `Autotuning` stage and it will be set to the autotuned value at the start of `Learning`.

swagger:model percentVariation

type PercentVariation float32

### func (PercentVariation) ContextValidate

func (m PercentVariation) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this percent variation based on context it is used

### func (PercentVariation) Validate

func (m PercentVariation) Validate(formats strfmt.Registry) error

Validate validates this percent variation

## type PostConfigRequest

PostConfigRequest post config request

swagger:model postConfigRequest

type PostConfigRequest struct {

    // autotuning
    Autotuning *AutotuneConfig `json:"autotuning,omitempty"`

    // features
    // Required: true
    Features []*FeatureConfig `json:"features"`

    // percent variation
    PercentVariation *PercentVariation `json:"percentVariation,omitempty"`

    // streaming window
    // Required: true
    StreamingWindow *StreamingWindow `json:"streamingWindow"`

    // training
    Training *TrainingConfig `json:"training,omitempty"`
}

### func (*PostConfigRequest) ContextValidate

func (m *PostConfigRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this post config request based on the context it is used

### func (*PostConfigRequest) MarshalBinary

func (m *PostConfigRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PostConfigRequest) UnmarshalBinary

func (m *PostConfigRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PostConfigRequest) Validate

func (m *PostConfigRequest) Validate(formats strfmt.Registry) error

Validate validates this post config request

## type PostConfigResponse

PostConfigResponse post config response

swagger:model postConfigResponse

type PostConfigResponse struct {
    ConfigResponse
}

### func (*PostConfigResponse) ContextValidate

func (m *PostConfigResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this post config response based on the context it is used

### func (*PostConfigResponse) MarshalBinary

func (m *PostConfigResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (PostConfigResponse) MarshalJSON

func (m PostConfigResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

### func (*PostConfigResponse) UnmarshalBinary

func (m *PostConfigResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PostConfigResponse) UnmarshalJSON

func (m *PostConfigResponse) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

### func (*PostConfigResponse) Validate

func (m *PostConfigResponse) Validate(formats strfmt.Registry) error

Validate validates this post config response

## type PostDataRequest

PostDataRequest post data request

swagger:model postDataRequest

type PostDataRequest struct {

    // Data as a flat list of comma-separated values. The number of values sent must be a multiple of the number of features in the configuration.
    // Required: true
    Data *string `json:"data"`

    // If false, saved model image will not be updated on this request. Applies only to on-premises deployments.
    SaveImage *bool `json:"saveImage,omitempty"`
}

### func (*PostDataRequest) ContextValidate

func (m *PostDataRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post data request based on context it is used

### func (*PostDataRequest) MarshalBinary

func (m *PostDataRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PostDataRequest) UnmarshalBinary

func (m *PostDataRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PostDataRequest) Validate

func (m *PostDataRequest) Validate(formats strfmt.Registry) error

Validate validates this post data request

## type PostDataResponse

PostDataResponse post data response

swagger:model postDataResponse

type PostDataResponse struct {

    // analytics
    Analytics *AnalyticResults `json:"analytics,omitempty"`

    // status
    Status *ModelStatus `json:"status,omitempty"`
}

### func (*PostDataResponse) ContextValidate

func (m *PostDataResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this post data response based on the context it is used

### func (*PostDataResponse) MarshalBinary

func (m *PostDataResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PostDataResponse) UnmarshalBinary

func (m *PostDataResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PostDataResponse) Validate

func (m *PostDataResponse) Validate(formats strfmt.Registry) error

Validate validates this post data response

## type PostLearningRequest

PostLearningRequest post learning request

swagger:model postLearningRequest

type PostLearningRequest struct {

    // training
    Training *TrainingConfig `json:"training,omitempty"`
}

### func (*PostLearningRequest) ContextValidate

func (m *PostLearningRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this post learning request based on the context it is used

### func (*PostLearningRequest) MarshalBinary

func (m *PostLearningRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PostLearningRequest) UnmarshalBinary

func (m *PostLearningRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PostLearningRequest) Validate

func (m *PostLearningRequest) Validate(formats strfmt.Registry) error

Validate validates this post learning request

## type PostLearningResponse

PostLearningResponse post learning response

swagger:model postLearningResponse

type PostLearningResponse struct {

    // status
    Status *ModelStatus `json:"status,omitempty"`

    // training
    Training *TrainingConfig `json:"training,omitempty"`
}

### func (*PostLearningResponse) ContextValidate

func (m *PostLearningResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this post learning response based on the context it is used

### func (*PostLearningResponse) MarshalBinary

func (m *PostLearningResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PostLearningResponse) UnmarshalBinary

func (m *PostLearningResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PostLearningResponse) Validate

func (m *PostLearningResponse) Validate(formats strfmt.Registry) error

Validate validates this post learning response

## type PostModelCopyRequest

PostModelCopyRequest post model copy request

swagger:model postModelCopyRequest

type PostModelCopyRequest struct {

    // Label for the new model. Allowed characters: `+.:_-` and any alphanumeric.
    Label *string `json:"label,omitempty"`
}

### func (*PostModelCopyRequest) ContextValidate

func (m *PostModelCopyRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post model copy request based on context it is used

### func (*PostModelCopyRequest) MarshalBinary

func (m *PostModelCopyRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PostModelCopyRequest) UnmarshalBinary

func (m *PostModelCopyRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PostModelCopyRequest) Validate

func (m *PostModelCopyRequest) Validate(formats strfmt.Registry) error

Validate validates this post model copy request

## type PostModelDataSetRunResponse

PostModelDataSetRunResponse post model data set run response

swagger:model postModelDataSetRunResponse

type PostModelDataSetRunResponse struct {
    DataSetRunResponse
}

### func (*PostModelDataSetRunResponse) ContextValidate

func (m *PostModelDataSetRunResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this post model data set run response based on the context it is used

### func (*PostModelDataSetRunResponse) MarshalBinary

func (m *PostModelDataSetRunResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (PostModelDataSetRunResponse) MarshalJSON

func (m PostModelDataSetRunResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

### func (*PostModelDataSetRunResponse) UnmarshalBinary

func (m *PostModelDataSetRunResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PostModelDataSetRunResponse) UnmarshalJSON

func (m *PostModelDataSetRunResponse) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

### func (*PostModelDataSetRunResponse) Validate

func (m *PostModelDataSetRunResponse) Validate(formats strfmt.Registry) error

Validate validates this post model data set run response

## type PostModelRequest

PostModelRequest post model request

swagger:model postModelRequest

type PostModelRequest struct {

    // Label for this model. Does not need to be unique. Allowed characters: `+.:_-` and any alphanumeric.
    Label string `json:"label,omitempty"`
}

### func (*PostModelRequest) ContextValidate

func (m *PostModelRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post model request based on context it is used

### func (*PostModelRequest) MarshalBinary

func (m *PostModelRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PostModelRequest) UnmarshalBinary

func (m *PostModelRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PostModelRequest) Validate

func (m *PostModelRequest) Validate(formats strfmt.Registry) error

Validate validates this post model request

## type PostModelResponse

PostModelResponse post model response

swagger:model postModelResponse

type PostModelResponse struct {
    Model
}

### func (*PostModelResponse) ContextValidate

func (m *PostModelResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this post model response based on the context it is used

### func (*PostModelResponse) MarshalBinary

func (m *PostModelResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (PostModelResponse) MarshalJSON

func (m PostModelResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

### func (*PostModelResponse) UnmarshalBinary

func (m *PostModelResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PostModelResponse) UnmarshalJSON

func (m *PostModelResponse) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

### func (*PostModelResponse) Validate

func (m *PostModelResponse) Validate(formats strfmt.Registry) error

Validate validates this post model response

## type PostOauth2AccessRequest

PostOauth2AccessRequest post oauth2 access request

swagger:model postOauth2AccessRequest

type PostOauth2AccessRequest struct {

    // Amber account license.
    // Required: true
    LicenseID *string `json:"licenseId"`

    // Amber account secret key.
    // Required: true
    SecretKey *string `json:"secretKey"`
}

### func (*PostOauth2AccessRequest) ContextValidate

func (m *PostOauth2AccessRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post oauth2 access request based on context it is used

### func (*PostOauth2AccessRequest) MarshalBinary

func (m *PostOauth2AccessRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PostOauth2AccessRequest) UnmarshalBinary

func (m *PostOauth2AccessRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PostOauth2AccessRequest) Validate

func (m *PostOauth2AccessRequest) Validate(formats strfmt.Registry) error

Validate validates this post oauth2 access request

## type PostOauth2AccessResponse

PostOauth2AccessResponse post oauth2 access response

swagger:model postOauth2AccessResponse

type PostOauth2AccessResponse struct {

    // Number of seconds before `idToken` becomes invalid.
    ExpiresIn string `json:"expiresIn,omitempty"`

    // Authorization token. Requests to all API endpoints except `POST /oauth2` must include a valid token in a header field called `Authorization` with value `Bearer ${idToken}`.
    IDToken string `json:"idToken,omitempty"`

    // Can be used to refresh the `idToken` when it is nearing expiration.
    RefreshToken string `json:"refreshToken,omitempty"`

    // Always `Bearer`.
    TokenType string `json:"tokenType,omitempty"`
}

### func (*PostOauth2AccessResponse) ContextValidate

func (m *PostOauth2AccessResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post oauth2 access response based on context it is used

### func (*PostOauth2AccessResponse) MarshalBinary

func (m *PostOauth2AccessResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PostOauth2AccessResponse) UnmarshalBinary

func (m *PostOauth2AccessResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PostOauth2AccessResponse) Validate

func (m *PostOauth2AccessResponse) Validate(formats strfmt.Registry) error

Validate validates this post oauth2 access response

## type PostOauth2RefreshRequest

PostOauth2RefreshRequest post oauth2 refresh request

swagger:model postOauth2RefreshRequest

type PostOauth2RefreshRequest struct {

    // Refresh token used to acquire new access token
    // Required: true
    RefreshToken *string `json:"refreshToken"`
}

### func (*PostOauth2RefreshRequest) ContextValidate

func (m *PostOauth2RefreshRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post oauth2 refresh request based on context it is used

### func (*PostOauth2RefreshRequest) MarshalBinary

func (m *PostOauth2RefreshRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PostOauth2RefreshRequest) UnmarshalBinary

func (m *PostOauth2RefreshRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PostOauth2RefreshRequest) Validate

func (m *PostOauth2RefreshRequest) Validate(formats strfmt.Registry) error

Validate validates this post oauth2 refresh request

## type PostOauth2RefreshResponse

PostOauth2RefreshResponse post oauth2 refresh response

swagger:model postOauth2RefreshResponse

type PostOauth2RefreshResponse struct {

    // Number of seconds before `idToken` becomes invalid.
    ExpiresIn string `json:"expiresIn,omitempty"`

    // Authorization token. Requests to all API endpoints except `POST /oauth2` must include a valid token in a header field called `Authorization` with value `Bearer ${idToken}`.
    IDToken string `json:"idToken,omitempty"`

    // Can be used to refresh the `idToken` when it is nearing expiration.
    RefreshToken string `json:"refreshToken,omitempty"`

    // Always `Bearer`.
    TokenType string `json:"tokenType,omitempty"`
}

### func (*PostOauth2RefreshResponse) ContextValidate

func (m *PostOauth2RefreshResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post oauth2 refresh response based on context it is used

### func (*PostOauth2RefreshResponse) MarshalBinary

func (m *PostOauth2RefreshResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PostOauth2RefreshResponse) UnmarshalBinary

func (m *PostOauth2RefreshResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PostOauth2RefreshResponse) Validate

func (m *PostOauth2RefreshResponse) Validate(formats strfmt.Registry) error

Validate validates this post oauth2 refresh response

## type PostPretrainRequest

PostPretrainRequest post pretrain request

swagger:model postPretrainRequest

type PostPretrainRequest struct {

    // Data in one of two formats:
    // 1) A flat list of comma-separated values.
    // 2) The string that results from flattening the dataset, packing the values into a byte buffer as float32s (little-endian), and base-64 encoding the buffer.
    //
    // Datasets which are too large to send in one request may be sent in multiple chunks using the header parameters for chunked uploads (`txnId` and `chunkspec`).
    //
    // The total number of data values sent for pretraining must be a multiple of the number of features in the configuration.
    // Required: true
    Data *string `json:"data"`

    // Format specifier for `data`.
    // Enum: [csv b64float packed-float]
    Format *string `json:"format,omitempty"`
}

### func (*PostPretrainRequest) ContextValidate

func (m *PostPretrainRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post pretrain request based on context it is used

### func (*PostPretrainRequest) MarshalBinary

func (m *PostPretrainRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PostPretrainRequest) UnmarshalBinary

func (m *PostPretrainRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PostPretrainRequest) Validate

func (m *PostPretrainRequest) Validate(formats strfmt.Registry) error

Validate validates this post pretrain request

## type PostPretrainResponse

PostPretrainResponse post pretrain response

swagger:model postPretrainResponse

type PostPretrainResponse struct {
    PretrainStatus

    // Chunk specifier for chunked uploads.
    Chunkspec string `json:"chunkspec,omitempty"`

    // Transaction id for chunked uploads.
    TxnID string `json:"txnId,omitempty"`
}

### func (*PostPretrainResponse) ContextValidate

func (m *PostPretrainResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this post pretrain response based on the context it is used

### func (*PostPretrainResponse) MarshalBinary

func (m *PostPretrainResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (PostPretrainResponse) MarshalJSON

func (m PostPretrainResponse) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

### func (*PostPretrainResponse) UnmarshalBinary

func (m *PostPretrainResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PostPretrainResponse) UnmarshalJSON

func (m *PostPretrainResponse) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

### func (*PostPretrainResponse) Validate

func (m *PostPretrainResponse) Validate(formats strfmt.Registry) error

Validate validates this post pretrain response

## type PresignedURL

PresignedURL presigned URL

swagger:model presignedURL

type PresignedURL struct {

    // feature name
    Name string `json:"name,omitempty"`

    // url used for downloading
    URL string `json:"url,omitempty"`
}

### func (*PresignedURL) ContextValidate

func (m *PresignedURL) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this presigned URL based on context it is used

### func (*PresignedURL) MarshalBinary

func (m *PresignedURL) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PresignedURL) UnmarshalBinary

func (m *PresignedURL) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PresignedURL) Validate

func (m *PresignedURL) Validate(formats strfmt.Registry) error

Validate validates this presigned URL

## type PretrainStatus

PretrainStatus pretrain status

swagger:model pretrainStatus

type PretrainStatus struct {

    // Pretraining status description.
    Message string `json:"message,omitempty"`

    // Pretraining status of the model. One of: `None`, `Chunking`, `Pretraining`, `Pretrained`.
    // Enum: [None Chunking Pretraining Pretrained]
    Status string `json:"status,omitempty"`
}

### func (*PretrainStatus) ContextValidate

func (m *PretrainStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this pretrain status based on context it is used

### func (*PretrainStatus) MarshalBinary

func (m *PretrainStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PretrainStatus) UnmarshalBinary

func (m *PretrainStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PretrainStatus) Validate

func (m *PretrainStatus) Validate(formats strfmt.Registry) error

Validate validates this pretrain status

## type PutDataRequest

PutDataRequest put data request

swagger:model putDataRequest

type PutDataRequest struct {

    // If `submit`, the fusion vector will be submitted for inference on this request. If `nosubmit`, this request will not trigger an inference. If `default`, follow the rules for the submitted features.
    // Enum: [default submit nosubmit]
    FusionRule *string `json:"fusionRule,omitempty"`

    // Updates to apply to the current fusion vector.
    // Required: true
    Vector []*FusionFeature `json:"vector"`
}

### func (*PutDataRequest) ContextValidate

func (m *PutDataRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this put data request based on the context it is used

### func (*PutDataRequest) MarshalBinary

func (m *PutDataRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PutDataRequest) UnmarshalBinary

func (m *PutDataRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PutDataRequest) Validate

func (m *PutDataRequest) Validate(formats strfmt.Registry) error

Validate validates this put data request

## type PutDataResponse

PutDataResponse put data response

swagger:model putDataResponse

type PutDataResponse struct {

    // analytics
    Analytics *AnalyticResults `json:"analytics,omitempty"`

    // status
    Status *ModelStatus `json:"status,omitempty"`

    // The current fusion vector.
    Vector map[string]float32 `json:"vector,omitempty"`
}

### func (*PutDataResponse) ContextValidate

func (m *PutDataResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this put data response based on the context it is used

### func (*PutDataResponse) MarshalBinary

func (m *PutDataResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PutDataResponse) UnmarshalBinary

func (m *PutDataResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PutDataResponse) Validate

func (m *PutDataResponse) Validate(formats strfmt.Registry) error

Validate validates this put data response

## type PutModelRequest

PutModelRequest put model request

swagger:model putModelRequest

type PutModelRequest struct {

    // New label for this model.
    // Required: true
    Label *string `json:"label"`
}

### func (*PutModelRequest) ContextValidate

func (m *PutModelRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this put model request based on context it is used

### func (*PutModelRequest) MarshalBinary

func (m *PutModelRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*PutModelRequest) UnmarshalBinary

func (m *PutModelRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*PutModelRequest) Validate

func (m *PutModelRequest) Validate(formats strfmt.Registry) error

Validate validates this put model request

## type StreamingWindow

StreamingWindow Number of recent input _vectors_ concatenated together to make up a full input _pattern_ presented to the model for inference.

Let `featureCount` be the configured number of features. The model consumes data sequentially in steps of size `featureCount`. Each time it receives `featureCount` data values, `featureCount` input values are consumed and concatenated together to form an input _vector_. This input vector is then concatenated with zero or more past input vectors to form an input _pattern_. The input _pattern_ is the true data vector inferenced by the model at each step. Configuring the `streamingWindow` greater than 1 allows a model to identify patterns in vectors that change over time.

If monitoring a single timeseries signal, the model should be configured with just one feature. In that case the input vector has length 1, and `streamingWindow` determines the length of a moving window over past samples which is the input pattern to the model for each new sample. For example, a model configured with one feature and a `streamingWindow` of 25 will concatenate together and inference the 25 most recent data values for each new value consumed.

If monitoring instantaneous readings from several sensors jointly, each sensor should be associated with one feature in the configuration. In this case `streamingWindow` is usually set to 1 so that the input pattern is just the current vector of readings. For example, a model configured with 5 features and a `streamingWindow` of 1 will consume 5 values at a time and inference those 5 values as a pattern of length 5. If the `streamingWindow` were 2, the model would still consume 5 values at a time, but its input pattern would contain the last 10 samples.

swagger:model streamingWindow

type StreamingWindow uint16

### func (StreamingWindow) ContextValidate

func (m StreamingWindow) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this streaming window based on context it is used

### func (StreamingWindow) Validate

func (m StreamingWindow) Validate(formats strfmt.Registry) error

Validate validates this streaming window

## type TrainingConfig

TrainingConfig training config

swagger:model trainingConfig

type TrainingConfig struct {

    // Number of data vectors to collect during `Buffering`. These samples are used as data for `Autotuning`.
    BufferingSamples *uint32 `json:"bufferingSamples,omitempty"`

    // Number of past inferences to take into account when computing `warningLevel` at a given moment.
    HistoryWindow *uint32 `json:"historyWindow,omitempty"`

    // Maximum number of clusters before model transitions from `Learning` to `Monitoring`.
    LearningMaxClusters *uint16 `json:"learningMaxClusters,omitempty"`

    // Maximum number of vectors to process during `Learning` before transitioning to `Monitoring`.
    LearningMaxSamples *uint64 `json:"learningMaxSamples,omitempty"`

    // See `learningRateNumerator`.
    LearningRateDenominator *uint64 `json:"learningRateDenominator,omitempty"`

    // Switch to `Monitoring` if there were fewer than `learningRateNumerator` new clusters in the last `learningRateDenominator` inferences.
    LearningRateNumerator *uint64 `json:"learningRateNumerator,omitempty"`
}

### func (*TrainingConfig) ContextValidate

func (m *TrainingConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this training config based on context it is used

### func (*TrainingConfig) MarshalBinary

func (m *TrainingConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

### func (*TrainingConfig) UnmarshalBinary

func (m *TrainingConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

### func (*TrainingConfig) Validate

func (m *TrainingConfig) Validate(formats strfmt.Registry) error

Validate validates this training config

Generated by gomarkdoc