Back to Google Cloud Node

[Vertex AI Search for commerce API: Nodejs Client][homepage]

packages/google-cloud-retail/README.md

0.57.042.4 KB
Original Source

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.

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 Search for commerce 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/retail

Samples

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

SampleSource Code
export analytics metricssource code
add catalog attributesource code
get attributes configsource code
get completion configsource code
get default branchsource code
list catalogssource code
remove catalog attributesource code
replace catalog attributesource code
set default branchsource code
update attributes configsource code
update catalogsource code
update completion configsource code
complete querysource code
import completion datasource code
create controlsource code
delete controlsource code
get controlsource code
list controlssource code
update controlsource code
conversational searchsource code
batch update generative question configssource code
get generative questions feature configsource code
list generative question configssource code
update generative question configsource code
update generative questions feature configsource code
create modelsource code
delete modelsource code
get modelsource code
list modelssource code
pause modelsource code
resume modelsource code
tune modelsource code
update modelsource code
predictsource code
add fulfillment placessource code
add local inventoriessource code
create productsource code
delete productsource code
get productsource code
import productssource code
list productssource code
purge productssource code
remove fulfillment placessource code
remove local inventoriessource code
set inventorysource code
update productsource code
searchsource code
add controlsource code
create serving configsource code
delete serving configsource code
get serving configsource code
list serving configssource code
remove controlsource code
update serving configsource code
cloudsource code
collect user eventsource code
import user eventssource code
purge user eventssource code
rejoin user eventssource code
write user eventsource code
export analytics metricssource code
get branchsource code
list branchessource code
add catalog attributesource code
batch remove catalog attributessource code
get attributes configsource code
get completion configsource code
get default branchsource code
list catalogssource code
remove catalog attributesource code
replace catalog attributesource code
set default branchsource code
update attributes configsource code
update catalogsource code
update completion configsource code
complete querysource code
import completion datasource code
create controlsource code
delete controlsource code
get controlsource code
list controlssource code
update controlsource code
conversational searchsource code
batch update generative question configssource code
get generative questions feature configsource code
list generative question configssource code
update generative question configsource code
update generative questions feature configsource code
create merchant center account linksource code
delete merchant center account linksource code
list merchant center account linkssource code
create modelsource code
delete modelsource code
get modelsource code
list modelssource code
pause modelsource code
resume modelsource code
tune modelsource code
update modelsource code
predictsource code
add fulfillment placessource code
add local inventoriessource code
create productsource code
delete productsource code
export productssource code
get productsource code
import productssource code
list productssource code
purge productssource code
remove fulfillment placessource code
remove local inventoriessource code
set inventorysource code
update productsource code
accept termssource code
enroll solutionsource code
get alert configsource code
get logging configsource code
get projectsource code
list enrolled solutionssource code
update alert configsource code
update logging configsource code
searchsource code
add controlsource code
create serving configsource code
delete serving configsource code
get serving configsource code
list serving configssource code
remove controlsource code
update serving configsource code
cloudsource code
collect user eventsource code
export user eventssource code
import user eventssource code
purge user eventssource code
rejoin user eventssource code
write user eventsource code
export analytics metricssource code
add catalog attributesource code
batch remove catalog attributessource code
get attributes configsource code
get completion configsource code
get default branchsource code
list catalogssource code
remove catalog attributesource code
replace catalog attributesource code
set default branchsource code
update attributes configsource code
update catalogsource code
update completion configsource code
complete querysource code
import completion datasource code
create controlsource code
delete controlsource code
get controlsource code
list controlssource code
update controlsource code
conversational searchsource code
batch update generative question configssource code
get generative questions feature configsource code
list generative question configssource code
update generative question configsource code
update generative questions feature configsource code
create modelsource code
delete modelsource code
get modelsource code
list modelssource code
pause modelsource code
resume modelsource code
tune modelsource code
update modelsource code
predictsource code
add fulfillment placessource code
add local inventoriessource code
create productsource code
delete productsource code
export productssource code
get productsource code
import productssource code
list productssource code
purge productssource code
remove fulfillment placessource code
remove local inventoriessource code
set inventorysource code
update productsource code
get alert configsource code
update alert configsource code
searchsource code
add controlsource code
create serving configsource code
delete serving configsource code
get serving configsource code
list serving configssource code
remove controlsource code
update serving configsource code
cloudsource code
collect user eventsource code
export user eventssource code
import user eventssource code
purge user eventssource code
rejoin user eventssource code
write user eventsource 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