Updated TS signature

Author: andrescrz

apps/opik-documentation/documentation/fern/docs/evaluation/update_existing_experiment.mdx

@@ -79,31 +79,27 @@ import { Opik } from "opik";
 const opik = new Opik();
 
 // Update experiment name
-await opik.updateExperiment(
-  "experiment-id",
-  "Updated Experiment Name"
-);
+await opik.updateExperiment("experiment-id", {
+  name: "Updated Experiment Name"
+});
 
 // Update experiment configuration
-await opik.updateExperiment(
-  "experiment-id",
-  undefined,
-  {
+await opik.updateExperiment("experiment-id", {
+  experimentConfig: {
     model: "gpt-4",
     temperature: 0.7,
     promptTemplate: "Answer the following question: {question}"
   }
-);
+});
 
 // Update both name and configuration
-await opik.updateExperiment(
-  "experiment-id",
-  "Updated Experiment Name",
-  {
+await opik.updateExperiment("experiment-id", {
+  name: "Updated Experiment Name",
+  experimentConfig: {
     model: "gpt-4",
     temperature: 0.7
   }
-);
+});
 ```
 
 ## Update Experiment Scores

apps/opik-documentation/documentation/fern/docs/reference/typescript-sdk/evaluation/experiments.mdx

@@ -34,31 +34,27 @@ const datasetExperiments = await opik.getDatasetExperiments("my-dataset", 100);
 
 ```typescript
 // Update experiment name
-await opik.updateExperiment(
-  "experiment-id",
-  "Updated Experiment Name"
-);
+await opik.updateExperiment("experiment-id", {
+  name: "Updated Experiment Name"
+});
 
 // Update experiment configuration
-await opik.updateExperiment(
-  "experiment-id",
-  undefined,
-  {
+await opik.updateExperiment("experiment-id", {
+  experimentConfig: {
     model: "gpt-4",
     temperature: 0.7,
     promptTemplate: "Answer the following question: {question}"
   }
-);
+});
 
 // Update both name and configuration
-await opik.updateExperiment(
-  "experiment-id",
-  "Updated Experiment Name",
-  {
+await opik.updateExperiment("experiment-id", {
+  name: "Updated Experiment Name",
+  experimentConfig: {
     model: "gpt-4",
     temperature: 0.7
   }
-);
+});
 ```
 
 ### Deleting an Experiment

sdks/python/tests/unit/api_objects/test_opik_client.py

@@ -28,7 +28,7 @@ def test_opik_client__update_experiment__both_name_and_config__both_sent_to_api(
     opik_client_ = opik_client.Opik()
 
     with patch.object(
-            opik_client_._rest_client.experiments, "update_experiment"
+        opik_client_._rest_client.experiments, "update_experiment"
     ) as mock_update:
         new_config = {"model": "gpt-4", "temperature": 0.7}
         opik_client_.update_experiment(
@@ -45,7 +45,7 @@ def test_opik_client__update_experiment__name_only__only_name_sent_to_api():
     opik_client_ = opik_client.Opik()
 
     with patch.object(
-            opik_client_._rest_client.experiments, "update_experiment"
+        opik_client_._rest_client.experiments, "update_experiment"
     ) as mock_update:
         opik_client_.update_experiment(id="some-experiment-id", name="new-name")
 
@@ -59,7 +59,7 @@ def test_opik_client__update_experiment__config_only__only_metadata_sent_to_api(
     opik_client_ = opik_client.Opik()
 
     with patch.object(
-            opik_client_._rest_client.experiments, "update_experiment"
+        opik_client_._rest_client.experiments, "update_experiment"
     ) as mock_update:
         new_config = {"model": "gpt-4", "temperature": 0.7}
         opik_client_.update_experiment(
@@ -80,7 +80,7 @@ def test_opik_client__update_experiment__config_only__only_metadata_sent_to_api(
     ],
 )
 def test_opik_client__update_experiment__missing_mandatory_parameters__error_raised(
-        experiment_id,
+    experiment_id,
 ):
     opik_client_ = opik_client.Opik()
 

sdks/typescript/src/opik/client/Client.ts

@@ -346,20 +346,25 @@ export class OpikClient {
      * Updates an experiment by ID
      *
      * @param id The ID of the experiment
-     * @param name Optional new name for the experiment
-     * @param experimentConfig Optional new configuration for the experiment
+     * @param experimentUpdate Object containing the fields to update
+     * @param experimentUpdate.name Optional new name for the experiment
+     * @param experimentUpdate.experimentConfig Optional new configuration for the experiment
      * @returns Promise that resolves when the experiment is updated
      * @throws {Error} If id is not provided or if neither name nor experimentConfig is provided
      */
     public updateExperiment = async (
         id: string,
-        name?: string,
-        experimentConfig?: Record<string, unknown>
+        experimentUpdate: {
+            name?: string;
+            experimentConfig?: Record<string, unknown>;
+        }
     ): Promise<void> => {
         if (!id) {
             throw new Error("id is required to update an experiment");
         }
 
+        const { name, experimentConfig } = experimentUpdate;
+
         if (!name && !experimentConfig) {
             throw new Error("At least one of 'name' or 'experimentConfig' must be provided to update an experiment");
         }

sdks/typescript/tests/experiment/client-experiment.test.ts

@@ -535,7 +535,10 @@ describe("Opik experiment operations", () => {
     }) => {
       const experimentId = "experiment-to-update-id";
 
-      await client.updateExperiment(experimentId, "updated-name", { k: "v" });
+      await client.updateExperiment(experimentId, {
+        name: "updated-name",
+        experimentConfig: { k: "v" },
+      });
 
       expect(spies.updateExperiment).toHaveBeenCalledWith(experimentId, {
         name: "updated-name",
@@ -550,7 +553,7 @@ describe("Opik experiment operations", () => {
     }) => {
       const experimentId = "experiment-to-update-name-only";
 
-      await client.updateExperiment(experimentId, "new-name-only");
+      await client.updateExperiment(experimentId, { name: "new-name-only" });
 
       const callArgs = spies.updateExperiment.mock.calls[0];
       expect(callArgs[0]).toBe(experimentId);
@@ -566,7 +569,9 @@ describe("Opik experiment operations", () => {
       const experimentId = "experiment-to-update-config-only";
       const newConfig = { model: "gpt-4", temperature: 0.7 };
 
-      await client.updateExperiment(experimentId, undefined, newConfig);
+      await client.updateExperiment(experimentId, {
+        experimentConfig: newConfig,
+      });
 
       const callArgs = spies.updateExperiment.mock.calls[0];
       expect(callArgs[0]).toBe(experimentId);
@@ -579,7 +584,7 @@ describe("Opik experiment operations", () => {
       expect,
     }) => {
       await expect(
-        client.updateExperiment("", "new-name")
+        client.updateExperiment("", { name: "new-name" })
       ).rejects.toThrow("id is required to update an experiment");
     });
 
@@ -590,7 +595,7 @@ describe("Opik experiment operations", () => {
       const experimentId = "experiment-to-update-no-params";
 
       await expect(
-        client.updateExperiment(experimentId)
+        client.updateExperiment(experimentId, {})
       ).rejects.toThrow("At least one of 'name' or 'experimentConfig' must be provided to update an experiment");
     });
 
@@ -606,7 +611,10 @@ describe("Opik experiment operations", () => {
       });
 
       await expect(
-        client.updateExperiment(experimentId, "bad-name", {})
+        client.updateExperiment(experimentId, {
+          name: "bad-name",
+          experimentConfig: {},
+        })
       ).rejects.toThrow("Failed to update experiment");
 
       expect(spies.updateExperiment).toHaveBeenCalledWith(experimentId, {