request

Documentation

Index

• type AlignedMetricRunRequest
• type AlignedMetricTraceRequest
• type AppState
• type CreateApp
• type CreateDashboard
• type GetAlignedMetricRequest
• type GetRunMetric
• type GetRunMetrics
• type SearchMetricsRequest
• type SearchRunsRequest
• type UpdateApp
• type UpdateDashboard
• type UpdateExperimentRequest
• type UpdateRunRequest

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 AppState

type AppState map[string]any

AppState represents key/value state data

type CreateApp

type CreateApp struct {
	Type  string   `json:"type"`
	State AppState `json:"state"`
}

CreateApp represents the data to create an App

type CreateDashboard

type CreateDashboard struct {
	AppID       uuid.UUID `json:"app_id"`
	Name        string    `json:"name"`
	Description string    `json:"description"`
}

CreateDashboard represents the data to create a Dashboard

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 GetRunMetric

type GetRunMetric struct {
	Context map[string]string `json:"context"`
	Name    string            `json:"name"`
}

GetRunMetric is one element of GetRunMetricsRequest

type GetRunMetrics

type GetRunMetrics []GetRunMetric

GetRunMetrics is a request struct for `POST /runs/:id/metric/get-batch`

type SearchMetricsRequest

type SearchMetricsRequest struct {
	Query          string `query:"q"`
	Steps          int    `query:"p"`
	XAxis          string `query:"x_axis"`
	SkipSystem     bool   `query:"skip_system"`
	ReportProgress bool   `query:"report_progress"`
}

SearchMetricsRequest is a request struct for `GET /runs/search/metric/` endpoint.

type SearchRunsRequest

type SearchRunsRequest struct {
	Query           string   `query:"q"`
	Limit           int      `query:"limit"`
	Offset          string   `query:"offset"`
	Action          string   `query:"action"`
	SkipSystem      bool     `query:"skip_system"`
	ReportProgress  bool     `query:"report_progress"`
	ExcludeParams   bool     `query:"exclude_params"`
	ExcludeTraces   bool     `query:"exclude_traces"`
	ExperimentNames []string `query:"experiment_names"`
}

type UpdateApp

type UpdateApp struct {
	Type  string   `json:"type"`
	State AppState `json:"state"`
}

UpdateApp represents the data to update an App

type UpdateDashboard

type UpdateDashboard struct {
	Name        string `json:"name"`
	Description string `json:"description"`
}

UpdateDashboard represents the data to update a Dashboard

type UpdateExperimentRequest

type UpdateExperimentRequest struct {
	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 {
	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.