Back to Google Cloud Node

[Vision AI API: Nodejs Client][homepage]

packages/google-cloud-visionai/README.md

0.57.028.9 KB
Original Source

Vision AI API: Nodejs Client

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:

Quickstart

Before you begin

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

Installing the client library

bash
npm install @google-cloud/visionai

Samples

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

SampleSource Code
add application stream inputsource code
create applicationsource code
create application instancessource code
create draftsource code
create processorsource code
delete applicationsource code
delete application instancessource code
delete draftsource code
delete processorsource code
deploy applicationsource code
get applicationsource code
get draftsource code
get instancesource code
get processorsource code
list applicationssource code
list draftssource code
list instancessource code
list prebuilt processorssource code
list processorssource code
remove application stream inputsource code
undeploy applicationsource code
update applicationsource code
update application instancessource code
update application stream inputsource code
update draftsource code
update processorsource code
health checksource code
batch run processsource code
create analysissource code
create operatorsource code
create processsource code
delete analysissource code
delete operatorsource code
delete processsource code
get analysissource code
get operatorsource code
get processsource code
list analysessource code
list operatorssource code
list processessource code
list public operatorssource code
resolve operator infosource code
update analysissource code
update operatorsource code
update processsource code
cloudsource code
acquire leasesource code
receive eventssource code
receive packetssource code
release leasesource code
renew leasesource code
send packetssource code
create clustersource code
create eventsource code
create seriessource code
create streamsource code
delete clustersource code
delete eventsource code
delete seriessource code
delete streamsource code
generate stream hls tokensource code
get clustersource code
get eventsource code
get seriessource code
get streamsource code
get stream thumbnailsource code
list clusterssource code
list eventssource code
list seriessource code
list streamssource code
materialize channelsource code
update clustersource code
update eventsource code
update seriessource code
update streamsource code
add collection itemsource code
analyze assetsource code
analyze corpussource code
clip assetsource code
create annotationsource code
create assetsource code
create collectionsource code
create corpussource code
create data schemasource code
create indexsource code
create index endpointsource code
create search configsource code
create search hypernymsource code
delete annotationsource code
delete assetsource code
delete collectionsource code
delete corpussource code
delete data schemasource code
delete indexsource code
delete index endpointsource code
delete search configsource code
delete search hypernymsource code
deploy indexsource code
generate hls urisource code
generate retrieval urlsource code
get annotationsource code
get assetsource code
get collectionsource code
get corpussource code
get data schemasource code
get indexsource code
get index endpointsource code
get search configsource code
get search hypernymsource code
import assetssource code
index assetsource code
ingest assetsource code
list annotationssource code
list assetssource code
list collectionssource code
list corporasource code
list data schemassource code
list index endpointssource code
list indexessource code
list search configssource code
list search hypernymssource code
remove collection itemsource code
remove index assetsource code
search assetssource code
search index endpointsource code
undeploy indexsource code
update annotationsource code
update assetsource code
update collectionsource code
update corpussource code
update data schemasource code
update indexsource code
update index endpointsource code
update search configsource code
update search hypernymsource code
upload assetsource code
view collection itemssource code
view indexed assetssource code

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. 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.

Versioning

This library follows Semantic Versioning.

More Information: Google Cloud Platform Launch Stages

Contributing

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.

License

Apache Version 2.0

See LICENSE