For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.genai.update_scenario_set(
    scenario_set_uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
    body={
        "name": "example name",
        "scenario_set_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "scenarios": [...],
    },
)

Description

To update a scenario set in place, send a PUT request to /v2/gen-ai/scenario_sets/{scenario_set_uuid}. Provide a new name and/or replacement scenarios. At least one is required. Replacing contents keeps the same scenario set UUID, remints scenario UUIDs, and is rejected unless the set is ready and no simulation run references it. There is no file-upload path on update.

Parameters

scenario_set_uuid string required

UUID of the scenario set to update. Returned by CreateScenarioSet
and listed via ListScenarioSets.

name string optional

Example: example name

Optional new name. When set, must be non-empty and at most 255 characters.

scenario_set_uuid string optional

Example: 123e4567-e89b-12d3-a456-426614174000

UUID of the scenario set to update.

scenarios array of objects optional

Optional inline scenarios to replace the set contents. At least one of
name or scenarios is required.

Show child properties

description string optional

Example: example string

What the user tries to accomplish. Required.

exploration_budget integer optional

Example: 123

Number of journeys to explore for this scenario. Defaults to 1 if unset.

max_turns integer optional

Example: 123

Turn budget for the scenario. Falls back to the run-level default if unset.

name string optional

Example: example name

Human-readable name for the scenario. Optional.

scenario_uuid string optional

Example: 123e4567-e89b-12d3-a456-426614174000

Unique id for the scenario. Always generated by the API; any
customer-supplied value is ignored and overwritten.

stopping_criteria array of strings optional

Example: ['example string']

Judge stopping criteria. Required; must contain at least one entry.

user_persona string optional

Example: example string

How the user communicates (tone, role). Optional.

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

req = {
  "name": "example name",
  "scenario_set_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "scenarios": [
    {
      "description": "example string",
      "exploration_budget": 123,
      "max_turns": 123,
      "name": "example name",
      "scenario_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "stopping_criteria": [
        "example string"
      ],
      "user_persona": "example string"
    }
  ]
}

resp = client.genai.update_scenario_set(scenario_set_uuid="\"123e4567-e89b-12d3-a456-426614174000\"", body=req)

Response Example

{
  "scenario_set": {
    "bucket_name": "example name",
    "bucket_region": "example string",
    "created_at": "2023-01-01T00:00:00Z",
    "deleted_at": "2023-01-01T00:00:00Z",
    "description": "example string",
    "failure_reason": "example string",
    "generator_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "library_scenario_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "name": "example name",
    "scenario_count": 123,
    "scenario_set_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "source_export_id": "123e4567-e89b-12d3-a456-426614174000",
    "source_goal_description": "example string",
    "source_kind": "SCENARIO_SET_SOURCE_KIND_UNSPECIFIED",
    "spaces_key": "example string",
    "status": "SCENARIO_SET_STATUS_UNSPECIFIED",
    "updated_at": "2023-01-01T00:00:00Z",
    "workflow_uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}

More Information

See /v2/gen-ai/scenario_sets/{scenario_set_uuid} in the API reference for additional detail on responses, headers, parameters, and more.