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.create_scenario_set(
    body={
        "file_upload_scenario_set": {...},
        "name": "support-agent-scenarios",
        "scenarios": [...],
    },
)

Description

To create a scenario set, send a POST request to /v2/gen-ai/scenario_sets. Provide exactly one of scenarios or file_upload_scenario_set. The set is created in the ready state.

Parameters

file_upload_scenario_set object optional

Uploaded scenario file to ingest. Provide this or scenarios, not both.

Show child properties

original_file_name string optional

Example: example name

The original file name

size_in_bytes string optional

Example: 12345

The size of the file in bytes

stored_object_key string optional

Example: example string

The object key the file was stored as

name string optional

Example: support-agent-scenarios

The name of the scenario set.

scenarios array of objects optional

Inline scenarios. Provide this or file_upload_scenario_set, not both.

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 = {
  "file_upload_scenario_set": {
    "original_file_name": "example name",
    "size_in_bytes": "12345",
    "stored_object_key": "example string"
  },
  "name": "support-agent-scenarios",
  "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.create_scenario_set(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 in the API reference for additional detail on responses, headers, parameters, and more.