Skip to content

Protocol Documentation

Table of Contents

Top

app.proto

ApiKey

Field Type Label Description
name string
key string

App

Field Type Label Description
id string App's id
name string Name of the application
description string Description of the application
problem_type string App's Problem Type (could be 'classification', 'regression', or 'forecasting')
target_columns string repeated List of target columns in the dataset
extra_columns App.ExtraColumnsEntry repeated Map of extra columns
training_data_proportion double Proportion of train/test split
status string Status of the application
metadata string Application metadata in JSON format
org RefEntity The organisation to that this application belongs
project RefEntity The project to that this application belongs
dataset RefEntity The dataset that this application uses
stats App.StatsEntry repeated Application's statistics
audit Audit Audit information

App.ExtraColumnsEntry

Field Type Label Description
key string
value string

App.StatsEntry

Field Type Label Description
key string
value string

CreateAppRequest

Create new application request

Field Type Label Description
name string Name of the application
description string Description of the application
dataset_id string ID of the dataset used to create the application
problem_type string Type of the problem that this application solves (the value must be one of 'classification', 'regression', or 'forecasting')
target_columns string repeated
extra_columns CreateAppRequest.ExtraColumnsEntry repeated
training_data_proportion double

CreateAppRequest.ExtraColumnsEntry

Field Type Label Description
key string
value string

DeleteAppRequest

Field Type Label Description
id string

DeleteDeploymentRequest

Field Type Label Description
id string
deployment_id string

Deployment

Field Type Label Description
id string
app RefEntity
model RefEntity
training RefEntity
status string
endpoint RefEntity
audit Audit

Endpoint

Field Type Label Description
id string
name string
url string
api_keys ApiKey repeated
app RefEntity
audit Audit

GenerateApiKeyRequest

Field Type Label Description
id string deployment's id
endpoint_id string endpoint's id
name string name of the API Key

GetAppDataRequest

Field Type Label Description
id string

GetAppDataResponse

Field Type Label Description
train_data_url string
test_data_url string
sample_train_data_url string
sample_test_data_url string
sample_data_url string

GetAppRequest

Field Type Label Description
id string

GetDeploymentRequest

Field Type Label Description
id string
deployment_id string

GetEndpointRequest

Field Type Label Description
id string
endpoint_id string

ListAppsRequest

Field Type Label Description
project_id string

ListAppsResponse

Field Type Label Description
apps App repeated

ListDeploymentsRequest

Field Type Label Description
id string

ListDeploymentsResponse

Field Type Label Description
deployments Deployment repeated

ListEndpointsRequest

Field Type Label Description
id string

ListEndpointsResponse

Field Type Label Description
endpoints Endpoint repeated

RevokeApiKeyRequest

Field Type Label Description
id string
endpoint_id string
name string

UpdateAppMetadataRequest

Field Type Label Description
id string
metadata string

UpdateAppRequest

Field Type Label Description
id string
name string
description string

AppService

Provides APIs to manage applications in a project

Method Name Request Type Response Type Description
CreateApp CreateAppRequest App Create a new application
ListApps ListAppsRequest ListAppsResponse Get the list of current applications in the project
GetApp GetAppRequest App Get application details
UpdateApp UpdateAppRequest App Update application details
DeleteApp DeleteAppRequest .google.protobuf.Empty Update application details
UpdateAppMetadata UpdateAppMetadataRequest .google.protobuf.Empty Update the metadata of application
GetAppData GetAppDataRequest GetAppDataResponse Get application's data URLs
ListEndpoints ListEndpointsRequest ListEndpointsResponse Get list of deployment endpoints of the application
GetEndpoint GetEndpointRequest Endpoint Get endpoint details
GenerateApiKey GenerateApiKeyRequest Endpoint Generate new API Key for an endpoint
RevokeApiKey RevokeApiKeyRequest Endpoint Revoke the API Key
ListDeployments ListDeploymentsRequest ListDeploymentsResponse Get list of deployments of an application
GetDeployment GetDeploymentRequest Deployment Get deployment details
DeleteDeployment DeleteDeploymentRequest .google.protobuf.Empty Delete the deploymennt

Top

audit.proto

AuditRecord

Field Type Label Description
id string
project RefEntity
by RefEntity
action string
object_type string
object RefEntity
timestamp double

ListAuditRecordsRequest

Field Type Label Description
project_id string

ListAuditRecordsResponse

Field Type Label Description
auditRecords AuditRecord repeated

AuditService

Method Name Request Type Response Type Description
ListAuditRecords ListAuditRecordsRequest ListAuditRecordsResponse Get list of audit records

Top

billing.proto

GetBillingReply

Field Type Label Description
balance double
budget double
transactions Transaction repeated

GetBillingRequest

Field Type Label Description
org_id string
start_time int64
end_time int64

Transaction

Field Type Label Description
id string
type string
description string
amount double
data Transaction.DataEntry repeated
audit Audit

Transaction.DataEntry

Field Type Label Description
key string
value string

BillingService

Method Name Request Type Response Type Description
GetBilling GetBillingRequest GetBillingReply Get organisation billing information

Top

cleanup.proto

UpdateCleanUpStatusRequest

Field Type Label Description
id string
success bool

ResourceCleanupService

Method Name Request Type Response Type Description
UpdateCleanUpStatus UpdateCleanUpStatusRequest .google.protobuf.Empty

Top

common.proto

Audit

Field Type Label Description
created AuditLog
updated AuditLog

AuditLog

Field Type Label Description
timestamp uint64
by RefEntity

Progress

Field Type Label Description
progress double
tasks Task repeated

RefEntity

Field Type Label Description
id string
name string

Task

Field Type Label Description
name string
progress double

User

Field Type Label Description
id string
display_name string
email string
photo_url string

Top

config.proto

GetConfigRequest

Field Type Label Description
id string

GetConfigResponse

Field Type Label Description
fields GetConfigResponse.FieldsEntry repeated

GetConfigResponse.FieldsEntry

Field Type Label Description
key string
value string

GetConfigsRequest

GetConfigsResponse

Field Type Label Description
roles Role repeated
permissions Permission repeated

Permission

Field Type Label Description
id string
name string
action string
resource string

Role

Field Type Label Description
id string
name string
permissions string repeated

UpdateConfigRequest

Field Type Label Description
id string
fields UpdateConfigRequest.FieldsEntry repeated

UpdateConfigRequest.FieldsEntry

Field Type Label Description
key string
value string

ConfigService

Method Name Request Type Response Type Description
GetConfigs GetConfigsRequest GetConfigsResponse Get system configurations
GetConfig GetConfigRequest GetConfigResponse Get system configuration of key
UpdateConfig UpdateConfigRequest GetConfigResponse Update configuration

Top

dataset.proto

AnalyseRequest

Field Type Label Description
id string

AnalysisResult

Field Type Label Description
row_count float
column_count float
analysis_time float
file_size float
is_time_series bool

AnalysisStats

Field Type Label Description
analysis_time float
file_size float

Column

Field Type Label Description
name string
type string
semantic_type string
group string

CreateDatasetRequest

Field Type Label Description
name string
description string
project_id string
type string

Dataset

Field Type Label Description
id string
name string
description string
step string
status string
org RefEntity
project RefEntity
stats Dataset.StatsEntry repeated statistics
audit Audit audit field

Dataset.StatsEntry

Field Type Label Description
key string
value string

DatasetSchema

Field Type Label Description
columns Column repeated
version string

DeleteDatasetRequest

Field Type Label Description
id string

GetDatasetRequest

Field Type Label Description
id string

GetFileFormatRequest

Field Type Label Description
id string

GetFileFormatResponse

Field Type Label Description
file_format string

GetMetadataUrlRequest

Field Type Label Description
id string

GetMetadataUrlResponse

Field Type Label Description
url string

GetSampleDataUrlRequest

Field Type Label Description
id string

GetSampleDataUrlResponse

Field Type Label Description
url string

GetSchemaUrlRequest

Field Type Label Description
id string

GetSchemaUrlResponse

Field Type Label Description
url string

InferSchemaRequest

Field Type Label Description
id string

ListDatasetsRequest

Field Type Label Description
project_id string

ListDatasetsResponse

Field Type Label Description
datasets Dataset repeated

UpdateAnalysisResultRequest

Field Type Label Description
id string
result AnalysisResult

UpdateDatasetRequest

Field Type Label Description
id string
name string
description string

UpdateFileFormatRequest

Field Type Label Description
id string
file_format string
error string
schema DatasetSchema

UpdateSchemaRequest

Field Type Label Description
id string
schema DatasetSchema

DatasetService

Method Name Request Type Response Type Description
CreateDataset CreateDatasetRequest Dataset Create a new, empty dataset. To upload data files to this dataset, please use the File API.
UpdateDataset UpdateDatasetRequest Dataset Update name or description of the dataset
UpdateAnalysisResult UpdateAnalysisResultRequest .google.protobuf.Empty
Analyse AnalyseRequest .google.protobuf.Empty Manually run dataset analysis pipeline
UpdateSchema UpdateSchemaRequest Dataset Update dataset schema. This will start running the dataset analysis pipeline
UpdateFileFormat UpdateFileFormatRequest Dataset Create dataset's file format. Used by dataset file format inference pipeline to update dataset's file format.
GetFileFormat GetFileFormatRequest GetFileFormatResponse Get dataset's file format
ListDatasets ListDatasetsRequest ListDatasetsResponse Return the list of datasets available in a project
GetDataset GetDatasetRequest Dataset Return detail information of a dataset
DeleteDataset DeleteDatasetRequest .google.protobuf.Empty Delete a dataset. All related information such as data files are also deleted.
GetMetadataUrl GetMetadataUrlRequest GetMetadataUrlResponse Get dataset metadata download URL
GetSampleDataUrl GetSampleDataUrlRequest GetSampleDataUrlResponse Get dataset's sample data download URL
GetSchemaUrl GetSchemaUrlRequest GetSchemaUrlResponse Get dataset's schema download URL

Top

feature_set.proto

CreateFeatureSetRequest

Field Type Label Description
app_id string Id of the app from which the feature set is created
name string Name of the feature set
description string
selected_features string repeated

DeleteFeatureSetRequest

Field Type Label Description
id string

FeatureSet

Field Type Label Description
id string
name string Name of feature set
description string
feature_names string repeated List of feature names
recommendations string Recommendations in JSON format
status string
org RefEntity
project RefEntity
app RefEntity
dataset RefEntity
stats FeatureSet.StatsEntry repeated
audit Audit

FeatureSet.StatsEntry

Field Type Label Description
key string
value string

GetFeatureSetRequest

Field Type Label Description
id string

ListFeatureSetsRequest

Field Type Label Description
app_id string

ListFeatureSetsResponse

Field Type Label Description
feature_sets FeatureSet repeated

UpdateFeatureSetRequest

Field Type Label Description
id string
name string
description string
selected_features string repeated

UpdateRecommendationsRequest

Field Type Label Description
id string
recommendations string

FeatureSetService

Method Name Request Type Response Type Description
CreateFeatureSet CreateFeatureSetRequest FeatureSet Create a new feature set.
UpdateFeatureSet UpdateFeatureSetRequest FeatureSet add or remove features, rename feature set name
UpdateRecommendations UpdateRecommendationsRequest .google.protobuf.Empty update model recommendation when feature set changes
GetFeatureSet GetFeatureSetRequest FeatureSet
DeleteFeatureSet DeleteFeatureSetRequest .google.protobuf.Empty
ListFeatureSets ListFeatureSetsRequest ListFeatureSetsResponse list all feature sets for a specific app

Top

file.proto

CreateFilesRequest

Field Type Label Description
dataset_id string
files FileInfo repeated
metadata CreateFilesRequest.MetadataEntry repeated

CreateFilesRequest.MetadataEntry

Field Type Label Description
key string
value string

File

Field Type Label Description
id string
name string
url string
status string
content_type string
size uint64
dataset RefEntity
audit Audit audit field

FileInfo

Field Type Label Description
name string
url string
content_type string
size uint64

GetFileDownloadUrlRequest

Field Type Label Description
id string

GetFileDownloadUrlResponse

Field Type Label Description
url string

ImportFilesRequest

Field Type Label Description
dataset_id string
source string
data ImportFilesRequest.DataEntry repeated

ImportFilesRequest.DataEntry

Field Type Label Description
key string
value string

ListFilesRequest

Field Type Label Description
dataset_id string

ListFilesResponse

Field Type Label Description
files File repeated

UploadFileRequest

Field Type Label Description
name string
content_type string
project_id string

UploadFileResponse

Field Type Label Description
url string
upload_url string

FileService

Method Name Request Type Response Type Description
UploadFile UploadFileRequest UploadFileResponse Request the pre-signed URL used for uploading data file.
ImportFiles ImportFilesRequest .google.protobuf.Empty Import files from data sources such as Databases, S3, GCS...
CreateFiles CreateFilesRequest ListFilesResponse Save multiple files into the dataset
ListFiles ListFilesRequest ListFilesResponse Return a list of data files belongs to the dataset
GetFileDownloadUrl GetFileDownloadUrlRequest GetFileDownloadUrlResponse Return a pre-signed URL which can be used to download the dataset's file.

Top

model.proto

CreateModelRequest

Field Type Label Description
app_id string
feature_set_id string
name string
template_id string
hyperparameters string
evaluation ModelEvaluation

DeleteModelRequest

Field Type Label Description
id string

DeployModelRequest

Field Type Label Description
id string
training_id string
endpoint_id string
endpoint_name string

DeployModelResponse

Field Type Label Description
id string
app RefEntity
model RefEntity
training RefEntity
status string
endpoint RefEntity
audit Audit

GetModelRequest

Field Type Label Description
id string

GetModelStatsRequest

Field Type Label Description
id string model's id
stats_name string 'traffic', 'model_health' or 'prediction'
stats_type string 'CUMULATIVE', 'WEEKLY', 'QUATERLY', 'MONTHLY', 'YEARLY'
from_date string ISO Date string 'YYYY-MM-DD', for example '2000-01-01'
to_date string ISO Date string 'YYYY-MM-DD'

GetModelStatsResponse

Field Type Label Description
stats string a JSON string

GetPredictResultRequest

Field Type Label Description
job_id string

GetPredictResultResponse

Field Type Label Description
status string
result_url string

GetTrainingRequest

Field Type Label Description
id string
training_id string

GetTrainingResultRequest

Field Type Label Description
id string
training_id string

GetTrainingResultResponse

Field Type Label Description
url string

ListModelsRequest

Field Type Label Description
app_id string

ListModelsResponse

Field Type Label Description
models Model repeated

ListTrainingsRequest

Field Type Label Description
id string

ListTrainingsResponse

Field Type Label Description
trainings Training repeated

Model

Field Type Label Description
id string
name string
evaluation ModelEvaluation
org RefEntity
project RefEntity
app RefEntity
dataset RefEntity
feature_set RefEntity
template RefEntity
hyperparameters string
status string
last_training uint64
last_deployed uint64
last_training_id string
last_success_training Training
audit Audit audit field

ModelEvaluation

Field Type Label Description
metric string
threshold double
min_feedback_count double
auto_retrain bool

PredictRequest

Field Type Label Description
id string
dataset_id string
data string
content_type string csv,parquet,json

PredictResponse

Field Type Label Description
job_id string

TrainModelRequest

Field Type Label Description
id string

TrainModelResponse

Field Type Label Description
id string

Training

Field Type Label Description
id string
status string
result string
job_name string
model RefEntity
audit Audit audit fields

UpdateModelRequest

Field Type Label Description
id string
name string
evaluation ModelEvaluation

UpdatePredictionResultRequest

Field Type Label Description
job_id string
result_url string

UpdateTrainingResultRequest

Field Type Label Description
id string
training_id string
result string

ModelService

Method Name Request Type Response Type Description
CreateModel CreateModelRequest Model Create a new model. The model will be trained automatically on created.
UpdateModel UpdateModelRequest Model Update model information Only model's name are allowed to update
TrainModel TrainModelRequest TrainModelResponse Retrain the model Re-run the training pipeline in case of any infrastructure failure
UpdateTrainingResult UpdateTrainingResultRequest .google.protobuf.Empty
GetTrainingResult GetTrainingResultRequest GetTrainingResultResponse Get the training result Return the URL which can be used to download the detail training report.
DeployModel DeployModelRequest DeployModelResponse Deploy a model to an endpoint
Predict PredictRequest PredictResponse Predict data with a trained model
UpdatePredictionResult UpdatePredictionResultRequest .google.protobuf.Empty
GetPredictResult GetPredictResultRequest GetPredictResultResponse Get model details
ListModels ListModelsRequest ListModelsResponse Get the list of models of an app
GetModel GetModelRequest Model Get model details
DeleteModel DeleteModelRequest .google.protobuf.Empty Delete the model
ListTrainings ListTrainingsRequest ListTrainingsResponse Get all available model trainings
GetTraining GetTrainingRequest Training Get model training details
GetModelStats GetModelStatsRequest GetModelStatsResponse Get model statistics

Top

notification.proto

GetNotificationsResponse

Field Type Label Description
notifications Notification repeated

MarkNotificationAsReadRequest

Field Type Label Description
id string

Notification

Field Type Label Description
id string
project RefEntity
type string
data Notification.DataEntry repeated
status string
audit Audit

Notification.DataEntry

Field Type Label Description
key string
value string

NotificationService

Method Name Request Type Response Type Description
GetNotifications .google.protobuf.Empty GetNotificationsResponse Get user's notifications
MarkNotificationAsRead MarkNotificationAsReadRequest .google.protobuf.Empty Mark a notification as read

Top

org.proto

CreateOrgRequest

Field Type Label Description
name string
description string
logo_url string

CreateOrgUserRequest

Field Type Label Description
id string
user_id string
role_id string

DeleteOrgRequest

Field Type Label Description
id string

DeleteOrgUserRequest

Field Type Label Description
id string
user_id string

GetOrgRequest

Field Type Label Description
id string

GetOrgUserRequest

Field Type Label Description
id string
user_id string

ListOrgUsersRequest

Field Type Label Description
id string

ListOrgUsersResponse

Field Type Label Description
orgUsers OrgUser repeated

ListOrgsRequest

ListOrgsResponse

Field Type Label Description
orgs Org repeated

ListUserOrgsRequest

Field Type Label Description
user_id string

ListUserOrgsResponse

Field Type Label Description
orgs Org repeated

Org

Field Type Label Description
id string
name string
description string
logo_url string
subscription_id string Current Active Subscription
stats Org.StatsEntry repeated statistics
audit Audit audit field

Org.StatsEntry

Field Type Label Description
key string
value string

OrgUser

Field Type Label Description
user User
role string

UpdateOrgRequest

Field Type Label Description
id string
name string
description string
logo_url string

OrgService

Method Name Request Type Response Type Description
ListOrgs ListOrgsRequest ListOrgsResponse List all organizations to which the user belongs
GetOrg GetOrgRequest Org Get details of an organization
CreateOrg CreateOrgRequest Org Create a new organization.
UpdateOrg UpdateOrgRequest Org Update organization details
DeleteOrg DeleteOrgRequest .google.protobuf.Empty Delete an organization
ListOrgUsers ListOrgUsersRequest ListOrgUsersResponse List all org's users. This API requires organisation Owner role.
GetOrgUser GetOrgUserRequest OrgUser Get organization user details
CreateOrgUser CreateOrgUserRequest OrgUser Add a user to the organization
DeleteOrgUser DeleteOrgUserRequest .google.protobuf.Empty Remove a user from the organization

Top

pipeline.proto

ContainerResource

Field Type Label Description
requests ContainerResource.RequestsEntry repeated
limits ContainerResource.LimitsEntry repeated

ContainerResource.LimitsEntry

Field Type Label Description
key string
value string

ContainerResource.RequestsEntry

Field Type Label Description
key string
value string

CreatePipelineRunRequest

Field Type Label Description
pipeline_id string
owner_type string
owner_id string
owner_metadata CreatePipelineRunRequest.OwnerMetadataEntry repeated
step_parameters StepParameter repeated
global_parameters CreatePipelineRunRequest.GlobalParametersEntry repeated

CreatePipelineRunRequest.GlobalParametersEntry

Field Type Label Description
key string
value string

CreatePipelineRunRequest.OwnerMetadataEntry

Field Type Label Description
key string
value string

DeletePipelineRequest

Field Type Label Description
id string

EnvFrom

Field Type Label Description
type string
name string

EnvVarFromSource

Field Type Label Description
name string
value_from string
conf EnvVarFromSource.ConfEntry repeated

EnvVarFromSource.ConfEntry

Field Type Label Description
key string
value string

GetPipelineRequest

Field Type Label Description
id string

GetProgressRequest

Field Type Label Description
owner_id string
owner_type string
metadata GetProgressRequest.MetadataEntry repeated

GetProgressRequest.MetadataEntry

Field Type Label Description
key string
value string

Input

Field Type Label Description
parameters Input.ParametersEntry repeated

Input.ParametersEntry

Field Type Label Description
key string
value string

Output

Field Type Label Description
parameters string repeated

Pipeline

Field Type Label Description
id string
name string
sequence_steps SequenceStep repeated
global_inputs Input
labels Pipeline.LabelsEntry repeated
volumes Volume repeated
volume_claim_templates VolumeClaimTemplates repeated
node_selector Pipeline.NodeSelectorEntry repeated

Pipeline.LabelsEntry

Field Type Label Description
key string
value string

Pipeline.NodeSelectorEntry

Field Type Label Description
key string
value string

PipelineRun

Field Type Label Description
id string
pipeline_id string
owner_type string
owner_id string
owner_metadata PipelineRun.OwnerMetadataEntry repeated
status int32
progress Progress

PipelineRun.OwnerMetadataEntry

Field Type Label Description
key string
value string

RefItem

Field Type Label Description
key string
path string

SequenceStep

Field Type Label Description
parallel_steps Step repeated

Step

Field Type Label Description
name string
image string
command string repeated
inputs Input
outputs Output
condition string
env Step.EnvEntry repeated
env_var_from_sources EnvVarFromSource repeated
env_froms EnvFrom repeated
volume_mounts VolumeMount repeated
labels Step.LabelsEntry repeated
resources ContainerResource
node_selector Step.NodeSelectorEntry repeated

Step.EnvEntry

Field Type Label Description
key string
value string

Step.LabelsEntry

Field Type Label Description
key string
value string

Step.NodeSelectorEntry

Field Type Label Description
key string
value string

StepParameter

Field Type Label Description
step_name string
parameters StepParameter.ParametersEntry repeated

StepParameter.ParametersEntry

Field Type Label Description
key string
value string

UpdateProgressRequest

Field Type Label Description
id string
status int32
tasks Task repeated

Volume

Field Type Label Description
name string
type string
conf Volume.ConfEntry repeated
ref_items RefItem repeated

Volume.ConfEntry

Field Type Label Description
key string
value string

VolumeClaimTemplates

Field Type Label Description
name string
access_modes string repeated
storage_size string
storage_class_name string

VolumeMount

Field Type Label Description
name string
path string
read_only bool

PipelineService

Method Name Request Type Response Type Description
CreatePipeline Pipeline Pipeline Create a new pipeline which has one or multiple steps
UpdatePipeline Pipeline Pipeline Update pipeline information
GetPipeline GetPipelineRequest Pipeline Get pipeline definition
DeletePipeline DeletePipelineRequest .google.protobuf.Empty Delete pipeline
CreatePipelineRun CreatePipelineRunRequest PipelineRun Run pipeline with a special input
UpdateProgress UpdateProgressRequest .google.protobuf.Empty Update progress, status(failed/successed) a PipelineRun
GetProgress GetProgressRequest Progress Get progress of owner of pipelinerun

Top

project.proto

ClusterConfig

Field Type Label Description
scheduler_endpoint string

CreateProjectRequest

Field Type Label Description
name string
description string
org_id string

CreateProjectUserRequest

Field Type Label Description
id string
user_id string
role_id string

DeleteProjectRequest

Field Type Label Description
id string

DeleteProjectUserRequest

Field Type Label Description
id string
user_id string

GetProjectRequest

Field Type Label Description
id string

GetProjectUserRequest

Field Type Label Description
id string
user_id string

GsInfo

Field Type Label Description
bucket string
credentials string

HdfsInfo

Field Type Label Description
name_nodes string
rpc_port float
http_port float
root_folder string

ListOrgProjectsRequest

Field Type Label Description
org_id string

ListOrgProjectsResponse

Field Type Label Description
projects Project repeated

ListProjectUsersRequest

Field Type Label Description
id string

ListProjectUsersResponse

Field Type Label Description
projectUsers ProjectUser repeated

ListUserProjectsRequest

ListUserProjectsResponse

Field Type Label Description
projects Project repeated

Project

Field Type Label Description
id string
name string
description string
org RefEntity
config ProjectConfig
stats Project.StatsEntry repeated statistics
audit Audit audit field

Project.StatsEntry

Field Type Label Description
key string
value string

ProjectConfig

Field Type Label Description
cluster ClusterConfig
storage StorageConfig

ProjectUser

Field Type Label Description
user User
role string

S3Info

Field Type Label Description
bucket string
aws_key string
aws_secret string
aws_region string
endpoint string

StorageConfig

Field Type Label Description
protocol string
protocol_info StorageConfig.ProtocolInfoEntry repeated

StorageConfig.ProtocolInfoEntry

Field Type Label Description
key string
value string

UpdateProjectRequest

Field Type Label Description
id string
name string
description string

ProjectService

Method Name Request Type Response Type Description
ListOrgProjects ListOrgProjectsRequest ListOrgProjectsResponse List all organization's projects
GetProject GetProjectRequest Project Get detail information of the project
ListUserProjects ListUserProjectsRequest ListUserProjectsResponse List all user's projects
CreateProject CreateProjectRequest Project Create a new project
UpdateProject UpdateProjectRequest Project Update project details
DeleteProject DeleteProjectRequest .google.protobuf.Empty Delete a project
ListProjectUsers ListProjectUsersRequest ListProjectUsersResponse List all project's users
GetProjectUser GetProjectUserRequest ProjectUser Get project user details
CreateProjectUser CreateProjectUserRequest ProjectUser Add a user to a project
DeleteProjectUser DeleteProjectUserRequest .google.protobuf.Empty Remove a user from a project

Top

recipe.proto

AddActionsRequest

Field Type Label Description
id string
iteration int32
actions string JSON string represents the list of actions

AddActionsResponse

Field Type Label Description
invalid_index int32
error string
result string
job_id string

CommitActionsRequest

Field Type Label Description
id string
iteration int32
target_columns string repeated

CompleteRecipeRequest

Field Type Label Description
id string
dataset_name string

CompleteRecipeResponse

Field Type Label Description
dataset_id string

CreateRecipeRequest

Field Type Label Description
name string
description string
datasets InputDataset repeated

CreateRecommendedActionsRequest

Field Type Label Description
id string
iteration int32
actions string

DeleteRecipeRequest

Field Type Label Description
id string

GetCommittedActionsUrlRequest

Field Type Label Description
id string
iteration int32

GetCommittedActionsUrlResponse

Field Type Label Description
url string

GetRecipeIterationRequest

Field Type Label Description
id string
iteration int32

GetRecipeRequest

Field Type Label Description
id string

GetRecipeRunningResultRequest

Field Type Label Description
job_id string

GetRecommendedActionsUrlRequest

Field Type Label Description
id string
iteration int32

GetRecommendedActionsUrlResponse

Field Type Label Description
url string

GetRunActionsResultUrlByJobIdRequest

Field Type Label Description
job_id string

GetRunActionsResultUrlByJobIdResponse

Field Type Label Description
status string
url string

GetRunActionsResultUrlRequest

Field Type Label Description
id string
iteration int32

GetRunActionsResultUrlResponse

Field Type Label Description
url string

InputDataset

Field Type Label Description
id string
target_columns string repeated

ListRecipesRequest

Field Type Label Description
project_id string

ListRecipesResponse

Field Type Label Description
recipes Recipe repeated

PingRequest

Field Type Label Description
id string

PredictionInfo

Field Type Label Description
data string
content_type string csv,parquet,json

Recipe

Field Type Label Description
id string
name string
description string
datasets InputDataset repeated
iterations RecipeIteration repeated
status string
project RefEntity
org RefEntity
audit Audit

RecipeIteration

Field Type Label Description
iteration int32
dataset_id string
recommended_actions_url string
committed_actions_url string
action_state_url string
target_columns string repeated
status string
step string

RecipeRunningResult

Field Type Label Description
status string
new_dataset_id string
result_url string

RunActionsRequest

Field Type Label Description
id string
iteration int32
to_index int32

RunActionsResponse

Field Type Label Description
result string
job_id string

RunRecipeRequest

Field Type Label Description
id string
dataset_id string
new_dataset_name string
prediction PredictionInfo

RunRecipeResponse

Field Type Label Description
job_id string

UpdateActionsRequest

Field Type Label Description
id string
iteration int32
actions string JSON string represents the array of updating actions
from_index int32 index of the action in the queue, from which will be replaced by the provided actions

UpdateActionsResponse

Field Type Label Description
invalid_index int32
error string
result string
job_id string

UpdateRecipeIterationRequest

Field Type Label Description
id string
iteration int32
dataset_id string

UpdateRecipeRunningResultRequest

Field Type Label Description
job_id string
new_dataset_id string
result_url string

RecipeService

Method Name Request Type Response Type Description
CreateRecipe CreateRecipeRequest Recipe Create new recipe
GetRecipe GetRecipeRequest Recipe Get recipe details
DeleteRecipe DeleteRecipeRequest .google.protobuf.Empty Delete Recipe
Ping PingRequest .google.protobuf.Empty Ping service
ListRecipes ListRecipesRequest ListRecipesResponse Get list of available recipes in the projects
GetRecipeIteration GetRecipeIterationRequest RecipeIteration Get recipe iteration details
UpdateRecipeIteration UpdateRecipeIterationRequest RecipeIteration Update recipe iteration details
CreateRecommendedActions CreateRecommendedActionsRequest .google.protobuf.Empty Create recommendations for the iteration
AddActions AddActionsRequest AddActionsResponse Add actions
UpdateActions UpdateActionsRequest UpdateActionsResponse Update action
CommitActions CommitActionsRequest .google.protobuf.Empty Commit actions
RunActions RunActionsRequest RunActionsResponse Run actions
CompleteRecipe CompleteRecipeRequest CompleteRecipeResponse Complete the recipe
GetRecommendedActionsUrl GetRecommendedActionsUrlRequest GetRecommendedActionsUrlResponse Get recipe iteration's recommendedActions download URL
GetCommittedActionsUrl GetCommittedActionsUrlRequest GetCommittedActionsUrlResponse Get recipe iteration's recommendedActions download URL
GetRunActionsResultUrl GetRunActionsResultUrlRequest GetRunActionsResultUrlResponse Get recipe iteration's run action result download URL
GetRunActionsResultUrlByJobId GetRunActionsResultUrlByJobIdRequest GetRunActionsResultUrlByJobIdResponse Get running action result by jobId
RunRecipe RunRecipeRequest RunRecipeResponse Run recipe with provided dataset
GetRecipeRunningResult GetRecipeRunningResultRequest RecipeRunningResult Get running result when running Recipe
UpdateRecipeRunningResult UpdateRecipeRunningResultRequest RecipeRunningResult

Top

subscription.proto

CancelSubscriptionRequest

Field Type Label Description
id string

CreateSubscriptionRequest

Field Type Label Description
org_id string
plan_id string
payment_method_id string

GetSubscriptionRequest

Field Type Label Description
id string

ListPlansResponse

Field Type Label Description
plans Plan repeated

PaymentMethod

Field Type Label Description
id string
type string
billing_details PaymentMethod.BillingDetails
card PaymentMethod.Card

PaymentMethod.Address

Field Type Label Description
line1 string
line2 string
city string
state string
postal_code string
country string

PaymentMethod.BillingDetails

Field Type Label Description
address PaymentMethod.Address
email string
name string
phone string

PaymentMethod.Card

Field Type Label Description
brand string
expire_month int64
expire_year int64
last4 string

Plan

Field Type Label Description
id string
name string
price int64
currency string
credits double

Subscription

Field Type Label Description
id string Subscription's id
credits double Monthly credits
payment_method PaymentMethod Payment Method of the Subscription
next_billing_date int64
start_billing_date int64
plan RefEntity
org RefEntity The organisation to that this Subscription belongs
status string Subscription status
audit Audit Audit information

UpdatePaymentMethodRequest

Field Type Label Description
org_id string
payment_method_id string

SubscriptionService

Provides APIs to manage subscription in a organisation

Method Name Request Type Response Type Description
CreateSubscription CreateSubscriptionRequest Subscription Create subscription
UpdatePaymentMethod UpdatePaymentMethodRequest PaymentMethod
CancelSubscription CancelSubscriptionRequest Subscription Cancel subscription
ListPlans .google.protobuf.Empty ListPlansResponse List all subscription plans
GetSubscription GetSubscriptionRequest Subscription Get subscription details

Top

template.proto

CreateTemplateRequest

Field Type Label Description
id string
name string
summary string
description string
category string
metadata string
version string
image string

ListTemplatesResponse

Field Type Label Description
templates Template repeated

Template

Field Type Label Description
id string
name string
summary string
description string
category string
metadata string
version string
image string
audit Audit

UpdateTemplateRequest

Field Type Label Description
id string
name string
summary string
description string
category string
metadata string
version string
image string

TemplateService

Method Name Request Type Response Type Description
CreateTemplate CreateTemplateRequest Template Create a new model template
UpdateTemplate UpdateTemplateRequest Template Update model template details
ListTemplates .google.protobuf.Empty ListTemplatesResponse Get all available model templates

Top

user.proto

CreateUserRequest

Field Type Label Description
email string
password string
name string
phone string
organization string

GetUserByEmailRequest

Field Type Label Description
email string

RefreshTokenRequest

Field Type Label Description
refresh_token string

ResetPasswordRequest

Field Type Label Description
code string
password string

SendCodeRequest

Field Type Label Description
email string
codeType string Can be 'PASSWORD_RESET' or 'VERIFY_EMAIL'

SignInWithCustomTokenRequest

Field Type Label Description
token string

SignInWithEmailRequest

Field Type Label Description
email string
password string

TokenResponse

Field Type Label Description
token string
refresh_token string
expires_in string

UserService

Method Name Request Type Response Type Description
CreateUser CreateUserRequest User Register new user
GetUserByEmail GetUserByEmailRequest User Get user's detail by email
SignInWithEmail SignInWithEmailRequest TokenResponse Sign in with email and password
SignInWithCustomToken SignInWithCustomTokenRequest TokenResponse Sign in with custom token
RefreshToken RefreshTokenRequest TokenResponse Refresh the authorization token using the refresh token
SendCode SendCodeRequest .google.protobuf.Empty
ResetPassword ResetPasswordRequest .google.protobuf.Empty

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)