Constructor

AutoMlClient

new AutoMlClient(options)

Construct an instance of AutoMlClient.

Parameter

options

Optional

object

The configuration object. See the subsequent parameters for more details.

Values in options have the following properties:

Parameter

credentials

Optional

object

Credentials object.

credentials.client_email

Optional

string

credentials.private_key

Optional

string

email

Optional

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

Optional

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

Optional

number

The port on which to connect to the remote host.

projectId

Optional

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

promise

Optional

function()

Custom promise module to use instead of native Promises.

servicePath

Optional

string

The domain name of the API remote host.

Properties

port

static

The port for this API service.

scopes

static

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static

The DNS address for this API service.

Methods

annotationSpecPath

annotationSpecPath(project, location, dataset, annotationSpec) returns String

Return a fully-qualified annotation_spec resource name string.

Parameter

project

String

location

String

dataset

String

annotationSpec

String

Returns

String 

columnSpecPath

columnSpecPath(project, location, dataset, tableSpec, columnSpec) returns String

Return a fully-qualified column_spec resource name string.

Parameter

project

String

location

String

dataset

String

tableSpec

String

columnSpec

String

Returns

String 

createDataset

createDataset(request, options, callback) returns Promise

Creates a dataset.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

The resource name of the project to create the dataset for.

dataset

Object

The dataset to create.

This object should have the same structure as Dataset

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Dataset.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing Dataset. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');
const dataset = {};
const request = {
  parent: formattedParent,
  dataset: dataset,
};
client.createDataset(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

createModel

createModel(request, options, callback) returns Promise

Creates a model. Returns a Model in the response field when it completes. When you create a model, several model evaluations are created for it: a global evaluation, and one evaluation for each annotation spec.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Resource name of the parent project where the model is being created.

model

Object

The model to create.

This object should have the same structure as Model

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is a gax.Operation object.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');
const model = {};
const request = {
  parent: formattedParent,
  model: model,
};

// Handle the operation using the promise pattern.
client.createModel(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Operation#promise starts polling for the completion of the LRO.
    return operation.promise();
  })
  .then(responses => {
    const result = responses[0];
    const metadata = responses[1];
    const finalApiResponse = responses[2];
  })
  .catch(err => {
    console.error(err);
  });

const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');
const model = {};
const request = {
  parent: formattedParent,
  model: model,
};

// Handle the operation using the event emitter pattern.
client.createModel(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Adding a listener for the "complete" event starts polling for the
    // completion of the operation.
    operation.on('complete', (result, metadata, finalApiResponse) => {
      // doSomethingWith(result);
    });

    // Adding a listener for the "progress" event causes the callback to be
    // called on any change in metadata when the operation is polled.
    operation.on('progress', (metadata, apiResponse) => {
      // doSomethingWith(metadata)
    });

    // Adding a listener for the "error" event handles any errors found during polling.
    operation.on('error', err => {
      // throw(err);
    });
  })
  .catch(err => {
    console.error(err);
  });

const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');
const model = {};
const request = {
  parent: formattedParent,
  model: model,
};

// Handle the operation using the await pattern.
const [operation] = await client.createModel(request);

const [response] = await operation.promise();

datasetPath

datasetPath(project, location, dataset) returns String

Return a fully-qualified dataset resource name string.

Parameter

project

String

location

String

dataset

String

Returns

String 

deleteDataset

deleteDataset(request, options, callback) returns Promise

Deletes a dataset and all of its contents. Returns empty response in the response field when it completes, and delete_details in the metadata field.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

The resource name of the dataset to delete.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is a gax.Operation object.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedName = client.datasetPath('[PROJECT]', '[LOCATION]', '[DATASET]');

// Handle the operation using the promise pattern.
client.deleteDataset({name: formattedName})
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Operation#promise starts polling for the completion of the LRO.
    return operation.promise();
  })
  .then(responses => {
    const result = responses[0];
    const metadata = responses[1];
    const finalApiResponse = responses[2];
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.datasetPath('[PROJECT]', '[LOCATION]', '[DATASET]');

// Handle the operation using the event emitter pattern.
client.deleteDataset({name: formattedName})
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Adding a listener for the "complete" event starts polling for the
    // completion of the operation.
    operation.on('complete', (result, metadata, finalApiResponse) => {
      // doSomethingWith(result);
    });

    // Adding a listener for the "progress" event causes the callback to be
    // called on any change in metadata when the operation is polled.
    operation.on('progress', (metadata, apiResponse) => {
      // doSomethingWith(metadata)
    });

    // Adding a listener for the "error" event handles any errors found during polling.
    operation.on('error', err => {
      // throw(err);
    });
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.datasetPath('[PROJECT]', '[LOCATION]', '[DATASET]');

// Handle the operation using the await pattern.
const [operation] = await client.deleteDataset({name: formattedName});

const [response] = await operation.promise();

deleteModel

deleteModel(request, options, callback) returns Promise

Deletes a model. Returns google.protobuf.Empty in the response field when it completes, and delete_details in the metadata field.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Resource name of the model being deleted.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is a gax.Operation object.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedName = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');

// Handle the operation using the promise pattern.
client.deleteModel({name: formattedName})
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Operation#promise starts polling for the completion of the LRO.
    return operation.promise();
  })
  .then(responses => {
    const result = responses[0];
    const metadata = responses[1];
    const finalApiResponse = responses[2];
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');

// Handle the operation using the event emitter pattern.
client.deleteModel({name: formattedName})
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Adding a listener for the "complete" event starts polling for the
    // completion of the operation.
    operation.on('complete', (result, metadata, finalApiResponse) => {
      // doSomethingWith(result);
    });

    // Adding a listener for the "progress" event causes the callback to be
    // called on any change in metadata when the operation is polled.
    operation.on('progress', (metadata, apiResponse) => {
      // doSomethingWith(metadata)
    });

    // Adding a listener for the "error" event handles any errors found during polling.
    operation.on('error', err => {
      // throw(err);
    });
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');

// Handle the operation using the await pattern.
const [operation] = await client.deleteModel({name: formattedName});

const [response] = await operation.promise();

deployModel

deployModel(request, options, callback) returns Promise

Deploys a model. If a model is already deployed, deploying it with the same parameters has no effect. Deploying with different parametrs (as e.g. changing

node_number ) will update the deployment without pausing the model's availability.

Only applicable for Text Classification, Image Object Detection and Tables; all other domains manage deployment automatically.

Returns an empty response in the response field when it completes.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Resource name of the model to deploy.

imageObjectDetectionModelDeploymentMetadata

Optional

Object

Model deployment metadata specific to Image Object Detection.

This object should have the same structure as ImageObjectDetectionModelDeploymentMetadata

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is a gax.Operation object.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedName = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');

// Handle the operation using the promise pattern.
client.deployModel({name: formattedName})
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Operation#promise starts polling for the completion of the LRO.
    return operation.promise();
  })
  .then(responses => {
    const result = responses[0];
    const metadata = responses[1];
    const finalApiResponse = responses[2];
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');

// Handle the operation using the event emitter pattern.
client.deployModel({name: formattedName})
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Adding a listener for the "complete" event starts polling for the
    // completion of the operation.
    operation.on('complete', (result, metadata, finalApiResponse) => {
      // doSomethingWith(result);
    });

    // Adding a listener for the "progress" event causes the callback to be
    // called on any change in metadata when the operation is polled.
    operation.on('progress', (metadata, apiResponse) => {
      // doSomethingWith(metadata)
    });

    // Adding a listener for the "error" event handles any errors found during polling.
    operation.on('error', err => {
      // throw(err);
    });
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');

// Handle the operation using the await pattern.
const [operation] = await client.deployModel({name: formattedName});

const [response] = await operation.promise();

exportData

exportData(request, options, callback) returns Promise

Exports dataset's data to the provided output location. Returns an empty response in the response field when it completes.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required. The resource name of the dataset.

outputConfig

Object

Required. The desired output location.

This object should have the same structure as OutputConfig

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is a gax.Operation object.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedName = client.datasetPath('[PROJECT]', '[LOCATION]', '[DATASET]');
const outputConfig = {};
const request = {
  name: formattedName,
  outputConfig: outputConfig,
};

// Handle the operation using the promise pattern.
client.exportData(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Operation#promise starts polling for the completion of the LRO.
    return operation.promise();
  })
  .then(responses => {
    const result = responses[0];
    const metadata = responses[1];
    const finalApiResponse = responses[2];
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.datasetPath('[PROJECT]', '[LOCATION]', '[DATASET]');
const outputConfig = {};
const request = {
  name: formattedName,
  outputConfig: outputConfig,
};

// Handle the operation using the event emitter pattern.
client.exportData(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Adding a listener for the "complete" event starts polling for the
    // completion of the operation.
    operation.on('complete', (result, metadata, finalApiResponse) => {
      // doSomethingWith(result);
    });

    // Adding a listener for the "progress" event causes the callback to be
    // called on any change in metadata when the operation is polled.
    operation.on('progress', (metadata, apiResponse) => {
      // doSomethingWith(metadata)
    });

    // Adding a listener for the "error" event handles any errors found during polling.
    operation.on('error', err => {
      // throw(err);
    });
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.datasetPath('[PROJECT]', '[LOCATION]', '[DATASET]');
const outputConfig = {};
const request = {
  name: formattedName,
  outputConfig: outputConfig,
};

// Handle the operation using the await pattern.
const [operation] = await client.exportData(request);

const [response] = await operation.promise();

exportEvaluatedExamples

exportEvaluatedExamples(request, options, callback) returns Promise

Exports examples on which the model was evaluated (i.e. which were in the TEST set of the dataset the model was created from), together with their ground truth annotations and the annotations created (predicted) by the model. The examples, ground truth and predictions are exported in the state they were at the moment the model was evaluated.

This export is available only for 30 days since the model evaluation is created.

Currently only available for Tables.

Returns an empty response in the response field when it completes.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required. The resource name of the model whose evaluated examples are to be exported.

outputConfig

Object

Required. The desired output location and configuration.

This object should have the same structure as ExportEvaluatedExamplesOutputConfig

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is a gax.Operation object.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedName = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');
const outputConfig = {};
const request = {
  name: formattedName,
  outputConfig: outputConfig,
};

// Handle the operation using the promise pattern.
client.exportEvaluatedExamples(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Operation#promise starts polling for the completion of the LRO.
    return operation.promise();
  })
  .then(responses => {
    const result = responses[0];
    const metadata = responses[1];
    const finalApiResponse = responses[2];
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');
const outputConfig = {};
const request = {
  name: formattedName,
  outputConfig: outputConfig,
};

// Handle the operation using the event emitter pattern.
client.exportEvaluatedExamples(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Adding a listener for the "complete" event starts polling for the
    // completion of the operation.
    operation.on('complete', (result, metadata, finalApiResponse) => {
      // doSomethingWith(result);
    });

    // Adding a listener for the "progress" event causes the callback to be
    // called on any change in metadata when the operation is polled.
    operation.on('progress', (metadata, apiResponse) => {
      // doSomethingWith(metadata)
    });

    // Adding a listener for the "error" event handles any errors found during polling.
    operation.on('error', err => {
      // throw(err);
    });
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');
const outputConfig = {};
const request = {
  name: formattedName,
  outputConfig: outputConfig,
};

// Handle the operation using the await pattern.
const [operation] = await client.exportEvaluatedExamples(request);

const [response] = await operation.promise();

exportModel

exportModel(request, options, callback) returns Promise

Exports a trained, "export-able", model to a user specified Google Cloud Storage location. A model is considered export-able if and only if it has an export format defined for it in

ModelExportOutputConfig.

Returns an empty response in the response field when it completes.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required. The resource name of the model to export.

outputConfig

Object

Required. The desired output location and configuration.

This object should have the same structure as ModelExportOutputConfig

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is a gax.Operation object.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedName = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');
const outputConfig = {};
const request = {
  name: formattedName,
  outputConfig: outputConfig,
};

// Handle the operation using the promise pattern.
client.exportModel(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Operation#promise starts polling for the completion of the LRO.
    return operation.promise();
  })
  .then(responses => {
    const result = responses[0];
    const metadata = responses[1];
    const finalApiResponse = responses[2];
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');
const outputConfig = {};
const request = {
  name: formattedName,
  outputConfig: outputConfig,
};

// Handle the operation using the event emitter pattern.
client.exportModel(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Adding a listener for the "complete" event starts polling for the
    // completion of the operation.
    operation.on('complete', (result, metadata, finalApiResponse) => {
      // doSomethingWith(result);
    });

    // Adding a listener for the "progress" event causes the callback to be
    // called on any change in metadata when the operation is polled.
    operation.on('progress', (metadata, apiResponse) => {
      // doSomethingWith(metadata)
    });

    // Adding a listener for the "error" event handles any errors found during polling.
    operation.on('error', err => {
      // throw(err);
    });
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');
const outputConfig = {};
const request = {
  name: formattedName,
  outputConfig: outputConfig,
};

// Handle the operation using the await pattern.
const [operation] = await client.exportModel(request);

const [response] = await operation.promise();

getAnnotationSpec

getAnnotationSpec(request, options, callback) returns Promise

Gets an annotation spec.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

The resource name of the annotation spec to retrieve.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing AnnotationSpec.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing AnnotationSpec. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedName = client.annotationSpecPath('[PROJECT]', '[LOCATION]', '[DATASET]', '[ANNOTATION_SPEC]');
client.getAnnotationSpec({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getColumnSpec

getColumnSpec(request, options, callback) returns Promise

Gets a column spec.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

The resource name of the column spec to retrieve.

fieldMask

Optional

Object

Mask specifying which fields to read.

This object should have the same structure as FieldMask

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing ColumnSpec.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing ColumnSpec. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedName = client.columnSpecPath('[PROJECT]', '[LOCATION]', '[DATASET]', '[TABLE_SPEC]', '[COLUMN_SPEC]');
client.getColumnSpec({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getDataset

getDataset(request, options, callback) returns Promise

Gets a dataset.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

The resource name of the dataset to retrieve.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Dataset.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing Dataset. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedName = client.datasetPath('[PROJECT]', '[LOCATION]', '[DATASET]');
client.getDataset({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getModel

getModel(request, options, callback) returns Promise

Gets a model.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Resource name of the model.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Model.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing Model. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedName = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');
client.getModel({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getModelEvaluation

getModelEvaluation(request, options, callback) returns Promise

Gets a model evaluation.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Resource name for the model evaluation.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing ModelEvaluation.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing ModelEvaluation. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedName = client.modelEvaluationPath('[PROJECT]', '[LOCATION]', '[MODEL]', '[MODEL_EVALUATION]');
client.getModelEvaluation({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getProjectId

getProjectId(callback)

Return the project ID used by this class.

Parameter

callback

function(Error, string)

the callback to be called with the current project Id.

getTableSpec

getTableSpec(request, options, callback) returns Promise

Gets a table spec.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

The resource name of the table spec to retrieve.

fieldMask

Optional

Object

Mask specifying which fields to read.

This object should have the same structure as FieldMask

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing TableSpec.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing TableSpec. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedName = client.tableSpecPath('[PROJECT]', '[LOCATION]', '[DATASET]', '[TABLE_SPEC]');
client.getTableSpec({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

importData

importData(request, options, callback) returns Promise

Imports data into a dataset. For Tables this method can only be called on an empty Dataset.

For Tables:

  • A schema_inference_version parameter must be explicitly set. Returns an empty response in the response field when it completes.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required. Dataset name. Dataset must already exist. All imported annotations and examples will be added.

inputConfig

Object

Required. The desired input location and its domain specific semantics, if any.

This object should have the same structure as InputConfig

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is a gax.Operation object.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedName = client.datasetPath('[PROJECT]', '[LOCATION]', '[DATASET]');
const inputConfig = {};
const request = {
  name: formattedName,
  inputConfig: inputConfig,
};

// Handle the operation using the promise pattern.
client.importData(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Operation#promise starts polling for the completion of the LRO.
    return operation.promise();
  })
  .then(responses => {
    const result = responses[0];
    const metadata = responses[1];
    const finalApiResponse = responses[2];
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.datasetPath('[PROJECT]', '[LOCATION]', '[DATASET]');
const inputConfig = {};
const request = {
  name: formattedName,
  inputConfig: inputConfig,
};

// Handle the operation using the event emitter pattern.
client.importData(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Adding a listener for the "complete" event starts polling for the
    // completion of the operation.
    operation.on('complete', (result, metadata, finalApiResponse) => {
      // doSomethingWith(result);
    });

    // Adding a listener for the "progress" event causes the callback to be
    // called on any change in metadata when the operation is polled.
    operation.on('progress', (metadata, apiResponse) => {
      // doSomethingWith(metadata)
    });

    // Adding a listener for the "error" event handles any errors found during polling.
    operation.on('error', err => {
      // throw(err);
    });
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.datasetPath('[PROJECT]', '[LOCATION]', '[DATASET]');
const inputConfig = {};
const request = {
  name: formattedName,
  inputConfig: inputConfig,
};

// Handle the operation using the await pattern.
const [operation] = await client.importData(request);

const [response] = await operation.promise();

listColumnSpecs

listColumnSpecs(request, options, callback) returns Promise

Lists column specs in a table spec.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

The resource name of the table spec to list column specs from.

fieldMask

Optional

Object

Mask specifying which fields to read.

This object should have the same structure as FieldMask

filter

Optional

string

Filter expression, see go/filtering.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Array, nullable Object, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is Array of ColumnSpec.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListColumnSpecsResponse.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is Array of ColumnSpec.

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of ColumnSpec in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListColumnSpecsResponse.

    The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.tableSpecPath('[PROJECT]', '[LOCATION]', '[DATASET]', '[TABLE_SPEC]');

client.listColumnSpecs({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.tableSpecPath('[PROJECT]', '[LOCATION]', '[DATASET]', '[TABLE_SPEC]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listColumnSpecs(nextRequest, options).then(callback);
  }
}
client.listColumnSpecs({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listColumnSpecsStream

listColumnSpecsStream(request, options) returns Stream

Equivalent to listColumnSpecs, but returns a NodeJS Stream object.

This fetches the paged responses for listColumnSpecs continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

The resource name of the table spec to list column specs from.

fieldMask

Optional

Object

Mask specifying which fields to read.

This object should have the same structure as FieldMask

filter

Optional

string

Filter expression, see go/filtering.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

See also
https://nodejs.org/api/stream.html
Returns

Stream 

An object stream which emits an object representing ColumnSpec on 'data' event.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedParent = client.tableSpecPath('[PROJECT]', '[LOCATION]', '[DATASET]', '[TABLE_SPEC]');
client.listColumnSpecsStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

listDatasets

listDatasets(request, options, callback) returns Promise

Lists datasets in a project.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

The resource name of the project from which to list datasets.

filter

Optional

string

An expression for filtering the results of the request.

* `dataset_metadata` - for existence of the case (e.g.
          image_classification_dataset_metadata:*). Some examples of using the filter are:

* `translation_dataset_metadata:*` --> The dataset has
                                       translation_dataset_metadata.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Array, nullable Object, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is Array of Dataset.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListDatasetsResponse.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is Array of Dataset.

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of Dataset in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListDatasetsResponse.

    The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');

client.listDatasets({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listDatasets(nextRequest, options).then(callback);
  }
}
client.listDatasets({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listDatasetsStream

listDatasetsStream(request, options) returns Stream

Equivalent to listDatasets, but returns a NodeJS Stream object.

This fetches the paged responses for listDatasets continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

The resource name of the project from which to list datasets.

filter

Optional

string

An expression for filtering the results of the request.

* `dataset_metadata` - for existence of the case (e.g.
          image_classification_dataset_metadata:*). Some examples of using the filter are:

* `translation_dataset_metadata:*` --> The dataset has
                                       translation_dataset_metadata.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

See also
https://nodejs.org/api/stream.html
Returns

Stream 

An object stream which emits an object representing Dataset on 'data' event.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');
client.listDatasetsStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

listModelEvaluations

listModelEvaluations(request, options, callback) returns Promise

Lists model evaluations.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Resource name of the model to list the model evaluations for. If modelId is set as "-", this will list model evaluations from across all models of the parent location.

filter

Optional

string

An expression for filtering the results of the request.

* `annotation_spec_id` - for =, !=  or existence. See example below for
                       the last.

Some examples of using the filter are:

* `annotation_spec_id!=4` --> The model evaluation was done for
                          annotation spec with ID different than 4.
* `NOT annotation_spec_id:*` --> The model evaluation was done for
                             aggregate of all annotation specs.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Array, nullable Object, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is Array of ModelEvaluation.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListModelEvaluationsResponse.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is Array of ModelEvaluation.

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of ModelEvaluation in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListModelEvaluationsResponse.

    The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');

client.listModelEvaluations({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listModelEvaluations(nextRequest, options).then(callback);
  }
}
client.listModelEvaluations({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listModelEvaluationsStream

listModelEvaluationsStream(request, options) returns Stream

Equivalent to listModelEvaluations, but returns a NodeJS Stream object.

This fetches the paged responses for listModelEvaluations continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Resource name of the model to list the model evaluations for. If modelId is set as "-", this will list model evaluations from across all models of the parent location.

filter

Optional

string

An expression for filtering the results of the request.

* `annotation_spec_id` - for =, !=  or existence. See example below for
                       the last.

Some examples of using the filter are:

* `annotation_spec_id!=4` --> The model evaluation was done for
                          annotation spec with ID different than 4.
* `NOT annotation_spec_id:*` --> The model evaluation was done for
                             aggregate of all annotation specs.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

See also
https://nodejs.org/api/stream.html
Returns

Stream 

An object stream which emits an object representing ModelEvaluation on 'data' event.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedParent = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');
client.listModelEvaluationsStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

listModels

listModels(request, options, callback) returns Promise

Lists models.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Resource name of the project, from which to list the models.

filter

Optional

string

An expression for filtering the results of the request.

* `model_metadata` - for existence of the case (e.g.
          video_classification_model_metadata:*).
* `dataset_id` - for = or !=. Some examples of using the filter are:

* `image_classification_model_metadata:*` --> The model has
                                     image_classification_model_metadata.
* `dataset_id=5` --> The model was created from a dataset with ID 5.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Array, nullable Object, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is Array of Model.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListModelsResponse.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is Array of Model.

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of Model in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListModelsResponse.

    The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');

client.listModels({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listModels(nextRequest, options).then(callback);
  }
}
client.listModels({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listModelsStream

listModelsStream(request, options) returns Stream

Equivalent to listModels, but returns a NodeJS Stream object.

This fetches the paged responses for listModels continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Resource name of the project, from which to list the models.

filter

Optional

string

An expression for filtering the results of the request.

* `model_metadata` - for existence of the case (e.g.
          video_classification_model_metadata:*).
* `dataset_id` - for = or !=. Some examples of using the filter are:

* `image_classification_model_metadata:*` --> The model has
                                     image_classification_model_metadata.
* `dataset_id=5` --> The model was created from a dataset with ID 5.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

See also
https://nodejs.org/api/stream.html
Returns

Stream 

An object stream which emits an object representing Model on 'data' event.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');
client.listModelsStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

listTableSpecs

listTableSpecs(request, options, callback) returns Promise

Lists table specs in a dataset.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

The resource name of the dataset to list table specs from.

fieldMask

Optional

Object

Mask specifying which fields to read.

This object should have the same structure as FieldMask

filter

Optional

string

Filter expression, see go/filtering.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Array, nullable Object, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is Array of TableSpec.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListTableSpecsResponse.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is Array of TableSpec.

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of TableSpec in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListTableSpecsResponse.

    The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.datasetPath('[PROJECT]', '[LOCATION]', '[DATASET]');

client.listTableSpecs({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.datasetPath('[PROJECT]', '[LOCATION]', '[DATASET]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listTableSpecs(nextRequest, options).then(callback);
  }
}
client.listTableSpecs({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listTableSpecsStream

listTableSpecsStream(request, options) returns Stream

Equivalent to listTableSpecs, but returns a NodeJS Stream object.

This fetches the paged responses for listTableSpecs continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

The resource name of the dataset to list table specs from.

fieldMask

Optional

Object

Mask specifying which fields to read.

This object should have the same structure as FieldMask

filter

Optional

string

Filter expression, see go/filtering.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

See also
https://nodejs.org/api/stream.html
Returns

Stream 

An object stream which emits an object representing TableSpec on 'data' event.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedParent = client.datasetPath('[PROJECT]', '[LOCATION]', '[DATASET]');
client.listTableSpecsStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

locationPath

locationPath(project, location) returns String

Return a fully-qualified location resource name string.

Parameter

project

String

location

String

Returns

String 

matchAnnotationSpecFromAnnotationSpecName

matchAnnotationSpecFromAnnotationSpecName(annotationSpecName) returns String

Parse the annotationSpecName from a annotation_spec resource.

Parameter

annotationSpecName

String

A fully-qualified path representing a annotation_spec resources.

Returns

String 

  • A string representing the annotation_spec.

matchColumnSpecFromColumnSpecName

matchColumnSpecFromColumnSpecName(columnSpecName) returns String

Parse the columnSpecName from a column_spec resource.

Parameter

columnSpecName

String

A fully-qualified path representing a column_spec resources.

Returns

String 

  • A string representing the column_spec.

matchDatasetFromAnnotationSpecName

matchDatasetFromAnnotationSpecName(annotationSpecName) returns String

Parse the annotationSpecName from a annotation_spec resource.

Parameter

annotationSpecName

String

A fully-qualified path representing a annotation_spec resources.

Returns

String 

  • A string representing the dataset.

matchDatasetFromColumnSpecName

matchDatasetFromColumnSpecName(columnSpecName) returns String

Parse the columnSpecName from a column_spec resource.

Parameter

columnSpecName

String

A fully-qualified path representing a column_spec resources.

Returns

String 

  • A string representing the dataset.

matchDatasetFromDatasetName

matchDatasetFromDatasetName(datasetName) returns String

Parse the datasetName from a dataset resource.

Parameter

datasetName

String

A fully-qualified path representing a dataset resources.

Returns

String 

  • A string representing the dataset.

matchDatasetFromTableSpecName

matchDatasetFromTableSpecName(tableSpecName) returns String

Parse the tableSpecName from a table_spec resource.

Parameter

tableSpecName

String

A fully-qualified path representing a table_spec resources.

Returns

String 

  • A string representing the dataset.

matchLocationFromAnnotationSpecName

matchLocationFromAnnotationSpecName(annotationSpecName) returns String

Parse the annotationSpecName from a annotation_spec resource.

Parameter

annotationSpecName

String

A fully-qualified path representing a annotation_spec resources.

Returns

String 

  • A string representing the location.

matchLocationFromColumnSpecName

matchLocationFromColumnSpecName(columnSpecName) returns String

Parse the columnSpecName from a column_spec resource.

Parameter

columnSpecName

String

A fully-qualified path representing a column_spec resources.

Returns

String 

  • A string representing the location.

matchLocationFromDatasetName

matchLocationFromDatasetName(datasetName) returns String

Parse the datasetName from a dataset resource.

Parameter

datasetName

String

A fully-qualified path representing a dataset resources.

Returns

String 

  • A string representing the location.

matchLocationFromLocationName

matchLocationFromLocationName(locationName) returns String

Parse the locationName from a location resource.

Parameter

locationName

String

A fully-qualified path representing a location resources.

Returns

String 

  • A string representing the location.

matchLocationFromModelEvaluationName

matchLocationFromModelEvaluationName(modelEvaluationName) returns String

Parse the modelEvaluationName from a model_evaluation resource.

Parameter

modelEvaluationName

String

A fully-qualified path representing a model_evaluation resources.

Returns

String 

  • A string representing the location.

matchLocationFromModelName

matchLocationFromModelName(modelName) returns String

Parse the modelName from a model resource.

Parameter

modelName

String

A fully-qualified path representing a model resources.

Returns

String 

  • A string representing the location.

matchLocationFromTableSpecName

matchLocationFromTableSpecName(tableSpecName) returns String

Parse the tableSpecName from a table_spec resource.

Parameter

tableSpecName

String

A fully-qualified path representing a table_spec resources.

Returns

String 

  • A string representing the location.

matchModelEvaluationFromModelEvaluationName

matchModelEvaluationFromModelEvaluationName(modelEvaluationName) returns String

Parse the modelEvaluationName from a model_evaluation resource.

Parameter

modelEvaluationName

String

A fully-qualified path representing a model_evaluation resources.

Returns

String 

  • A string representing the model_evaluation.

matchModelFromModelEvaluationName

matchModelFromModelEvaluationName(modelEvaluationName) returns String

Parse the modelEvaluationName from a model_evaluation resource.

Parameter

modelEvaluationName

String

A fully-qualified path representing a model_evaluation resources.

Returns

String 

  • A string representing the model.

matchModelFromModelName

matchModelFromModelName(modelName) returns String

Parse the modelName from a model resource.

Parameter

modelName

String

A fully-qualified path representing a model resources.

Returns

String 

  • A string representing the model.

matchProjectFromAnnotationSpecName

matchProjectFromAnnotationSpecName(annotationSpecName) returns String

Parse the annotationSpecName from a annotation_spec resource.

Parameter

annotationSpecName

String

A fully-qualified path representing a annotation_spec resources.

Returns

String 

  • A string representing the project.

matchProjectFromColumnSpecName

matchProjectFromColumnSpecName(columnSpecName) returns String

Parse the columnSpecName from a column_spec resource.

Parameter

columnSpecName

String

A fully-qualified path representing a column_spec resources.

Returns

String 

  • A string representing the project.

matchProjectFromDatasetName

matchProjectFromDatasetName(datasetName) returns String

Parse the datasetName from a dataset resource.

Parameter

datasetName

String

A fully-qualified path representing a dataset resources.

Returns

String 

  • A string representing the project.

matchProjectFromLocationName

matchProjectFromLocationName(locationName) returns String

Parse the locationName from a location resource.

Parameter

locationName

String

A fully-qualified path representing a location resources.

Returns

String 

  • A string representing the project.

matchProjectFromModelEvaluationName

matchProjectFromModelEvaluationName(modelEvaluationName) returns String

Parse the modelEvaluationName from a model_evaluation resource.

Parameter

modelEvaluationName

String

A fully-qualified path representing a model_evaluation resources.

Returns

String 

  • A string representing the project.

matchProjectFromModelName

matchProjectFromModelName(modelName) returns String

Parse the modelName from a model resource.

Parameter

modelName

String

A fully-qualified path representing a model resources.

Returns

String 

  • A string representing the project.

matchProjectFromTableSpecName

matchProjectFromTableSpecName(tableSpecName) returns String

Parse the tableSpecName from a table_spec resource.

Parameter

tableSpecName

String

A fully-qualified path representing a table_spec resources.

Returns

String 

  • A string representing the project.

matchTableSpecFromColumnSpecName

matchTableSpecFromColumnSpecName(columnSpecName) returns String

Parse the columnSpecName from a column_spec resource.

Parameter

columnSpecName

String

A fully-qualified path representing a column_spec resources.

Returns

String 

  • A string representing the table_spec.

matchTableSpecFromTableSpecName

matchTableSpecFromTableSpecName(tableSpecName) returns String

Parse the tableSpecName from a table_spec resource.

Parameter

tableSpecName

String

A fully-qualified path representing a table_spec resources.

Returns

String 

  • A string representing the table_spec.

modelEvaluationPath

modelEvaluationPath(project, location, model, modelEvaluation) returns String

Return a fully-qualified model_evaluation resource name string.

Parameter

project

String

location

String

model

String

modelEvaluation

String

Returns

String 

modelPath

modelPath(project, location, model) returns String

Return a fully-qualified model resource name string.

Parameter

project

String

location

String

model

String

Returns

String 

tableSpecPath

tableSpecPath(project, location, dataset, tableSpec) returns String

Return a fully-qualified table_spec resource name string.

Parameter

project

String

location

String

dataset

String

tableSpec

String

Returns

String 

undeployModel

undeployModel(request, options, callback) returns Promise

Undeploys a model. If the model is not deployed this method has no effect.

Only applicable for Text Classification, Image Object Detection and Tables; all other domains manage deployment automatically.

Returns an empty response in the response field when it completes.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Resource name of the model to undeploy.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is a gax.Operation object.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const formattedName = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');

// Handle the operation using the promise pattern.
client.undeployModel({name: formattedName})
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Operation#promise starts polling for the completion of the LRO.
    return operation.promise();
  })
  .then(responses => {
    const result = responses[0];
    const metadata = responses[1];
    const finalApiResponse = responses[2];
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');

// Handle the operation using the event emitter pattern.
client.undeployModel({name: formattedName})
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Adding a listener for the "complete" event starts polling for the
    // completion of the operation.
    operation.on('complete', (result, metadata, finalApiResponse) => {
      // doSomethingWith(result);
    });

    // Adding a listener for the "progress" event causes the callback to be
    // called on any change in metadata when the operation is polled.
    operation.on('progress', (metadata, apiResponse) => {
      // doSomethingWith(metadata)
    });

    // Adding a listener for the "error" event handles any errors found during polling.
    operation.on('error', err => {
      // throw(err);
    });
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.modelPath('[PROJECT]', '[LOCATION]', '[MODEL]');

// Handle the operation using the await pattern.
const [operation] = await client.undeployModel({name: formattedName});

const [response] = await operation.promise();

updateColumnSpec

updateColumnSpec(request, options, callback) returns Promise

Updates a column spec.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

columnSpec

Object

The column spec which replaces the resource on the server.

This object should have the same structure as ColumnSpec

updateMask

Optional

Object

The update mask applies to the resource. For the FieldMask definition, see

https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask

This object should have the same structure as FieldMask

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing ColumnSpec.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing ColumnSpec. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const columnSpec = {};
client.updateColumnSpec({columnSpec: columnSpec})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

updateDataset

updateDataset(request, options, callback) returns Promise

Updates a dataset.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

dataset

Object

The dataset which replaces the resource on the server.

This object should have the same structure as Dataset

updateMask

Optional

Object

The update mask applies to the resource. For the FieldMask definition, see

https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask

This object should have the same structure as FieldMask

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Dataset.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing Dataset. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const dataset = {};
client.updateDataset({dataset: dataset})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

updateTableSpec

updateTableSpec(request, options, callback) returns Promise

Updates a table spec.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

tableSpec

Object

The table spec which replaces the resource on the server.

This object should have the same structure as TableSpec

updateMask

Optional

Object

The update mask applies to the resource. For the FieldMask definition, see

https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask

This object should have the same structure as FieldMask

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing TableSpec.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing TableSpec. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const automl = require('@google-cloud/automl');

const client = new automl.v1beta1.AutoMlClient({
  // optional auth parameters.
});

const tableSpec = {};
client.updateTableSpec({tableSpec: tableSpec})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });