Back to Google Cloud Node

[Generative Language API: Nodejs Client][homepage]

packages/google-ai-generativelanguage/README.md

0.57.033.3 KB
Original Source

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

Generative Language 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 Generative Language API API.
  4. Set up authentication so you can access the API from your local workstation.

Installing the client library

bash
npm install @google-ai/generativelanguage

Samples

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

SampleSource Code
batch embed contentssource code
count tokenssource code
embed contentsource code
generate contentsource code
stream generate contentsource code
get modelsource code
list modelssource code
aisource code
create cached contentsource code
delete cached contentsource code
get cached contentsource code
list cached contentssource code
update cached contentsource code
count message tokenssource code
generate messagesource code
create filesource code
delete filesource code
get filesource code
list filessource code
batch embed contentssource code
bidi generate contentsource code
count tokenssource code
embed contentsource code
generate answersource code
generate contentsource code
stream generate contentsource code
create tuned modelsource code
delete tuned modelsource code
get modelsource code
get tuned modelsource code
list modelssource code
list tuned modelssource code
update tuned modelsource code
create permissionsource code
delete permissionsource code
get permissionsource code
list permissionssource code
transfer ownershipsource code
update permissionsource code
predictsource code
batch create chunkssource code
batch delete chunkssource code
batch update chunkssource code
create chunksource code
create corpussource code
create documentsource code
delete chunksource code
delete corpussource code
delete documentsource code
get chunksource code
get corpussource code
get documentsource code
list chunkssource code
list corporasource code
list documentssource code
query corpussource code
query documentsource code
update chunksource code
update corpussource code
update documentsource code
aisource code
batch embed textsource code
count text tokenssource code
embed textsource code
generate textsource code
create cached contentsource code
delete cached contentsource code
get cached contentsource code
list cached contentssource code
update cached contentsource code
count message tokenssource code
generate messagesource code
create filesource code
delete filesource code
download filesource code
get filesource code
list filessource code
batch embed contentssource code
bidi generate contentsource code
count tokenssource code
embed contentsource code
generate answersource code
generate contentsource code
stream generate contentsource code
create tuned modelsource code
delete tuned modelsource code
get modelsource code
get tuned modelsource code
list modelssource code
list tuned modelssource code
update tuned modelsource code
create permissionsource code
delete permissionsource code
get permissionsource code
list permissionssource code
transfer ownershipsource code
update permissionsource code
predictsource code
predict long runningsource code
batch create chunkssource code
batch delete chunkssource code
batch update chunkssource code
create chunksource code
create corpussource code
create documentsource code
delete chunksource code
delete corpussource code
delete documentsource code
get chunksource code
get corpussource code
get documentsource code
list chunkssource code
list corporasource code
list documentssource code
query corpussource code
query documentsource code
update chunksource code
update corpussource code
update documentsource code
aisource code
batch embed textsource code
count text tokenssource code
embed textsource code
generate textsource code
count message tokenssource code
generate messagesource code
get modelsource code
list modelssource code
aisource code
embed textsource code
generate textsource code
count message tokenssource code
generate messagesource code
create tuned modelsource code
delete tuned modelsource code
get modelsource code
get tuned modelsource code
list modelssource code
list tuned modelssource code
update tuned modelsource code
create permissionsource code
delete permissionsource code
get permissionsource code
list permissionssource code
transfer ownershipsource code
update permissionsource code
aisource code
batch embed textsource code
count text tokenssource code
embed textsource code
generate textsource 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-ai/generativelanguage@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