Netherworld's Pretend Minibar

    @google-cloud/aiplatform
    TypeScript icon, indicating that this package has built-in type declarations

    1.13.0 • Public • Published

    Google Cloud Platform logo

    Vertex AI: Node.js Client

    release level npm version codecov

    Google Cloud Vertex AI is an integrated suite of machine learning tools and services for building and using ML models with AutoML or custom code. It offers both novices and experts the best workbench for the entire machine learning development lifecycle.

    A comprehensive list of changes in each version may be found in the CHANGELOG.

    Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

    Table of contents:

    Quickstart

    Before you begin

    1. Select or create a Cloud Platform project.
    2. Enable billing for your project.
    3. Enable the Vertex AI API.
    4. Set up authentication with a service account so you can access the API from your local workstation.

    Installing the client library

    npm install @google-cloud/aiplatform

    Using the client library

    const {DatasetServiceClient} = require('@google-cloud/aiplatform');
    const client = new DatasetServiceClient();
    
    // Do something with DatasetServiceClient.
    console.info(client);
    

    Samples

    Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

    Sample Source Code Try it
    Cancel-batch-prediction-job source code Open in Cloud Shell
    Cancel-custom-job source code Open in Cloud Shell
    Create-batch-prediction-job-text-classification source code Open in Cloud Shell
    Create-batch-prediction-job-text-entity-extraction source code Open in Cloud Shell
    Create-batch-prediction-job-text-sentiment-analysis source code Open in Cloud Shell
    Create-batch-prediction-job-video-action-recognition source code Open in Cloud Shell
    Create-batch-prediction-job-video-classification source code Open in Cloud Shell
    Create-batch-prediction-job-video-object-tracking source code Open in Cloud Shell
    Create-custom-job source code Open in Cloud Shell
    Create-dataset-image source code Open in Cloud Shell
    Create-dataset-tabular-bigquery source code Open in Cloud Shell
    Create-dataset-tabular-gcs source code Open in Cloud Shell
    Create-dataset-text source code Open in Cloud Shell
    Create-dataset-video source code Open in Cloud Shell
    Create-dataset source code Open in Cloud Shell
    Create-endpoint source code Open in Cloud Shell
    Create-hyperparameter-tuning-job-sample source code Open in Cloud Shell
    Create-hyperparameter-tuning-job source code Open in Cloud Shell
    Create-training-pipeline-image-classification source code Open in Cloud Shell
    Create-training-pipeline-image-object-detection source code Open in Cloud Shell
    Create-training-pipeline-tabular-classification source code Open in Cloud Shell
    Create-training-pipeline-tabular-regression source code Open in Cloud Shell
    Create-training-pipeline-text-classification source code Open in Cloud Shell
    Create-training-pipeline-text-entity-extraction source code Open in Cloud Shell
    Create-training-pipeline-text-sentiment-analysis source code Open in Cloud Shell
    Create-training-pipeline-video-action-recognition source code Open in Cloud Shell
    Create-training-pipeline-video-classification source code Open in Cloud Shell
    Create-training-pipeline-video-object-tracking source code Open in Cloud Shell
    Delete-batch-prediction-job source code Open in Cloud Shell
    Delete-custom-job source code Open in Cloud Shell
    Delete-dataset source code Open in Cloud Shell
    Delete-endpoint source code Open in Cloud Shell
    Delete-export-model source code Open in Cloud Shell
    Delete-model source code Open in Cloud Shell
    Deploy-model-custom-trained-model source code Open in Cloud Shell
    Deploy-model source code Open in Cloud Shell
    Export-model-tabular-classification source code Open in Cloud Shell
    Export-model source code Open in Cloud Shell
    Get-batch-prediction-job source code Open in Cloud Shell
    Get-custom-job source code Open in Cloud Shell
    Get-hyperparameter-tuning-job source code Open in Cloud Shell
    Get-model-evaluation-image-classification source code Open in Cloud Shell
    Get-model-evaluation-image-object-detection source code Open in Cloud Shell
    Get-model-evaluation-slice source code Open in Cloud Shell
    Get-model-evaluation-tabular-classification source code Open in Cloud Shell
    Get-model-evaluation-tabular-regression source code Open in Cloud Shell
    Get-model-evaluation-text-classification source code Open in Cloud Shell
    Get-model-evaluation-text-entity-extraction source code Open in Cloud Shell
    Get-model-evaluation-text-sentiment-analysis source code Open in Cloud Shell
    Get-model-evaluation-video-action-recognition source code Open in Cloud Shell
    Get-model-evaluation-video-classification source code Open in Cloud Shell
    Get-model-evaluation-video-object-tracking source code Open in Cloud Shell
    Get-model-evaluation source code Open in Cloud Shell
    Get-model source code Open in Cloud Shell
    Get-training-pipeline source code Open in Cloud Shell
    Import-data-image-classification source code Open in Cloud Shell
    Import-data-image-object-detection source code Open in Cloud Shell
    Import-data-text-classification-single-label source code Open in Cloud Shell
    Import-data-text-entity-extraction source code Open in Cloud Shell
    Import-data-text-sentiment-analysis source code Open in Cloud Shell
    Import-data-video-action-recognition source code Open in Cloud Shell
    Import-data-video-classification source code Open in Cloud Shell
    Import-data-video-object-tracking source code Open in Cloud Shell
    Import-data source code Open in Cloud Shell
    List-endpoints source code Open in Cloud Shell
    List-model-evaluation-slices source code Open in Cloud Shell
    Predict-custom-trained-model source code Open in Cloud Shell
    Predict-image-classification source code Open in Cloud Shell
    Predict-image-object-detection source code Open in Cloud Shell
    Predict-tabular-classification source code Open in Cloud Shell
    Predict-tabular-regression source code Open in Cloud Shell
    Predict-text-classification source code Open in Cloud Shell
    Predict-text-entity-extraction source code Open in Cloud Shell
    Predict-text-sentiment-analysis source code Open in Cloud Shell
    Quickstart source code Open in Cloud Shell
    Undeploy-model source code Open in Cloud Shell
    Upload-model source code Open in Cloud Shell

    The Vertex AI Node.js Client API Reference documentation also contains samples.

    Supported Node.js Versions

    Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.

    Client libraries targeting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

    Legacy Node.js versions are supported as a best effort:

    • Legacy versions will not be tested in continuous integration.
    • Some security patches may not be able to be backported.
    • Dependencies will not be kept up-to-date, and features will not be backported.

    Legacy tags available

    • legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

    Versioning

    This library follows Semantic Versioning.

    This library is considered to be General Availability (GA). This means it is stable; the code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against GA libraries are addressed with the highest priority.

    More Information: Google Cloud Platform Launch Stages

    Contributing

    Contributions welcome! See the Contributing Guide.

    Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

    License

    Apache Version 2.0

    See LICENSE

    Install

    npm i @google-cloud/aiplatform

    DownloadsWeekly Downloads

    860

    Version

    1.13.0

    License

    Apache-2.0

    Unpacked Size

    37.9 MB

    Total Files

    359

    Last publish

    Collaborators

    • ofrobots
    • google-wombot
    • google-admin
    • soldair