# 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 Entities API
  version: 1.0.0
extends: openapi/microsoft-azure-entities-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['/providers/Microsoft.Management/getEntities'].post
  update:
    x-apievangelist-phrasing:
      intent: List management groups and subscriptions I can see
      effect: read
      questions:
      - Which management groups and subscriptions do I have access to?
      - Can I see the whole management group hierarchy for my signed-in account?
      instructions:
      - text: List all management entities visible to me.
      - text: List entities under management group {groupName}.
        slots:
          groupName: query.groupName
      - text: Get the next page of management entities using skip token {skiptoken}.
        slots:
          skiptoken: query.$skiptoken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/health/jobs/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get healthcare analysis job status and results
      effect: read
      questions:
      - Is my Text Analytics for health job finished yet?
      - Can I page through the results of a healthcare entity extraction job?
      instructions:
      - text: Get status and results of healthcare job {jobId}.
        slots:
          jobId: path.jobId
      - text: Show the first {top} documents from healthcare job {jobId} with statistics.
        slots:
          top: query.$top
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/health/jobs/{jobId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a healthcare analysis job
      effect: destructive
      questions:
      - How do I cancel a healthcare text analysis job that's still running?
      - Can I stop a Text Analytics for health job I submitted by mistake?
      instructions:
      - text: Cancel healthcare job {jobId}.
        slots:
          jobId: path.jobId
      - text: Stop the running health entity job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/health/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a healthcare text analysis job
      effect: write
      questions:
      - How do I extract drugs, conditions and symptoms from clinical notes?
      - Can I find relations between medical entities in a batch of documents?
      instructions:
      - text: Start a healthcare analysis job on documents {input}.
        slots:
          input: body.input
      - text: Submit clinical text {input} for health entity extraction using model version {modelVersion}.
        slots:
          input: body.input
          modelVersion: query.model-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/recognition/general'].post
  update:
    x-apievangelist-phrasing:
      intent: Recognize named entities in text
      effect: read
      questions:
      - How do I pull people, places and organizations out of a document?
      - Which general entity types can named entity recognition detect?
      instructions:
      - text: Recognize named entities in documents {input}.
        slots:
          input: body.input
      - text: Run general NER on {input} with model version {modelVersion} and return stats.
        slots:
          input: body.input
          modelVersion: query.model-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/recognition/pii'].post
  update:
    x-apievangelist-phrasing:
      intent: Detect personal information in text
      effect: read
      questions:
      - Can I find social security numbers and bank accounts in customer text?
      - Is there a way to limit PII detection to specific categories or the PHI domain?
      instructions:
      - text: Detect PII entities in documents {input}.
        slots:
          input: body.input
      - text: Find only {piiCategories} personal data in {input}.
        slots:
          piiCategories: query.piiCategories
          input: body.input
      - text: Scan {input} for personal information in domain {domain}.
        slots:
          input: body.input
          domain: query.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/linking'].post
  update:
    x-apievangelist-phrasing:
      intent: Link entities in text to a knowledge base
      effect: read
      questions:
      - How do I disambiguate entities in text and get links to a knowledge base?
      - Can entity linking tell me which well-known knowledge base entry a mention refers to?
      instructions:
      - text: Link recognized entities in documents {input} to the knowledge base.
        slots:
          input: body.input
      - text: Run entity linking on {input} using model version {modelVersion}.
        slots:
          input: body.input
          modelVersion: query.model-version
      method: generated
      generated: '2026-09-26'