# 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 Fine Tunes: API'
  version: 1.0.0
extends: openapi/microsoft-azure-fine-tunes-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: 10
- target: $.paths['/fine-tunes'].get
  update:
    x-apievangelist-phrasing:
      intent: List fine-tune jobs on an OpenAI resource
      effect: read
      questions:
      - Which fine-tune jobs has my Azure OpenAI resource run?
      - Can I see the base model and status of every fine-tuning job at once?
      instructions:
      - text: List all fine-tune jobs on this OpenAI resource.
      - text: Show every fine-tuning job with its base model and status, calling API version {api_version}.
        slots:
          api_version: query.api-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fine-tunes'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a fine-tune job
      effect: write
      questions:
      - How do I fine-tune a base model on my own training file?
      - Can I pass a validation file and hyperparameters when starting a fine-tune?
      instructions:
      - text: Fine-tune model {model} using training file {training_file}.
        slots:
          model: requestBody.model
          training_file: requestBody.training_file
      - text: Start a fine-tune of {model} on {training_file}, validating against {validation_file} with hyperparameters {hyperparams}.
        slots:
          model: requestBody.model
          training_file: requestBody.training_file
          validation_file: requestBody.validation_file
          hyperparams: requestBody.hyperparams
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fine-tunes/{fine_tune_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a fine-tune job (fine_tune_id route)
      effect: read
      questions:
      - What is the status and hyperparameters of one fine-tune job, via the underscore fine_tune_id path?
      - Can I read a fine-tune job's training files and timestamps using the fine_tune_id route?
      instructions:
      - text: Get fine-tune job {job} through the fine_tune_id route.
        slots:
          job: path.fine_tune_id
      - text: Show details for fine-tune {job} using the underscore-style path.
        slots:
          job: path.fine_tune_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fine-tunes/{fine_tune_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a fine-tune job (fine_tune_id route)
      effect: destructive
      questions:
      - How do I delete a fine-tune job through the underscore fine_tune_id path?
      - Can a finished fine-tune job be removed using the fine_tune_id route?
      instructions:
      - text: Delete fine-tune job {job} through the fine_tune_id route.
        slots:
          job: path.fine_tune_id
      - text: Remove fine-tune {job} using the underscore-style path.
        slots:
          job: path.fine_tune_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fine-tunes/{fine_tune_id}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fine-tune job events (fine_tune_id route)
      effect: read
      questions:
      - When did my fine-tune job change status, according to the fine_tune_id events path?
      - Can I stream a fine-tune job's events through the underscore fine_tune_id route?
      instructions:
      - text: List events for fine-tune job {job} through the fine_tune_id route.
        slots:
          job: path.fine_tune_id
      - text: Stream the event log of fine-tune {job} via the underscore-style path with stream set to {stream}.
        slots:
          job: path.fine_tune_id
          stream: query.stream
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fine-tunes/{fine_tune_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a fine-tune job (fine_tune_id route)
      effect: destructive
      questions:
      - How do I stop a running fine-tune job through the underscore fine_tune_id path?
      - Can I cancel fine-tune processing using the fine_tune_id route?
      instructions:
      - text: Cancel fine-tune job {job} through the fine_tune_id route.
        slots:
          job: path.fine_tune_id
      - text: Stop processing fine-tune {job} using the underscore-style path.
        slots:
          job: path.fine_tune_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fine-tunes/{fine-tune-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a fine-tune job (fine-tune-id route)
      effect: read
      questions:
      - What base model, files and status does a fine-tune job have on the hyphenated fine-tune-id path?
      - Can I check a single fine-tuning job's result files by id?
      instructions:
      - text: Get fine-tune job {job} via the hyphenated fine-tune-id path.
        slots:
          job: path.fine-tune-id
      - text: Look up fine-tuning run {job} and report its status.
        slots:
          job: path.fine-tune-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fine-tunes/{fine-tune-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a fine-tune job (fine-tune-id route)
      effect: destructive
      questions:
      - How do I delete a fine-tune job on the hyphenated fine-tune-id path?
      - Is deleting a fine-tuning job by id permanent?
      instructions:
      - text: Delete fine-tune job {job} via the hyphenated fine-tune-id path.
        slots:
          job: path.fine-tune-id
      - text: Permanently remove fine-tuning run {job}.
        slots:
          job: path.fine-tune-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fine-tunes/{fine-tune-id}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fine-tune job events (fine-tune-id route)
      effect: read
      questions:
      - What events has a fine-tune job emitted, like running or complete, on the hyphenated path?
      - Can I follow a fine-tuning run's progress as a stream of events?
      instructions:
      - text: List events for fine-tune job {job} via the hyphenated fine-tune-id path.
        slots:
          job: path.fine-tune-id
      - text: Follow fine-tuning run {job}'s events live with stream {stream}.
        slots:
          job: path.fine-tune-id
          stream: query.stream
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fine-tunes/{fine-tune-id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a fine-tune job (fine-tune-id route)
      effect: destructive
      questions:
      - Which call aborts an in-flight fine-tune on the hyphenated fine-tune-id path?
      - Can I halt a fine-tuning run that is still processing?
      instructions:
      - text: Cancel fine-tune job {job} via the hyphenated fine-tune-id path.
        slots:
          job: path.fine-tune-id
      - text: Halt fine-tuning run {job} before it completes.
        slots:
          job: path.fine-tune-id
      method: generated
      generated: '2026-09-26'