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

@google/genai 0.8.0 → 0.9.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
@@ -253,3 +219,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.

package/dist/genai.d.ts CHANGED Viewed

@@ -46,11 +46,11 @@ declare class ApiClient {
     private shouldPrependVertexProjectPath;
     request(request: HttpRequest): Promise<HttpResponse>;
     private patchHttpOptions;
-    requestStream(request: HttpRequest): Promise<any>;
+    requestStream(request: HttpRequest): Promise<AsyncGenerator<HttpResponse>>;
     private includeExtraHttpOptionsToRequestInit;
     private unaryApiCall;
     private streamApiCall;
-    processStreamResponse(response: Response): AsyncGenerator<any>;
+    processStreamResponse(response: Response): AsyncGenerator<HttpResponse>;
     private apiCall;
     getDefaultHeaders(): Record<string, string>;
     private getHeadersInternal;
@@ -237,8 +237,8 @@ export declare class Caches extends BaseModule {
      *
      * @remarks
      * Context caching is only supported for specific models. See [Gemini
-     * Developer API reference] (https://ai.google.dev/gemini-api/docs/caching?lang=node/context-cac)
-     * and [Vertex AI reference] (https://cloud.google.com/vertex-ai/generative-ai/docs/context-cache/context-cache-overview#supported_models)
+     * Developer API reference](https://ai.google.dev/gemini-api/docs/caching?lang=node/context-cac)
+     * and [Vertex AI reference](https://cloud.google.com/vertex-ai/generative-ai/docs/context-cache/context-cache-overview#supported_models)
      * for more information.
      *
      * @param params - The parameters for the create request.
@@ -540,7 +540,7 @@ export declare interface ContentEmbeddingStatistics {
     tokenCount?: number;
 }
-export declare type ContentListUnion = ContentUnion[] | ContentUnion;
+export declare type ContentListUnion = Content | Content[] | PartUnion | PartUnion[];
 export declare type ContentUnion = Content | PartUnion[] | PartUnion;
@@ -897,6 +897,14 @@ export declare interface ExecutableCode {
     language?: Language;
 }
+/** Options for feature selection preference. */
+export declare enum FeatureSelectionPreference {
+    FEATURE_SELECTION_PREFERENCE_UNSPECIFIED = "FEATURE_SELECTION_PREFERENCE_UNSPECIFIED",
+    PRIORITIZE_QUALITY = "PRIORITIZE_QUALITY",
+    BALANCED = "BALANCED",
+    PRIORITIZE_COST = "PRIORITIZE_COST"
+}
 export declare interface FetchPredictOperationConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
@@ -1239,6 +1247,9 @@ export declare interface GenerateContentConfig {
     /** Configuration for model router requests.
      */
     routingConfig?: GenerationConfigRoutingConfig;
+    /** Configuration for model selection.
+     */
+    modelSelectionConfig?: ModelSelectionConfig;
     /** Safety settings in the request to block unsafe content in the
      response.
      */
@@ -2128,17 +2139,20 @@ 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.
      @example
      ```ts
+     let model: string;
+     if (GOOGLE_GENAI_USE_VERTEXAI) {
+     model = 'gemini-2.0-flash-live-preview-04-09';
+     } else {
+     model = 'gemini-2.0-flash-live-001';
+     }
      const session = await ai.live.connect({
-     model: 'gemini-2.0-flash-exp',
+     model: model,
      config: {
      responseModalities: [Modality.AUDIO],
      },
@@ -2253,7 +2267,7 @@ export declare interface LiveClientSetup {
     /** The user provided system instructions for the model.
      Note: only text should be used in parts and content in each part will be
      in a separate paragraph. */
-    systemInstruction?: Content;
+    systemInstruction?: ContentUnion;
     /**  A list of `Tools` the model may use to generate the next response.
      A `Tool` is a piece of code that enables the system to interact with
@@ -2270,6 +2284,13 @@ export declare interface LiveClientSetup {
      If included, server will compress context window to fit into given length. */
     contextWindowCompression?: ContextWindowCompressionConfig;
+    /** The transcription of the input aligns with the input audio language.
+     */
+    inputAudioTranscription?: AudioTranscriptionConfig;
+    /** The transcription of the output aligns with the language code
+     specified for the output audio.
+     */
+    outputAudioTranscription?: AudioTranscriptionConfig;
 }
 /** Client generated response to a `ToolCall` received from the server.
@@ -2295,13 +2316,42 @@ export declare interface LiveConnectConfig {
      modalities that the model can return. Defaults to AUDIO if not specified.
      */
     responseModalities?: Modality[];
+    /** Value that controls the degree of randomness in token selection.
+     Lower temperatures are good for prompts that require a less open-ended or
+     creative response, while higher temperatures can lead to more diverse or
+     creative results.
+     */
+    temperature?: number;
+    /** Tokens are selected from the most to least probable until the sum
+     of their probabilities equals this value. Use a lower value for less
+     random responses and a higher value for more random responses.
+     */
+    topP?: number;
+    /** For each token selection step, the ``top_k`` tokens with the
+     highest probabilities are sampled. Then tokens are further filtered based
+     on ``top_p`` with the final token selected using temperature sampling. Use
+     a lower number for less random responses and a higher number for more
+     random responses.
+     */
+    topK?: number;
+    /** Maximum number of tokens that can be generated in the response.
+     */
+    maxOutputTokens?: number;
+    /** If specified, the media resolution specified will be used.
+     */
+    mediaResolution?: MediaResolution;
+    /** When ``seed`` is fixed to a specific number, the model makes a best
+     effort to provide the same response for repeated requests. By default, a
+     random number is used.
+     */
+    seed?: number;
     /** The speech generation configuration.
      */
     speechConfig?: SpeechConfig;
     /** The user provided system instructions for the model.
      Note: only text should be used in parts and content in each part will be
      in a separate paragraph. */
-    systemInstruction?: Content;
+    systemInstruction?: ContentUnion;
     /** A list of `Tools` the model may use to generate the next response.
      A `Tool` is a piece of code that enables the system to interact with
@@ -2312,6 +2362,13 @@ export declare interface LiveConnectConfig {
      If included the server will send SessionResumptionUpdate messages. */
     sessionResumption?: SessionResumptionConfig;
+    /** The transcription of the input aligns with the input audio language.
+     */
+    inputAudioTranscription?: AudioTranscriptionConfig;
+    /** The transcription of the output aligns with the language code
+     specified for the output audio.
+     */
+    outputAudioTranscription?: AudioTranscriptionConfig;
     /** Configures the realtime input behavior in BidiGenerateContent. */
     realtimeInputConfig?: RealtimeInputConfig;
     /** Configures context window compression mechanism.
@@ -2379,6 +2436,15 @@ export declare interface LiveServerContent {
      has finished generating all content. This is a signal to the client
      that it can stop sending messages. */
     generationComplete?: boolean;
+    /** Input transcription. The transcription is independent to the model
+     turn which means it doesn’t imply any ordering between transcription and
+     model turn. */
+    inputTranscription?: Transcription;
+    /** Output transcription. The transcription is independent to the model
+     turn which means it doesn’t imply any ordering between transcription and
+     model turn.
+     */
+    outputTranscription?: Transcription;
 }
 /** Server will not be able to service client soon. */
@@ -2799,6 +2865,12 @@ export declare class Models extends BaseModule {
     generateVideos(params: types.GenerateVideosParameters): Promise<types.GenerateVideosOperation>;
 }
+/** Config for model selection. */
+export declare interface ModelSelectionConfig {
+    /** Options for feature selection preference. */
+    featureSelectionPreference?: FeatureSelectionPreference;
+}
 /** Parameters for the get method of the operations module. */
 export declare interface OperationGetParameters {
     /** The operation to be retrieved. */
@@ -3006,6 +3078,54 @@ export declare interface PrebuiltVoiceConfig {
     voiceName?: string;
 }
+/** Specifies the context retrieval config. */
+export declare interface RagRetrievalConfig {
+    /** Optional. Config for filters. */
+    filter?: RagRetrievalConfigFilter;
+    /** Optional. Config for Hybrid Search. */
+    hybridSearch?: RagRetrievalConfigHybridSearch;
+    /** Optional. Config for ranking and reranking. */
+    ranking?: RagRetrievalConfigRanking;
+    /** Optional. The number of contexts to retrieve. */
+    topK?: number;
+}
+/** Config for filters. */
+export declare interface RagRetrievalConfigFilter {
+    /** Optional. String for metadata filtering. */
+    metadataFilter?: string;
+    /** Optional. Only returns contexts with vector distance smaller than the threshold. */
+    vectorDistanceThreshold?: number;
+    /** Optional. Only returns contexts with vector similarity larger than the threshold. */
+    vectorSimilarityThreshold?: number;
+}
+/** Config for Hybrid Search. */
+export declare interface RagRetrievalConfigHybridSearch {
+    /** Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. */
+    alpha?: number;
+}
+/** Config for ranking and reranking. */
+export declare interface RagRetrievalConfigRanking {
+    /** Optional. Config for LlmRanker. */
+    llmRanker?: RagRetrievalConfigRankingLlmRanker;
+    /** Optional. Config for Rank Service. */
+    rankService?: RagRetrievalConfigRankingRankService;
+}
+/** Config for LlmRanker. */
+export declare interface RagRetrievalConfigRankingLlmRanker {
+    /** Optional. The model name used for ranking. Format: `gemini-1.5-pro` */
+    modelName?: string;
+}
+/** Config for Rank Service. */
+export declare interface RagRetrievalConfigRankingRankService {
+    /** Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` */
+    modelName?: string;
+}
 /** A raw reference image.
  A raw reference image represents the base image to edit, provided by the user.
@@ -3328,8 +3448,14 @@ export declare class Session {
      @example
      ```ts
+     let model: string;
+     if (GOOGLE_GENAI_USE_VERTEXAI) {
+     model = 'gemini-2.0-flash-live-preview-04-09';
+     } else {
+     model = 'gemini-2.0-flash-live-001';
+     }
      const session = await ai.live.connect({
-     model: 'gemini-2.0-flash-exp',
+     model: model,
      config: {
      responseModalities: [Modality.AUDIO],
      }
@@ -3372,6 +3498,10 @@ export declare interface SpeechConfig {
     /** The configuration for the speaker to use.
      */
     voiceConfig?: VoiceConfig;
+    /** Language code (ISO 639. e.g. en-US) for the speech synthesization.
+     Only available for Live API.
+     */
+    languageCode?: string;
 }
 export declare type SpeechConfigUnion = SpeechConfig | string;
@@ -3526,6 +3656,16 @@ export declare enum TrafficType {
     PROVISIONED_THROUGHPUT = "PROVISIONED_THROUGHPUT"
 }
+/** Audio transcription in Server Conent. */
+export declare interface Transcription {
+    /** Transcription text.
+     */
+    text?: string;
+    /** The bool indicates the end of the transcription.
+     */
+    finished?: boolean;
+}
 /** A tuned machine learning model. */
 export declare interface TunedModelInfo {
     /** ID of the base model that you want to tune. */
@@ -3579,6 +3719,7 @@ declare namespace types {
         TrafficType,
         Modality,
         MediaResolution,
+        FeatureSelectionPreference,
         DynamicRetrievalConfigMode,
         FunctionCallingConfigMode,
         SafetyFilterLevel,
@@ -3605,6 +3746,7 @@ declare namespace types {
         Content,
         HttpOptions,
         Schema,
+        ModelSelectionConfig,
         SafetySetting,
         FunctionDeclaration,
         GoogleSearch,
@@ -3612,6 +3754,12 @@ declare namespace types {
         GoogleSearchRetrieval,
         VertexAISearch,
         VertexRagStoreRagResource,
+        RagRetrievalConfigFilter,
+        RagRetrievalConfigHybridSearch,
+        RagRetrievalConfigRankingLlmRanker,
+        RagRetrievalConfigRankingRankService,
+        RagRetrievalConfigRanking,
+        RagRetrievalConfig,
         VertexRagStore,
         Retrieval,
         ToolCodeExecution,
@@ -3732,6 +3880,7 @@ declare namespace types {
         SubjectReferenceConfig,
         SubjectReferenceImage,
         LiveServerSetupComplete,
+        Transcription,
         LiveServerContent,
         LiveServerToolCall,
         LiveServerToolCallCancellation,
@@ -3744,6 +3893,7 @@ declare namespace types {
         SessionResumptionConfig,
         SlidingWindow,
         ContextWindowCompressionConfig,
+        AudioTranscriptionConfig,
         LiveClientSetup,
         LiveClientContent,
         ActivityStart,
@@ -3751,7 +3901,6 @@ declare namespace types {
         LiveClientRealtimeInput,
         LiveClientToolResponse,
         LiveClientMessage,
-        AudioTranscriptionConfig,
         LiveConnectConfig,
         LiveConnectParameters,
         CreateChatParameters,
@@ -3904,6 +4053,8 @@ export declare interface VertexRagStore {
     ragCorpora?: string[];
     /** Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. */
     ragResources?: VertexRagStoreRagResource[];
+    /** Optional. The retrieval config for the Rag query. */
+    ragRetrievalConfig?: RagRetrievalConfig;
     /** Optional. Number of top k results to return from the selected corpora. */
     similarityTopK?: number;
     /** Optional. Only return results with vector distance smaller than the threshold. */