# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Purview Sensitivity Labels API
  version: 1.0.0
extends: openapi/microsoft-purview-sensitivity-labels-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: 10
- target: $.paths['/security/dataSecurityAndGovernance/sensitivityLabels'].get
  update:
    x-apievangelist-phrasing:
      intent: List sensitivity labels for the whole tenant
      effect: read
      questions:
      - Which sensitivity labels exist across our entire tenant?
      - Can I count tenant-wide labels or filter them?
      instructions:
      - text: List all tenant-wide sensitivity labels.
      - text: Show tenant sensitivity labels matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/dataSecurityAndGovernance/sensitivityLabels/{sensitivityLabelId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tenant-level sensitivity label
      effect: read
      questions:
      - Where can I read a sensitivity label's tenant-level definition?
      - What does one label look like at the data security and governance level?
      instructions:
      - text: Get tenant sensitivity label {label}.
        slots:
          label: path.sensitivityLabelId
      - text: Show the tenant-level definition of label {label}.
        slots:
          label: path.sensitivityLabelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/informationProtection/sensitivityLabels'].get
  update:
    x-apievangelist-phrasing:
      intent: List information protection sensitivity labels
      effect: read
      questions:
      - What sensitivity labels are available to the organization under information protection?
      - Can I sort and page through information protection labels?
      instructions:
      - text: List the organization's information protection sensitivity labels.
      - text: Show information protection labels ordered by {order}, skipping {skip}.
        slots:
          order: query.$orderby
          skip: query.$skip
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/informationProtection/sensitivityLabels/{sensitivityLabelId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an information protection sensitivity label
      effect: read
      questions:
      - What are the settings of one information protection label?
      - Can I look up an information protection sensitivity label by ID?
      instructions:
      - text: Get information protection sensitivity label {label}.
        slots:
          label: path.sensitivityLabelId
      - text: Show the information protection details of label {label}.
        slots:
          label: path.sensitivityLabelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{userId}/security/informationProtection/sensitivityLabels'].get
  update:
    x-apievangelist-phrasing:
      intent: List sensitivity labels available to a user
      effect: read
      questions:
      - Which sensitivity labels can a specific user apply?
      - Can I filter the labels available to one person?
      instructions:
      - text: List the sensitivity labels available to user {user}.
        slots:
          user: path.userId
      - text: Show labels user {user} can apply matching {filter}.
        slots:
          user: path.userId
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/me/security/informationProtection/sensitivityLabels'].get
  update:
    x-apievangelist-phrasing:
      intent: List my own sensitivity labels
      effect: read
      questions:
      - Which sensitivity labels am I allowed to apply?
      - What labels does the signed-in account see?
      instructions:
      - text: List the sensitivity labels available to me.
      - text: Show my top {top} sensitivity labels.
        slots:
          top: query.$top
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/informationProtection/sensitivityLabels/microsoft.graph.security.evaluateApplication'].post
  update:
    x-apievangelist-phrasing:
      intent: Work out which sensitivity label to apply
      effect: read
      questions:
      - Which sensitivity label should be applied to a document, and what actions follow?
      - What marking or protection actions come with applying a label?
      instructions:
      - text: Evaluate the sensitivity label to apply to content {content}.
        slots:
          content: requestBody.contentInfo
      - text: Compute labeling actions for {content} with options {options}.
        slots:
          content: requestBody.contentInfo
          options: requestBody.labelingOptions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/informationProtection/sensitivityLabels/microsoft.graph.security.evaluateRemoval'].post
  update:
    x-apievangelist-phrasing:
      intent: Work out how to remove a sensitivity label
      effect: read
      questions:
      - What has to happen to strip a sensitivity label from a file?
      - Can I give a justification when downgrading a label?
      instructions:
      - text: Evaluate removing the sensitivity label from content {content}.
        slots:
          content: requestBody.contentInfo
      - text: Compute label removal actions for {content} with justification {justification}.
        slots:
          content: requestBody.contentInfo
          justification: requestBody.downgradeJustification
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/informationProtection/sensitivityLabels/microsoft.graph.security.evaluateClassificationResults'].post
  update:
    x-apievangelist-phrasing:
      intent: Pick a label from classification results
      effect: read
      questions:
      - Can Purview recommend a label based on sensitive info types found in content?
      - Which label fits content given its classification results?
      instructions:
      - text: Evaluate classification results {results} for content {content}.
        slots:
          results: requestBody.classificationResults
          content: requestBody.contentInfo
      - text: Choose a label for {content} using detected classifications {results}.
        slots:
          content: requestBody.contentInfo
          results: requestBody.classificationResults
      method: generated
      generated: '2026-10-01'
- target: $.paths['/drives/{driveId}/items/{driveItemId}/assignSensitivityLabel'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a sensitivity label to a file
      effect: write
      questions:
      - How do I label a SharePoint or OneDrive file as confidential?
      - Can I give a justification when assigning a label to a file?
      instructions:
      - text: Assign label {label} to item {item} in drive {drive}.
        slots:
          label: requestBody.sensitivityLabelId
          item: path.driveItemId
          drive: path.driveId
      - text: Label file {item} in drive {drive} as {label} with justification {justification}.
        slots:
          item: path.driveItemId
          drive: path.driveId
          label: requestBody.sensitivityLabelId
          justification: requestBody.justificationText
      method: generated
      generated: '2026-10-01'