# 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 Trial Matcher API
  version: 1.0.0
extends: openapi/microsoft-azure-trialmatcher-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: 4
- target: $.paths['/trial-matcher/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a Trial Matcher job (hyphenated path)
      effect: write
      questions:
      - How do I submit patients to the trial-matcher jobs endpoint to find eligible clinical trials?
      - Can I send a retry-safe trial matching request using a repeatability request ID on the /trial-matcher route?
      instructions:
      - text: Create a trial-matcher job for patients {patients} on the hyphenated /trial-matcher endpoint.
        slots:
          patients: requestBody.patients
      - text: Submit patients {patients} to /trial-matcher/jobs with configuration {configuration}.
        slots:
          patients: requestBody.patients
          configuration: requestBody.configuration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/trial-matcher/jobs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a Trial Matcher job by id (hyphenated path)
      effect: read
      questions:
      - Has my trial-matcher job finished processing on the /trial-matcher route?
      - Where do I fetch trial match results for a job id from /trial-matcher/jobs?
      instructions:
      - text: Get the status of trial-matcher job {id} from the hyphenated /trial-matcher endpoint.
        slots:
          id: path.id
      - text: Fetch the results of /trial-matcher job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/trialmatcher/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a Trial Matcher job (trialmatcher path)
      effect: write
      questions:
      - How do I match patients to clinical trials using the /trialmatcher jobs endpoint without a hyphen?
      - What patient clinical data does the trialmatcher job endpoint expect in the request?
      instructions:
      - text: Create a job on /trialmatcher/jobs for patients {patients}.
        slots:
          patients: requestBody.patients
      - text: Run trialmatcher matching for patients {patients} using configuration {configuration} on the unhyphenated route.
        slots:
          patients: requestBody.patients
          configuration: requestBody.configuration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/trialmatcher/jobs/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a Trial Matcher job by jobId (trialmatcher path)
      effect: read
      questions:
      - Is my job on the /trialmatcher endpoint still running or complete?
      - Can I retrieve trial matches for a jobId from /trialmatcher/jobs?
      instructions:
      - text: Get the status of trialmatcher job {jobId}.
        slots:
          jobId: path.jobId
      - text: Fetch the details of /trialmatcher/jobs/{jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'