@google-ai/generativelanguage
TypeScript icon, indicating that this package has built-in type declarations

2.6.0 • Public • Published

Google Cloud Platform logo

release level npm version

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 with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-ai/generativelanguage

Using the client library

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The model name to use with the format name=models/{model}.
 */
// const model = 'abc123'
/**
 *  Required. The free-form input text given to the model as a prompt.
 *  Given a prompt, the model will generate a TextCompletion response it
 *  predicts as the completion of the input text.
 */
// const prompt = {
//  text: 'abc123'
// }
/**
 *  Controls the randomness of the output.
 *  Note: The default value varies by model, see the `Model.temperature`
 *  attribute of the `Model` returned the `getModel` function.
 *  Values can range from 0.0,1.0,
 *  inclusive. A value closer to 1.0 will produce responses that are more
 *  varied and creative, while a value closer to 0.0 will typically result in
 *  more straightforward responses from the model.
 */
// const temperature = 1234
/**
 *  Number of generated responses to return.
 *  This value must be between 1, 8, inclusive. If unset, this will default
 *  to 1.
 */
// const candidateCount = 1234
/**
 *  The maximum number of tokens to include in a candidate.
 *  If unset, this will default to 64.
 */
// const maxOutputTokens = 1234
/**
 *  The maximum cumulative probability of tokens to consider when sampling.
 *  The model uses combined Top-k and nucleus sampling.
 *  Tokens are sorted based on their assigned probabilities so that only the
 *  most liekly tokens are considered. Top-k sampling directly limits the
 *  maximum number of tokens to consider, while Nucleus sampling limits number
 *  of tokens based on the cumulative probability.
 *  Note: The default value varies by model, see the `Model.top_p`
 *  attribute of the `Model` returned the `getModel` function.
 */
// const topP = 1234
/**
 *  The maximum number of tokens to consider when sampling.
 *  The model uses combined Top-k and nucleus sampling.
 *  Top-k sampling considers the set of `top_k` most probable tokens.
 *  Defaults to 40.
 *  Note: The default value varies by model, see the `Model.top_k`
 *  attribute of the `Model` returned the `getModel` function.
 */
// const topK = 1234
/**
 *  The set of character sequences (up to 5) that will stop output generation.
 *  If specified, the API will stop at the first appearance of a stop
 *  sequence. The stop sequence will not be included as part of the response.
 */
// const stopSequences = 'abc123'

// Imports the Generativelanguage library
const {TextServiceClient} = require('@google-ai/generativelanguage').v1beta2;

// Instantiates a client
const generativelanguageClient = new TextServiceClient();

async function callGenerateText() {
  // Construct request
  const request = {
    model,
    prompt,
  };

  // Run request
  const response = await generativelanguageClient.generateText(request);
  console.log(response);
}

callGenerateText();

Samples

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

Sample Source Code Try it
Generative_service.batch_embed_contents source code Open in Cloud Shell
Generative_service.count_tokens source code Open in Cloud Shell
Generative_service.embed_content source code Open in Cloud Shell
Generative_service.generate_content source code Open in Cloud Shell
Generative_service.stream_generate_content source code Open in Cloud Shell
Model_service.get_model source code Open in Cloud Shell
Model_service.list_models source code Open in Cloud Shell
Cache_service.create_cached_content source code Open in Cloud Shell
Cache_service.delete_cached_content source code Open in Cloud Shell
Cache_service.get_cached_content source code Open in Cloud Shell
Cache_service.list_cached_contents source code Open in Cloud Shell
Cache_service.update_cached_content source code Open in Cloud Shell
Discuss_service.count_message_tokens source code Open in Cloud Shell
Discuss_service.generate_message source code Open in Cloud Shell
File_service.create_file source code Open in Cloud Shell
File_service.delete_file source code Open in Cloud Shell
File_service.get_file source code Open in Cloud Shell
File_service.list_files source code Open in Cloud Shell
Generative_service.batch_embed_contents source code Open in Cloud Shell
Generative_service.count_tokens source code Open in Cloud Shell
Generative_service.embed_content source code Open in Cloud Shell
Generative_service.generate_answer source code Open in Cloud Shell
Generative_service.generate_content source code Open in Cloud Shell
Generative_service.stream_generate_content source code Open in Cloud Shell
Model_service.create_tuned_model source code Open in Cloud Shell
Model_service.delete_tuned_model source code Open in Cloud Shell
Model_service.get_model source code Open in Cloud Shell
Model_service.get_tuned_model source code Open in Cloud Shell
Model_service.list_models source code Open in Cloud Shell
Model_service.list_tuned_models source code Open in Cloud Shell
Model_service.update_tuned_model source code Open in Cloud Shell
Permission_service.create_permission source code Open in Cloud Shell
Permission_service.delete_permission source code Open in Cloud Shell
Permission_service.get_permission source code Open in Cloud Shell
Permission_service.list_permissions source code Open in Cloud Shell
Permission_service.transfer_ownership source code Open in Cloud Shell
Permission_service.update_permission source code Open in Cloud Shell
Retriever_service.batch_create_chunks source code Open in Cloud Shell
Retriever_service.batch_delete_chunks source code Open in Cloud Shell
Retriever_service.batch_update_chunks source code Open in Cloud Shell
Retriever_service.create_chunk source code Open in Cloud Shell
Retriever_service.create_corpus source code Open in Cloud Shell
Retriever_service.create_document source code Open in Cloud Shell
Retriever_service.delete_chunk source code Open in Cloud Shell
Retriever_service.delete_corpus source code Open in Cloud Shell
Retriever_service.delete_document source code Open in Cloud Shell
Retriever_service.get_chunk source code Open in Cloud Shell
Retriever_service.get_corpus source code Open in Cloud Shell
Retriever_service.get_document source code Open in Cloud Shell
Retriever_service.list_chunks source code Open in Cloud Shell
Retriever_service.list_corpora source code Open in Cloud Shell
Retriever_service.list_documents source code Open in Cloud Shell
Retriever_service.query_corpus source code Open in Cloud Shell
Retriever_service.query_document source code Open in Cloud Shell
Retriever_service.update_chunk source code Open in Cloud Shell
Retriever_service.update_corpus source code Open in Cloud Shell
Retriever_service.update_document source code Open in Cloud Shell
Text_service.batch_embed_text source code Open in Cloud Shell
Text_service.count_text_tokens source code Open in Cloud Shell
Text_service.embed_text source code Open in Cloud Shell
Text_service.generate_text source code Open in Cloud Shell
Discuss_service.count_message_tokens source code Open in Cloud Shell
Discuss_service.generate_message source code Open in Cloud Shell
Model_service.get_model source code Open in Cloud Shell
Model_service.list_models source code Open in Cloud Shell
Text_service.embed_text source code Open in Cloud Shell
Text_service.generate_text source code Open in Cloud Shell
Discuss_service.count_message_tokens source code Open in Cloud Shell
Discuss_service.generate_message source code Open in Cloud Shell
Model_service.create_tuned_model source code Open in Cloud Shell
Model_service.delete_tuned_model source code Open in Cloud Shell
Model_service.get_model source code Open in Cloud Shell
Model_service.get_tuned_model source code Open in Cloud Shell
Model_service.list_models source code Open in Cloud Shell
Model_service.list_tuned_models source code Open in Cloud Shell
Model_service.update_tuned_model source code Open in Cloud Shell
Permission_service.create_permission source code Open in Cloud Shell
Permission_service.delete_permission source code Open in Cloud Shell
Permission_service.get_permission source code Open in Cloud Shell
Permission_service.list_permissions source code Open in Cloud Shell
Permission_service.transfer_ownership source code Open in Cloud Shell
Permission_service.update_permission source code Open in Cloud Shell
Text_service.batch_embed_text source code Open in Cloud Shell
Text_service.count_text_tokens source code Open in Cloud Shell
Text_service.embed_text source code Open in Cloud Shell
Text_service.generate_text source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell

The Generative Language API Node.js Client API Reference documentation also contains samples.

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.

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.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE

Package Sidebar

Install

npm i @google-ai/generativelanguage

Weekly Downloads

27,377

Version

2.6.0

License

Apache-2.0

Unpacked Size

9.54 MB

Total Files

128

Last publish

Collaborators

  • google-wombot