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:
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Generative Language API API.
- Set up authentication so you can access the API from your local workstation.
npm install @google-ai/generativelanguageSamples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code |
|---|---|
| batch embed contents | source code |
| count tokens | source code |
| embed content | source code |
| generate content | source code |
| stream generate content | source code |
| get model | source code |
| list models | source code |
| ai | source code |
| create cached content | source code |
| delete cached content | source code |
| get cached content | source code |
| list cached contents | source code |
| update cached content | source code |
| count message tokens | source code |
| generate message | source code |
| create file | source code |
| delete file | source code |
| get file | source code |
| list files | source code |
| batch embed contents | source code |
| bidi generate content | source code |
| count tokens | source code |
| embed content | source code |
| generate answer | source code |
| generate content | source code |
| stream generate content | source code |
| create tuned model | source code |
| delete tuned model | source code |
| get model | source code |
| get tuned model | source code |
| list models | source code |
| list tuned models | source code |
| update tuned model | source code |
| create permission | source code |
| delete permission | source code |
| get permission | source code |
| list permissions | source code |
| transfer ownership | source code |
| update permission | source code |
| predict | source code |
| batch create chunks | source code |
| batch delete chunks | source code |
| batch update chunks | source code |
| create chunk | source code |
| create corpus | source code |
| create document | source code |
| delete chunk | source code |
| delete corpus | source code |
| delete document | source code |
| get chunk | source code |
| get corpus | source code |
| get document | source code |
| list chunks | source code |
| list corpora | source code |
| list documents | source code |
| query corpus | source code |
| query document | source code |
| update chunk | source code |
| update corpus | source code |
| update document | source code |
| ai | source code |
| batch embed text | source code |
| count text tokens | source code |
| embed text | source code |
| generate text | source code |
| create cached content | source code |
| delete cached content | source code |
| get cached content | source code |
| list cached contents | source code |
| update cached content | source code |
| count message tokens | source code |
| generate message | source code |
| create file | source code |
| delete file | source code |
| download file | source code |
| get file | source code |
| list files | source code |
| batch embed contents | source code |
| bidi generate content | source code |
| count tokens | source code |
| embed content | source code |
| generate answer | source code |
| generate content | source code |
| stream generate content | source code |
| create tuned model | source code |
| delete tuned model | source code |
| get model | source code |
| get tuned model | source code |
| list models | source code |
| list tuned models | source code |
| update tuned model | source code |
| create permission | source code |
| delete permission | source code |
| get permission | source code |
| list permissions | source code |
| transfer ownership | source code |
| update permission | source code |
| predict | source code |
| predict long running | source code |
| batch create chunks | source code |
| batch delete chunks | source code |
| batch update chunks | source code |
| create chunk | source code |
| create corpus | source code |
| create document | source code |
| delete chunk | source code |
| delete corpus | source code |
| delete document | source code |
| get chunk | source code |
| get corpus | source code |
| get document | source code |
| list chunks | source code |
| list corpora | source code |
| list documents | source code |
| query corpus | source code |
| query document | source code |
| update chunk | source code |
| update corpus | source code |
| update document | source code |
| ai | source code |
| batch embed text | source code |
| count text tokens | source code |
| embed text | source code |
| generate text | source code |
| count message tokens | source code |
| generate message | source code |
| get model | source code |
| list models | source code |
| ai | source code |
| embed text | source code |
| generate text | source code |
| count message tokens | source code |
| generate message | source code |
| create tuned model | source code |
| delete tuned model | source code |
| get model | source code |
| get tuned model | source code |
| list models | source code |
| list tuned models | source code |
| update tuned model | source code |
| create permission | source code |
| delete permission | source code |
| get permission | source code |
| list permissions | source code |
| transfer ownership | source code |
| update permission | source code |
| ai | source code |
| batch embed text | source code |
| count text tokens | source code |
| embed text | source code |
| generate text | source code |
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.
This library follows Semantic Versioning.
More Information: Google Cloud Platform Launch Stages
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.
Apache Version 2.0
See LICENSE