@google/genai 0.4.0 → 0.6.0

package/dist/node/node.d.ts

@@ -261,10 +261,12 @@ export declare interface Candidate {
     /** Number of tokens for this candidate.
      */
     tokenCount?: number;
+    /** The reason why the model stopped generating tokens.
+     If empty, the model has not stopped generating the tokens.
+     */
+    finishReason?: FinishReason;
     /** Output only. Average log probability score of the candidate. */
     avgLogprobs?: number;
-    /** Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. */
-    finishReason?: FinishReason;
     /** Output only. Metadata specifies sources used to ground generated content. */
     groundingMetadata?: GroundingMetadata;
     /** Output only. Index of the candidate. */
@@ -375,7 +377,7 @@ export declare class Chats {
      * @remarks
      * The config in the params will be used for all requests within the chat
      * session unless overridden by a per-request `config` in
-     * {@link ./types.SendMessageParameters}.
+     * @see {@link types.SendMessageParameters#config}.
      *
      * @param params - Parameters for creating a chat session.
      * @returns A new chat session.
@@ -496,12 +498,6 @@ export declare interface ContentEmbeddingStatistics {
 
 export declare type ContentListUnion = ContentUnion[] | ContentUnion;
 
-/** @internal */
-export declare function contentToMldev(apiClient: ApiClient, fromObject: types.Content): Record<string, unknown>;
-
-/** @internal */
-export declare function contentToVertex(apiClient: ApiClient, fromObject: types.Content): Record<string, unknown>;
-
 export declare type ContentUnion = Content | PartUnion[] | PartUnion;
 
 /** Configuration for a Control reference image. */
@@ -989,7 +985,8 @@ export declare enum FinishReason {
     BLOCKLIST = "BLOCKLIST",
     PROHIBITED_CONTENT = "PROHIBITED_CONTENT",
     SPII = "SPII",
-    MALFORMED_FUNCTION_CALL = "MALFORMED_FUNCTION_CALL"
+    MALFORMED_FUNCTION_CALL = "MALFORMED_FUNCTION_CALL",
+    IMAGE_SAFETY = "IMAGE_SAFETY"
 }
 
 declare function formatMap(templateString: string, valueMap: Record<string, unknown>): string;
@@ -1317,13 +1314,25 @@ export declare class GenerateContentResponsePromptFeedback {
 
 /** Usage metadata about response(s). */
 export declare class GenerateContentResponseUsageMetadata {
+    /** Output only. List of modalities of the cached content in the request input. */
+    cacheTokensDetails?: ModalityTokenCount[];
     /** Output only. Number of tokens in the cached part in the input (the cached content). */
     cachedContentTokenCount?: number;
     /** Number of tokens in the response(s). */
     candidatesTokenCount?: number;
+    /** Output only. List of modalities that were returned in the response. */
+    candidatesTokensDetails?: ModalityTokenCount[];
     /** Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. */
     promptTokenCount?: number;
-    /** Total token count for prompt and response candidates. */
+    /** Output only. List of modalities that were processed in the request input. */
+    promptTokensDetails?: ModalityTokenCount[];
+    /** Output only. Number of tokens present in thoughts output. */
+    thoughtsTokenCount?: number;
+    /** Output only. Number of tokens present in tool-use prompt(s). */
+    toolUsePromptTokenCount?: number;
+    /** Output only. List of modalities that were processed for tool-use request inputs. */
+    toolUsePromptTokensDetails?: ModalityTokenCount[];
+    /** Total token count for prompt, response candidates, and tool-use prompts (if present). */
     totalTokenCount?: number;
 }
 
@@ -1512,13 +1521,22 @@ declare function getValueByPath(data: unknown, keys: string[]): unknown;
  * The Google GenAI SDK.
  *
  * @remarks
- * Provides access to the GenAI features through either the {@link https://cloud.google.com/vertex-ai/docs/reference/rest | Gemini API}
- * or the {@link https://cloud.google.com/vertex-ai/docs/reference/rest | Vertex AI API}.
+ * Provides access to the GenAI features through either the {@link
+ * https://cloud.google.com/vertex-ai/docs/reference/rest | Gemini API} or
+ * the {@link https://cloud.google.com/vertex-ai/docs/reference/rest | Vertex AI
+ * API}.
+ *
+ * The {@link GoogleGenAIOptions.vertexai} value determines which of the API
+ * services to use.
  *
- * The {@link GoogleGenAIOptions.vertexai} value determines which of the API services to use.
+ * When using the Gemini API, a {@link GoogleGenAIOptions.apiKey} must also be
+ * set. When using Vertex AI, both {@link GoogleGenAIOptions.project} and {@link
+ * GoogleGenAIOptions.location} must be set, or a {@link
+ * GoogleGenAIOptions.apiKey} must be set when using Express Mode.
  *
- * When using the Gemini API, a {@link GoogleGenAIOptions.apiKey} must also be set,
- * when using Vertex AI {@link GoogleGenAIOptions.project} and {@link GoogleGenAIOptions.location} must also be set.
+ * Explicitly passed in values in {@link GoogleGenAIOptions} will always take
+ * precedence over environment variables. If both project/location and api_key
+ * exist in the environment variables, the project/location will be used.
  *
  * @example
  * Initializing the SDK for using the Gemini API:
@@ -1886,6 +1904,11 @@ export declare class Live {
 
      @experimental
 
+     @remarks
+     If using the Gemini API, Live is currently only supported behind API
+     version `v1alpha`. Ensure that the API version is set to `v1alpha` when
+     initializing the SDK if relying on the Gemini API.
+
      @param params - The parameters for establishing a connection to the model.
      @return A live session.
 
@@ -2058,6 +2081,28 @@ export declare interface LiveConnectParameters {
     config?: LiveConnectConfig;
 }
 
+/** Parameters for sending client content to the live API. */
+export declare interface LiveSendClientContentParameters {
+    /** Client content to send to the session. */
+    turns?: ContentListUnion;
+    /** If true, indicates that the server content generation should start with
+     the currently accumulated prompt. Otherwise, the server will await
+     additional messages before starting generation. */
+    turnComplete?: boolean;
+}
+
+/** Parameters for sending realtime input to the live API. */
+export declare interface LiveSendRealtimeInputParameters {
+    /** Realtime input to send to the session. */
+    media: Blob_2;
+}
+
+/** Parameters for sending tool responses to the live API. */
+export declare class LiveSendToolResponseParameters {
+    /** Tool responses to send to the session. */
+    functionResponses: FunctionResponse[] | FunctionResponse;
+}
+
 /** Incremental server update generated by the model in response to client messages.
 
  Content is generated as quickly as possible, and not in real time. Clients
@@ -2185,6 +2230,14 @@ export declare enum Modality {
     AUDIO = "AUDIO"
 }
 
+/** Represents token counting info for a single modality. */
+export declare interface ModalityTokenCount {
+    /** The modality associated with this token count. */
+    modality?: Modality;
+    /** Number of tokens. */
+    tokenCount?: number;
+}
+
 export declare enum Mode {
     MODE_UNSPECIFIED = "MODE_UNSPECIFIED",
     MODE_DYNAMIC = "MODE_DYNAMIC"
@@ -2374,7 +2427,7 @@ export declare enum Outcome {
  * SPDX-License-Identifier: Apache-2.0
  */
 /**
- * @fileoverview Pagers for the GenAI List APIs.
+ * Pagers for the GenAI List APIs.
  */
 declare enum PagedItem {
     PAGED_ITEM_BATCH_JOBS = "batchJobs",
@@ -2755,12 +2808,13 @@ export declare class Session {
      `turnComplete`.
 
      - `turns` will be converted to a `Content[]`
-     - `turnComplete: true` indicates that you are done sending content and
-     expect a response.
+     - `turnComplete: true` [default] indicates that you are done sending
+     content and expect a response. If `turnComplete: false`, the server
+     will wait for additional messages before starting generation.
 
      @experimental
 
-     @remanks
+     @remarks
      There are two ways to send messages to the live API:
      `sendClientContent` and `sendRealtimeInput`.
 
@@ -2796,7 +2850,7 @@ export declare class Session {
      ```
      @experimental
      */
-    sendClientContent(params: types.SessionSendClientContentParameters): void;
+    sendClientContent(params: types.LiveSendClientContentParameters): void;
     /**
      Send a realtime message over the established connection.
 
@@ -2806,7 +2860,7 @@ export declare class Session {
 
      @experimental
 
-     @remanks
+     @remarks
      Use `sendRealtimeInput` for realtime audio chunks and video frames (images).
 
      With `sendRealtimeInput` the api will respond to audio automatically
@@ -2819,7 +2873,7 @@ export declare class Session {
      Note: The Call signature expects a `Blob` object, but only a subset
      of audio and image mimetypes are allowed.
      */
-    sendRealtimeInput(params: types.SessionSendRealtimeInputParameters): void;
+    sendRealtimeInput(params: types.LiveSendRealtimeInputParameters): void;
     /**
      Send a function response message over the established connection.
 
@@ -2827,14 +2881,14 @@ export declare class Session {
 
      - `functionResponses` will be converted to a `functionResponses[]`
 
-     @remanks
+     @remarks
      Use `sendFunctionResponse` to reply to `LiveServerToolCall` from the server.
 
-     Use {@link LiveConnectConfig#tools} to configure the callable functions.
+     Use {@link types.LiveConnectConfig#tools} to configure the callable functions.
 
      @experimental
      */
-    sendToolResponse(params: types.SessionSendToolResponseParameters): void;
+    sendToolResponse(params: types.LiveSendToolResponseParameters): void;
     /**
      Terminates the WebSocket connection.
 
@@ -2855,28 +2909,6 @@ export declare class Session {
     close(): void;
 }
 
-/** Parameters for sending client content to the live API. */
-export declare interface SessionSendClientContentParameters {
-    /** Client content to send to the session. */
-    turns?: ContentListUnion;
-    /** If true, indicates that the server content generation should start with
-     the currently accumulated prompt. Otherwise, the server will await
-     additional messages before starting generation. */
-    turnComplete?: boolean;
-}
-
-/** Parameters for sending realtime input to the live API. */
-export declare interface SessionSendRealtimeInputParameters {
-    /** Realtime input to send to the session. */
-    media: Blob_2;
-}
-
-/** Parameters for sending tool responses to the live API. */
-export declare class SessionSendToolResponseParameters {
-    /** Tool responses to send to the session. */
-    functionResponses: FunctionResponse | FunctionResponse[];
-}
-
 declare function setValueByPath(data: Record<string, unknown>, keys: string[], value: unknown): void;
 
 /** The speech generation configuration. */
@@ -3024,12 +3056,6 @@ export declare interface ToolConfig {
 
 export declare type ToolListUnion = Tool[];
 
-/** @internal */
-export declare function toolToMldev(apiClient: ApiClient, fromObject: types.Tool): Record<string, unknown>;
-
-/** @internal */
-export declare function toolToVertex(apiClient: ApiClient, fromObject: types.Tool): Record<string, unknown>;
-
 export declare enum Type {
     TYPE_UNSPECIFIED = "TYPE_UNSPECIFIED",
     STRING = "STRING",
@@ -3062,6 +3088,7 @@ declare namespace types {
         HarmProbability,
         HarmSeverity,
         BlockedReason,
+        Modality,
         State,
         DynamicRetrievalConfigMode,
         FunctionCallingConfigMode,
@@ -3074,7 +3101,6 @@ declare namespace types {
         MaskReferenceMode,
         ControlReferenceType,
         SubjectReferenceType,
-        Modality,
         VideoMetadata,
         CodeExecutionResult,
         ExecutableCode,
@@ -3125,6 +3151,7 @@ declare namespace types {
         SafetyRating,
         Candidate,
         GenerateContentResponsePromptFeedback,
+        ModalityTokenCount,
         GenerateContentResponseUsageMetadata,
         GenerateContentResponse,
         EmbedContentConfig,
@@ -3206,9 +3233,9 @@ declare namespace types {
         LiveConnectParameters,
         CreateChatParameters,
         SendMessageParameters,
-        SessionSendClientContentParameters,
-        SessionSendRealtimeInputParameters,
-        SessionSendToolResponseParameters,
+        LiveSendClientContentParameters,
+        LiveSendRealtimeInputParameters,
+        LiveSendToolResponseParameters,
         PartUnion,
         PartListUnion,
         ContentUnion,