@google/genai 0.9.0 → 0.11.0

package/README.md

@@ -107,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.
 
@@ -212,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