@google/genai 0.9.0 → 0.10.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
 

package/dist/genai.d.ts

@@ -164,6 +164,14 @@ export declare interface AutomaticActivityDetection {
 declare class BaseModule {
 }
 
+/**
+ * Parameters for setting the base URLs for the Gemini API and Vertex AI API.
+ */
+export declare interface BaseUrlParameters {
+    geminiUrl?: string;
+    vertexUrl?: string;
+}
+
 /** Content blob. */
 declare interface Blob_2 {
     /** Required. Raw bytes. */
@@ -173,6 +181,8 @@ declare interface Blob_2 {
 }
 export { Blob_2 as Blob }
 
+export declare type BlobImageUnion = Blob_2;
+
 /** Output only. Blocked reason. */
 export declare enum BlockedReason {
     BLOCKED_REASON_UNSPECIFIED = "BLOCKED_REASON_UNSPECIFIED",
@@ -487,6 +497,13 @@ export declare interface CodeExecutionResult {
 export declare interface ComputeTokensConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
 }
 
 /** Parameters for computing tokens. */
@@ -595,6 +612,13 @@ export declare enum ControlReferenceType {
 export declare interface CountTokensConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
     /** Instructions for the model to steer it toward better performance.
      */
     systemInstruction?: ContentUnion;
@@ -631,6 +655,13 @@ export declare class CountTokensResponse {
 export declare interface CreateCachedContentConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
     /** The TTL for this resource. The expiration time is computed: now + TTL. It is a duration string, with up to nine fractional digits, terminated by 's'. Example: "3.5s". */
     ttl?: string;
     /** Timestamp of when this resource is considered expired. Uses RFC 3339 format, Example: 2014-10-02T15:01:23Z. */
@@ -692,6 +723,13 @@ export declare interface CreateChatParameters {
 export declare interface CreateFileConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
 }
 
 /** Generates the parameters for the private _create method. */
@@ -762,6 +800,13 @@ export declare function createUserContent(partOrString: PartListUnion | string):
 export declare interface DeleteCachedContentConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
 }
 
 /** Parameters for caches.delete method. */
@@ -782,6 +827,13 @@ export declare class DeleteCachedContentResponse {
 export declare interface DeleteFileConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
 }
 
 /** Generates the parameters for the get method. */
@@ -800,6 +852,13 @@ export declare class DeleteFileResponse {
 export declare interface DownloadFileConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
 }
 
 /** Describes the options to customize dynamic retrieval. */
@@ -819,6 +878,13 @@ export declare enum DynamicRetrievalConfigMode {
 export declare interface EmbedContentConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
     /** Type of task for which the embedding will be used.
      */
     taskType?: string;
@@ -908,6 +974,13 @@ export declare enum FeatureSelectionPreference {
 export declare interface FetchPredictOperationConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
 }
 
 /** Parameters for the fetchPredictOperation method. */
@@ -1111,6 +1184,7 @@ export declare enum FinishReason {
     MAX_TOKENS = "MAX_TOKENS",
     SAFETY = "SAFETY",
     RECITATION = "RECITATION",
+    LANGUAGE = "LANGUAGE",
     OTHER = "OTHER",
     BLOCKLIST = "BLOCKLIST",
     PROHIBITED_CONTENT = "PROHIBITED_CONTENT",
@@ -1182,6 +1256,13 @@ export declare class FunctionResponse {
 export declare interface GenerateContentConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
     /** Instructions for the model to steer it toward better performance.
      For example, "Answer as concisely as possible" or "Don't use technical
      terms in your response".
@@ -1339,6 +1420,17 @@ export declare class GenerateContentResponse {
      * ```
      */
     get text(): string | undefined;
+    /**
+     * Returns the concatenation of all inline data parts from the first candidate
+     * in the response.
+     *
+     * @remarks
+     * If there are multiple candidates in the response, the inline data from the
+     * first one will be returned. If there are non-inline data parts in the
+     * response, the concatenation of all inline data parts will be returned, and
+     * a warning will be logged.
+     */
+    get data(): string | undefined;
     /**
      * Returns the function calls from the first candidate in the response.
      *
@@ -1499,6 +1591,13 @@ export declare interface GeneratedVideo {
 export declare interface GenerateImagesConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
     /** Cloud Storage URI used to store the generated images.
      */
     outputGcsUri?: string;
@@ -1580,6 +1679,13 @@ export declare class GenerateImagesResponse {
 export declare interface GenerateVideosConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
     /** Number of output videos. */
     numberOfVideos?: number;
     /** The gcs bucket where to save the generated videos. */
@@ -1702,6 +1808,13 @@ export declare interface GenerationConfigRoutingConfigManualRoutingMode {
 export declare interface GetCachedContentConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
 }
 
 /** Parameters for caches.get method. */
@@ -1718,6 +1831,13 @@ export declare interface GetCachedContentParameters {
 export declare interface GetFileConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
 }
 
 /** Generates the parameters for the get method. */
@@ -1732,6 +1852,13 @@ export declare interface GetFileParameters {
 export declare interface GetModelConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
 }
 
 export declare interface GetModelParameters {
@@ -1743,6 +1870,13 @@ export declare interface GetModelParameters {
 export declare interface GetOperationConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
 }
 
 /** Parameters for the GET method. */
@@ -2033,6 +2167,10 @@ declare interface HttpRequest {
      * Optional set of customizable configuration for HTTP requests.
      */
     httpOptions?: HttpOptions;
+    /**
+     * Optional abort signal which can be used to cancel the request.
+     */
+    abortSignal?: AbortSignal;
 }
 
 /** A wrapper class for the http response. */
@@ -2081,6 +2219,13 @@ export declare enum Language {
 export declare interface ListCachedContentsConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
     pageSize?: number;
     pageToken?: string;
 }
@@ -2103,6 +2248,13 @@ export declare class ListCachedContentsResponse {
 export declare interface ListFilesConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
     pageSize?: number;
     pageToken?: string;
 }
@@ -2247,6 +2399,22 @@ export declare interface LiveClientMessage {
 export declare interface LiveClientRealtimeInput {
     /** Inlined bytes data for media input. */
     mediaChunks?: Blob_2[];
+    /** The realtime audio input stream. */
+    audio?: Blob_2;
+    /**
+     Indicates that the audio stream has ended, e.g. because the microphone was
+     turned off.
+
+     This should only be sent when automatic activity detection is enabled
+     (which is the default).
+
+     The client can reopen the stream by sending an audio message.
+     */
+    audioStreamEnd?: boolean;
+    /** The realtime video input stream. */
+    video?: Blob_2;
+    /** The realtime text input stream. */
+    text?: string;
     /** Marks the start of user activity. */
     activityStart?: ActivityStart;
     /** Marks the end of user activity. */
@@ -2402,7 +2570,23 @@ export declare interface LiveSendClientContentParameters {
 /** Parameters for sending realtime input to the live API. */
 export declare interface LiveSendRealtimeInputParameters {
     /** Realtime input to send to the session. */
-    media: Blob_2;
+    media?: BlobImageUnion;
+    /** The realtime audio input stream. */
+    audio?: Blob_2;
+    /**
+     Indicates that the audio stream has ended, e.g. because the microphone was
+     turned off.
+
+     This should only be sent when automatic activity detection is enabled
+     (which is the default).
+
+     The client can reopen the stream by sending an audio message.
+     */
+    audioStreamEnd?: boolean;
+    /** The realtime video input stream. */
+    video?: BlobImageUnion;
+    /** The realtime text input stream. */
+    text?: string;
     /** Marks the start of user activity. */
     activityStart?: ActivityStart;
     /** Marks the end of user activity. */
@@ -3351,7 +3535,6 @@ export declare class Session {
     private readonly apiClient;
     constructor(conn: WebSocket_2, apiClient: ApiClient);
     private tLiveClientContent;
-    private tLiveClientRealtimeInput;
     private tLiveClienttToolResponse;
     /**
      Send a message over the established connection.
@@ -3481,6 +3664,28 @@ export declare interface SessionResumptionConfig {
     transparent?: boolean;
 }
 
+/**
+ * Overrides the base URLs for the Gemini API and Vertex AI API.
+ *
+ * @remarks This function should be called before initializing the SDK. If the
+ * base URLs are set after initializing the SDK, the base URLs will not be
+ * updated. Base URLs provided in the HttpOptions will also take precedence over
+ * URLs set here.
+ *
+ * @example
+ * ```ts
+ * import {GoogleGenAI, setDefaultBaseUrls} from '@google/genai';
+ * // Override the base URL for the Gemini API.
+ * setDefaultBaseUrls({geminiUrl:'https://gemini.google.com'});
+ *
+ * // Override the base URL for the Vertex AI API.
+ * setDefaultBaseUrls({vertexUrl: 'https://vertexai.googleapis.com'});
+ *
+ * const ai = new GoogleGenAI({apiKey: 'GEMINI_API_KEY'});
+ * ```
+ */
+export declare function setDefaultBaseUrls(baseUrlParams: BaseUrlParameters): void;
+
 /** Context window will be truncated by keeping only suffix of it.
 
  Context window will always be cut at start of USER role turn. System
@@ -3909,6 +4114,7 @@ declare namespace types {
         LiveSendRealtimeInputParameters,
         LiveSendToolResponseParameters,
         OperationGetParameters,
+        BlobImageUnion,
         PartUnion,
         PartListUnion,
         ContentUnion,
@@ -3923,6 +4129,13 @@ declare namespace types {
 export declare interface UpdateCachedContentConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
     /** The TTL for this resource. The expiration time is computed: now + TTL. It is a duration string, with up to nine fractional digits, terminated by 's'. Example: "3.5s". */
     ttl?: string;
     /** Timestamp of when this resource is considered expired. Uses RFC 3339 format, Example: 2014-10-02T15:01:23Z. */
@@ -3965,6 +4178,13 @@ declare interface Uploader {
 export declare interface UploadFileConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
     /** The name of the file in the destination (e.g., 'files/sample-image'. If not provided one will be generated. */
     name?: string;
     /** mime_type: The MIME type of the file. If not provided, it will be inferred from the file extension. */
@@ -3990,6 +4210,13 @@ export declare interface UploadFileParameters {
 export declare interface UpscaleImageConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
     /** Whether to include a reason for filtered-out images in the
      response. */
     includeRaiReason?: boolean;