Vertex AI Search for commerce API: Nodejs Client

This library is considered to be 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 stable libraries are addressed with the highest priority

Vertex AI Search for commerce API client for Node.js

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

• Vertex AI Search for commerce API Nodejs Client API Reference

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
  • Installing the client library

• Versioning

• Contributing

• License

Quickstart

Before you begin

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

Installing the client library

npm install @google-cloud/retail

Samples

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

| Sample | Source Code | | --------------------------- | --------------------------------- | | export analytics metrics | source code | | add catalog attribute | source code | | get attributes config | source code | | get completion config | source code | | get default branch | source code | | list catalogs | source code | | remove catalog attribute | source code | | replace catalog attribute | source code | | set default branch | source code | | update attributes config | source code | | update catalog | source code | | update completion config | source code | | complete query | source code | | import completion data | source code | | create control | source code | | delete control | source code | | get control | source code | | list controls | source code | | update control | source code | | conversational search | source code | | batch update generative question configs | source code | | get generative questions feature config | source code | | list generative question configs | source code | | update generative question config | source code | | update generative questions feature config | source code | | create model | source code | | delete model | source code | | get model | source code | | list models | source code | | pause model | source code | | resume model | source code | | tune model | source code | | update model | source code | | predict | source code | | add fulfillment places | source code | | add local inventories | source code | | create product | source code | | delete product | source code | | get product | source code | | import products | source code | | list products | source code | | purge products | source code | | remove fulfillment places | source code | | remove local inventories | source code | | set inventory | source code | | update product | source code | | search | source code | | add control | source code | | create serving config | source code | | delete serving config | source code | | get serving config | source code | | list serving configs | source code | | remove control | source code | | update serving config | source code | | cloud | source code | | collect user event | source code | | import user events | source code | | purge user events | source code | | rejoin user events | source code | | write user event | source code | | export analytics metrics | source code | | get branch | source code | | list branches | source code | | add catalog attribute | source code | | batch remove catalog attributes | source code | | get attributes config | source code | | get completion config | source code | | get default branch | source code | | list catalogs | source code | | remove catalog attribute | source code | | replace catalog attribute | source code | | set default branch | source code | | update attributes config | source code | | update catalog | source code | | update completion config | source code | | complete query | source code | | import completion data | source code | | create control | source code | | delete control | source code | | get control | source code | | list controls | source code | | update control | source code | | conversational search | source code | | batch update generative question configs | source code | | get generative questions feature config | source code | | list generative question configs | source code | | update generative question config | source code | | update generative questions feature config | source code | | create merchant center account link | source code | | delete merchant center account link | source code | | list merchant center account links | source code | | create model | source code | | delete model | source code | | get model | source code | | list models | source code | | pause model | source code | | resume model | source code | | tune model | source code | | update model | source code | | predict | source code | | add fulfillment places | source code | | add local inventories | source code | | create product | source code | | delete product | source code | | export products | source code | | get product | source code | | import products | source code | | list products | source code | | purge products | source code | | remove fulfillment places | source code | | remove local inventories | source code | | set inventory | source code | | update product | source code | | accept terms | source code | | enroll solution | source code | | get alert config | source code | | get logging config | source code | | get project | source code | | list enrolled solutions | source code | | update alert config | source code | | update logging config | source code | | search | source code | | add control | source code | | create serving config | source code | | delete serving config | source code | | get serving config | source code | | list serving configs | source code | | remove control | source code | | update serving config | source code | | cloud | source code | | collect user event | source code | | export user events | source code | | import user events | source code | | purge user events | source code | | rejoin user events | source code | | write user event | source code | | export analytics metrics | source code | | add catalog attribute | source code | | batch remove catalog attributes | source code | | get attributes config | source code | | get completion config | source code | | get default branch | source code | | list catalogs | source code | | remove catalog attribute | source code | | replace catalog attribute | source code | | set default branch | source code | | update attributes config | source code | | update catalog | source code | | update completion config | source code | | complete query | source code | | import completion data | source code | | create control | source code | | delete control | source code | | get control | source code | | list controls | source code | | update control | source code | | conversational search | source code | | batch update generative question configs | source code | | get generative questions feature config | source code | | list generative question configs | source code | | update generative question config | source code | | update generative questions feature config | source code | | create model | source code | | delete model | source code | | get model | source code | | list models | source code | | pause model | source code | | resume model | source code | | tune model | source code | | update model | source code | | predict | source code | | add fulfillment places | source code | | add local inventories | source code | | create product | source code | | delete product | source code | | export products | source code | | get product | source code | | import products | source code | | list products | source code | | purge products | source code | | remove fulfillment places | source code | | remove local inventories | source code | | set inventory | source code | | update product | source code | | get alert config | source code | | update alert config | source code | | search | source code | | add control | source code | | create serving config | source code | | delete serving config | source code | | get serving config | source code | | list serving configs | source code | | remove control | source code | | update serving config | source code | | cloud | source code | | collect user event | source code | | export user events | source code | | import user events | source code | | purge user events | source code | | rejoin user events | source code | | write user event | source 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/retail@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