Add support for Code Execution

firebase-ai/CHANGELOG.md

@@ -1,5 +1,6 @@
 # Unreleased
 
+- [feature] Added support for code execution.
 - [feature] Introduced `MissingPermissionsException`, which is thrown when the necessary permissions
   have not been granted by the user.
 - [feature] Added helper functions to `LiveSession` to allow developers to track the status of the

firebase-ai/api.txt

@@ -220,6 +220,7 @@ package com.google.firebase.ai.type {
 
   public final class CodeExecutionResultPart implements com.google.firebase.ai.type.Part {
     ctor public CodeExecutionResultPart(String outcome, String output);
+    method public boolean executionSucceeded();
     method public String getOutcome();
     method public String getOutput();
     method public boolean isThought();
@@ -1199,12 +1200,14 @@ package com.google.firebase.ai.type {
   }
 
   public final class Tool {
+    method public static com.google.firebase.ai.type.Tool codeExecution();
     method public static com.google.firebase.ai.type.Tool functionDeclarations(java.util.List<com.google.firebase.ai.type.FunctionDeclaration> functionDeclarations);
     method public static com.google.firebase.ai.type.Tool googleSearch(com.google.firebase.ai.type.GoogleSearch googleSearch = com.google.firebase.ai.type.GoogleSearch());
     field public static final com.google.firebase.ai.type.Tool.Companion Companion;
   }
 
   public static final class Tool.Companion {
+    method public com.google.firebase.ai.type.Tool codeExecution();
     method public com.google.firebase.ai.type.Tool functionDeclarations(java.util.List<com.google.firebase.ai.type.FunctionDeclaration> functionDeclarations);
     method public com.google.firebase.ai.type.Tool googleSearch(com.google.firebase.ai.type.GoogleSearch googleSearch = com.google.firebase.ai.type.GoogleSearch());
   }

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Part.kt

@@ -54,6 +54,12 @@ internal constructor(
   ) : InternalPart
 }
 
+/**
+ * Represents the code execution result from the model.
+ * @property outcome The result of the execution.
+ * @property output The stdout from the code execution, or an error message if it failed.
+ * @property isThought Indicates whether the response is a thought.
+ */
 public class CodeExecutionResultPart
 internal constructor(
   public val outcome: String,
@@ -64,21 +70,26 @@ internal constructor(
 
   public constructor(outcome: String, output: String) : this(outcome, output, false, null)
 
+  /** Indicates if the code execution was successful */
+  public fun executionSucceeded(): Boolean = (outcome.lowercase() == "outcome_ok")
+
   @Serializable
   internal data class Internal(
     @SerialName("codeExecutionResult") val codeExecutionResult: CodeExecutionResult,
     val thought: Boolean? = null,
     val thoughtSignature: String? = null
   ) : InternalPart {
 
-    @Serializable
-    internal data class CodeExecutionResult(
-      @SerialName("outcome") val outcome: String,
-      val output: String
-    )
+    @Serializable internal data class CodeExecutionResult(val outcome: String, val output: String)
   }
 }
 
+/**
+ * Represents the code that was executed by the model.
+ * @property language The programming language of the code.
+ * @property code The source code to be executed.
+ * @property isThought Indicates whether the response is a thought.
+ */
 public class ExecutableCodePart
 internal constructor(
   public val language: String,

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Tool.kt

@@ -26,12 +26,14 @@ import kotlinx.serialization.json.JsonObject
 public class Tool
 internal constructor(
   internal val functionDeclarations: List<FunctionDeclaration>?,
-  internal val googleSearch: GoogleSearch?
+  internal val googleSearch: GoogleSearch?,
+  internal val codeExecution: JsonObject?,
 ) {
   internal fun toInternal() =
     Internal(
       functionDeclarations?.map { it.toInternal() } ?: emptyList(),
-      googleSearch = this.googleSearch?.toInternal()
+      googleSearch = this.googleSearch?.toInternal(),
+      codeExecution = this.codeExecution
     )
   @Serializable
   internal data class Internal(
@@ -42,14 +44,22 @@ internal constructor(
   )
   public companion object {
 
+    private val codeExecutionInstance = Tool(null, null, JsonObject(emptyMap()))
+
     /**
      * Creates a [Tool] instance that provides the model with access to the [functionDeclarations].
      *
      * @param functionDeclarations The list of functions that this tool allows the model access to.
      */
     @JvmStatic
     public fun functionDeclarations(functionDeclarations: List<FunctionDeclaration>): Tool {
-      return Tool(functionDeclarations, null)
+      return Tool(functionDeclarations, null, null)
+    }
+
+    /** Creates a [Tool] instance that allows the model to use Code Execution. */
+    @JvmStatic
+    public fun codeExecution(): Tool {
+      return codeExecutionInstance
     }
 
     /**
@@ -70,7 +80,7 @@ internal constructor(
      */
     @JvmStatic
     public fun googleSearch(googleSearch: GoogleSearch = GoogleSearch()): Tool {
-      return Tool(null, googleSearch)
+      return Tool(null, googleSearch, null)
     }
   }
 }

firebase-ai/src/test/java/com/google/firebase/ai/type/ToolTest.kt

@@ -27,6 +27,7 @@ internal class ToolTest {
 
     tool.googleSearch.shouldNotBeNull()
     tool.functionDeclarations.shouldBeNull()
+    tool.codeExecution.shouldBeNull()
   }
 
   @Test
@@ -36,5 +37,14 @@ internal class ToolTest {
 
     tool.functionDeclarations?.first() shouldBe functionDeclaration
     tool.googleSearch.shouldBeNull()
+    tool.codeExecution.shouldBeNull()
+  }
+
+  @Test
+  fun `codeExecution() creates a tool with code execution`() {
+    val tool = Tool.codeExecution()
+    tool.codeExecution.shouldNotBeNull()
+    tool.functionDeclarations.shouldBeNull()
+    tool.googleSearch.shouldBeNull()
   }
 }