npm - @google/genai - Versions diffs - 0.8.0 → 0.10.0 - Mend

@google/genai 0.8.0 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

package/README.md CHANGED Viewed

@@ -23,7 +23,6 @@ The Google Gen AI SDK is designed to work with Gemini 2.0 features.
 > **API Key Security:** Avoid exposing API keys in client-side code.
 > Use server-side implementations in production environments.
 ## Prerequisites
 * Node.js version 18 or later
@@ -58,39 +57,6 @@ async function main() {
 main();
 ```
-## Web quickstart
-The package contents are also available unzipped in the
-`package/` directory of the bucket, so an equivalent web example is:
-```html
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Using My Package</title>
-  </head>
-  <body>
-    <script type="module">
-      import {GoogleGenAI} from 'https://cdn.jsdelivr.net/npm/@google/genai@latest/+esm'
-          const ai = new GoogleGenAI({apiKey:"GEMINI_API_KEY"});
-          async function main() {
-            const response = await ai.models.generateContent({
-              model: 'gemini-2.0-flash-001',
-              contents: 'Why is the sky blue?',
-            });
-            console.log(response.text);
-          }
-          main();
-    </script>
-  </body>
-</html>
-```
 ## Initialization
 The Google Gen AI SDK provides support for both the
@@ -141,19 +107,19 @@ const ai = new GoogleGenAI({
 All API features are accessed through an instance of the `GoogleGenAI` classes.
 The submodules bundle together related API methods:
-- [`ai.models`](https://googleapis.github.io/js-genai/classes/models.Models.html):
+- [`ai.models`](https://googleapis.github.io/js-genai/main/classes/models.Models.html):
   Use `models` to query models (`generateContent`, `generateImages`, ...), or
   examine their metadata.
-- [`ai.caches`](https://googleapis.github.io/js-genai/classes/caches.Caches.html):
+- [`ai.caches`](https://googleapis.github.io/js-genai/main/classes/caches.Caches.html):
   Create and manage `caches` to reduce costs when repeatedly using the same
   large prompt prefix.
-- [`ai.chats`](https://googleapis.github.io/js-genai/classes/chats.Chats.html):
+- [`ai.chats`](https://googleapis.github.io/js-genai/main/classes/chats.Chats.html):
   Create local stateful `chat` objects to simplify multi turn interactions.
-- [`ai.files`](https://googleapis.github.io/js-genai/classes/files.Files.html):
+- [`ai.files`](https://googleapis.github.io/js-genai/main/classes/files.Files.html):
   Upload `files` to the API and reference them in your prompts.
   This reduces bandwidth if you use a file many times, and handles files too
   large to fit inline with your prompt.
-- [`ai.live`](https://googleapis.github.io/js-genai/classes/live.Live.html):
+- [`ai.live`](https://googleapis.github.io/js-genai/main/classes/live.Live.html):
   Start a `live` session for real time interaction, allows text + audio + video
   input, and text or audio output.
@@ -246,6 +212,31 @@ async function main() {
 main();
 ```
+### Generate Content
+#### How to structure `contents` argument for `generateContent`
+The SDK allows you to specify the following types in the `contents` parameter:
+#### Content
+- `Content`: The SDK will wrap the singular `Content` instance in an array which
+contains only the given content instance
+- `Content[]`: No transformation happens
+#### Part
+Parts will be aggregated on a singular Content, with role 'user'.
+- `Part | string`: The SDK will wrap the `string` or `Part` in a `Content`
+instance with role 'user'.
+- `Part[] | string[]`: The SDK will wrap the full provided list into a single
+`Content` with role 'user'.
+**_NOTE:_** This doesn't apply to `FunctionCall` and `FunctionResponse` parts,
+if you are specifying those, you need to explicitly provide the full
+`Content[]` structure making it explicit which Parts are 'spoken' by the model,
+or the user. The SDK will throw an exception if you try this.
 ## Preview Launch
@@ -253,3 +244,12 @@ The SDK is curently in a preview launch stage, per [Google's launch stages](http
 > At Preview, products or features are ready for testing by customers. Preview offerings are often publicly announced, but are not necessarily feature-complete, and no SLAs or technical support commitments are provided for these. Unless stated otherwise by Google, Preview offerings are intended for use in test environments only. The average Preview stage lasts about six months.
+## How is this different from the other Google AI SDKs
+This SDK (`@google/genai`) is Google Deepmind’s "vanilla" SDK for its generative AI offerings, and is where Google Deepmind adds new AI features.
+Models hosted either on the [Vertex AI platform](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview) or the [Gemini Developer platform](https://ai.google.dev/gemini-api/docs) are accessible through this SDK.
+Other SDKs may be offering additional AI frameworks on top of this SDK, or may be targeting specific project environments (like Firebase).
+The `@google/generative_language` and `@google-cloud/vertexai` SDKs are previous iterations of this SDK and are no longer receiving new Gemini 2.0+ features.