Class defaultAbstract

Abstract class outlining MLEngine API operations supported by the SDK.

Hierarchy

Constructors

constructor

Methods

createMLEngine deleteMLEngine getAllMLEngines getMLEngine updateMLEngine

Constructors

constructor

Methods

Abstract createMLEngine

  • Creates a mlEngine with the given name, engine, and parameters.

    Returns

    • Newly created mlEngine.

    Throws

    • Something went wrong creating the mlEngine.

    Parameters

    • name: string

      Name of the mlEngine to be created.

    • Optional codeFilePath: string | Readable

      Path to the code file or Readable of to be used for the mlEngine.

    • Optional modulesFilePath: string | Readable

      Path to the modules file or Readable of to be used for the mlEngine.

    Returns Promise<undefined | default>

Abstract deleteMLEngine

  • Deletes a mlEngine by name.

    Throws

    • Something went wrong deleting the mlEngine.

    Parameters

    • name: string

      Name of the mlEngine to be deleted.

    Returns Promise<void>

Abstract getAllMLEngines

Abstract getMLEngine

  • Gets a mlEngine by name for the authenticated user.

    Returns

    • Matching mlEngine, or undefined if it doesn't exist.

    Parameters

    • name: string

      Name of the mlEngine.

    Returns Promise<undefined | default>

Abstract updateMLEngine

  • Updates a mlEngine with the given name, engine, and parameters.

    Returns

    • Newly created mlEngine.

    Throws

    • Something went wrong creating the mlEngine.

    Parameters

    • name: string

      Name of the mlEngine to be created.

    • Optional codeFilePath: string | Readable

      Path to the code file to be used for the mlEngine.

    • Optional modulesFilePath: string | Readable

      Path to the modules file to be used for the mlEngine.

    Returns Promise<undefined | default>

Settings

Member Visibility

Theme

Generated using TypeDoc