Documentation
¶
Index ¶
- type AlignedMetricRunRequest
- type AlignedMetricTraceRequest
- type AppState
- type ArchiveBatchRequest
- type BaseSearchRequest
- type CreateAppRequest
- type CreateDashboardRequest
- type DeleteAppRequest
- type DeleteBatchRequest
- type DeleteDashboardRequest
- type DeleteExperimentRequest
- type DeleteRunRequest
- type GetAlignedMetricRequest
- type GetAppRequest
- type GetDashboardRequest
- type GetExperimentActivityRequest
- type GetExperimentRequest
- type GetExperimentRunsRequest
- type GetProjectParamsRequest
- type GetRunInfoRequest
- type GetRunMetricsRequest
- type GetRunsActiveRequest
- type MetricTuple
- type SearchAlignedMetricsRequest
- type SearchMetricsRequest
- type SearchRunsRequest
- type UpdateAppRequest
- type UpdateDashboardRequest
- type UpdateExperimentRequest
- type UpdateRunRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AlignedMetricRunRequest ¶
type AlignedMetricRunRequest struct {
ID string `json:"run_id"`
Traces []AlignedMetricTraceRequest `json:"traces"`
}
AlignedMetricRunRequest is a partial request object for GetAlignedMetricRequest
type AlignedMetricTraceRequest ¶
type AlignedMetricTraceRequest struct {
Context fiber.Map `json:"context"`
Name string `json:"name"`
Slice []int `json:"slice"`
}
AlignedMetricTraceRequest is a partial request object for AlignedMetricRunRequest
type ArchiveBatchRequest ¶
type ArchiveBatchRequest []string
ArchiveBatchRequest is a request struct for `DELETE /runs/archive-batch` endpoint.
type BaseSearchRequest ¶
type BaseSearchRequest struct {
ReportProgress bool `query:"report_progress"`
}
BaseSearchRequest defines some shared fields for search requestes.
type CreateAppRequest ¶
CreateAppRequest is a request object for `POST /aim/apps` endpoint.
type CreateDashboardRequest ¶
type CreateDashboardRequest struct {
AppID uuid.UUID `json:"app_id"`
Name string `json:"name"`
Description string `json:"description"`
}
CreateDashboardRequest is a request object for `POST /aim/dashboards` endpoint.
type DeleteAppRequest ¶
DeleteAppRequest is a request object for `DELETE /aim/apps/:id` endpoint.
type DeleteBatchRequest ¶
type DeleteBatchRequest []string
DeleteBatchRequest is a request struct for `DELETE /runs/delete-batch` endpoint.
type DeleteDashboardRequest ¶
DeleteDashboardRequest is a request object for `DELETE /aim/dashboards/:id` endpoint.
type DeleteExperimentRequest ¶
type DeleteExperimentRequest struct {
ID int32 `params:"id"`
}
DeleteExperimentRequest is a request object for `DELETE /aim/experiments/:id` endpoint.
type DeleteRunRequest ¶
type DeleteRunRequest struct {
ID string `params:"id"`
}
DeleteRunRequest is a request struct for `DELETE /runs/:id` endpoint.
type GetAlignedMetricRequest ¶
type GetAlignedMetricRequest struct {
Runs []AlignedMetricRunRequest `json:"runs"`
AlignBy string `json:"align_by"`
}
GetAlignedMetricRequest is a request object for `GET /search/metrics/align` endpoint.
type GetAppRequest ¶
GetAppRequest is a request object for `GET /aim/apps/:id` endpoint.
type GetDashboardRequest ¶
GetDashboardRequest is a request object for `GET /aim/dashboards/:id` endpoint.
type GetExperimentActivityRequest ¶
type GetExperimentActivityRequest struct {
ID int32 `params:"id"`
}
GetExperimentActivityRequest is a request object for `GET /aim/experiments/:id/activity/` endpoint.
type GetExperimentRequest ¶
type GetExperimentRequest struct {
ID int32 `params:"id"`
}
GetExperimentRequest is a request object for `GET /aim/experiments/:id` endpoint.
type GetExperimentRunsRequest ¶
type GetExperimentRunsRequest struct {
ID int32 `params:"id"`
Limit int `query:"limit"`
Offset string `query:"offset"`
}
GetExperimentRunsRequest is a request object for `GET /aim/experiments/:id/runs` endpoint.
type GetProjectParamsRequest ¶
type GetProjectParamsRequest struct {
Sequences []string `query:"sequence"`
Experiments []int `query:"experiments"`
ExcludeParams bool `query:"exclude_params"`
}
GetProjectParamsRequest is a request object for `GET /projects/params` endpoint.
type GetRunInfoRequest ¶
type GetRunInfoRequest struct {
ID string `params:"id"`
SkipSystem bool `query:"skip_system"`
Sequences []string `query:"sequence"`
}
GetRunInfoRequest is a request object for `GET /runs/:id/info` endpoint.
type GetRunMetricsRequest ¶
type GetRunMetricsRequest []struct {
Name string `json:"name"`
Context map[string]string `json:"context"`
}
GetRunMetricsRequest is a request object for `POST /runs/:id/metric/get-batch` endpoint.
type GetRunsActiveRequest ¶
type GetRunsActiveRequest struct {
BaseSearchRequest
}
GetRunsActiveRequest is a request object for `GET /runs/active` endpoint.
type MetricTuple ¶
type MetricTuple struct {
Key string `json:"key"`
Context fiber.Map `json:"context"`
}
MetricTuple represents a metric with key and context.
type SearchAlignedMetricsRequest ¶
type SearchAlignedMetricsRequest struct {
Runs []struct {
ID string `json:"run_id"`
Traces []struct {
Name string `json:"name"`
Slice [3]int `json:"slice"`
Context fiber.Map `json:"context"`
} `json:"traces"`
} `json:"runs"`
AlignBy string `json:"align_by"`
}
SearchAlignedMetricsRequest is a request struct for `GET /runs/search/metric/align` endpoint.
type SearchMetricsRequest ¶
type SearchMetricsRequest struct {
BaseSearchRequest
Metrics []MetricTuple `json:"metrics"`
Query string `json:"query"`
Steps int `json:"steps"`
XAxis string `json:"x_axis"`
SkipSystem bool `json:"skip_system"`
}
SearchMetricsRequest is a request struct for `GET /runs/search/metric` endpoint.
type SearchRunsRequest ¶
type SearchRunsRequest struct {
BaseSearchRequest
Query string `query:"q"`
Limit int `query:"limit"`
Offset string `query:"offset"`
Action string `query:"action"`
SkipSystem bool `query:"skip_system"`
ExcludeParams bool `query:"exclude_params"`
ExcludeTraces bool `query:"exclude_traces"`
ExperimentNames []string `query:"experiment_names"`
}
SearchRunsRequest is a request object for `GET /runs/search/run` endpoint.
type UpdateAppRequest ¶
type UpdateAppRequest struct {
ID uuid.UUID `params:"id"`
Type string `json:"type"`
State AppState `json:"state"`
}
UpdateAppRequest is a request object for `PUT /aim/apps/:id` endpoint.
type UpdateDashboardRequest ¶
type UpdateDashboardRequest struct {
ID uuid.UUID `params:"id"`
Name string `json:"name"`
Description string `json:"description"`
}
UpdateDashboardRequest is a request object for `PUT /aim/dashboards` endpoint.
type UpdateExperimentRequest ¶
type UpdateExperimentRequest struct {
ID int32 `params:"id"`
Name *string `json:"name"`
Description *string `json:"description"`
Archived *bool `json:"archived"`
}
UpdateExperimentRequest is a request struct for `PUT /experiments/:id` endpoint.
type UpdateRunRequest ¶
type UpdateRunRequest struct {
ID string `params:"id"`
RunID *string `json:"run_id"`
RunUUID *string `json:"run_uuid"`
Name *string `json:"run_name"`
Description *string `json:"description"`
Status *string `json:"status"`
EndTime *int64 `json:"end_time"`
Archived *bool `json:"archived"`
}
UpdateRunRequest is a request struct for `PUT /runs/:id` endpoint.