feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 92
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runloop-ai%2Frunloop-75c0dc94dd629772c98b3e6f763d8b3a1bdb732aa3eb92d49a59fb446fb2410d.yml
-openapi_spec_hash: 12286e648ea1156bfa23020ed0c7598b
-config_hash: aeb178e14a85ac4cd585f0667484c7c3
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runloop-ai%2Frunloop-e5ce0fefdcb08eeb8d337329c89374e8a11a26dd986c75cffd93ad2756fb6ed7.yml
+openapi_spec_hash: e2807c1c3955b268937eb33f345dbfe5
+config_hash: 60681f589a9e641fdb7f19af2021a033

src/runloop_api_client/resources/benchmarks/benchmarks.py

@@ -70,6 +70,7 @@ def create(
         *,
         name: str,
         metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
+        required_environment_variables: Optional[List[str]] | NotGiven = NOT_GIVEN,
         scenario_ids: Optional[List[str]] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -87,6 +88,9 @@ def create(
 
           metadata: User defined metadata to attach to the benchmark for organization.
 
+          required_environment_variables: Environment variables required to run the benchmark. If these variables are not
+              supplied, the benchmark will fail to start
+
           scenario_ids: The Scenario IDs that make up the Benchmark.
 
           extra_headers: Send extra headers
@@ -105,6 +109,7 @@ def create(
                 {
                     "name": name,
                     "metadata": metadata,
+                    "required_environment_variables": required_environment_variables,
                     "scenario_ids": scenario_ids,
                 },
                 benchmark_create_params.BenchmarkCreateParams,
@@ -158,6 +163,7 @@ def update(
         *,
         name: str,
         metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
+        required_environment_variables: Optional[List[str]] | NotGiven = NOT_GIVEN,
         scenario_ids: Optional[List[str]] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -175,6 +181,9 @@ def update(
 
           metadata: User defined metadata to attach to the benchmark for organization.
 
+          required_environment_variables: Environment variables required to run the benchmark. If these variables are not
+              supplied, the benchmark will fail to start
+
           scenario_ids: The Scenario IDs that make up the Benchmark.
 
           extra_headers: Send extra headers
@@ -195,6 +204,7 @@ def update(
                 {
                     "name": name,
                     "metadata": metadata,
+                    "required_environment_variables": required_environment_variables,
                     "scenario_ids": scenario_ids,
                 },
                 benchmark_update_params.BenchmarkUpdateParams,
@@ -358,6 +368,7 @@ def start_run(
         benchmark_id: str,
         metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
         run_name: Optional[str] | NotGiven = NOT_GIVEN,
+        run_profile: Optional[benchmark_start_run_params.RunProfile] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -376,6 +387,8 @@ def start_run(
 
           run_name: Display name of the run.
 
+          run_profile: Runtime configuration to use for this benchmark run
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -393,6 +406,7 @@ def start_run(
                     "benchmark_id": benchmark_id,
                     "metadata": metadata,
                     "run_name": run_name,
+                    "run_profile": run_profile,
                 },
                 benchmark_start_run_params.BenchmarkStartRunParams,
             ),
@@ -436,6 +450,7 @@ async def create(
         *,
         name: str,
         metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
+        required_environment_variables: Optional[List[str]] | NotGiven = NOT_GIVEN,
         scenario_ids: Optional[List[str]] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -453,6 +468,9 @@ async def create(
 
           metadata: User defined metadata to attach to the benchmark for organization.
 
+          required_environment_variables: Environment variables required to run the benchmark. If these variables are not
+              supplied, the benchmark will fail to start
+
           scenario_ids: The Scenario IDs that make up the Benchmark.
 
           extra_headers: Send extra headers
@@ -471,6 +489,7 @@ async def create(
                 {
                     "name": name,
                     "metadata": metadata,
+                    "required_environment_variables": required_environment_variables,
                     "scenario_ids": scenario_ids,
                 },
                 benchmark_create_params.BenchmarkCreateParams,
@@ -524,6 +543,7 @@ async def update(
         *,
         name: str,
         metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
+        required_environment_variables: Optional[List[str]] | NotGiven = NOT_GIVEN,
         scenario_ids: Optional[List[str]] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -541,6 +561,9 @@ async def update(
 
           metadata: User defined metadata to attach to the benchmark for organization.
 
+          required_environment_variables: Environment variables required to run the benchmark. If these variables are not
+              supplied, the benchmark will fail to start
+
           scenario_ids: The Scenario IDs that make up the Benchmark.
 
           extra_headers: Send extra headers
@@ -561,6 +584,7 @@ async def update(
                 {
                     "name": name,
                     "metadata": metadata,
+                    "required_environment_variables": required_environment_variables,
                     "scenario_ids": scenario_ids,
                 },
                 benchmark_update_params.BenchmarkUpdateParams,
@@ -724,6 +748,7 @@ async def start_run(
         benchmark_id: str,
         metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
         run_name: Optional[str] | NotGiven = NOT_GIVEN,
+        run_profile: Optional[benchmark_start_run_params.RunProfile] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -742,6 +767,8 @@ async def start_run(
 
           run_name: Display name of the run.
 
+          run_profile: Runtime configuration to use for this benchmark run
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -759,6 +786,7 @@ async def start_run(
                     "benchmark_id": benchmark_id,
                     "metadata": metadata,
                     "run_name": run_name,
+                    "run_profile": run_profile,
                 },
                 benchmark_start_run_params.BenchmarkStartRunParams,
             ),

src/runloop_api_client/resources/blueprints.py

@@ -82,7 +82,7 @@ def create(
 
           dockerfile: Dockerfile contents to be used to build the Blueprint.
 
-          file_mounts: (Optional) Map of paths and file contents to write before setup..
+          file_mounts: (Optional) Map of paths and file contents to write before setup.
 
           launch_parameters: Parameters to configure your Devbox at launch time.
 
@@ -420,7 +420,7 @@ def preview(
 
           dockerfile: Dockerfile contents to be used to build the Blueprint.
 
-          file_mounts: (Optional) Map of paths and file contents to write before setup..
+          file_mounts: (Optional) Map of paths and file contents to write before setup.
 
           launch_parameters: Parameters to configure your Devbox at launch time.
 
@@ -511,7 +511,7 @@ async def create(
 
           dockerfile: Dockerfile contents to be used to build the Blueprint.
 
-          file_mounts: (Optional) Map of paths and file contents to write before setup..
+          file_mounts: (Optional) Map of paths and file contents to write before setup.
 
           launch_parameters: Parameters to configure your Devbox at launch time.
 
@@ -849,7 +849,7 @@ async def preview(
 
           dockerfile: Dockerfile contents to be used to build the Blueprint.
 
-          file_mounts: (Optional) Map of paths and file contents to write before setup..
+          file_mounts: (Optional) Map of paths and file contents to write before setup.
 
           launch_parameters: Parameters to configure your Devbox at launch time.
 

src/runloop_api_client/resources/scenarios/scenarios.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Dict, Optional
+from typing import Dict, List, Optional
 
 import httpx
 
@@ -90,6 +90,7 @@ def create(
         environment_parameters: Optional[ScenarioEnvironmentParam] | NotGiven = NOT_GIVEN,
         metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
         reference_output: Optional[str] | NotGiven = NOT_GIVEN,
+        required_environment_variables: Optional[List[str]] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -117,6 +118,9 @@ def create(
               can be the result of a git diff or a sequence of command actions to apply to the
               environment.
 
+          required_environment_variables: Environment variables required to run the scenario. If these variables are not
+              provided, the scenario will fail to start.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -137,6 +141,7 @@ def create(
                     "environment_parameters": environment_parameters,
                     "metadata": metadata,
                     "reference_output": reference_output,
+                    "required_environment_variables": required_environment_variables,
                 },
                 scenario_create_params.ScenarioCreateParams,
             ),
@@ -192,6 +197,7 @@ def update(
         metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
         name: Optional[str] | NotGiven = NOT_GIVEN,
         reference_output: Optional[str] | NotGiven = NOT_GIVEN,
+        required_env_vars: Optional[List[str]] | NotGiven = NOT_GIVEN,
         scoring_contract: Optional[ScoringContractUpdateParam] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -219,6 +225,8 @@ def update(
               can be the result of a git diff or a sequence of command actions to apply to the
               environment.
 
+          required_env_vars: Environment variables required to run the benchmark.
+
           scoring_contract: The scoring contract for the Scenario.
 
           extra_headers: Send extra headers
@@ -242,6 +250,7 @@ def update(
                     "metadata": metadata,
                     "name": name,
                     "reference_output": reference_output,
+                    "required_env_vars": required_env_vars,
                     "scoring_contract": scoring_contract,
                 },
                 scenario_update_params.ScenarioUpdateParams,
@@ -369,6 +378,7 @@ def start_run(
         benchmark_run_id: Optional[str] | NotGiven = NOT_GIVEN,
         metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
         run_name: Optional[str] | NotGiven = NOT_GIVEN,
+        run_profile: Optional[scenario_start_run_params.RunProfile] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -389,6 +399,8 @@ def start_run(
 
           run_name: Display name of the run.
 
+          run_profile: Runtime configuration to use for this benchmark run
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -407,6 +419,7 @@ def start_run(
                     "benchmark_run_id": benchmark_run_id,
                     "metadata": metadata,
                     "run_name": run_name,
+                    "run_profile": run_profile,
                 },
                 scenario_start_run_params.ScenarioStartRunParams,
             ),
@@ -513,6 +526,7 @@ async def create(
         environment_parameters: Optional[ScenarioEnvironmentParam] | NotGiven = NOT_GIVEN,
         metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
         reference_output: Optional[str] | NotGiven = NOT_GIVEN,
+        required_environment_variables: Optional[List[str]] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -540,6 +554,9 @@ async def create(
               can be the result of a git diff or a sequence of command actions to apply to the
               environment.
 
+          required_environment_variables: Environment variables required to run the scenario. If these variables are not
+              provided, the scenario will fail to start.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -560,6 +577,7 @@ async def create(
                     "environment_parameters": environment_parameters,
                     "metadata": metadata,
                     "reference_output": reference_output,
+                    "required_environment_variables": required_environment_variables,
                 },
                 scenario_create_params.ScenarioCreateParams,
             ),
@@ -615,6 +633,7 @@ async def update(
         metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
         name: Optional[str] | NotGiven = NOT_GIVEN,
         reference_output: Optional[str] | NotGiven = NOT_GIVEN,
+        required_env_vars: Optional[List[str]] | NotGiven = NOT_GIVEN,
         scoring_contract: Optional[ScoringContractUpdateParam] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -642,6 +661,8 @@ async def update(
               can be the result of a git diff or a sequence of command actions to apply to the
               environment.
 
+          required_env_vars: Environment variables required to run the benchmark.
+
           scoring_contract: The scoring contract for the Scenario.
 
           extra_headers: Send extra headers
@@ -665,6 +686,7 @@ async def update(
                     "metadata": metadata,
                     "name": name,
                     "reference_output": reference_output,
+                    "required_env_vars": required_env_vars,
                     "scoring_contract": scoring_contract,
                 },
                 scenario_update_params.ScenarioUpdateParams,
@@ -792,6 +814,7 @@ async def start_run(
         benchmark_run_id: Optional[str] | NotGiven = NOT_GIVEN,
         metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
         run_name: Optional[str] | NotGiven = NOT_GIVEN,
+        run_profile: Optional[scenario_start_run_params.RunProfile] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -812,6 +835,8 @@ async def start_run(
 
           run_name: Display name of the run.
 
+          run_profile: Runtime configuration to use for this benchmark run
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -830,6 +855,7 @@ async def start_run(
                     "benchmark_run_id": benchmark_run_id,
                     "metadata": metadata,
                     "run_name": run_name,
+                    "run_profile": run_profile,
                 },
                 scenario_start_run_params.ScenarioStartRunParams,
             ),

src/runloop_api_client/types/benchmark_create_params.py

@@ -15,5 +15,11 @@ class BenchmarkCreateParams(TypedDict, total=False):
     metadata: Optional[Dict[str, str]]
     """User defined metadata to attach to the benchmark for organization."""
 
+    required_environment_variables: Optional[List[str]]
+    """Environment variables required to run the benchmark.
+
+    If these variables are not supplied, the benchmark will fail to start
+    """
+
     scenario_ids: Optional[List[str]]
     """The Scenario IDs that make up the Benchmark."""

src/runloop_api_client/types/benchmark_run_view.py

@@ -27,9 +27,15 @@ class BenchmarkRunView(BaseModel):
     duration_ms: Optional[int] = None
     """The duration for the BenchmarkRun to complete."""
 
+    environment_variables: Optional[Dict[str, str]] = None
+    """Environment variables used to run the benchmark."""
+
     name: Optional[str] = None
     """The name of the BenchmarkRun."""
 
+    purpose: Optional[str] = None
+    """Purpose of the run."""
+
     score: Optional[float] = None
     """The final score across the BenchmarkRun, present once completed.