This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.
Vision AI API client for Node.js
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:
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Vision AI API API.
- Set up authentication so you can access the API from your local workstation.
npm install @google-cloud/visionaiSamples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code |
|---|---|
| add application stream input | source code |
| create application | source code |
| create application instances | source code |
| create draft | source code |
| create processor | source code |
| delete application | source code |
| delete application instances | source code |
| delete draft | source code |
| delete processor | source code |
| deploy application | source code |
| get application | source code |
| get draft | source code |
| get instance | source code |
| get processor | source code |
| list applications | source code |
| list drafts | source code |
| list instances | source code |
| list prebuilt processors | source code |
| list processors | source code |
| remove application stream input | source code |
| undeploy application | source code |
| update application | source code |
| update application instances | source code |
| update application stream input | source code |
| update draft | source code |
| update processor | source code |
| health check | source code |
| batch run process | source code |
| create analysis | source code |
| create operator | source code |
| create process | source code |
| delete analysis | source code |
| delete operator | source code |
| delete process | source code |
| get analysis | source code |
| get operator | source code |
| get process | source code |
| list analyses | source code |
| list operators | source code |
| list processes | source code |
| list public operators | source code |
| resolve operator info | source code |
| update analysis | source code |
| update operator | source code |
| update process | source code |
| cloud | source code |
| acquire lease | source code |
| receive events | source code |
| receive packets | source code |
| release lease | source code |
| renew lease | source code |
| send packets | source code |
| create cluster | source code |
| create event | source code |
| create series | source code |
| create stream | source code |
| delete cluster | source code |
| delete event | source code |
| delete series | source code |
| delete stream | source code |
| generate stream hls token | source code |
| get cluster | source code |
| get event | source code |
| get series | source code |
| get stream | source code |
| get stream thumbnail | source code |
| list clusters | source code |
| list events | source code |
| list series | source code |
| list streams | source code |
| materialize channel | source code |
| update cluster | source code |
| update event | source code |
| update series | source code |
| update stream | source code |
| add collection item | source code |
| analyze asset | source code |
| analyze corpus | source code |
| clip asset | source code |
| create annotation | source code |
| create asset | source code |
| create collection | source code |
| create corpus | source code |
| create data schema | source code |
| create index | source code |
| create index endpoint | source code |
| create search config | source code |
| create search hypernym | source code |
| delete annotation | source code |
| delete asset | source code |
| delete collection | source code |
| delete corpus | source code |
| delete data schema | source code |
| delete index | source code |
| delete index endpoint | source code |
| delete search config | source code |
| delete search hypernym | source code |
| deploy index | source code |
| generate hls uri | source code |
| generate retrieval url | source code |
| get annotation | source code |
| get asset | source code |
| get collection | source code |
| get corpus | source code |
| get data schema | source code |
| get index | source code |
| get index endpoint | source code |
| get search config | source code |
| get search hypernym | source code |
| import assets | source code |
| index asset | source code |
| ingest asset | source code |
| list annotations | source code |
| list assets | source code |
| list collections | source code |
| list corpora | source code |
| list data schemas | source code |
| list index endpoints | source code |
| list indexes | source code |
| list search configs | source code |
| list search hypernyms | source code |
| remove collection item | source code |
| remove index asset | source code |
| search assets | source code |
| search index endpoint | source code |
| undeploy index | source code |
| update annotation | source code |
| update asset | source code |
| update collection | source code |
| update corpus | source code |
| update data schema | source code |
| update index | source code |
| update index endpoint | source code |
| update search config | source code |
| update search hypernym | source code |
| upload asset | source code |
| view collection items | source code |
| view indexed assets | source code |
Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.
Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:
- Legacy versions are not tested in continuous integration.
- Some security patches and features cannot be backported.
- Dependencies cannot be kept up-to-date.
Client libraries targeting some end-of-life versions of Node.js are available, and
can be installed through npm dist-tags.
The dist-tags follow the naming convention legacy-(version).
For example, npm install @google-cloud/visionai@legacy-8 installs client libraries
for versions compatible with Node.js 8.
This library follows Semantic Versioning.
More Information: Google Cloud Platform Launch Stages
Contributions welcome! See the Contributing Guide.
Please note that this README.md
and a variety of configuration files in this repository (including .nycrc and tsconfig.json)
are generated from a central template.
Apache Version 2.0
See LICENSE