upiv1

type Column struct {

	// Column's name
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Column's type
	Type Type `protobuf:"varint,2,opt,name=type,proto3,enum=caraml.upi.v1.Type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

type Header struct {
	Key   string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

type LogObservationsRequest struct {

	// List of observations per request
	Observations []*ObservationLog `protobuf:"bytes,1,rep,name=observations,proto3" json:"observations,omitempty"`
	// contains filtered or unexported fields
}

type LogObservationsResponse struct {

	// Unique identifier to identify records from a batch of observation logs
	ObservationBatchId string `protobuf:"bytes,1,opt,name=observation_batch_id,json=observationBatchId,proto3" json:"observation_batch_id,omitempty"`
	// contains filtered or unexported fields
}

type ModelInput struct {

	// JSON-representation of features table. "table_schema_version" field describe the encoding of this field.
	FeaturesTable *structpb.Struct `protobuf:"bytes,1,opt,name=features_table,json=featuresTable,proto3" json:"features_table,omitempty"`
	// JSON-representation of entities table. "table_schema_version" field describe the encoding of this field.
	EntitiesTable *structpb.Struct `protobuf:"bytes,2,opt,name=entities_table,json=entitiesTable,proto3" json:"entities_table,omitempty"`
	// JSON-representation of raw_features table. "table_schema_version" field describe the encoding of this field.
	RawFeatures *structpb.Struct `protobuf:"bytes,3,opt,name=raw_features,json=rawFeatures,proto3" json:"raw_features,omitempty"`
	// Context of the prediction request.
	PredictionContext []*Variable `protobuf:"bytes,4,rep,name=prediction_context,json=predictionContext,proto3" json:"prediction_context,omitempty"`
	// map containing request headers/metadata
	Headers []*Header `protobuf:"bytes,10,rep,name=headers,proto3" json:"headers,omitempty"`
	// contains filtered or unexported fields
}

type ModelMetadata struct {

	// Model name that produce prediction
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Model version that produce prediction
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

type ModelOutput struct {

	// JSON-representation of prediction result table. "table_schema_version" field describe the encoding of this field.
	PredictionResultsTable *structpb.Struct `` /* 129-byte string literal not displayed */
	// Context of the prediction response.
	PredictionContext []*Variable `protobuf:"bytes,2,rep,name=prediction_context,json=predictionContext,proto3" json:"prediction_context,omitempty"`
	// map containing response headers/metadata
	Headers []*Header `protobuf:"bytes,10,rep,name=headers,proto3" json:"headers,omitempty"`
	// grpc status of the response from model (see https://grpc.github.io/grpc/core/md_doc_statuscodes.html)
	Status uint32 `protobuf:"varint,11,opt,name=status,proto3" json:"status,omitempty"`
	// grpc message
	Message string `protobuf:"bytes,12,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

type ObservationLog struct {

	// Unique identifier of a prediction response returned by prediction service.
	// This information is used to join the prediction to an observation.
	PredictionId string `protobuf:"bytes,1,opt,name=prediction_id,json=predictionId,proto3" json:"prediction_id,omitempty"`
	// Prediction requests may contain multiple prediction instances.
	// The row_id identifies a particular prediction instance that was used to produce an observation.
	// This information is used to join the prediction to an observation.
	RowId string `protobuf:"bytes,2,opt,name=row_id,json=rowId,proto3" json:"row_id,omitempty"`
	// The name of the observation target. This information is used to join the prediction to an observation.
	TargetName string `protobuf:"bytes,3,opt,name=target_name,json=targetName,proto3" json:"target_name,omitempty"`
	// The ground-truth value. It can be a double, string or integer type.
	ObservationValues []*Variable `protobuf:"bytes,4,rep,name=observation_values,json=observationValues,proto3" json:"observation_values,omitempty"`
	// A set of key-value pairs to provide additional context for the observation.
	ObservationContext []*Variable `protobuf:"bytes,5,rep,name=observation_context,json=observationContext,proto3" json:"observation_context,omitempty"`
	// Timestamp when the observation is made
	ObservationTimestamp *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=observation_timestamp,json=observationTimestamp,proto3" json:"observation_timestamp,omitempty"`
	// contains filtered or unexported fields
}

type ObservationLogKey struct {

	// Id to uniquely identify records from a batch of observation logs
	ObservationBatchId string `protobuf:"bytes,1,opt,name=observation_batch_id,json=observationBatchId,proto3" json:"observation_batch_id,omitempty"`
	// Unique identifier of a prediction response returned by prediction service.
	// This information is used to join the prediction to an observation.
	PredictionId string `protobuf:"bytes,2,opt,name=prediction_id,json=predictionId,proto3" json:"prediction_id,omitempty"`
	// Prediction requests may contain multiple prediction instances.
	// The row_id identifies a particular prediction instance that was used to produce an observation.
	// This information is used to join the prediction to an observation.
	RowId string `protobuf:"bytes,3,opt,name=row_id,json=rowId,proto3" json:"row_id,omitempty"`
	// contains filtered or unexported fields
}

type ObservationServiceClient interface {
	LogObservations(ctx context.Context, in *LogObservationsRequest, opts ...grpc.CallOption) (*LogObservationsResponse, error)
}

type ObservationServiceServer interface {
	LogObservations(context.Context, *LogObservationsRequest) (*LogObservationsResponse, error)
}

type PredictValuesRequest struct {

	// Prediction table contains instances to be predicted.
	// Each row in the table correspond to one prediction instance.
	// Prediction table should contain all preprocessed feature that model use to perform prediction.
	// The column ordering in the prediction table must be the same as feature order expected by model in the case of standard model.
	// Prediction table can be populated via 3 ways:
	// - By performing preprocessing in the client-side and sent as part of original request.
	// - By transforming feature values stored in transformer_inputs.
	// - By retrieving precomputed feature value from feature store.
	// Row ID of the prediction_table must be populated by the client and can be used
	// to join a row in prediction_table with another row in the prediction_result_table,
	// and to track predictions generated by multiple models.
	// The user is expected to include row ID (along with prediction ID)
	// when calling the observations API so that predictions
	// and observations can be joined.
	// NOTE: the ordering of rows might differ in the response but the number of row must remain the same.
	PredictionTable *Table `protobuf:"bytes,1,opt,name=prediction_table,json=predictionTable,proto3" json:"prediction_table,omitempty"`
	// Transformer input contains list of tables and variables that can be used to enrich prediction_table using transformer.
	// Typically transformer_inputs contains:
	// - unprocessed/raw features that requires further transformation.
	// - list of entities for which their precomputed features are retrieved from feature store using standard transformer.
	TransformerInput *TransformerInput `protobuf:"bytes,4,opt,name=transformer_input,json=transformerInput,proto3" json:"transformer_input,omitempty"`
	// Name of the concept we wish to predict.
	// For example in context of iris classification problem it can be "iris-species"
	TargetName string `protobuf:"bytes,2,opt,name=target_name,json=targetName,proto3" json:"target_name,omitempty"`
	// Prediction context may contain additional data applicable to all prediction instances
	// For example it can be used to store information for traffic rules, experimentation
	// or tracking purposes.
	// Eg. country_code, service_type, service_area_id
	PredictionContext []*Variable `protobuf:"bytes,3,rep,name=prediction_context,json=predictionContext,proto3" json:"prediction_context,omitempty"`
	// Request metadata
	Metadata *RequestMetadata `protobuf:"bytes,10,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

type PredictValuesResponse struct {

	// Prediction results corresponding to the
	// prediction rows provided in the request.
	// NOTE: the ordering of prediction_result_rows might differ with prediction_table in the request but the number of row must match with the prediction_table
	PredictionResultTable *Table `` /* 126-byte string literal not displayed */
	// Target name as defined in the request metadata
	TargetName string `protobuf:"bytes,2,opt,name=target_name,json=targetName,proto3" json:"target_name,omitempty"`
	// Extensible field to cover unforeseen requirements
	PredictionContext []*Variable `protobuf:"bytes,3,rep,name=prediction_context,json=predictionContext,proto3" json:"prediction_context,omitempty"`
	// Response metadata
	Metadata *ResponseMetadata `protobuf:"bytes,10,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

type PredictionLog struct {

	// Unique identifier of prediction.
	PredictionId string `protobuf:"bytes,1,opt,name=prediction_id,json=predictionId,proto3" json:"prediction_id,omitempty"`
	// Target name / concept to be predicted by the prediction.
	TargetName string `protobuf:"bytes,2,opt,name=target_name,json=targetName,proto3" json:"target_name,omitempty"`
	// Project name that host the model performing prediction.
	ProjectName string `protobuf:"bytes,3,opt,name=project_name,json=projectName,proto3" json:"project_name,omitempty"`
	// Model name performing the prediction.
	ModelName string `protobuf:"bytes,4,opt,name=model_name,json=modelName,proto3" json:"model_name,omitempty"`
	// Model version performing the prediction.
	ModelVersion string `protobuf:"bytes,5,opt,name=model_version,json=modelVersion,proto3" json:"model_version,omitempty"`
	// Input of the prediction process
	Input *ModelInput `protobuf:"bytes,10,opt,name=input,proto3" json:"input,omitempty"`
	// Output of the prediction process
	Output *ModelOutput `protobuf:"bytes,11,opt,name=output,proto3" json:"output,omitempty"`
	// Timestamp of the corresponding prediction request
	RequestTimestamp *timestamppb.Timestamp `protobuf:"bytes,20,opt,name=request_timestamp,json=requestTimestamp,proto3" json:"request_timestamp,omitempty"`
	// Schema version of raw_features, features, entities, and prediction results fields are formatted
	// I.e. for version 1, all of those fields will be formatted as a modified JSON SPLIT representation of a table
	TableSchemaVersion uint32 `protobuf:"varint,100,opt,name=table_schema_version,json=tableSchemaVersion,proto3" json:"table_schema_version,omitempty"`
	// contains filtered or unexported fields
}

type RequestMetadata struct {

	// Unique identifier for each request. Optional.
	// Prediction ID will generated by the platform. The user is expected
	// include the prediction ID (along with row ID) when calling
	// the observations API so that predictions and observations can be joined.
	// Prediction ID is needed because row ID may not be globally unique
	// across requests (only locally unique within each request).
	// If there are experiments with alternative models, the mapping
	// from prediciton ID to treatment ID will be logged by the platform
	PredictionId string `protobuf:"bytes,1,opt,name=prediction_id,json=predictionId,proto3" json:"prediction_id,omitempty"`
	// Timestamp of the request
	RequestTimestamp *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=request_timestamp,json=requestTimestamp,proto3" json:"request_timestamp,omitempty"`
	// contains filtered or unexported fields
}

type ResponseMetadata struct {

	// Prediction ID generated by the platform.
	// The user is expected include the prediction ID (along with row ID) when calling
	// the observations API so that predictions and observations can be joined.
	// Prediction ID is needed because row ID may not be globally unique
	// across requests (only locally unique within each request).
	// If there are experiments with alternative models, the mapping
	// from prediciton ID to treatment ID will be logged by the platform
	PredictionId string `protobuf:"bytes,1,opt,name=prediction_id,json=predictionId,proto3" json:"prediction_id,omitempty"`
	// List of model that produces the prediction
	// This field is repeated to cater for use case such as ensembling several model production results
	Models []*ModelMetadata `protobuf:"bytes,2,rep,name=models,proto3" json:"models,omitempty"`
	// Name of the experiment that is used to produce the response
	// The value might be empty if experimentation is not involved to produce response
	ExperimentName string `protobuf:"bytes,3,opt,name=experiment_name,json=experimentName,proto3" json:"experiment_name,omitempty"`
	// Name of the treatment chosen from the experiment to produce the response
	// The value might be empty if experimentation is not involved to produce response
	TreatmentName string `protobuf:"bytes,4,opt,name=treatment_name,json=treatmentName,proto3" json:"treatment_name,omitempty"`
	// contains filtered or unexported fields
}

type RouterInput struct {

	// JSON-representation of prediction_table of the UPI request to router. "table_schema_version" field describe the encoding of this field.
	PredictionTable *structpb.Struct `protobuf:"bytes,1,opt,name=prediction_table,json=predictionTable,proto3" json:"prediction_table,omitempty"`
	// List of tables in the transformer inputs in JSON format. "table_schema_version" field describe the encoding of this field.
	TransformerTables []*structpb.Struct `protobuf:"bytes,2,rep,name=transformer_tables,json=transformerTables,proto3" json:"transformer_tables,omitempty"`
	// List of variables extracted from "transformer_inputs"
	TransformerVariables []*Variable `protobuf:"bytes,3,rep,name=transformer_variables,json=transformerVariables,proto3" json:"transformer_variables,omitempty"`
	// Context of the prediction request.
	PredictionContext []*Variable `protobuf:"bytes,4,rep,name=prediction_context,json=predictionContext,proto3" json:"prediction_context,omitempty"`
	// map containing request headers/metadata
	Headers []*Header `protobuf:"bytes,10,rep,name=headers,proto3" json:"headers,omitempty"`
	// contains filtered or unexported fields
}

type RouterLog struct {

	// Unique identifier of prediction.
	PredictionId string `protobuf:"bytes,1,opt,name=prediction_id,json=predictionId,proto3" json:"prediction_id,omitempty"`
	// Target name / concept to be predicted by the prediction.
	TargetName string `protobuf:"bytes,2,opt,name=target_name,json=targetName,proto3" json:"target_name,omitempty"`
	// Project name that host the router.
	ProjectName string `protobuf:"bytes,3,opt,name=project_name,json=projectName,proto3" json:"project_name,omitempty"`
	// Name of the router.
	RouterName string `protobuf:"bytes,4,opt,name=router_name,json=routerName,proto3" json:"router_name,omitempty"`
	// Router version.
	RouterVersion string `protobuf:"bytes,5,opt,name=router_version,json=routerVersion,proto3" json:"router_version,omitempty"`
	// Routing logic describes the decision that was made within the router to produce the router output
	RoutingLogic *RoutingLogic `protobuf:"bytes,10,opt,name=routing_logic,json=routingLogic,proto3" json:"routing_logic,omitempty"`
	// Input of the router
	RouterInput *RouterInput `protobuf:"bytes,11,opt,name=router_input,json=routerInput,proto3" json:"router_input,omitempty"`
	// Output of the router
	RouterOutput *RouterOutput `protobuf:"bytes,12,opt,name=router_output,json=routerOutput,proto3" json:"router_output,omitempty"`
	// Timestamp of the corresponding prediction request
	RequestTimestamp *timestamppb.Timestamp `protobuf:"bytes,20,opt,name=request_timestamp,json=requestTimestamp,proto3" json:"request_timestamp,omitempty"`
	// Schema version of raw_features, features, entities, and prediction results fields are formatted
	// I.e. for version 1, all of those fields will be formatted as a modified JSON SPLIT representation of a table
	TableSchemaVersion uint32 `protobuf:"varint,100,opt,name=table_schema_version,json=tableSchemaVersion,proto3" json:"table_schema_version,omitempty"`
	// contains filtered or unexported fields
}

type RouterOutput struct {

	// JSON-representation of prediction result table returned by router. "table_schema_version" field describe the encoding of this field.
	PredictionResultsTable *structpb.Struct `` /* 129-byte string literal not displayed */
	// Context of the prediction response.
	PredictionContext []*Variable `protobuf:"bytes,2,rep,name=prediction_context,json=predictionContext,proto3" json:"prediction_context,omitempty"`
	// map containing response headers/metadata
	Headers []*Header `protobuf:"bytes,10,rep,name=headers,proto3" json:"headers,omitempty"`
	// grpc status of the response from model (see https://grpc.github.io/grpc/core/md_doc_statuscodes.html)
	Status uint32 `protobuf:"varint,11,opt,name=status,proto3" json:"status,omitempty"`
	// grpc message
	Message string `protobuf:"bytes,12,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

type RoutingLogic struct {

	// List of models that was involved in producing the router output.
	// Router can behave as multiplexer or combiner.
	// In multiplexer case, the router will select 1 out of many models, thus this field will only have 1 entry.
	// In combiner case, this field can contain more than 1 entries.
	// This field will be used to join witht the prediction log.
	Models []*ModelMetadata `protobuf:"bytes,1,rep,name=models,proto3" json:"models,omitempty"`
	// Traffic rule that was used to route the prediction request (optional).
	TrafficRule string `protobuf:"bytes,2,opt,name=traffic_rule,json=trafficRule,proto3" json:"traffic_rule,omitempty"`
	// Experiment name that was used to handle the prediction request (optional).
	ExperimentName string `protobuf:"bytes,3,opt,name=experiment_name,json=experimentName,proto3" json:"experiment_name,omitempty"`
	// Treatment name from the experiment that was used to handle the prediction request (optional).
	TreatmentName string `protobuf:"bytes,4,opt,name=treatment_name,json=treatmentName,proto3" json:"treatment_name,omitempty"`
	// contains filtered or unexported fields
}

type Row struct {

	// Id of the particular row in a table.
	// The row id should be at least locally unique within the table.
	// Row ID must be populated for prediction_table
	RowId string `protobuf:"bytes,1,opt,name=row_id,json=rowId,proto3" json:"row_id,omitempty"`
	// List of values within a row.
	// It is table's creator responsibility to ensure that the number of entry
	// values matches with the length of columns in the table.
	Values []*Value `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

type Table struct {

	// Table's name
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Columns stores schema informations of all columns in the table.
	Columns []*Column `protobuf:"bytes,2,rep,name=columns,proto3" json:"columns,omitempty"`
	// Rows stores list of row values in the table.
	Rows []*Row `protobuf:"bytes,3,rep,name=rows,proto3" json:"rows,omitempty"`
	// contains filtered or unexported fields
}

type TransformerInput struct {

	// List of tables
	// All tables must have unique name.
	// Each table doesn't need to have same number of row.
	Tables []*Table `protobuf:"bytes,1,rep,name=tables,proto3" json:"tables,omitempty"`
	// List of variables
	Variables []*Variable `protobuf:"bytes,2,rep,name=variables,proto3" json:"variables,omitempty"`
	// contains filtered or unexported fields
}

type Type int32

type UnimplementedObservationServiceServer struct {
}

type UnimplementedUniversalPredictionServiceServer struct {
}

type UniversalPredictionServiceClient interface {
	PredictValues(ctx context.Context, in *PredictValuesRequest, opts ...grpc.CallOption) (*PredictValuesResponse, error)
}

type UniversalPredictionServiceServer interface {
	PredictValues(context.Context, *PredictValuesRequest) (*PredictValuesResponse, error)
}

type UnsafeObservationServiceServer interface {
	// contains filtered or unexported methods
}

type UnsafeUniversalPredictionServiceServer interface {
	// contains filtered or unexported methods
}

type Value struct {

	// One of following field will be set depending on the column's type
	DoubleValue  float64 `protobuf:"fixed64,1,opt,name=double_value,json=doubleValue,proto3" json:"double_value,omitempty"`
	IntegerValue int64   `protobuf:"varint,2,opt,name=integer_value,json=integerValue,proto3" json:"integer_value,omitempty"`
	StringValue  string  `protobuf:"bytes,3,opt,name=string_value,json=stringValue,proto3" json:"string_value,omitempty"`
	// Flag to be used to signify that the value is null
	IsNull bool `protobuf:"varint,10,opt,name=is_null,json=isNull,proto3" json:"is_null,omitempty"`
	// contains filtered or unexported fields
}

type Variable struct {

	// Name describing what the value represents.
	// Uses include:
	// - Ensuring ML models process columns in the correct order
	// - Defining a Feast row entity name
	// - Parsing metadata to apply traffic rules
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Type of the variable
	Type Type `protobuf:"varint,2,opt,name=type,proto3,enum=caraml.upi.v1.Type" json:"type,omitempty"`
	// One of the following field will be set depending on the type
	DoubleValue  float64 `protobuf:"fixed64,3,opt,name=double_value,json=doubleValue,proto3" json:"double_value,omitempty"`
	IntegerValue int64   `protobuf:"varint,4,opt,name=integer_value,json=integerValue,proto3" json:"integer_value,omitempty"`
	StringValue  string  `protobuf:"bytes,5,opt,name=string_value,json=stringValue,proto3" json:"string_value,omitempty"`
	// contains filtered or unexported fields
}