module.proto

path kilroy/module/v1alpha/module.proto

package kilroy.module.v1alpha

Definitions for module service.

---

Messages

FitReinforcedRequest

Request for FitReinforced.

Name	Type	Description
content	string	The content of the post as a JSON string.
metadata	string	The metadata of the post as a JSON string.
score	double	The score of the post.

FitReinforcedResponse

Response from FitReinforced.

Name	Type	Description

FitSupervisedRequest

Request for FitSupervised.

Name	Type	Description
content	string	The content of the post as a JSON string.
score	double	The score of the post.

FitSupervisedResponse

Response from FitSupervised.

Name	Type	Description

GenerateRequest

Request for Generate.

Name	Type	Description
quantity	uint64	The quantity of posts to generate.

GenerateResponse

Response from Generate.

Name	Type	Description
content	string	The content of the post as a JSON string.
metadata	string	The metadata of the post as a JSON string.

GetConfigRequest

Request for GetConfig.

Name	Type	Description

GetConfigResponse

Response from GetConfig.

Name	Type	Description
config	string	The config of the module as a JSON string.

GetConfigSchemaRequest

Request for GetConfigSchema.

Name	Type	Description

GetConfigSchemaResponse

Response from GetConfigSchema.

Name	Type	Description
schema	string	The schema of the config as a JSON string.

GetMetadataRequest

Request for GetMetadata.

Name	Type	Description

GetMetadataResponse

Response from GetMetadata.

Name	Type	Description
key	string	The key of the module.
description	string	The description of the module.

GetMetricsConfigRequest

Request for GetMetricsConfig.

Name	Type	Description

GetMetricsConfigResponse

Response from GetMetricsConfig.

Name	Type	Description
configs	MetricConfig	The configs of the metrics.

GetPostSchemaRequest

Request for GetPostSchema.

Name	Type	Description

GetPostSchemaResponse

Response from GetPostSchema.

Name	Type	Description
schema	string	The schema of a post as a JSON string.

GetStatusRequest

Request for GetStatus.

Name	Type	Description

GetStatusResponse

Response from GetStatus.

Name	Type	Description
status	Status	The status of the module.

MetricConfig

Metric configuration data.

Name	Type	Description
id	string	The ID of the metric.
label	string	The label of the metric.
config	string	The config of the metric as a JSON string.
tags	string	The tags of the metric.

ResetRequest

Request for Reset.

Name	Type	Description

ResetResponse

Response from Reset.

Name	Type	Description

SaveRequest

Request for Save.

Name	Type	Description

SaveResponse

Response from Save.

Name	Type	Description

SetConfigRequest

Request for SetConfig.

Name	Type	Description
config	string	The config of the module as a JSON string.

SetConfigResponse

Response from SetConfig.

Name	Type	Description
config	string	The config of the module as a JSON string.

WatchConfigRequest

Request for WatchConfig.

Name	Type	Description

WatchConfigResponse

Response from WatchConfig.

Name	Type	Description
config	string	The config of the module as a JSON string.

WatchMetricsRequest

Request for WatchMetrics.

Name	Type	Description

WatchMetricsResponse

Response from WatchMetrics.

Name	Type	Description
metric_id	string	The ID of the metric.
dataset_id	uint64	The ID of the dataset.
data	string	The data of the metric as a JSON string.

WatchStatusRequest

Request for WatchStatus.

Name	Type	Description

WatchStatusResponse

Response from WatchStatus.

Name	Type	Description
status	Status	The status of the module.

---

Enums

Status

Possible module statuses.

Name	Number	Description
STATUS_UNSPECIFIED	0	Unspecified status.
STATUS_LOADING	1	The module is loading.
STATUS_READY	2	The module is ready.

---

Services

ModuleService

Module service.

GetMetadata

Method	GetMetadata
Request	GetMetadataRequest
Response	GetMetadataResponse
Description	Returns the metadata of the module.

GetPostSchema

Method	GetPostSchema
Request	GetPostSchemaRequest
Response	GetPostSchemaResponse
Description	Returns the schema of a post.

GetStatus

Method	GetStatus
Request	GetStatusRequest
Response	GetStatusResponse
Description	Returns the status of the module.

WatchStatus

Method	WatchStatus
Request	WatchStatusRequest
Response	WatchStatusResponse stream
Description	Returns an infinite stream of status updates.

GetConfigSchema

Method	GetConfigSchema
Request	GetConfigSchemaRequest
Response	GetConfigSchemaResponse
Description	Returns the schema of the config.

GetConfig

Method	GetConfig
Request	GetConfigRequest
Response	GetConfigResponse
Description	Returns the config of the module.

WatchConfig

Method	WatchConfig
Request	WatchConfigRequest
Response	WatchConfigResponse stream
Description	Returns an infinite stream of config updates.

SetConfig

Method	SetConfig
Request	SetConfigRequest
Response	SetConfigResponse
Description	Sets the config of the module.

Generate

Method	Generate
Request	GenerateRequest
Response	GenerateResponse stream
Description	Generates posts.

FitSupervised

Method	FitSupervised
Request	FitSupervisedRequest stream
Response	FitSupervisedResponse
Description	Fits supervised.

FitReinforced

Method	FitReinforced
Request	FitReinforcedRequest stream
Response	FitReinforcedResponse
Description	Fits reinforced.

GetMetricsConfig

Method	GetMetricsConfig
Request	GetMetricsConfigRequest
Response	GetMetricsConfigResponse
Description	Returns the configs of the metrics.

WatchMetrics

Method	WatchMetrics
Request	WatchMetricsRequest
Response	WatchMetricsResponse stream
Description	Returns an infinite stream of metric updates.

Reset

Method	Reset
Request	ResetRequest
Response	ResetResponse
Description	Resets the module.

Save

Method	Save
Request	SaveRequest
Response	SaveResponse
Description	Saves the module.

---