@firebase/ai 2.2.1-canary.120a30838 → 2.2.1-canary.43276b041

package/dist/ai-public.d.ts

@@ -393,6 +393,53 @@ export declare interface CitationMetadata {
     citations: Citation[];
 }
 
+/**
+ * The results of code execution run by the model.
+ *
+ * @public
+ */
+export declare interface CodeExecutionResult {
+    /**
+     * The result of the code execution.
+     */
+    outcome?: Outcome;
+    /**
+     * The output from the code execution, or an error message
+     * if it failed.
+     */
+    output?: string;
+}
+
+/**
+ * Represents the code execution result from the model.
+ *
+ * @public
+ */
+export declare interface CodeExecutionResultPart {
+    text?: never;
+    inlineData?: never;
+    functionCall?: never;
+    functionResponse?: never;
+    fileData: never;
+    thought?: never;
+    /* Excluded from this release type: thoughtSignature */
+    executableCode?: never;
+    codeExecutionResult?: CodeExecutionResult;
+}
+
+/**
+ * A tool that enables the model to use code execution.
+ *
+ * @public
+ */
+export declare interface CodeExecutionTool {
+    /**
+     * Specifies the Google Search configuration.
+     * Currently, this is an empty object, but it's reserved for future configuration options.
+     */
+    codeExecution: {};
+}
+
 /**
  * Content type for both prompts and response candidates.
  * @public
@@ -530,6 +577,39 @@ export declare interface ErrorDetails {
     [key: string]: unknown;
 }
 
+/**
+ * An interface for executable code returned by the model.
+ *
+ * @public
+ */
+export declare interface ExecutableCode {
+    /**
+     * The programming language of the code.
+     */
+    language?: Language;
+    /**
+     * The source code to be executed.
+     */
+    code?: string;
+}
+
+/**
+ * Represents the code that is executed by the model.
+ *
+ * @public
+ */
+export declare interface ExecutableCodePart {
+    text?: never;
+    inlineData?: never;
+    functionCall?: never;
+    functionResponse?: never;
+    fileData: never;
+    thought?: never;
+    /* Excluded from this release type: thoughtSignature */
+    executableCode?: ExecutableCode;
+    codeExecutionResult?: never;
+}
+
 /**
  * Data pointing to a file uploaded on Google Cloud Storage.
  * @public
@@ -551,6 +631,8 @@ export declare interface FileDataPart {
     fileData: FileData;
     thought?: boolean;
     /* Excluded from this release type: thoughtSignature */
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -669,6 +751,8 @@ export declare interface FunctionCallPart {
     functionResponse?: never;
     thought?: boolean;
     /* Excluded from this release type: thoughtSignature */
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -753,6 +837,8 @@ export declare interface FunctionResponsePart {
     functionResponse: FunctionResponse;
     thought?: boolean;
     /* Excluded from this release type: thoughtSignature */
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -1024,8 +1110,6 @@ export declare interface GoogleSearchTool {
     /**
      * Specifies the Google Search configuration.
      * Currently, this is an empty object, but it's reserved for future configuration options.
-     * Specifies the Google Search configuration. Currently, this is an empty object, but it's
-     * reserved for future configuration options.
      *
      * When using this feature, you are required to comply with the "Grounding with Google Search"
      * usage requirements for your chosen API provider: {@link https://ai.google.dev/gemini-api/terms#grounding-with-google-search | Gemini Developer API}
@@ -1766,6 +1850,8 @@ export declare interface InlineDataPart {
     videoMetadata?: VideoMetadata;
     thought?: boolean;
     /* Excluded from this release type: thoughtSignature */
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -1776,6 +1862,23 @@ export declare class IntegerSchema extends Schema {
     constructor(schemaParams?: SchemaParams);
 }
 
+/**
+ * The programming language of the code.
+ *
+ * @public
+ */
+export declare const Language: {
+    UNSPECIFIED: string;
+    PYTHON: string;
+};
+
+/**
+ * The programming language of the code.
+ *
+ * @public
+ */
+export declare type Language = (typeof Language)[keyof typeof Language];
+
 /**
  * <b>(EXPERIMENTAL)</b>
  * Configures the creation of an on-device language model session.
@@ -2196,12 +2299,31 @@ export declare interface OnDeviceParams {
     promptOptions?: LanguageModelPromptOptions;
 }
 
+/**
+ * Represents the result of the code execution.
+ *
+ * @public
+ */
+export declare const Outcome: {
+    UNSPECIFIED: string;
+    OK: string;
+    FAILED: string;
+    DEADLINE_EXCEEDED: string;
+};
+
+/**
+ * Represents the result of the code execution.
+ *
+ * @public
+ */
+export declare type Outcome = (typeof Outcome)[keyof typeof Outcome];
+
 /**
  * Content part - includes text, image/video, or function call/response
  * part types.
  * @public
  */
-export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;
+export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart | ExecutableCodePart | CodeExecutionResultPart;
 
 /**
  * Possible roles.
@@ -2703,6 +2825,8 @@ export declare interface TextPart {
     functionResponse?: never;
     thought?: boolean;
     /* Excluded from this release type: thoughtSignature */
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -2743,7 +2867,7 @@ export declare interface ThinkingConfig {
  * Defines a tool that model can call to access external knowledge.
  * @public
  */
-export declare type Tool = FunctionDeclarationsTool | GoogleSearchTool;
+export declare type Tool = FunctionDeclarationsTool | GoogleSearchTool | CodeExecutionTool;
 
 /**
  * Tool config. This config is shared for all tools provided in the request.

package/dist/ai.d.ts

@@ -436,6 +436,56 @@ export declare interface CitationMetadata {
     citations: Citation[];
 }
 
+/**
+ * The results of code execution run by the model.
+ *
+ * @public
+ */
+export declare interface CodeExecutionResult {
+    /**
+     * The result of the code execution.
+     */
+    outcome?: Outcome;
+    /**
+     * The output from the code execution, or an error message
+     * if it failed.
+     */
+    output?: string;
+}
+
+/**
+ * Represents the code execution result from the model.
+ *
+ * @public
+ */
+export declare interface CodeExecutionResultPart {
+    text?: never;
+    inlineData?: never;
+    functionCall?: never;
+    functionResponse?: never;
+    fileData: never;
+    thought?: never;
+    /**
+     * @internal
+     */
+    thoughtSignature?: never;
+    executableCode?: never;
+    codeExecutionResult?: CodeExecutionResult;
+}
+
+/**
+ * A tool that enables the model to use code execution.
+ *
+ * @public
+ */
+export declare interface CodeExecutionTool {
+    /**
+     * Specifies the Google Search configuration.
+     * Currently, this is an empty object, but it's reserved for future configuration options.
+     */
+    codeExecution: {};
+}
+
 /**
  * Content type for both prompts and response candidates.
  * @public
@@ -573,6 +623,42 @@ export declare interface ErrorDetails {
     [key: string]: unknown;
 }
 
+/**
+ * An interface for executable code returned by the model.
+ *
+ * @public
+ */
+export declare interface ExecutableCode {
+    /**
+     * The programming language of the code.
+     */
+    language?: Language;
+    /**
+     * The source code to be executed.
+     */
+    code?: string;
+}
+
+/**
+ * Represents the code that is executed by the model.
+ *
+ * @public
+ */
+export declare interface ExecutableCodePart {
+    text?: never;
+    inlineData?: never;
+    functionCall?: never;
+    functionResponse?: never;
+    fileData: never;
+    thought?: never;
+    /**
+     * @internal
+     */
+    thoughtSignature?: never;
+    executableCode?: ExecutableCode;
+    codeExecutionResult?: never;
+}
+
 /**
  * Data pointing to a file uploaded on Google Cloud Storage.
  * @public
@@ -597,6 +683,8 @@ export declare interface FileDataPart {
      * @internal
      */
     thoughtSignature?: never;
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -718,6 +806,8 @@ export declare interface FunctionCallPart {
      * @internal
      */
     thoughtSignature?: never;
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -805,6 +895,8 @@ export declare interface FunctionResponsePart {
      * @internal
      */
     thoughtSignature?: never;
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -1110,8 +1202,6 @@ export declare interface GoogleSearchTool {
     /**
      * Specifies the Google Search configuration.
      * Currently, this is an empty object, but it's reserved for future configuration options.
-     * Specifies the Google Search configuration. Currently, this is an empty object, but it's
-     * reserved for future configuration options.
      *
      * When using this feature, you are required to comply with the "Grounding with Google Search"
      * usage requirements for your chosen API provider: {@link https://ai.google.dev/gemini-api/terms#grounding-with-google-search | Gemini Developer API}
@@ -1874,6 +1964,8 @@ export declare interface InlineDataPart {
      * @internal
      */
     thoughtSignature?: never;
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -1884,6 +1976,23 @@ export declare class IntegerSchema extends Schema {
     constructor(schemaParams?: SchemaParams);
 }
 
+/**
+ * The programming language of the code.
+ *
+ * @public
+ */
+export declare const Language: {
+    UNSPECIFIED: string;
+    PYTHON: string;
+};
+
+/**
+ * The programming language of the code.
+ *
+ * @public
+ */
+export declare type Language = (typeof Language)[keyof typeof Language];
+
 /**
  * <b>(EXPERIMENTAL)</b>
  * Configures the creation of an on-device language model session.
@@ -2320,12 +2429,31 @@ export declare interface OnDeviceParams {
     promptOptions?: LanguageModelPromptOptions;
 }
 
+/**
+ * Represents the result of the code execution.
+ *
+ * @public
+ */
+export declare const Outcome: {
+    UNSPECIFIED: string;
+    OK: string;
+    FAILED: string;
+    DEADLINE_EXCEEDED: string;
+};
+
+/**
+ * Represents the result of the code execution.
+ *
+ * @public
+ */
+export declare type Outcome = (typeof Outcome)[keyof typeof Outcome];
+
 /**
  * Content part - includes text, image/video, or function call/response
  * part types.
  * @public
  */
-export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;
+export declare type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart | ExecutableCodePart | CodeExecutionResultPart;
 
 /**
  * Possible roles.
@@ -2838,6 +2966,8 @@ export declare interface TextPart {
      * @internal
      */
     thoughtSignature?: string;
+    executableCode?: never;
+    codeExecutionResult?: never;
 }
 
 /**
@@ -2878,7 +3008,7 @@ export declare interface ThinkingConfig {
  * Defines a tool that model can call to access external knowledge.
  * @public
  */
-export declare type Tool = FunctionDeclarationsTool | GoogleSearchTool;
+export declare type Tool = FunctionDeclarationsTool | GoogleSearchTool | CodeExecutionTool;
 
 /**
  * Tool config. This config is shared for all tools provided in the request.

package/dist/esm/index.esm.js

@@ -4,7 +4,7 @@ import { FirebaseError, Deferred, getModularInstance } from '@firebase/util';
 import { Logger } from '@firebase/logger';
 
 var name = "@firebase/ai";
-var version = "2.2.1-canary.120a30838";
+var version = "2.2.1-canary.43276b041";
 
 /**
  * @license
@@ -380,6 +380,26 @@ const InferenceMode = {
     'ONLY_IN_CLOUD': 'only_in_cloud',
     'PREFER_IN_CLOUD': 'prefer_in_cloud'
 };
+/**
+ * Represents the result of the code execution.
+ *
+ * @public
+ */
+const Outcome = {
+    UNSPECIFIED: 'OUTCOME_UNSPECIFIED',
+    OK: 'OUTCOME_OK',
+    FAILED: 'OUTCOME_FAILED',
+    DEADLINE_EXCEEDED: 'OUTCOME_DEADLINE_EXCEEDED'
+};
+/**
+ * The programming language of the code.
+ *
+ * @public
+ */
+const Language = {
+    UNSPECIFIED: 'LANGUAGE_UNSPECIFIED',
+    PYTHON: 'PYTHON'
+};
 
 /**
  * @license
@@ -2386,7 +2406,9 @@ function validateChatHistory(history) {
             functionCall: 0,
             functionResponse: 0,
             thought: 0,
-            thoughtSignature: 0
+            thoughtSignature: 0,
+            executableCode: 0,
+            codeExecutionResult: 0
         };
         for (const part of parts) {
             for (const key of VALID_PART_FIELDS) {
@@ -4014,5 +4036,5 @@ function registerAI() {
 }
 registerAI();
 
-export { AIError, AIErrorCode, AIModel, AnyOfSchema, ArraySchema, Backend, BackendType, BlockReason, BooleanSchema, ChatSession, FinishReason, FunctionCallingMode, GenerativeModel, GoogleAIBackend, HarmBlockMethod, HarmBlockThreshold, HarmCategory, HarmProbability, HarmSeverity, ImagenAspectRatio, ImagenImageFormat, ImagenModel, ImagenPersonFilterLevel, ImagenSafetyFilterLevel, InferenceMode, IntegerSchema, LiveGenerativeModel, LiveResponseType, LiveSession, Modality, NumberSchema, ObjectSchema, POSSIBLE_ROLES, ResponseModality, Schema, SchemaType, StringSchema, VertexAIBackend, getAI, getGenerativeModel, getImagenModel, getLiveGenerativeModel, startAudioConversation };
+export { AIError, AIErrorCode, AIModel, AnyOfSchema, ArraySchema, Backend, BackendType, BlockReason, BooleanSchema, ChatSession, FinishReason, FunctionCallingMode, GenerativeModel, GoogleAIBackend, HarmBlockMethod, HarmBlockThreshold, HarmCategory, HarmProbability, HarmSeverity, ImagenAspectRatio, ImagenImageFormat, ImagenModel, ImagenPersonFilterLevel, ImagenSafetyFilterLevel, InferenceMode, IntegerSchema, Language, LiveGenerativeModel, LiveResponseType, LiveSession, Modality, NumberSchema, ObjectSchema, Outcome, POSSIBLE_ROLES, ResponseModality, Schema, SchemaType, StringSchema, VertexAIBackend, getAI, getGenerativeModel, getImagenModel, getLiveGenerativeModel, startAudioConversation };
 //# sourceMappingURL=index.esm.js.map