# 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 Run History Run Artifacts API
  version: 1.0.0
extends: openapi/microsoft-azure-runartifacts-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}/artifacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List all artifacts of an ML experiment run
      effect: read
      questions:
      - What files did my Azure Machine Learning run produce?
      - Can I page through all artifacts of a run with a continuation token?
      instructions:
      - text: List all artifacts for run {run} in experiment {experiment}, workspace {workspace}, resource group {resource_group}, subscription {subscription}.
        slots:
          run: path.runId
          experiment: path.experimentName
          workspace: path.workspaceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show every output file from ML run {run} in experiment {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}/artifacts/path'].get
  update:
    x-apievangelist-phrasing:
      intent: List a run's artifacts under a folder path
      effect: read
      questions:
      - How do I list only the artifacts under one folder of an ML run, like outputs/?
      - Can I browse a run's artifacts by directory path?
      instructions:
      - text: List artifacts under path {path} for run {run} in experiment {experiment}, workspace {workspace}, group {resource_group}, subscription {subscription}.
        slots:
          path: query.path
          run: path.runId
          experiment: path.experimentName
          workspace: path.workspaceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the files in folder {path} of ML run {run}.
        slots:
          path: query.path
          run: path.runId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metadata for one run artifact
      effect: read
      questions:
      - How do I get the metadata for a single artifact file from an ML run?
      - What does the artifact record say about a specific file my run saved?
      instructions:
      - text: Get artifact metadata for {path} in run {run}, experiment {experiment}, workspace {workspace}, group {resource_group}, subscription {subscription}.
        slots:
          path: query.path
          run: path.runId
          experiment: path.experimentName
          workspace: path.workspaceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Look up the artifact record for file {path} from ML run {run}.
        slots:
          path: query.path
          run: path.runId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/contentinfo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get content info for a run artifact
      effect: read
      questions:
      - How do I get the content information, like download location, for an ML run artifact?
      - Can I see content details of one artifact before downloading it?
      instructions:
      - text: Get content information for artifact {path} of run {run} in experiment {experiment}, workspace {workspace}, group {resource_group}, subscription {subscription}.
        slots:
          path: query.path
          run: path.runId
          experiment: path.experimentName
          workspace: path.workspaceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show content details for run {run} artifact {path}.
        slots:
          run: path.runId
          path: query.path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/artifacturi'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SAS URI to download a run artifact
      effect: read
      questions:
      - How do I get a download URL for a model file my ML run saved?
      - Can I get a SAS link to a single run artifact?
      instructions:
      - text: Get the SAS URI for artifact {path} of run {run} in experiment {experiment}, workspace {workspace}, group {resource_group}, subscription {subscription}.
        slots:
          path: query.path
          run: path.runId
          experiment: path.experimentName
          workspace: path.workspaceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Give me a download link for {path} from ML run {run}.
        slots:
          path: query.path
          run: path.runId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/prefix/contentinfo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get SAS links for run artifacts under a prefix
      effect: read
      questions:
      - How do I get download links for every artifact under a folder prefix in an ML run?
      - Can I fetch SAS URIs in bulk for all files starting with a path?
      instructions:
      - text: Get SAS links for prefix {path} in run {run}, experiment {experiment}, workspace {workspace}, group {resource_group}, subscription {subscription}.
        slots:
          path: query.path
          run: path.runId
          experiment: path.experimentName
          workspace: path.workspaceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Generate download URLs for all run {run} files starting with {path}.
        slots:
          run: path.runId
          path: query.path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/history/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/experiments/{experimentName}/runs/{runId}/artifacts/batch/metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: Create empty artifact placeholders in a run
      effect: write
      questions:
      - How do I register several empty artifacts in an ML run before uploading their content?
      - Can I create a batch of artifact entries for a run in one request?
      instructions:
      - text: Create empty artifacts at paths {paths} in run {run}, experiment {experiment}, workspace {workspace}, group {resource_group}, subscription {subscription}.
        slots:
          paths: requestBody.paths
          run: path.runId
          experiment: path.experimentName
          workspace: path.workspaceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Register placeholder artifacts {paths} on ML run {run}.
        slots:
          paths: requestBody.paths
          run: path.runId
      method: generated
      generated: '2026-09-26'