Class default

Implementation of ModelsApiClient that goes through the REST API

Hierarchy

default
- default

Constructors

constructor

new default(sqlClient: default): default
Parameters
- sqlClient: default
  
  SQL API client to send all SQL query requests.
Returns default
Overrides default.constructor
- Defined in src/models/modelsRestApiClient.ts:24

Properties

sqlClient

sqlClient: default

SQL API client to send all SQL query requests.

Methods

adjustModel

adjustModel(name: string, project: string, adjustOptions: AdjustOptions): Promise<void>
Partially adjusts this model with the given options.

Throws
- Something went wrong querying the model.
Parameters
- name: string
  
  Name of the model.
- project: string
  
  Project the model belongs to.
- adjustOptions: AdjustOptions
Returns Promise<void>
Overrides default.adjustModel
- Defined in src/models/modelsRestApiClient.ts:413

batchQueryModel

batchQueryModel(name: string, version: number, targetColumn: string, project: string, options: BatchQueryOptions): Promise<ModelPrediction[]>
Queries this model for a batch prediction by joining with another data source.

Returns
- All prediction results from the batch query.
Throws
- Something went wrong querying the model.
Parameters
- name: string
  
  Name of the model.
- version: number
- targetColumn: string
  
  Column that the model predicts.
- project: string
  
  Project the model belongs to.
- options: BatchQueryOptions
  
  Options to use when querying the model.
Returns Promise<ModelPrediction[]>
Overrides default.batchQueryModel
- Defined in src/models/modelsRestApiClient.ts:272

deleteModel

deleteModel(name: string, project: string): Promise<void>
Deletes this model.

Throws
- Something went wrong deleting the model.
Parameters
- name: string
  
  Name of the model.
- project: string
  
  Project the model belongs to.
Returns Promise<void>
Overrides default.deleteModel
- Defined in src/models/modelsRestApiClient.ts:219

describeAccuracyModel

describeAccuracyModel(name: string, project: string, unique_id?: string): Promise<ModelDescribeAccuracy[]>
Describes the features of this model.

Returns
- All feature descriptions of the model. Empty if the model doesn't exist.
Parameters
- name: string
  
  Name of the model.
- project: string
  
  Project the model belongs to.
- Optional unique_id: string
  
  Optional unique id to filter the accuracy by.
Returns Promise<ModelDescribeAccuracy[]>
Overrides default.describeAccuracyModel
- Defined in src/models/modelsRestApiClient.ts:197

describeModel

describeModel(name: string, project: string): Promise<ModelFeatureDescription[]>
Describes the features of this model.

Returns
- All feature descriptions of the model. Empty if the model doesn't exist.
Parameters
- name: string
  
  Name of the model.
- project: string
  
  Project the model belongs to.
Returns Promise<ModelFeatureDescription[]>
Overrides default.describeModel
- Defined in src/models/modelsRestApiClient.ts:176

getAllModels

getAllModels(project: string): Promise<Model[]>
Gets all models associated with a project.

Returns
- All models for the given project.
Parameters
- project: string
  
  Project the models belong to.
Returns Promise<Model[]>
Overrides default.getAllModels
- Defined in src/models/modelsRestApiClient.ts:162

getModel

getModel(name: string, project: string, version?: number): Promise<undefined | Model>
Gets a model by name and project.

Returns
- The matching model, or undefined if none exists.
Parameters
- name: string
  
  Name of the model.
- project: string
  
  Project the model belongs to.
- Optional version: number
  
  The version of the model.
Returns Promise<undefined | Model>
Overrides default.getModel
- Defined in src/models/modelsRestApiClient.ts:140

`Private` makeRetrainClause

makeRetrainClause(name: string, project: string): string
Parameters
- name: string
- project: string
Returns string
- Defined in src/models/modelsRestApiClient.ts:29

`Private` makeTrainingCreateClause

makeTrainingCreateClause(name: string, project: string): string
Parameters
- name: string
- project: string
Returns string
- Defined in src/models/modelsRestApiClient.ts:33

`Private` makeTrainingFromClause

makeTrainingFromClause(options: TrainingOptions): string
Parameters
- options: TrainingOptions
Returns string
- Defined in src/models/modelsRestApiClient.ts:37

`Private` makeTrainingGroupByClause

makeTrainingGroupByClause(trainingOptions: TrainingOptions): string
Parameters
- trainingOptions: TrainingOptions
Returns string
- Defined in src/models/modelsRestApiClient.ts:67

`Private` makeTrainingOrderByClause

makeTrainingOrderByClause(trainingOptions: TrainingOptions): string
Parameters
- trainingOptions: TrainingOptions
Returns string
- Defined in src/models/modelsRestApiClient.ts:59

`Private` makeTrainingPredictClause

makeTrainingPredictClause(targetColumn: string): string
Parameters
- targetColumn: string
Returns string
- Defined in src/models/modelsRestApiClient.ts:55

`Private` makeTrainingSelectClause

makeTrainingSelectClause(options: AdjustOptions | TrainingOptions): string
Parameters
- options: AdjustOptions | TrainingOptions
Returns string
- Defined in src/models/modelsRestApiClient.ts:45

`Private` makeTrainingUsingClause

makeTrainingUsingClause(options: AdjustOptions | TrainingOptions): string
Parameters
- options: AdjustOptions | TrainingOptions
Returns string
- Defined in src/models/modelsRestApiClient.ts:112

`Private` makeTrainingWindowHorizonClause

makeTrainingWindowHorizonClause(trainingOptions: TrainingOptions): string
Parameters
- trainingOptions: TrainingOptions
Returns string
- Defined in src/models/modelsRestApiClient.ts:75

`Private` makeWhereClause

makeWhereClause(where: string | string[]): string
Parameters
- where: string | string[]
Returns string
- Defined in src/models/modelsRestApiClient.ts:86

queryModel

queryModel(name: string, version: number, targetColumn: string, project: string, options: QueryOptions): Promise<ModelPrediction>
Queries this model for a single prediction. For batch predictions, use batchQuery.

Returns
- The prediction result.
Throws
- Something went wrong querying the model.
Parameters
- name: string
  
  Name of the model.
- version: number
- targetColumn: string
  
  Column that the model predicts.
- project: string
  
  Project the model belongs to.
- options: QueryOptions
  
  Options to use when querying the model.
Returns Promise<ModelPrediction>
Overrides default.queryModel
- Defined in src/models/modelsRestApiClient.ts:238

retrainModel

retrainModel(name: string, targetColumn: string, project: string, trainingOptions?: TrainingOptions): Promise<void>
Rerains this model with the given options.

Throws
- Something went wrong querying the model.
Parameters
- name: string
  
  Name of the model.
- targetColumn: string
  
  Column for the model to predict.
- project: string
  
  Project the model belongs to.
- Optional trainingOptions: TrainingOptions
Returns Promise<void>
Overrides default.retrainModel
- Defined in src/models/modelsRestApiClient.ts:369

trainModel

trainModel(name: string, targetColumn: string, project: string, trainingOptions: TrainingOptions): Promise<Model>
Trains this model with the given options.

Throws
- Something went wrong querying the model.
Parameters
- name: string
  
  Name of the model.
- targetColumn: string
  
  Column for the model to predict.
- project: string
  
  Project the model belongs to.
- trainingOptions: TrainingOptions
Returns Promise<Model>
Overrides default.trainModel
- Defined in src/models/modelsRestApiClient.ts:317

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

sqlClient: default

Returns default

Properties

sqlClient

Methods

adjustModel

Throws

Parameters

name: string

project: string

adjustOptions: AdjustOptions

Returns Promise<void>

batchQueryModel

Returns

Throws

Parameters

name: string

version: number

targetColumn: string

project: string

options: BatchQueryOptions

Returns Promise<ModelPrediction[]>

deleteModel

Throws

Parameters

name: string

project: string

Returns Promise<void>

describeAccuracyModel

Returns

Parameters

name: string

project: string

Optional unique_id: string

Returns Promise<ModelDescribeAccuracy[]>

describeModel

Returns

Parameters

name: string

project: string

Returns Promise<ModelFeatureDescription[]>

getAllModels

Returns

Parameters

project: string

Returns Promise<Model[]>

getModel

Returns

Parameters

name: string

project: string

Optional version: number

Returns Promise<undefined | Model>

Private makeRetrainClause

Parameters

name: string

project: string

Returns string

Private makeTrainingCreateClause

Parameters

name: string

project: string

Returns string

Private makeTrainingFromClause

Parameters

options: TrainingOptions

Returns string

Private makeTrainingGroupByClause

Parameters

trainingOptions: TrainingOptions

Returns string

`Optional` unique_id: string

`Optional` version: number

`Private` makeRetrainClause

`Private` makeTrainingCreateClause

`Private` makeTrainingFromClause

`Private` makeTrainingGroupByClause

`Private` makeTrainingOrderByClause

`Private` makeTrainingPredictClause

`Private` makeTrainingSelectClause

`Private` makeTrainingUsingClause

`Private` makeTrainingWindowHorizonClause

`Private` makeWhereClause

`Optional` trainingOptions: TrainingOptions