AutoMl

google.cloud.automl.v1. AutoMl

Represents an AutoMl

Constructor

new AutoMl(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new AutoMl service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

createDataset(request, callback) → {undefined}

Calls CreateDataset.

Parameters:
Name Type Description
request google.cloud.automl.v1.ICreateDatasetRequest

CreateDatasetRequest message or plain object

callback google.cloud.automl.v1.AutoMl.CreateDatasetCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

createDataset(request) → {Promise.<google.longrunning.Operation>}

Calls CreateDataset.

Parameters:
Name Type Description
request google.cloud.automl.v1.ICreateDatasetRequest

CreateDatasetRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

createModel(request, callback) → {undefined}

Calls CreateModel.

Parameters:
Name Type Description
request google.cloud.automl.v1.ICreateModelRequest

CreateModelRequest message or plain object

callback google.cloud.automl.v1.AutoMl.CreateModelCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

createModel(request) → {Promise.<google.longrunning.Operation>}

Calls CreateModel.

Parameters:
Name Type Description
request google.cloud.automl.v1.ICreateModelRequest

CreateModelRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

deleteDataset(request, callback) → {undefined}

Calls DeleteDataset.

Parameters:
Name Type Description
request google.cloud.automl.v1.IDeleteDatasetRequest

DeleteDatasetRequest message or plain object

callback google.cloud.automl.v1.AutoMl.DeleteDatasetCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

deleteDataset(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteDataset.

Parameters:
Name Type Description
request google.cloud.automl.v1.IDeleteDatasetRequest

DeleteDatasetRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

deleteModel(request, callback) → {undefined}

Calls DeleteModel.

Parameters:
Name Type Description
request google.cloud.automl.v1.IDeleteModelRequest

DeleteModelRequest message or plain object

callback google.cloud.automl.v1.AutoMl.DeleteModelCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

deleteModel(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteModel.

Parameters:
Name Type Description
request google.cloud.automl.v1.IDeleteModelRequest

DeleteModelRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

deployModel(request, callback) → {undefined}

Calls DeployModel.

Parameters:
Name Type Description
request google.cloud.automl.v1.IDeployModelRequest

DeployModelRequest message or plain object

callback google.cloud.automl.v1.AutoMl.DeployModelCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

deployModel(request) → {Promise.<google.longrunning.Operation>}

Calls DeployModel.

Parameters:
Name Type Description
request google.cloud.automl.v1.IDeployModelRequest

DeployModelRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

exportData(request, callback) → {undefined}

Calls ExportData.

Parameters:
Name Type Description
request google.cloud.automl.v1.IExportDataRequest

ExportDataRequest message or plain object

callback google.cloud.automl.v1.AutoMl.ExportDataCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

exportData(request) → {Promise.<google.longrunning.Operation>}

Calls ExportData.

Parameters:
Name Type Description
request google.cloud.automl.v1.IExportDataRequest

ExportDataRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

exportModel(request, callback) → {undefined}

Calls ExportModel.

Parameters:
Name Type Description
request google.cloud.automl.v1.IExportModelRequest

ExportModelRequest message or plain object

callback google.cloud.automl.v1.AutoMl.ExportModelCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

exportModel(request) → {Promise.<google.longrunning.Operation>}

Calls ExportModel.

Parameters:
Name Type Description
request google.cloud.automl.v1.IExportModelRequest

ExportModelRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

getAnnotationSpec(request, callback) → {undefined}

Calls GetAnnotationSpec.

Parameters:
Name Type Description
request google.cloud.automl.v1.IGetAnnotationSpecRequest

GetAnnotationSpecRequest message or plain object

callback google.cloud.automl.v1.AutoMl.GetAnnotationSpecCallback

Node-style callback called with the error, if any, and AnnotationSpec

Returns:
Type Description
undefined

getAnnotationSpec(request) → {Promise.<google.cloud.automl.v1.AnnotationSpec>}

Calls GetAnnotationSpec.

Parameters:
Name Type Description
request google.cloud.automl.v1.IGetAnnotationSpecRequest

GetAnnotationSpecRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.automl.v1.AnnotationSpec>

Promise

getDataset(request, callback) → {undefined}

Calls GetDataset.

Parameters:
Name Type Description
request google.cloud.automl.v1.IGetDatasetRequest

GetDatasetRequest message or plain object

callback google.cloud.automl.v1.AutoMl.GetDatasetCallback

Node-style callback called with the error, if any, and Dataset

Returns:
Type Description
undefined

getDataset(request) → {Promise.<google.cloud.automl.v1.Dataset>}

Calls GetDataset.

Parameters:
Name Type Description
request google.cloud.automl.v1.IGetDatasetRequest

GetDatasetRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.automl.v1.Dataset>

Promise

getModel(request, callback) → {undefined}

Calls GetModel.

Parameters:
Name Type Description
request google.cloud.automl.v1.IGetModelRequest

GetModelRequest message or plain object

callback google.cloud.automl.v1.AutoMl.GetModelCallback

Node-style callback called with the error, if any, and Model

Returns:
Type Description
undefined

getModel(request) → {Promise.<google.cloud.automl.v1.Model>}

Calls GetModel.

Parameters:
Name Type Description
request google.cloud.automl.v1.IGetModelRequest

GetModelRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.automl.v1.Model>

Promise

getModelEvaluation(request, callback) → {undefined}

Calls GetModelEvaluation.

Parameters:
Name Type Description
request google.cloud.automl.v1.IGetModelEvaluationRequest

GetModelEvaluationRequest message or plain object

callback google.cloud.automl.v1.AutoMl.GetModelEvaluationCallback

Node-style callback called with the error, if any, and ModelEvaluation

Returns:
Type Description
undefined

getModelEvaluation(request) → {Promise.<google.cloud.automl.v1.ModelEvaluation>}

Calls GetModelEvaluation.

Parameters:
Name Type Description
request google.cloud.automl.v1.IGetModelEvaluationRequest

GetModelEvaluationRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.automl.v1.ModelEvaluation>

Promise

importData(request, callback) → {undefined}

Calls ImportData.

Parameters:
Name Type Description
request google.cloud.automl.v1.IImportDataRequest

ImportDataRequest message or plain object

callback google.cloud.automl.v1.AutoMl.ImportDataCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

importData(request) → {Promise.<google.longrunning.Operation>}

Calls ImportData.

Parameters:
Name Type Description
request google.cloud.automl.v1.IImportDataRequest

ImportDataRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

listDatasets(request, callback) → {undefined}

Calls ListDatasets.

Parameters:
Name Type Description
request google.cloud.automl.v1.IListDatasetsRequest

ListDatasetsRequest message or plain object

callback google.cloud.automl.v1.AutoMl.ListDatasetsCallback

Node-style callback called with the error, if any, and ListDatasetsResponse

Returns:
Type Description
undefined

listDatasets(request) → {Promise.<google.cloud.automl.v1.ListDatasetsResponse>}

Calls ListDatasets.

Parameters:
Name Type Description
request google.cloud.automl.v1.IListDatasetsRequest

ListDatasetsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.automl.v1.ListDatasetsResponse>

Promise

listModelEvaluations(request, callback) → {undefined}

Calls ListModelEvaluations.

Parameters:
Name Type Description
request google.cloud.automl.v1.IListModelEvaluationsRequest

ListModelEvaluationsRequest message or plain object

callback google.cloud.automl.v1.AutoMl.ListModelEvaluationsCallback

Node-style callback called with the error, if any, and ListModelEvaluationsResponse

Returns:
Type Description
undefined

listModelEvaluations(request) → {Promise.<google.cloud.automl.v1.ListModelEvaluationsResponse>}

Calls ListModelEvaluations.

Parameters:
Name Type Description
request google.cloud.automl.v1.IListModelEvaluationsRequest

ListModelEvaluationsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.automl.v1.ListModelEvaluationsResponse>

Promise

listModels(request, callback) → {undefined}

Calls ListModels.

Parameters:
Name Type Description
request google.cloud.automl.v1.IListModelsRequest

ListModelsRequest message or plain object

callback google.cloud.automl.v1.AutoMl.ListModelsCallback

Node-style callback called with the error, if any, and ListModelsResponse

Returns:
Type Description
undefined

listModels(request) → {Promise.<google.cloud.automl.v1.ListModelsResponse>}

Calls ListModels.

Parameters:
Name Type Description
request google.cloud.automl.v1.IListModelsRequest

ListModelsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.automl.v1.ListModelsResponse>

Promise

undeployModel(request, callback) → {undefined}

Calls UndeployModel.

Parameters:
Name Type Description
request google.cloud.automl.v1.IUndeployModelRequest

UndeployModelRequest message or plain object

callback google.cloud.automl.v1.AutoMl.UndeployModelCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

undeployModel(request) → {Promise.<google.longrunning.Operation>}

Calls UndeployModel.

Parameters:
Name Type Description
request google.cloud.automl.v1.IUndeployModelRequest

UndeployModelRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

updateDataset(request, callback) → {undefined}

Calls UpdateDataset.

Parameters:
Name Type Description
request google.cloud.automl.v1.IUpdateDatasetRequest

UpdateDatasetRequest message or plain object

callback google.cloud.automl.v1.AutoMl.UpdateDatasetCallback

Node-style callback called with the error, if any, and Dataset

Returns:
Type Description
undefined

updateDataset(request) → {Promise.<google.cloud.automl.v1.Dataset>}

Calls UpdateDataset.

Parameters:
Name Type Description
request google.cloud.automl.v1.IUpdateDatasetRequest

UpdateDatasetRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.automl.v1.Dataset>

Promise

updateModel(request, callback) → {undefined}

Calls UpdateModel.

Parameters:
Name Type Description
request google.cloud.automl.v1.IUpdateModelRequest

UpdateModelRequest message or plain object

callback google.cloud.automl.v1.AutoMl.UpdateModelCallback

Node-style callback called with the error, if any, and Model

Returns:
Type Description
undefined

updateModel(request) → {Promise.<google.cloud.automl.v1.Model>}

Calls UpdateModel.

Parameters:
Name Type Description
request google.cloud.automl.v1.IUpdateModelRequest

UpdateModelRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.automl.v1.Model>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {AutoMl}

Creates new AutoMl service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
AutoMl

RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CreateDatasetCallback(error, responseopt)

Callback as used by createDataset.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

CreateModelCallback(error, responseopt)

Callback as used by createModel.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

DeleteDatasetCallback(error, responseopt)

Callback as used by deleteDataset.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

DeleteModelCallback(error, responseopt)

Callback as used by deleteModel.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

DeployModelCallback(error, responseopt)

Callback as used by deployModel.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

ExportDataCallback(error, responseopt)

Callback as used by exportData.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

ExportModelCallback(error, responseopt)

Callback as used by exportModel.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

GetAnnotationSpecCallback(error, responseopt)

Callback as used by getAnnotationSpec.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.automl.v1.AnnotationSpec <optional>

AnnotationSpec

GetDatasetCallback(error, responseopt)

Callback as used by getDataset.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.automl.v1.Dataset <optional>

Dataset

GetModelCallback(error, responseopt)

Callback as used by getModel.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.automl.v1.Model <optional>

Model

GetModelEvaluationCallback(error, responseopt)

Callback as used by getModelEvaluation.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.automl.v1.ModelEvaluation <optional>

ModelEvaluation

ImportDataCallback(error, responseopt)

Callback as used by importData.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

ListDatasetsCallback(error, responseopt)

Callback as used by listDatasets.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.automl.v1.ListDatasetsResponse <optional>

ListDatasetsResponse

ListModelEvaluationsCallback(error, responseopt)

Callback as used by listModelEvaluations.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.automl.v1.ListModelEvaluationsResponse <optional>

ListModelEvaluationsResponse

ListModelsCallback(error, responseopt)

Callback as used by listModels.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.automl.v1.ListModelsResponse <optional>

ListModelsResponse

UndeployModelCallback(error, responseopt)

Callback as used by undeployModel.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

UpdateDatasetCallback(error, responseopt)

Callback as used by updateDataset.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.automl.v1.Dataset <optional>

Dataset

UpdateModelCallback(error, responseopt)

Callback as used by updateModel.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.automl.v1.Model <optional>

Model