# 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 Experiments API
  version: 1.0.0
extends: openapi/microsoft-azure-experiments-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: 11
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments'].get
  update:
    x-apievangelist-phrasing:
      intent: List network experiments in a profile
      effect: read
      questions:
      - Which network experiments are set up under my Network Experiment profile?
      - Can I see all the endpoint A/B experiments in one network experiment profile?
      instructions:
      - text: List the network experiments in profile {profile} in resource group {group}.
        slots:
          profile: path.profileName
          group: path.resourceGroupName
      - text: Show every experiment configured under network experiment profile {profile}.
        slots:
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a network experiment by name
      effect: read
      questions:
      - What endpoints and settings does one network experiment in my profile have?
      - Can I look up a single network experiment by its name within a profile?
      instructions:
      - text: Get network experiment {experiment} in profile {profile} in group {group}.
        slots:
          experiment: path.experimentName
          profile: path.profileName
          group: path.resourceGroupName
      - text: Show the configuration of network experiment {experiment} under profile {profile}.
        slots:
          experiment: path.experimentName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a network experiment
      effect: write
      questions:
      - How do I set up a new network experiment comparing two endpoints in a profile?
      - Can I overwrite an existing network experiment's full definition in one call?
      instructions:
      - text: Create network experiment {experiment} in profile {profile} in group {group} with properties {properties}.
        slots:
          experiment: path.experimentName
          profile: path.profileName
          group: path.resourceGroupName
          properties: requestBody.properties
      - text: Replace the definition of network experiment {experiment} in profile {profile}.
        slots:
          experiment: path.experimentName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a network experiment
      effect: destructive
      questions:
      - Can I remove a finished network experiment from my profile?
      - What happens when I delete a network experiment, is it gone for good?
      instructions:
      - text: Delete network experiment {experiment} from profile {profile} in group {group}.
        slots:
          experiment: path.experimentName
          profile: path.profileName
          group: path.resourceGroupName
      - text: Tear down the network experiment {experiment} under profile {profile}.
        slots:
          experiment: path.experimentName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch tags or properties of a network experiment
      effect: write
      questions:
      - Can I change just the tags on a network experiment without redefining it?
      - Is it possible to partially update a network experiment's properties?
      instructions:
      - text: Patch network experiment {experiment} in profile {profile} in group {group} with tags {tags}.
        slots:
          experiment: path.experimentName
          profile: path.profileName
          group: path.resourceGroupName
          tags: requestBody.tags
      - text: Update only the properties {properties} of network experiment {experiment} in profile {profile}.
        slots:
          properties: requestBody.properties
          experiment: path.experimentName
          profile: path.profileName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a machine learning experiment by name
      effect: read
      questions:
      - What are the details of a machine learning experiment in my Azure ML workspace?
      - Can I fetch an ML run-history experiment by its name?
      instructions:
      - text: Get ML experiment {experiment} in workspace {workspace}, resource group {group}, subscription {subscription}.
        slots:
          experiment: path.experimentName
          workspace: path.workspaceName
          group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Look up the Azure ML experiment named {experiment} in workspace {workspace}.
        slots:
          experiment: path.experimentName
          workspace: path.workspaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a machine learning experiment
      effect: write
      questions:
      - How do I create a new experiment to group runs in my ML workspace?
      - Can I register an ML experiment by name before submitting any runs?
      instructions:
      - text: Create ML experiment {experiment} in workspace {workspace}, group {group}, subscription {subscription}.
        slots:
          experiment: path.experimentName
          workspace: path.workspaceName
          group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Start a new machine learning experiment called {experiment} in workspace {workspace}.
        slots:
          experiment: path.experimentName
          workspace: path.workspaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a machine learning experiment by id
      effect: read
      questions:
      - Can I look up an ML experiment when I only have its experiment id, not its name?
      - What does my workspace return for a given ML experiment id?
      instructions:
      - text: Get ML experiment with id {experiment_id} in workspace {workspace}, group {group}, subscription {subscription}.
        slots:
          experiment_id: path.experimentId
          workspace: path.workspaceName
          group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Fetch the machine learning experiment whose id is {experiment_id} from workspace {workspace}.
        slots:
          experiment_id: path.experimentId
          workspace: path.workspaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update or archive a machine learning experiment
      effect: write
      questions:
      - Can I archive an old ML experiment so it stops cluttering my workspace?
      - How do I change the description or tags on an ML experiment by id?
      instructions:
      - text: Set the description of ML experiment {experiment_id} in workspace {workspace}, group {group}, sub {subscription} to {description}.
        slots:
          experiment_id: path.experimentId
          workspace: path.workspaceName
          group: path.resourceGroupName
          subscription: path.subscriptionId
          description: requestBody.description
      - text: Archive machine learning experiment {experiment_id} in workspace {workspace} ({archive}).
        slots:
          experiment_id: path.experimentId
          workspace: path.workspaceName
          archive: requestBody.archive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments:query'].post
  update:
    x-apievangelist-phrasing:
      intent: Search machine learning experiments in a workspace
      effect: read
      questions:
      - Which ML experiments in my workspace match a filter, ordered the way I want?
      - Can I cap how many ML experiments a query returns and page with a continuation token?
      instructions:
      - text: Query ML experiments in workspace {workspace}, group {group}, subscription {subscription} using filter {filter}.
        slots:
          workspace: path.workspaceName
          group: path.resourceGroupName
          subscription: path.subscriptionId
          filter: requestBody.filter
      - text: Return the top {top} machine learning experiments in {workspace} ordered by {order_by}.
        slots:
          top: requestBody.top
          workspace: path.workspaceName
          order_by: requestBody.orderBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experimentids/{experimentId}/tags'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a machine learning experiment
      effect: destructive
      questions:
      - Can I strip specific tags off an ML experiment without touching the rest?
      - What removes a list of tags from an experiment id in my workspace?
      instructions:
      - text: Delete tags {tags} from ML experiment {experiment_id} in workspace {workspace}, group {group}, sub {subscription}.
        slots:
          tags: requestBody.tags
          experiment_id: path.experimentId
          workspace: path.workspaceName
          group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Clear the tag list {tags} on machine learning experiment {experiment_id}.
        slots:
          tags: requestBody.tags
          experiment_id: path.experimentId
      method: generated
      generated: '2026-09-26'