Microsoft Azure Fine-Tunes: API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: 'Microsoft Azure AccessControlClient AccessConnector Fine-Tunes: API'
schemes:
- https
tags:
- name: 'Fine-Tunes:'
paths:
  /fine-tunes:
    get:
      tags:
      - 'Fine-Tunes:'
      summary: "Microsoft Azure Gets A List Of All Fine Tune Jobs Owned By The Azure Openai Resource \r\nthe Details That Are Returned For Each Fine Tune Job Contain Besides Its Identifier\r\nthe Base Model, Training And Validation Files, Hyper Parameters, Time Stamps, Status And Events \r\nevents Are Created When The Job Status Changes, E G Running Or Complete, And When Results Are Uploaded"
      operationId: microsoftAzureFinetunesList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/apiVersionQueryParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FineTuneList'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Getting all fine tune jobs owned by this account.:
          $ref: ./examples/get_finetunes.json
      description: Needs a more full description created.
    post:
      tags:
      - 'Fine-Tunes:'
      summary: "Microsoft Azure Creates A Job That Fine Tunes A Specified Model From A Given Training File \r\nresponse Includes Details Of The Enqueued Job Including Job Status And Hyper Parameters \r\nthe Name Of The Fine Tuned Model Is Added To The Response Once Complete"
      operationId: microsoftAzureFinetunesCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/apiVersionQueryParameter'
      - in: body
        name: body
        description: "The specification of the fine-tuned model to create.\r\nRequired parameters are the base model and the training file to use.\r\nOptionally a validation file can be specified to compute validation metrics during training.\r\nHyper parameters will be set to default values or can by optionally specified.\r\nThese include batch size, learning rate multiplier, number of epochs and others."
        schema:
          $ref: '#/definitions/FineTuneCreation'
      responses:
        '201':
          description: The fine tune has been successfully created.
          schema:
            $ref: '#/definitions/FineTune'
          headers:
            Location:
              description: The location of the newly created item.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Creating a fine tune job.:
          $ref: ./examples/post_finetune.json
      description: Needs a more full description created.
  /fine-tunes/{fine_tune_id}:
    get:
      tags:
      - 'Fine-Tunes:'
      summary: "Microsoft Azure Gets Details For A Single Fine Tune Job Specified By The Given Fine Tune Id \r\nthe Details Contain The Base Model, Training And Validation Files, Hyper Parameters, Time Stamps, Status And Events \r\nevents Are Created When The Job Status Changes, E G Running Or Complete, And When Results Are Uploaded"
      operationId: microsoftAzureFinetunesGet
      produces:
      - application/json
      parameters:
      - in: path
        name: fine_tune_id
        description: The identifier of the fine-tune job.
        required: true
        type: string
      - $ref: '#/parameters/apiVersionQueryParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FineTune'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Getting a fine tune job.:
          $ref: ./examples/get_finetune.json
      description: Needs a more full description created.
    delete:
      tags:
      - 'Fine-Tunes:'
      summary: Microsoft Azure Deletes The Fine Tune Job Specified By The Given Fine Tune Id
      operationId: microsoftAzureFinetunesDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: fine_tune_id
        description: The identifier of the fine-tune job.
        required: true
        type: string
      - $ref: '#/parameters/apiVersionQueryParameter'
      responses:
        '204':
          description: The fine tune was successfully deleted.
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Deleting a fine tune job.:
          $ref: ./examples/delete_finetune.json
      description: Needs a more full description created.
  /fine-tunes/{fine_tune_id}/events:
    get:
      tags:
      - 'Fine-Tunes:'
      summary: "Microsoft Azure Gets The Events For The Fine Tune Job Specified By The Given Fine Tune Id \r\nevents Are Created When The Job Status Changes, E G Running Or Complete, And When Results Are Uploaded"
      operationId: microsoftAzureFinetunesGetevents
      produces:
      - application/json
      - text/event-stream
      parameters:
      - in: path
        name: fine_tune_id
        description: The identifier of the fine-tune job.
        required: true
        type: string
      - in: query
        name: stream
        description: "A flag indicating whether to stream events for the fine-tune job. If set to true,\r\n            events will be sent as data-only server-sent events as they become available. The stream will terminate with\r\n            a data: [DONE] message when the job is finished (succeeded, cancelled, or failed).\r\n            If set to false, only events generated so far will be returned.."
        type: boolean
      - $ref: '#/parameters/apiVersionQueryParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/EventList'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Getting events of a fine tune job.:
          $ref: ./examples/get_finetune_events.json
      description: Needs a more full description created.
  /fine-tunes/{fine_tune_id}/cancel:
    post:
      tags:
      - 'Fine-Tunes:'
      summary: Microsoft Azure Cancels The Processing Of The Fine Tune Job Specified By The Given Fine Tune Id
      operationId: microsoftAzureFinetunesCancel
      produces:
      - application/json
      parameters:
      - in: path
        name: fine_tune_id
        description: The identifier of the fine-tune job.
        required: true
        type: string
      - $ref: '#/parameters/apiVersionQueryParameter'
      responses:
        '200':
          description: The fine tune has been successfully canceled
          schema:
            $ref: '#/definitions/FineTune'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Canceling a fine tune job.:
          $ref: ./examples/cancel_finetune.json
      description: Needs a more full description created.
  /fine-tunes/{fine-tune-id}:
    get:
      tags:
      - 'Fine-Tunes:'
      summary: "Microsoft Azure Gets Details For A Single Fine Tune Job Specified By The Given Fine Tune Id \r\nthe Details Contain The Base Model, Training And Validation Files, Hyper Parameters, Time Stamps, Status And Events \r\nevents Are Created When The Job Status Changes, E G Running Or Complete, And When Results Are Uploaded"
      operationId: microsoftAzureFinetunesGet
      produces:
      - application/json
      parameters:
      - in: path
        name: fine-tune-id
        description: The identifier of the fine-tune job.
        required: true
        type: string
      - $ref: '#/parameters/apiVersionQueryParameter_3'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FineTune_2'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse_2'
      x-ms-examples:
        Getting a fine tune job.:
          $ref: ./examples/get_finetune.json
      description: Needs a more full description created.
    delete:
      tags:
      - 'Fine-Tunes:'
      summary: Microsoft Azure Deletes The Fine Tune Job Specified By The Given Fine Tune Id
      operationId: microsoftAzureFinetunesDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: fine-tune-id
        description: The identifier of the fine-tune job.
        required: true
        type: string
      - $ref: '#/parameters/apiVersionQueryParameter_3'
      responses:
        '204':
          description: The fine tune was successfully deleted.
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse_2'
      x-ms-examples:
        Deleting a fine tune job.:
          $ref: ./examples/delete_finetune.json
      description: Needs a more full description created.
  /fine-tunes/{fine-tune-id}/events:
    get:
      tags:
      - 'Fine-Tunes:'
      summary: "Microsoft Azure Gets The Events For The Fine Tune Job Specified By The Given Fine Tune Id \r\nevents Are Created When The Job Status Changes, E G Running Or Complete, And When Results Are Uploaded"
      operationId: microsoftAzureFinetunesGetevents
      produces:
      - application/json
      - text/event-stream
      parameters:
      - in: path
        name: fine-tune-id
        description: The identifier of the fine-tune job.
        required: true
        type: string
      - in: query
        name: stream
        description: "A flag indicating whether to stream events for the fine-tune job. If set to true,\r\n            events will be sent as data-only server-sent events as they become available. The stream will terminate with\r\n            a data: [DONE] message when the job is finished (succeeded, cancelled, or failed).\r\n            If set to false, only events generated so far will be returned.."
        type: boolean
      - $ref: '#/parameters/apiVersionQueryParameter_3'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/EventList_2'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse_2'
      x-ms-examples:
        Getting events of a fine tune job.:
          $ref: ./examples/get_finetune_events.json
      description: Needs a more full description created.
  /fine-tunes/{fine-tune-id}/cancel:
    post:
      tags:
      - 'Fine-Tunes:'
      summary: Microsoft Azure Cancels The Processing Of The Fine Tune Job Specified By The Given Fine Tune Id
      operationId: microsoftAzureFinetunesCancel
      produces:
      - application/json
      parameters:
      - in: path
        name: fine-tune-id
        description: The identifier of the fine-tune job.
        required: true
        type: string
      - $ref: '#/parameters/apiVersionQueryParameter_3'
      responses:
        '200':
          description: The fine tune has been successfully canceled
          schema:
            $ref: '#/definitions/FineTune_2'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse_2'
      x-ms-examples:
        Canceling a fine tune job.:
          $ref: ./examples/cancel_finetune.json
      description: Needs a more full description created.
definitions:
  Event_2:
    title: Event
    required:
    - created_at
    - level
    - message
    type: object
    properties:
      object:
        $ref: '#/definitions/TypeDiscriminator'
      created_at:
        format: unixtime
        description: A timestamp when this event was created (in unix epochs).
        type: integer
      level:
        $ref: '#/definitions/LogLevel_2'
      message:
        description: The message describing the event. This can be a change of state, e.g., enqueued, started, failed or completed, or other events like uploaded results.
        minLength: 1
        type: string
  EventList_2:
    title: EventList
    description: Represents a list of events.
    type: object
    properties:
      object:
        $ref: '#/definitions/TypeDiscriminator'
      data:
        description: The list of items.
        type: array
        items:
          $ref: '#/definitions/Event_2'
  HyperParameters:
    title: HyperParameters
    description: The hyper parameter settings used in a fine tune job.
    type: object
    properties:
      batch_size:
        format: int32
        description: "The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model."
        type: integer
      learning_rate_multiplier:
        format: double
        description: "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results."
        type: number
      n_epochs:
        format: int32
        description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.
        type: integer
      prompt_loss_weight:
        format: double
        description: "The weight to use for loss on the prompt tokens. This controls how much the model tries to learn to generate the prompt\r\n(as compared to the completion which always has a weight of 1.0), and can add a stabilizing effect to training when completions are short.\r\nIf prompts are extremely long (relative to completions), it may make sense to reduce this weight so as to avoid over-prioritizing learning the prompt."
        type: number
  Event:
    title: Event
    type: object
    properties:
      object:
        $ref: '#/definitions/TypeDiscriminator'
      created_at:
        format: int32
        description: A timestamp when this event was created (in unix epochs).
        type: integer
        readOnly: true
      level:
        $ref: '#/definitions/LogLevel'
      message:
        description: The message describing the event. This can be a change of state, e.g., enqueued, started, failed or completed, or other events like uploaded results.
        type: string
        readOnly: true
  LogLevel:
    title: LogLevel
    description: The verbosity level of an event.
    enum:
    - info
    - warning
    - error
    type: string
    readOnly: true
    x-ms-enum:
      name: LogLevel
      modelAsString: false
      values:
      - value: info
        description: This event is for information only.
      - value: warning
        description: This event represents a mitigated issue.
      - value: error
        description: This message represents a non recoverable issue.
  Purpose:
    title: Purpose
    description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file.
    enum:
    - fine-tune
    - fine-tune-results
    type: string
    x-ms-enum:
      name: Purpose
      modelAsString: true
      values:
      - value: fine-tune
        description: This file contains training data for a fine tune job.
      - value: fine-tune-results
        description: This file contains the results of a fine tune job.
  FineTune:
    title: FineTune
    description: Fine tuning is a job to tailor a model to specific training data.
    required:
    - model
    - training_files
    type: object
    properties:
      object:
        $ref: '#/definitions/TypeDiscriminator'
      status:
        $ref: '#/definitions/State'
      created_at:
        format: int32
        description: A timestamp when this job or item was created (in unix epochs).
        type: integer
        readOnly: true
      updated_at:
        format: int32
        description: A timestamp when this job or item was modified last (in unix epochs).
        type: integer
        readOnly: true
      id:
        description: The identity of this item.
        type: string
        readOnly: true
      model:
        description: The identifier of the base model used for the fine-tune.
        minLength: 1
        type: string
      fine_tuned_model:
        description: "The identifier of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs.\r\nUse this identifier to create a deployment for inferencing."
        type: string
        readOnly: true
      training_files:
        description: The files that are used for training the fine tuned model.
        type: array
        items:
          $ref: '#/definitions/File'
      validation_files:
        description: The files that are used to evaluate the fine tuned model during training.
        type: array
        items:
          $ref: '#/definitions/File'
      result_files:
        description: "The result files containing training and evaluation metrics in csv format.\r\nThe file is only available for successfully completed fine-tune runs."
        type: array
        items:
          $ref: '#/definitions/File'
        readOnly: true
      events:
        description: The events that show the progress of the fine-tune run including queued, running and completed.
        type: array
        items:
          $ref: '#/definitions/Event'
        readOnly: true
      organisation_id:
        description: The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only.
        type: string
        readOnly: true
      user_id:
        description: The user id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only.
        type: string
        readOnly: true
      hyperparams:
        $ref: '#/definitions/HyperParameters'
  File:
    title: File
    description: A file is a document usable for training and validation. It can also be a service generated document with result details.
    required:
    - filename
    - purpose
    type: object
    properties:
      object:
        $ref: '#/definitions/TypeDiscriminator'
      status:
        $ref: '#/definitions/State'
      created_at:
        format: int32
        description: A timestamp when this job or item was created (in unix epochs).
        type: integer
        readOnly: true
      updated_at:
        format: int32
        description: A timestamp when this job or item was modified last (in unix epochs).
        type: integer
        readOnly: true
      id:
        description: The identity of this item.
        type: string
        readOnly: true
      bytes:
        format: int64
        description: "The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility\r\nwith JavaScript integers."
        type: integer
        readOnly: true
      purpose:
        $ref: '#/definitions/Purpose'
      filename:
        description: The name of the file.
        minLength: 1
        type: string
  FineTune_2:
    title: FineTune
    description: Fine tuning is a job to tailor a model to specific training data.
    required:
    - model
    - training_files
    type: object
    properties:
      object:
        $ref: '#/definitions/TypeDiscriminator'
      status:
        $ref: '#/definitions/State_2'
      created_at:
        format: unixtime
        description: A timestamp when this job or item was created (in unix epochs).
        type: integer
        readOnly: true
      updated_at:
        format: unixtime
        description: A timestamp when this job or item was modified last (in unix epochs).
        type: integer
        readOnly: true
      id:
        description: The identity of this item.
        type: string
        readOnly: true
      model:
        description: The identifier (model-id) of the base model used for the fine-tune.
        minLength: 1
        type: string
      fine_tuned_model:
        description: "The identifier (model-id) of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs.\r\nUse this identifier to create a deployment for inferencing."
        type: string
      training_files:
        description: The file identities (file-id) that are used for training the fine tuned model.
        type: array
        items:
          $ref: '#/definitions/File_2'
      validation_files:
        description: The file identities (file-id) that are used to evaluate the fine tuned model during training.
        type: array
        items:
          $ref: '#/definitions/File_2'
      result_files:
        description: "The result file identities (file-id) containing training and evaluation metrics in csv format.\r\nThe file is only available for successfully completed fine-tune runs."
        type: array
        items:
          $ref: '#/definitions/File_2'
      events:
        description: The events that show the progress of the fine-tune run including queued, running and completed.
        type: array
        items:
          $ref: '#/definitions/Event_2'
      organisation_id:
        description: The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only.
        type: string
      user_id:
        description: The user id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only.
        type: string
      hyperparams:
        $ref: '#/definitions/HyperParameters_3'
      suffix:
        description: The suffix used to identify the fine-tuned model.
        type: string
      error:
        $ref: '#/definitions/Error'
  State:
    title: State
    description: The state of a job or item.
    enum:
    - notRunning
    - running
    - succeeded
    - canceled
    - failed
    - deleted
    type: string
    readOnly: true
    x-ms-enum:
      name: State
      modelAsString: false
      values:
      - value: notRunning
        description: The operation was created and is not queued to be processed in the future.
      - value: running
        description: The operation has started to be processed.
      - value: succeeded
        description: The operation has successfully be processed and is ready for consumption.
      - value: canceled
        description: The operation has been canceled and is incomplete.
      - value: failed
        description: The operation has completed processing with a failure and cannot be further consumed.
      - value: deleted
        description: The entity has been deleted but may still be referenced by other entities predating the deletion.
  ErrorResponse_2:
    title: ErrorResponse
    description: "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)."
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/Error'
  FileStatistics:
    title: FileStatistics
    description: A file is a document usable for training and validation. It can also be a service generated document with result details.
    type: object
    properties:
      tokens:
        format: int32
        description: The number of tokens used in prompts and completions for files of kind "fine-tune" once validation of file content is complete.
        type: integer
      examples:
        format: int32
        description: The number of contained training examples in files of kind "fine-tune" once validation of file content is complete.
        type: integer
  FineTuneCreation:
    title: FineTuneCreation
    description: Defines the values of a fine tune job.
    required:
    - model
    - training_file
    type: object
    properties:
      model:
        description: The identifier of the base model used for this fine-tune.
        minLength: 1
        type: string
      training_file:
        description: The file that is used for training this fine tuned model.
        minLength: 1
        type: string
      validation_file:
        description: The file that is used to evaluate the fine tuned model during training.
        type: string
      hyperparams:
        $ref: '#/definitions/HyperParameters'
  LogLevel_2:
    title: LogLevel
    description: The verbosity level of an event.
    enum:
    - info
    - warning
    - error
    type: string
    x-ms-enum:
      name: LogLevel
      modelAsString: true
      values:
      - value: info
        description: This event is for information only.
      - value: warning
        description: This event represents a mitigated issue.
      - value: error
        description: This message represents a non recoverable issue.
  EventList:
    title: EventList
    description: Represents a list of events.
    type: object
    properties:
      object:
        $ref: '#/definitions/TypeDiscriminator'
      data:
        description: The list of items.
        type: array
        items:
          $ref: '#/definitions/Event'
        readOnly: true
  File_2:
    title: File
    description: A file is a document usable for training and validation. It can also be a service generated document with result details.
    required:
    - filename
    - purpose
    type: object
    properties:
      object:
        $ref: '#/definitions/TypeDiscriminator'
      status:
        $ref: '#/definitions/State_2'
      created_at:
        format: unixtime
        description: A timestamp when this job or item was created (in unix epochs).
        type: integer
        readOnly: true
      updated_at:
        format: unixtime
        description: A timestamp when this job or item was modified last (in unix epochs).
        type: integer
        readOnly: true
      id:
        description: The identity of this item.
        type: string
        readOnly: true
      bytes:
        format: int64
        description: "The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility\r\nwith JavaScript integers."
        type: integer
        readOnly: true
      purpose:
        $ref: '#/definitions/Purpose'
      filename:
        description: The name of the file.
        minLength: 1
        type: string
      statistics:
        $ref: '#/definitions/FileStatistics'
      error:
        $ref: '#/definitions/Error'
  TypeDiscriminator:
    title: TypeDiscriminator
    description: Defines the type of an object.
    enum:
    - list
    - fine-tune
    - file
    - fine-tune-event
    - model
    - deployment
    type: string
    readOnly: true
    x-ms-enum:
      name: TypeDiscriminator
      modelAsString: true
      values:
      - value: list
        description: This object represents a list of other objects.
      - value: fine-tune
        description: This object represents a fine tune job.
      - value: file
        description: This object represents a file.
      - value: fine-tune-event
        description: This object represents an event of a fine tune job.
      - value: model
        description: This object represents a model (can be a base models or fine tune job result).
      - value: deployment
        description: This object represents a deployment.
  State_2:
    title: State
    description: The state of a job or item.
    enum:
    - notRunning
    - running
    - succeeded
    - canceled
    - failed
    - deleted
    type: string
    readOnly: true
    x-ms-enum:
      name: State
      modelAsString: true
      values:
      - value: notRunning
        description: The operation was created and is not queued to be processed in the future.
      - value: running
        description: The operation has started to be processed.
      - value: succeeded
        description: The operation has successfully be processed and is ready for consumption.
      - value: canceled
        description: The operation has been canceled and is incomplete.
      - value: failed
        description: The operation has completed processing with a failure and cannot be further consumed.
      - value: deleted
        description: The entity has been deleted but may still be referenced by other entities predating the deletion.
  HyperParameters_3:
    title: HyperParameters
    description: The hyper parameter settings used in a fine tune job.
    type: object
    properties:
      batch_size:
        format: int32
        description: "The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model."
        type: integer
      learning_rate_multiplier:
        format: double
        description: "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results."
        type: number
      n_epochs:
        format: int32
        description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.
        type: integer
      prompt_loss_weight:
        format: double
        description: "The weight to use for loss on the prompt tokens. This controls how much the model tries to learn to generate the prompt\r\n(as compared to the completion which always has a weight of 1.0), and can add a stabilizing effect to training when completions are short.\r\nIf prompts are extremely long (relative to completions), it may make sense to reduce this weight so as to avoid over-prioritizing learning the prompt."
        type: number
      compute_classification_metrics:
        description: "A value indicating whether to compute classification metrics.\r\nIf set, we calculate classification-specific metrics such as accuracy and F-1 score using the validation set at the end of every epoch.\r\nThese metrics can be viewed in the results file. In order to compute classification metrics, you must provide a validation_file.Additionally,\r\nyou must specify classification_n_classes for multiclass classification or classification_positive_class for binary classification."
        type: boolean
      classification_n_classes:
        format: int32
        description: "The number of classes in a classification task.\r\nThis parameter is required for multiclass classification."
        type: integer
      classification_positive_class:
        description: "The positive class in binary classification.\r\nThis parameter is needed to generate precision, recall, and F1 metrics when doing binary classification."
        type: string
      classification_betas:
        description: "The classification beta values. If this is provided, we calculate F-beta scores at the specified beta values.\r\nThe F-beta score is a generalization of F-1 score. This is only used for binary classification.\r\nWith a beta of 1 (i.e.the F-1 score), precision and recall are given the same weight.\r\nA larger beta score puts more weight on recall and less on precision. A smaller beta score puts more weight on precision and less on recall."
        type: array
        items:
          format: double
          type: number
  Error:
    title: Error
    description: "Error content as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)."
    required:
    - code
    - message
    type: object
    properties:
      code:
        $ref: '#/definitions/ErrorCode'
      message:
        description: The message of this error.
        minLength: 1
        type: string
      target:
        description: The location where the error happened if available.
        type: string
      details:
        description: The error details if available.
        type: array
        items:
          $ref: '#/defi

# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-fine-tunes-api-openapi.yml