# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Textql.rpc.platform.Sandbox Service API
  version: 1.0.0
extends: openapi/textql-textql-rpc-platform-sandboxservice-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v1/sandbox/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a Python sandbox
      effect: write
      questions:
      - How do I spin up a Python environment to analyze data?
      - Can I give a new sandbox a name?
      instructions:
      - text: Start a Python sandbox named {name}.
        slots:
          name: requestBody.name
      - text: Launch a new sandbox called {name} for analysis.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/sandbox/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run Python code in a sandbox
      effect: write
      questions:
      - How do I execute Python code inside a running sandbox?
      - Can I run pandas code against data already loaded in a sandbox?
      instructions:
      - text: Run {code} in sandbox {sandbox}.
        slots:
          code: requestBody.code
          sandbox: requestBody.sandboxId
      - text: 'Execute this Python in sandbox {sandbox}: {code}.'
        slots:
          sandbox: requestBody.sandboxId
          code: requestBody.code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/sandbox/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a sandbox's status
      effect: read
      questions:
      - Is my sandbox still running, and how much memory is it using?
      - Which dataframes are loaded in a sandbox?
      instructions:
      - text: Get the status of sandbox {sandbox}.
        slots:
          sandbox: requestBody.sandboxId
      - text: Show the loaded dataframes and memory use of sandbox {sandbox}.
        slots:
          sandbox: requestBody.sandboxId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/sandbox/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop and destroy a sandbox
      effect: destructive
      questions:
      - How do I shut down a sandbox when I'm finished?
      - Does stopping a sandbox destroy its environment?
      instructions:
      - text: Stop sandbox {sandbox}.
        slots:
          sandbox: requestBody.sandboxId
      - text: Destroy the running sandbox {sandbox}.
        slots:
          sandbox: requestBody.sandboxId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/sandbox/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Load query results into a sandbox DataFrame
      effect: write
      questions:
      - How do I pull warehouse data into a sandbox as a pandas DataFrame?
      - Can I choose the DataFrame name when loading SQL results?
      instructions:
      - text: Load the results of {query} from connector {connector} into sandbox {sandbox}.
        slots:
          query: requestBody.query
          connector: requestBody.connectorId
          sandbox: requestBody.sandboxId
      - text: Run {query} on connector {connector} and store it as DataFrame {df} in sandbox {sandbox}.
        slots:
          query: requestBody.query
          connector: requestBody.connectorId
          df: requestBody.dataframeName
          sandbox: requestBody.sandboxId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/sandbox/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file into a sandbox
      effect: write
      questions:
      - How do I put a file into a sandbox's filesystem?
      - Can I upload a CSV for my sandbox code to read?
      instructions:
      - text: Upload {filename} with contents {content} to sandbox {sandbox}.
        slots:
          filename: requestBody.filename
          content: requestBody.content
          sandbox: requestBody.sandboxId
      - text: Write file {filename} into sandbox {sandbox} using {content}.
        slots:
          filename: requestBody.filename
          sandbox: requestBody.sandboxId
          content: requestBody.content
      method: generated
      generated: '2026-10-01'