Microsoft Azure Fine-Tuning: API

openapi: 3.2.0
info:
  title: Microsoft Azure Azure OpenAI API version 2023-10-01-preview…
  description: APIs for fine-tuning and managing deployments of OpenAI models.
  version: 2023-10-01-preview
security:
- api-key: []
tags:
- name: Fine Tuning
paths:
  /fine_tuning/jobs:
    get:
      tags:
      - Fine Tuning
      summary: Microsoft Azure Gets A List Of All Fine Tune Jobs Owned By The Azure Openai…
      operationId: microsoftAzureFinetuningList
      parameters:
      - in: query
        name: after
        description: Identifier for the last event from the previous pagination request.
        schema:
          type: string
      - in: query
        name: limit
        description: Number of events to retrieve. Defaults to 20.
        schema:
          type: integer
          format: int32
          default: 20
      - $ref: '#/components/parameters/apiVersionQueryParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FineTuningJobList'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Getting all fine tune jobs owned by this account.:
          $ref: ./examples/get_finetuning_jobs.json
      description: Needs a more full description created.
    post:
      tags:
      - Fine Tuning
      summary: Microsoft Azure Creates A Job That Fine Tunes A Specified Model From A Given…
      operationId: microsoftAzureFinetuningCreate
      parameters:
      - $ref: '#/components/parameters/apiVersionQueryParameter'
      responses:
        '201':
          description: The fine tune has been successfully created.
          headers:
            Location:
              description: The location of the newly created item.
              schema:
                type: string
                format: url
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FineTuningJob'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Creating a fine tune job.:
          $ref: ./examples/post_finetuning_job.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FineTuningJobCreation'
        description: 'The specification of the fine-tuned model to create.

          Required parameters are the base model and the training file to use.

          Optionally a validation file can be specified to compute validation metrics during training.

          Hyper parameters will be set to default values or can by optionally specified.

          These include batch size, learning rate multiplier, number of epochs and others.'
        required: true
  /fine_tuning/jobs/{fine-tuning-job-id}:
    get:
      tags:
      - Fine Tuning
      summary: Microsoft Azure Gets Details For A Single Fine Tune Job Specified By The Given…
      operationId: microsoftAzureFinetuningGet
      parameters:
      - in: path
        name: fine-tuning-job-id
        description: The identifier of the fine-tune job.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/apiVersionQueryParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FineTuningJob'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Getting a fine tune job.:
          $ref: ./examples/get_finetuning_job.json
      description: Needs a more full description created.
    delete:
      tags:
      - Fine Tuning
      summary: Microsoft Azure Deletes The Fine Tune Job Specified By The Given Fine Tune Id
      operationId: microsoftAzureFinetuningDelete
      parameters:
      - in: path
        name: fine-tuning-job-id
        description: The identifier of the fine-tune job.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/apiVersionQueryParameter'
      responses:
        '204':
          description: The fine tune was successfully deleted.
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Deleting a fine tune job.:
          $ref: ./examples/delete_finetuning_job.json
      description: Needs a more full description created.
  /fine_tuning/jobs/{fine-tuning-job-id}/events:
    get:
      tags:
      - Fine Tuning
      summary: Microsoft Azure Gets The Events For The Fine Tune Job Specified By The Given…
      operationId: microsoftAzureFinetuningGetevents
      parameters:
      - in: path
        name: fine-tuning-job-id
        description: The identifier of the fine-tune job.
        required: true
        schema:
          type: string
      - in: query
        name: after
        description: Identifier for the last event from the previous pagination request.
        schema:
          type: string
      - in: query
        name: limit
        description: Number of events to retrieve. Defaults to 20.
        schema:
          type: integer
          format: int32
          default: 20
      - $ref: '#/components/parameters/apiVersionQueryParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FineTuningJobEventList'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Getting events of a fine tune job.:
          $ref: ./examples/get_finetuning_job_events.json
      description: Needs a more full description created.
  /fine_tuning/jobs/{fine-tuning-job-id}/cancel:
    post:
      tags:
      - Fine Tuning
      summary: Microsoft Azure Cancels The Processing Of The Fine Tune Job Specified By The…
      operationId: microsoftAzureFinetuningCancel
      parameters:
      - in: path
        name: fine-tuning-job-id
        description: The identifier of the fine-tune job.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/apiVersionQueryParameter'
      responses:
        '200':
          description: The fine tune has been successfully canceled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FineTuningJob'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Canceling a fine tune job.:
          $ref: ./examples/cancel_finetuning_job.json
      description: Needs a more full description created.
components:
  schemas:
    FineTuningJob:
      title: FineTuningJob
      description: Defines the values of a fine tune job.
      required:
      - model
      - training_file
      type: object
      properties:
        object:
          $ref: '#/components/schemas/TypeDiscriminator'
        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
        status:
          $ref: '#/components/schemas/FineTuningState'
        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.

            Use this identifier to create a deployment for inferencing.'
          type: string
        training_file:
          description: The file which is used for training.
          minLength: 1
          type: string
        validation_file:
          description: The file which is used to evaluate the fine tuned model during training.
          type: string
        result_files:
          description: 'The result file identities (file-id) containing training and evaluation metrics in csv format.

            The file is only available for successfully completed fine-tune runs.'
          type: array
          items:
            type: string
        finished_at:
          format: int32
          description: A timestamp when this job or item has finished successfully (in unix epochs).
          type: integer
          readOnly: true
        organisation_id:
          description: The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only.
          type: string
        trained_tokens:
          format: int32
          description: The total number of billable tokens processed by this fine tuning job.
          type: integer
          readOnly: true
        hyperparameters:
          $ref: '#/components/schemas/FineTuningHyperParameters'
        suffix:
          description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name.
          type: string
    FineTuningJobCreation:
      title: FineTuningJobCreation
      description: Defines the values of a fine tune job.
      required:
      - model
      - training_file
      type: object
      properties:
        model:
          description: The identifier (model-id) of the base model used for this fine-tune.
          minLength: 1
          type: string
        training_file:
          description: The file identity (file-id) that is used for training this fine tuned model.
          minLength: 1
          type: string
        validation_file:
          description: The file identity (file-id) that is used to evaluate the fine tuned model during training.
          type: string
        hyperparameters:
          $ref: '#/components/schemas/FineTuningHyperParameters'
        suffix:
          description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name.
          type: string
    TypeDiscriminator:
      title: TypeDiscriminator
      description: Defines the type of an object.
      enum:
      - list
      - fine-tune
      - fine_tuning.job
      - file
      - fine-tune-event
      - fine_tuning.job.event
      - model
      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: fine_tuning.job
          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: fine_tuning.job.event
          description: This object represents an event of a fine tuning job.
        - value: model
          description: This object represents a model (can be a base model or fine tune job result).
    InnerErrorCode:
      title: InnerErrorCode
      description: 'Inner error codes as defined in the Microsoft REST guidelines

        (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).'
      enum:
      - invalidPayload
      type: string
      x-ms-enum:
        name: InnerErrorCode
        modelAsString: true
        values:
        - value: invalidPayload
          description: The request data is invalid for this operation.
    Error:
      title: Error
      description: 'Error content as defined in the Microsoft REST guidelines

        (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).'
      required:
      - code
      - message
      type: object
      properties:
        code:
          $ref: '#/components/schemas/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: '#/components/schemas/Error'
        innererror:
          $ref: '#/components/schemas/InnerError'
      readOnly: true
    FineTuningHyperParameters:
      title: FineTuningHyperParameters
      description: The hyper parameter settings used in a fine tune job.
      type: object
      properties:
        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
        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.

            In general, we''ve found that larger batch sizes tend to work better for larger datasets.

            The 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.

            Larger learning rates tend to perform better with larger batch sizes.

            We recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results.'
          type: number
    ErrorCode:
      title: ErrorCode
      description: 'Error codes as defined in the Microsoft REST guidelines

        (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).'
      enum:
      - conflict
      - invalidPayload
      - forbidden
      - notFound
      - unexpectedEntityState
      - itemDoesAlreadyExist
      - serviceUnavailable
      - internalFailure
      - quotaExceeded
      - jsonlValidationFailed
      - fileImportFailed
      - tooManyRequests
      - unauthorized
      - contentFilter
      type: string
      x-ms-enum:
        name: ErrorCode
        modelAsString: true
        values:
        - value: conflict
          description: The requested operation conflicts with the current resource state.
        - value: invalidPayload
          description: The request data is invalid for this operation.
        - value: forbidden
          description: The operation is forbidden for the current user/api key.
        - value: notFound
          description: The resource is not found.
        - value: unexpectedEntityState
          description: The operation cannot be executed in the current resource's state.
        - value: itemDoesAlreadyExist
          description: The item does already exist.
        - value: serviceUnavailable
          description: The service is currently not available.
        - value: internalFailure
          description: Internal error. Please retry.
        - value: quotaExceeded
          description: Quota exceeded.
        - value: jsonlValidationFailed
          description: Validation of jsonl data failed.
        - value: fileImportFailed
          description: Import of file failed.
        - value: tooManyRequests
          description: Too many requests. Please retry later.
        - value: unauthorized
          description: The current user/api key is not authorized for the operation.
        - value: contentFilter
          description: Image generation failed as a result of our safety system.
    FineTuningJobEvent:
      title: FineTuningJobEvent
      required:
      - created_at
      - level
      - message
      - type
      type: object
      properties:
        object:
          $ref: '#/components/schemas/TypeDiscriminator'
        id:
          description: The identity of this event.
          type: string
          readOnly: true
        created_at:
          format: unixtime
          description: A timestamp when this event was created (in unix epochs).
          type: integer
        level:
          $ref: '#/components/schemas/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.
          minLength: 1
          type: string
        type:
          $ref: '#/components/schemas/EventType'
        data:
          description: Machine readable data of this event.
    FineTuningState:
      title: FineTuningState
      description: The state of a finetunes object or fine tuning job.
      enum:
      - created
      - pending
      - running
      - succeeded
      - cancelled
      - failed
      type: string
      readOnly: true
      x-ms-enum:
        name: FineTuningState
        modelAsString: true
        values:
        - value: created
          description: The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state.
        - value: pending
          description: The operation is not yet queued to be processed in the future. It can be categorized as an inactive state.
        - value: running
          description: The operation has started to be processed. It can be categorized as an active state.
        - value: succeeded
          description: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state.
        - value: cancelled
          description: The operation has been cancelled and is incomplete. It can be categorized as a terminal state.
        - value: failed
          description: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state.
    InnerError:
      title: InnerError
      description: 'Inner error as defined in the Microsoft REST guidelines

        (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).'
      type: object
      properties:
        code:
          $ref: '#/components/schemas/InnerErrorCode'
        innererror:
          $ref: '#/components/schemas/InnerError'
    FineTuningJobList:
      title: FineTuningJobList
      description: Represents a list of fine tunes.
      type: object
      properties:
        object:
          $ref: '#/components/schemas/TypeDiscriminator'
        data:
          description: The list of items.
          type: array
          items:
            $ref: '#/components/schemas/FineTuningJob'
        has_more:
          description: A value indicating whether the list of events contains more elements than returned.
          type: boolean
    EventType:
      title: EventType
      description: Defines the severity of a content filter result.
      enum:
      - message
      - metrics
      type: string
      x-ms-enum:
        name: EventType
        modelAsString: true
        values:
        - value: message
          description: Event only contains human readable messages.
        - value: metrics
          description: Event contains metrics.
    FineTuningJobEventList:
      title: FineTuningJobEventList
      description: Represents a list of events.
      type: object
      properties:
        object:
          $ref: '#/components/schemas/TypeDiscriminator'
        data:
          description: The list of items.
          type: array
          items:
            $ref: '#/components/schemas/FineTuningJobEvent'
        has_more:
          description: A value indicating whether the list of events contains more elements than returned.
          type: boolean
    ErrorResponse:
      title: ErrorResponse
      description: 'Error response as defined in the Microsoft REST guidelines

        (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).'
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Error'
    LogLevel:
      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.
  parameters:
    apiVersionQueryParameter:
      in: query
      name: api-version
      description: The requested API version.
      required: true
      x-ms-client-default: 2023-10-01-preview
      x-ms-parameter-location: client
      schema:
        type: string
  securitySchemes:
    api-key:
      type: apiKey
      name: api-key
      in: header
      description: Provide your Cognitive Services Azure OpenAI account key here.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}/openai'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/endpoint'