Skip to content

Latest commit

 

History

History

README.md

Google Cloud Platform logo

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.

npm version

Gemini Enterprise for Customer Experience 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 Gemini Enterprise for Customer Experience API API.
  4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/ces

Samples

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

Sample Source Code
batch delete conversations source code
create agent source code
create app source code
create app version source code
create deployment source code
create example source code
create guardrail source code
create tool source code
create toolset source code
delete agent source code
delete app source code
delete app version source code
delete conversation source code
delete deployment source code
delete example source code
delete guardrail source code
delete tool source code
delete toolset source code
export app source code
get agent source code
get app source code
get app version source code
get changelog source code
get conversation source code
get deployment source code
get example source code
get guardrail source code
get tool source code
get toolset source code
import app source code
list agents source code
list app versions source code
list apps source code
list changelogs source code
list conversations source code
list deployments source code
list examples source code
list guardrails source code
list tools source code
list toolsets source code
restore app version source code
update agent source code
update app source code
update deployment source code
update example source code
update guardrail source code
update tool source code
update toolset source code
bidi run session source code
run session source code
cloud source code
execute tool source code
retrieve tool schema source code
retrieve tools source code
generate chat token source code
batch delete conversations source code
create agent source code
create app source code
create app version source code
create deployment source code
create example source code
create guardrail source code
create tool source code
create toolset source code
delete agent source code
delete app source code
delete app version source code
delete conversation source code
delete deployment source code
delete example source code
delete guardrail source code
delete tool source code
delete toolset source code
export app source code
get agent source code
get app source code
get app version source code
get changelog source code
get conversation source code
get deployment source code
get example source code
get guardrail source code
get security settings source code
get tool source code
get toolset source code
import app source code
list agents source code
list app versions source code
list apps source code
list changelogs source code
list conversations source code
list deployments source code
list examples source code
list guardrails source code
list tools source code
list toolsets source code
restore app version source code
update agent source code
update app source code
update deployment source code
update example source code
update guardrail source code
update security settings source code
update tool source code
update toolset source code
create evaluation source code
create evaluation dataset source code
create evaluation expectation source code
create scheduled evaluation run source code
delete evaluation source code
delete evaluation dataset source code
delete evaluation expectation source code
delete evaluation result source code
delete evaluation run source code
delete scheduled evaluation run source code
generate evaluation source code
get evaluation source code
get evaluation dataset source code
get evaluation expectation source code
get evaluation result source code
get evaluation run source code
get scheduled evaluation run source code
import evaluations source code
list evaluation datasets source code
list evaluation expectations source code
list evaluation results source code
list evaluation runs source code
list evaluations source code
list scheduled evaluation runs source code
run evaluation source code
test persona voice source code
update evaluation source code
update evaluation dataset source code
update evaluation expectation source code
update scheduled evaluation run source code
upload evaluation audio source code
bidi run session source code
run session source code
cloud source code
execute tool source code
retrieve tool schema source code
retrieve tools source code
generate chat token 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/ces@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