# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure History Run API
  version: 1.0.0
extends: openapi/microsoft-azure-run-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/children'].get
  update:
    x-apievangelist-phrasing:
      intent: List the child runs of an ML run
      effect: read
      questions:
      - Which child runs did a hyperparameter sweep run spawn?
      - Can I filter and sort the child runs of an Azure ML run?
      instructions:
      - text: List child runs of run {run} in experiment {experiment}, workspace {workspace}, group {group}, subscription {subscription}.
        slots:
          run: path.runId
          experiment: path.experimentName
          workspace: path.workspaceName
          group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the top {top} children of run {run} in {experiment} ({workspace}) matching {filter}.
        slots:
          top: query.$top
          run: path.runId
          experiment: path.experimentName
          workspace: path.workspaceName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the extended details of an ML run
      effect: read
      questions:
      - Where can I see the extended run details like compute target and logs for a training run?
      - Can I get the detailed view of one Azure ML run?
      instructions:
      - text: Get extended details for run {run} in experiment {experiment}, workspace {workspace}, group {group}, subscription {subscription}.
        slots:
          run: path.runId
          experiment: path.experimentName
          workspace: path.workspaceName
          group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the full details view of {run} in {experiment}.
        slots:
          run: path.runId
          experiment: path.experimentName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/batch/runs'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add or modify many ML runs at once
      effect: write
      questions:
      - Can I create or update several runs in an experiment in one call?
      - How do I bulk upsert runs into an Azure ML experiment?
      instructions:
      - text: Add or modify runs {runs} in experiment {experiment}, workspace {workspace}, group {group}, subscription {subscription}.
        slots:
          runs: requestBody.runs
          experiment: path.experimentName
          workspace: path.workspaceName
          group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Batch upsert these runs {runs} into {experiment}.
        slots:
          runs: requestBody.runs
          experiment: path.experimentName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an ML run by id
      effect: read
      questions:
      - What's the status of a specific Azure ML run?
      - Can I fetch one run's basic record by its run id?
      instructions:
      - text: Get run {run} in experiment {experiment}, workspace {workspace}, group {group}, subscription {subscription}.
        slots:
          run: path.runId
          experiment: path.experimentName
          workspace: path.workspaceName
          group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the status and start time of run {run} in {experiment}.
        slots:
          run: path.runId
          experiment: path.experimentName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Create or modify a single ML run
      effect: write
      questions:
      - How do I update the status or description of one run?
      - Can I mark a single run as hidden or change its name?
      instructions:
      - text: Set run {run} in {experiment} ({workspace}, group {group}, subscription {subscription}) to status {status}.
        slots:
          run: path.runId
          experiment: path.experimentName
          workspace: path.workspaceName
          group: path.resourceGroupName
          subscription: path.subscriptionId
          status: requestBody.status
      - text: Rename run {run} in {experiment} to {name} with description {description}.
        slots:
          run: path.runId
          experiment: path.experimentName
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/tags'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete tags from an ML run
      effect: destructive
      questions:
      - How do I strip tags off a training run?
      - Can I delete a list of tags from one Azure ML run?
      instructions:
      - text: Delete tags from run {run} in experiment {experiment}, workspace {workspace}, group {group}, subscription {subscription}.
        slots:
          run: path.runId
          experiment: path.experimentName
          workspace: path.workspaceName
          group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Remove the tags on {run} in {experiment}.
        slots:
          run: path.runId
          experiment: path.experimentName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs:query'].post
  update:
    x-apievangelist-phrasing:
      intent: Query the runs of an ML experiment
      effect: read
      questions:
      - Which runs in my experiment failed?
      - Can I query an experiment's runs with a filter and ordering?
      instructions:
      - text: Query runs in experiment {experiment}, workspace {workspace}, group {group}, subscription {subscription}.
        slots:
          experiment: path.experimentName
          workspace: path.workspaceName
          group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Find the top {top} runs in {experiment} matching {filter} ordered by {order}.
        slots:
          top: requestBody.top
          experiment: path.experimentName
          filter: requestBody.filter
          order: requestBody.orderBy
      method: generated
      generated: '2026-09-26'