response

Documentation

Index

• type App
• type AppState
• type Dashboard
• type DeleteExperiment
• type Error
• type ExperimentRun
• type Experiments
• type GetExperiment
• type GetExperimentActivity
• type GetExperimentRuns
• type GetProjectResponse
• type GetRunInfo
• type GetRunInfoExperiment
• type GetRunInfoParams
• type GetRunInfoProps
• type GetRunInfoTraces
• type GetRunMetrics
• type GetRunsActive
• type ProjectActivityResponse
• type ProjectParamsResponse
• type RunMetrics
• type Success

Types

type App

type App struct {
	ID        string    `json:"id"`
	Type      string    `json:"type"`
	State     AppState  `json:"state"`
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
}

App represents the response json in App endpoints

type AppState

type AppState map[string]any

AppState represents key/value state data

type Dashboard

type Dashboard struct {
	ID          string    `json:"id"`
	Name        string    `json:"name"`
	Description string    `json:"description"`
	AppID       uuid.UUID `json:"app_id"`
	Type        string    `json:"app_type"`
	CreatedAt   time.Time `json:"created_at"`
	UpdatedAt   time.Time `json:"updated_at"`
}

Dashboard represents the response json in Dashboard endpoints

type DeleteExperiment

type DeleteExperiment struct {
	ID     string `json:"id"`
	Status string `json:"status"`
}

DeleteExperiment represents the response json fot the DeleteExperimnt endpoint.

type Error

type Error struct {
	Message string `json:"message"`
	Detail  string `json:"detail"`
}

Error represents the response json in api errors

type ExperimentRun

type ExperimentRun struct {
	ID           string  `json:"run_id"`
	Name         string  `json:"name"`
	CreationTime float64 `json:"creation_time"`
	EndTime      float64 `json:"end_time"`
	Archived     bool    `json:"archived"`
}

ExperimentRun represents a run of an experiment.

type Experiments

type Experiments []GetExperiment

Experiments is the response struct for the GetExperiments endpoint (slice of GetExperiment).

type GetExperiment

type GetExperiment struct {
	ID           int32   `json:"id"`
	Name         string  `json:"name"`
	Description  string  `json:"description"`
	Archived     bool    `json:"archived"`
	RunCount     int     `json:"run_count"`
	CreationTime float64 `json:"creation_time"`
}

GetExperiment represents the response json fot the GetExperimnt endpoint.

type GetExperimentActivity

type GetExperimentActivity struct {
	NumRuns         int            `json:"num_runs"`
	NumArchivedRuns int            `json:"num_archived_runs"`
	NumActiveRuns   int            `json:"num_active_runs"`
	ActivityMap     map[string]int `json:"activity_map"`
}

GetExperiment represents the response json fot the GetExperimntActivity endpoint.

type GetExperimentRuns

type GetExperimentRuns struct {
	ID   string          `json:"id"`
	Runs []ExperimentRun `json:"runs"`
}

GetExperiment represents the response json fot the GetExperimntRuns endpoint.

type GetProjectResponse

type GetProjectResponse struct {
	Name             string  `json:"name"`
	Path             string  `json:"path"`
	Description      string  `json:"description"`
	TelemetryEnabled float64 `json:"telementry_enabled"`
}

GetProjectResponse represents the response json for the `GET aim/projects` endpoint.

type GetRunInfo

type GetRunInfo struct {
	Params GetRunInfoParams `json:"params"`
	Traces GetRunInfoTraces `json:"traces"`
	Props  GetRunInfoProps  `json:"props"`
}

GetRunInfo represents the response struct for GetRunInfo endpoint

type GetRunInfoExperiment

type GetRunInfoExperiment struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

GetRunInfoExperiment experiment properties

type GetRunInfoParams

type GetRunInfoParams struct {
	Tags map[string]string `json:"tags"`
}

GetRunInfoParams params

type GetRunInfoProps

type GetRunInfoProps struct {
	ID           string               `json:"id"`
	Name         string               `json:"name"`
	Description  string               `json:"description"`
	Experiment   GetRunInfoExperiment `json:"experiment"`
	Tags         []string             `json:"tags"`
	CreationTime int64                `json:"creation_time"`
	EndTime      int64                `json:"end_time"`
	Archived     bool                 `json:"archived"`
	Active       bool                 `json:"active"`
}

GetRunInfoProps run properties

type GetRunInfoTraces

type GetRunInfoTraces struct {
	Tags map[string]string `json:"tags"`
}

GetRunInfoTraces traces

type GetRunMetrics

type GetRunMetrics []RunMetrics

GetRunMetrics is the reponse struct for GetRunMetrics endpoint (slice of RunMetric)

type GetRunsActive

type GetRunsActive map[string]GetRunInfo

GetRunsActive represents the response struct for GetRunsActive endpoint

type ProjectActivityResponse

type ProjectActivityResponse struct {
	NumExperiments  float64        `json:"num_experiments"`
	NumRuns         float64        `json:"num_runs"`
	NumActiveRuns   float64        `json:"num_active_runs"`
	NumArchivedRuns float64        `json:"num_archived_runs"`
	ActivityMap     map[string]int `json:"activity_map"`
}

ProjectActivityResponse represents the response json for the `GET aim/projects/activity` endpoint.

type ProjectParamsResponse

type ProjectParamsResponse struct {
	Metric map[string][]struct{}  `json:"metric"`
	Params map[string]interface{} `json:"params"`
}

ProjectParamsResponse is a response object for `GET aim/projects/params` endpoint.

type RunMetrics

type RunMetrics struct {
	Name    string         `json:"name"`
	Context map[string]any `json:"context"`
	Values  []float64      `json:"values"`
	Iters   []int64        `json:"iters"`
}

RunMetrics is one run metrics

type Success

type Success struct {
	ID     string `json:"id"`
	Status string `json:"status"`
}

Success represents the response json in api success