specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/azureopenai.yaml [139:1181]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  /files:
    get:
      tags:
        - "Files:"
      summary: "Gets a list of all files owned by the Azure OpenAI resource.\r\nThese include user uploaded content like files with purpose \"fine-tune\" for training or validation of fine-tunes models\r\nas well as files that are generated by the service such as \"fine-tune-results\" which contains various metrics for the corresponding fine-tune job."
      operationId: Files_List
      produces:
        - application/json
      parameters:
        - in: query
          name: purpose
          description: Only return files with the given purpose.
          type: string
          enum:
            - fine-tune
            - fine-tune-results
            - assistants
            - assistants_output
            - batch
            - batch_output
          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.
              - value: assistants
                description: This file contains data to be used in assistants.
              - value: assistants_output
                description: This file contains the results of an assistant.
              - value: batch
                description: This file contains the input data for a batch.
              - value: batch_output
                description: This file contains the results of a batch.
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/FileList"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting all files owned by this account.:
          $ref: ./examples/get_files.yaml
    post:
      tags:
        - "Files:"
      summary: Creates a new file entity by uploading data from a local machine. Uploaded files can, for example, be used for training or evaluating fine-tuned models.
      operationId: Files_Upload
      consumes:
        - multipart/form-data
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: formData
          name: 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.
          required: true
          type: string
          enum:
            - fine-tune
            - fine-tune-results
            - assistants
            - assistants_output
            - batch
          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.
              - value: assistants
                description: This file contains data to be used in assistants.
              - value: assistants_output
                description: This file contains the results of an assistant.
              - value: batch
                description: This file contains the input data for a batch.
        - in: formData
          name: file
          description: Gets or sets the file to upload into Azure OpenAI.
          required: true
          type: file
      responses:
        "201":
          description: The file has been successfully created.
          schema:
            $ref: "#/definitions/File"
          headers:
            Location:
              description: The location of the newly created item.
              type: string
              format: url
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Upload a file.:
          $ref: ./examples/upload_file.yaml
  /files/import:
    post:
      tags:
        - "Files:"
      summary: Creates a new file entity by importing data from a provided url. Uploaded files can, for example, be used for training or evaluating fine-tuned models.
      operationId: Files_Import
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: body
          name: fileImport
          description: The definition of the file to create including its purpose, the file name and the url of the file location.
          required: true
          schema:
            $ref: "#/definitions/FileImport"
      responses:
        "201":
          description: The file has been successfully created.
          schema:
            $ref: "#/definitions/File"
          headers:
            Location:
              description: The location of the newly created item.
              type: string
              format: url
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Importing a file with a blob url as source.:
          $ref: ./examples/import_file.yaml
  /files/{file-id}:
    get:
      tags:
        - "Files:"
      summary: Gets details for a single file specified by the given file-id including status, size, purpose, etc.
      operationId: Files_Get
      produces:
        - application/json
      parameters:
        - in: path
          name: file-id
          description: The identifier of the file.
          required: true
          type: string
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/File"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting a file.:
          $ref: ./examples/get_file.yaml
    delete:
      tags:
        - "Files:"
      summary: "Deletes the file with the given file-id.\r\nDeletion is also allowed if a file was used, e.g., as training file in a fine-tune job."
      operationId: Files_Delete
      produces:
        - application/json
      parameters:
        - in: path
          name: file-id
          description: The identifier of the file.
          required: true
          type: string
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: The file was successfully deleted.
          schema:
            $ref: '#/definitions/FileDelete'
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Deleting a file.:
          $ref: ./examples/delete_file.yaml
  /files/{file-id}/content:
    get:
      tags:
        - "Files:"
      summary: "Gets the content of the file specified by the given file-id.\r\nFiles can be user uploaded content or generated by the service like result metrics of a fine-tune job."
      operationId: Files_GetContent
      produces:
        - application/octet-stream
        - application/json
      parameters:
        - in: path
          name: file-id
          description: The identifier of the file.
          required: true
          type: string
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            type: file
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting the file content.:
          $ref: ./examples/get_file_content.yaml
  /fine_tuning/jobs:
    get:
      tags:
        - "Fine-tuning:"
      summary: "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: FineTuning_List
      produces:
        - application/json
      parameters:
        - in: query
          name: after
          description: Identifier for the last event from the previous pagination request.
          type: string
        - in: query
          name: limit
          description: Number of events to retrieve. Defaults to 20.
          type: integer
          format: int32
          default: 20
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/FineTuningJobList"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting all fine tuning jobs owned by this account.:
          $ref: ./examples/get_finetuning_jobs.yaml
    post:
      tags:
        - "Fine-tuning:"
      summary: "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: FineTuning_Create
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: body
          name: fineTuningJob
          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 be optionally specified.\r\nThese include batch size, learning rate multiplier, number of epochs and others."
          required: true
          schema:
            $ref: "#/definitions/FineTuningJobCreation"
      responses:
        "201":
          description: The fine tune has been successfully created.
          schema:
            $ref: "#/definitions/FineTuningJob"
          headers:
            Location:
              description: The location of the newly created item.
              type: string
              format: url
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Creating a fine tuning job.:
          $ref: ./examples/post_finetuning_job.yaml
  /fine_tuning/jobs/{fine-tuning-job-id}:
    get:
      tags:
        - "Fine-tuning:"
      summary: "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: FineTuning_Get
      produces:
        - application/json
      parameters:
        - in: path
          name: fine-tuning-job-id
          description: The identifier of the fine-tune job.
          required: true
          type: string
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/FineTuningJob"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting a fine tuning job.:
          $ref: ./examples/get_finetuning_job.yaml
    delete:
      tags:
        - "Fine-tuning:"
      summary: Deletes the fine-tune job specified by the given fine-tune-id.
      operationId: FineTuning_Delete
      produces:
        - application/json
      parameters:
        - in: path
          name: fine-tuning-job-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 tuning job.:
          $ref: ./examples/delete_finetuning_job.yaml
  /fine_tuning/jobs/{fine-tuning-job-id}/cancel:
    post:
      tags:
        - "Fine-tuning:"
      summary: Cancels the processing of the fine-tune job specified by the given fine-tune-id.
      operationId: FineTuning_Cancel
      produces:
        - application/json
      parameters:
        - in: path
          name: fine-tuning-job-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/FineTuningJob"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Canceling a fine tuning job.:
          $ref: ./examples/cancel_finetuning_job.yaml
  /fine_tuning/jobs/{fine-tuning-job-id}/checkpoints:
    get:
      tags:
        - "Fine-tuning:"
      summary: "Gets the checkpoints for the fine-tune job specified by the given fine-tune-id.\r\nCheckpoints are created at the end of successful epochs during training."
      operationId: FineTuning_GetCheckpoints
      produces:
        - application/json
      parameters:
        - in: path
          name: fine-tuning-job-id
          description: The identifier of the fine-tune job.
          required: true
          type: string
        - in: query
          name: after
          description: Identifier for the last checkpoint ID from the previous pagination request.
          type: string
        - in: query
          name: limit
          description: Number of checkpoints to retrieve. Defaults to 10.
          type: integer
          format: int32
          default: 10
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/FineTuningJobCheckpointList"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting checkpoints of a fine tuning job.:
          $ref: ./examples/get_finetuning_job_checkpoints.yaml
  /fine_tuning/jobs/{fine-tuning-job-id}/events:
    get:
      tags:
        - "Fine-tuning:"
      summary: "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: FineTuning_GetEvents
      produces:
        - application/json
      parameters:
        - in: path
          name: fine-tuning-job-id
          description: The identifier of the fine-tune job.
          required: true
          type: string
        - in: query
          name: after
          description: Identifier for the last event from the previous pagination request.
          type: string
        - in: query
          name: limit
          description: Number of events to retrieve. Defaults to 20.
          type: integer
          format: int32
          default: 20
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/FineTuningJobEventList"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting events of a fine tuning job.:
          $ref: ./examples/get_finetuning_job_events.yaml
  /ingestion/jobs:
    get:
      tags:
        - "Ingestion:"
      summary: Lists the ingestion jobs.
      operationId: IngestionJobs_List
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: header
          name: mgmt-user-token
          type: string
          description: The token used to access the workspace (needed only for user compute jobs).
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/IngestionJobList"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        List all ingestion jobs:
          $ref: ./examples/list_ingestion_jobs.json
  /ingestion/jobs/{job-id}:
    put:
      tags:
        - "Ingestion:"
      summary: Creates an ingestion job with the specified job id.
      operationId: IngestionJobs_Create
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: path
          name: job-id
          required: true
          type: string
          description: The id of the job that will be created.
        - in: header
          name: mgmt-user-token
          type: string
          description: The token used to access the workspace (needed only for user compute jobs).
        - in: header
          name: aml-user-token
          type: string
          description: The token used to access the resources within the job in the workspace (needed only for user compute jobs).
        - in: body
          name: ingestionJob
          schema:
            $ref: "#/definitions/IngestionJob"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/IngestionJob"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Create a system-compute ingestion job:
          $ref: ./examples/put_ingestion_job_sc.json
        Create a user-compute ingestion job:
          $ref: ./examples/put_ingestion_job_uc.json
    get:
      tags:
        - "Ingestion:"
      summary: Gets the details of the specified job id.
      operationId: IngestionJobs_Get
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: path
          name: job-id
          required: true
          description: The id of the job.
          type: string
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/IngestionJob"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Get ingestion job:
          $ref: ./examples/get_ingestion_job.json
  /ingestion/jobs/{job-id}/runs:
    get:
      tags:
        - "Ingestion:"
      summary: Lists the runs of the specified job id.
      operationId: IngestionJobRuns_List
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: path
          name: job-id
          required: true
          description: The id of the job.
          type: string
        - in: header
          name: mgmt-user-token
          type: string
          description: The token used to access the workspace (needed only for user compute jobs).
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/IngestionJobRunList"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        List ingestion job runs:
          $ref: ./examples/list_ingestion_job_runs.json
  /ingestion/jobs/{job-id}/runs/{run-id}:
    get:
      tags:
        - "Ingestion:"
      summary: Gets the details of the specified run id as part of the specified job id.
      operationId: IngestionJobRuns_Get
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: path
          name: job-id
          required: true
          description: The id of the job.
          type: string
        - in: path
          name: run-id
          required: true
          description: The id of the run.
          type: string
        - in: header
          name: mgmt-user-token
          type: string
          description: The token used to access the workspace (needed only for user compute jobs).
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/IngestionJobRun"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Get ingestion job runs:
          $ref: ./examples/get_ingestion_job_run.json
  /models:
    get:
      tags:
        - "Models:"
      summary: "Gets a list of all models that are accessible by the Azure OpenAI resource.\r\nThese include base models as well as all successfully completed fine-tuned models owned by the Azure OpenAI resource."
      operationId: Models_List
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/ModelList"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting all models owned by account.:
          $ref: ./examples/get_models.yaml
  /models/{model-id}:
    get:
      tags:
        - "Models:"
      summary: Gets details for the model specified by the given modelId.
      operationId: Models_Get
      produces:
        - application/json
      parameters:
        - in: path
          name: model-id
          description: The identifier of the model.
          required: true
          type: string
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/Model"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting a base model.:
          $ref: ./examples/get_model_base.yaml
        Getting a fine-tuned model.:
          $ref: ./examples/get_model_finetune.yaml
  /uploads:
    post:
      tags:
        - "UploadFile:"
      summary: "An intermediate Upload object is created, allowing you to add Parts to it. Currently, an Upload size can be a maximum of 9 GB in total and will expire two hours after being created.\r\nAfter the Upload is completed a File object will be generated, containing all the uploaded parts. This File object can then be used across our platform just like any other file."
      operationId: UploadFile_Start
      consumes:
        - application/json
        - text/json
        - application/*+json
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: body
          name: requestBody
          description: The definition of the file to create including its purpose and the location on the local machine.
          required: true
          schema:
            $ref: "#/definitions/UploadFileStartBody"
      responses:
        "200":
          description: The upload has been successfully created.
          schema:
            $ref: "#/definitions/UploadResource"
          headers:
            Location:
              description: The location of the newly created item.
              type: string
              format: url
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Start a large file upload operation.:
          $ref: ./examples/upload_file_start.yaml
  /uploads/{upload-id}/cancel:
    post:
      tags:
        - "UploadFile:"
      summary: "Cancels the Upload, and will lead to all uploaded parts to be deleted asynchronously.\r\nNo Parts may be added after an Upload is cancelled."
      operationId: UploadFile_Cancel
      produces:
        - application/json
      parameters:
        - in: path
          name: upload-id
          description: The identifier of the upload.
          required: true
          type: string
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/UploadResource"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Cancel a large file upload operation.:
          $ref: ./examples/upload_file_cancel.yaml
  /uploads/{upload-id}/complete:
    post:
      tags:
        - "UploadFile:"
      summary: "This completes the Upload, and the returned Upload object contains a nested File object that is ready for use across the platform.\r\nYou can define the order of the Parts by providing an ordered list of Part IDs.\r\nThe total number of bytes uploaded must match the size originally specified when creating the Upload object.\r\nAfter this operation no additional Parts can be added once the Upload is completed."
      operationId: UploadFile_Complete
      consumes:
        - application/json
        - text/json
        - application/*+json
      produces:
        - application/json
      parameters:
        - in: path
          name: upload-id
          description: The identifier of the upload.
          required: true
          type: string
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: body
          name: requestBody
          description: The definition of the file to create including its purpose and the location on the local machine.
          required: true
          schema:
            $ref: "#/definitions/UploadFileCompleteBody"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/UploadResource"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Complete and validate a large file upload operation.:
          $ref: ./examples/upload_file_complete.yaml
  /uploads/{upload-id}/parts:
    post:
      tags:
        - "UploadFile:"
      summary: "Adds a Part to an Upload object, where each Part represents a segment of the file you are uploading.\r\nEach Part can be up to the standard size limit for file upload, based on the File Purpose. You can continue adding Parts until reaching the Upload size limit of 9 GB."
      operationId: UploadFile_Part
      consumes:
        - multipart/form-data
      produces:
        - application/json
      parameters:
        - in: path
          name: upload-id
          description: The identifier of the upload.
          required: true
          type: string
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: formData
          name: data
          required: true
          type: file
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/UploadPartResource"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Upload a part of large file upload operation.:
          $ref: ./examples/upload_file_part.yaml
definitions:
  AzureAISearchIndex:
    description: Azure AI Search Index.
    required:
      - connectionId
    allOf:
      - $ref: "#/definitions/TargetIndex"
      - type: object
        properties:
          connectionId:
            type: string
            description: The id of the connection pointing to the Azure AI Search Index.
    x-ms-discriminator-value: AzureAISearch
  BaseConnection:
    title: BaseConnection
    description: A connection to a resource.
    type: object
    required:
      - kind
    properties:
      kind:
        $ref: "#/definitions/ConnectionType"
    discriminator: kind
  Batch:
    title: Batch
    description: Defines the values of a batch.
    required:
      - id
      - input_file_id
    type: object
    properties:
      id:
        description: The identity of this item.
        type: string
      object:
        $ref: "#/definitions/TypeDiscriminator"
      endpoint:
        description: The API endpoint used by the batch.
        type: string
        readOnly: true
      errors:
        $ref: "#/definitions/BatchErrors"
      input_file_id:
        description: The ID of the input file for the batch.
        minLength: 1
        type: string
      completion_window:
        description: The time frame within which the batch should be processed.
        type: string
      status:
        $ref: "#/definitions/BatchStatus"
      output_file_id:
        description: The ID of the file containing outputs of successfully executed requests.
        type: string
      error_file_id:
        description: The ID of the file containing outputs of requests with errors.
        type: string
      created_at:
        format: unixtime
        description: A timestamp when this batch was created (in unix epochs).
        type: integer
        readOnly: true
      in_progress_at:
        format: unixtime
        description: A timestamp when this batch started progressing (in unix epochs).
        type: integer
        readOnly: true
      expires_at:
        format: unixtime
        description: A timestamp when this batch will expire (in unix epochs).
        type: integer
        readOnly: true
      finalizing_at:
        format: unixtime
        description: A timestamp when this batch started finalizing (in unix epochs).
        type: integer
        readOnly: true
      completed_at:
        format: unixtime
        description: A timestamp when this batch was completed (in unix epochs).
        type: integer
        readOnly: true
      failed_at:
        format: unixtime
        description: A timestamp when this batch failed (in unix epochs).
        type: integer
        readOnly: true
      expired_at:
        format: unixtime
        description: A timestamp when this batch expired (in unix epochs).
        type: integer
        readOnly: true
      cancelling_at:
        format: unixtime
        description: A timestamp when this batch started cancelling (in unix epochs).
        type: integer
        readOnly: true
      cancelled_at:
        format: unixtime
        description: A timestamp when this batch was cancelled (in unix epochs).
        type: integer
        readOnly: true
      request_counts:
        $ref: "#/definitions/BatchRequestCounts"
      metadata:
        description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional infomration about the batch in a structured format.
        type: object
        additionalProperties:
          type: string
  BatchCreateRequest:
    title: BatchCreateRequest
    description: Defines the request to create a batch.
    required:
      - input_file_id
      - endpoint
      - completion_window
    type: object
    properties:
      input_file_id:
        description: The ID if the input file for the batch.
        minLength: 1
        type: string
      endpoint:
        description: The API endpoint used by the batch.
        type: string
      completion_window:
        description: The time frame within which the batch should be processed.
        type: string
      metadata:
        description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional infomration about the batch in a structured format.
        type: object
        additionalProperties:
          type: string
  BatchErrorData:
    title: BatchErrorData
    description: Error information for a failure in batch.
    type: object
    properties:
      code:
        description: An error code identifying the error type.
        type: string
      message:
        description: A human-readable message providing more details about the error.
        type: string
      param:
        description: The name of the parameter that caused the error, if applicable (can be null).
        type: string
      line:
        description: The line number of the input file where the error occurred, if applicable (can be null).
        type: string
  BatchErrors:
    title: BatchErrors
    description: For batches that have failed, this will contain more information on the cause of the failures.
    type: object
    properties:
      object:
        description: The type of the errors object. This is always 'list'.
        type: string
      data:
        $ref: "#/definitions/BatchErrorData"
  BatchRequestCounts:
    title: BatchRequestCounts
    description: The request counts for different statuses within the batch.
    type: object
    properties:
      total:
        description: The total number of requests in the batch.
        type: integer
      completed:
        description: The number of requests in the batch that have been completed successfully.
        type: integer
      failed:
        description: The number of requests in the batch that have failed.
        type: integer
  BatchStatus:
    title: BatchStatus
    description: The status of a batch.
    enum:
      - validating
      - failed
      - in_progress
      - finalizing
      - completed
      - expired
      - cancelling
      - cancelled
    type: string
    readOnly: true
    x-ms-enum:
      name: BatchStatus
      modelAsString: true
      values:
        - value: validating
          description: The input file is being validated before the batch can begin.
        - value: failed
          description: The input file has failed the validation process.
        - value: in_progress
          description: The input file was successfully validated and the batch is currently being executed.
        - value: finalizing
          description: The batch has completed and the results are being prepared.
        - value: completed
          description: The batch has been completed and the results are ready.
        - value: expired
          description: The batch was not able to complete within the 24-hour time window.
        - value: cancelling
          description: Cancellation of the batch has been initiated.
        - value: cancelled
          description: The batch was cancelled.
  BatchesList:
    title: BatchList
    description: Represents a list of batches.
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      data:
        description: The list of items.
        type: array
        items:
          $ref: "#/definitions/Batch"
      first_id:
        description: The id of the first batch in the list of batches returned.
        type: string
      last_id:
        description: The id of the last batch in the list of batches returned.
        type: string
      has_more:
        description: A value indicating whether the list contains more elements than returned.
        type: boolean
  Capabilities:
    title: Capabilities
    description: The capabilities of a base or fine tune model.
    required:
      - chat_completion
      - completion
      - embeddings
      - fine_tune
      - inference
    type: object
    properties:
      fine_tune:
        description: A value indicating whether a model can be used for fine tuning.
        type: boolean
      inference:
        description: A value indicating whether a model can be deployed.
        type: boolean
      completion:
        description: A value indicating whether a model supports completion.
        type: boolean
      chat_completion:
        description: A value indicating whether a model supports chat completion.
        type: boolean
      embeddings:
        description: A value indicating whether a model supports embeddings.
        type: boolean
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-02-01-preview/azureopenai.yaml [311:1353]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  /files:
    get:
      tags:
        - "Files:"
      summary: "Gets a list of all files owned by the Azure OpenAI resource.\r\nThese include user uploaded content like files with purpose \"fine-tune\" for training or validation of fine-tunes models\r\nas well as files that are generated by the service such as \"fine-tune-results\" which contains various metrics for the corresponding fine-tune job."
      operationId: Files_List
      produces:
        - application/json
      parameters:
        - in: query
          name: purpose
          description: Only return files with the given purpose.
          type: string
          enum:
            - fine-tune
            - fine-tune-results
            - assistants
            - assistants_output
            - batch
            - batch_output
          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.
              - value: assistants
                description: This file contains data to be used in assistants.
              - value: assistants_output
                description: This file contains the results of an assistant.
              - value: batch
                description: This file contains the input data for a batch.
              - value: batch_output
                description: This file contains the results of a batch.
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/FileList"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting all files owned by this account.:
          $ref: ./examples/get_files.yaml
    post:
      tags:
        - "Files:"
      summary: Creates a new file entity by uploading data from a local machine. Uploaded files can, for example, be used for training or evaluating fine-tuned models.
      operationId: Files_Upload
      consumes:
        - multipart/form-data
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: formData
          name: 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.
          required: true
          type: string
          enum:
            - fine-tune
            - fine-tune-results
            - assistants
            - assistants_output
            - batch
          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.
              - value: assistants
                description: This file contains data to be used in assistants.
              - value: assistants_output
                description: This file contains the results of an assistant.
              - value: batch
                description: This file contains the input data for a batch.
        - in: formData
          name: file
          description: Gets or sets the file to upload into Azure OpenAI.
          required: true
          type: file
      responses:
        "201":
          description: The file has been successfully created.
          schema:
            $ref: "#/definitions/File"
          headers:
            Location:
              description: The location of the newly created item.
              type: string
              format: url
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Upload a file.:
          $ref: ./examples/upload_file.yaml
  /files/import:
    post:
      tags:
        - "Files:"
      summary: Creates a new file entity by importing data from a provided url. Uploaded files can, for example, be used for training or evaluating fine-tuned models.
      operationId: Files_Import
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: body
          name: fileImport
          description: The definition of the file to create including its purpose, the file name and the url of the file location.
          required: true
          schema:
            $ref: "#/definitions/FileImport"
      responses:
        "201":
          description: The file has been successfully created.
          schema:
            $ref: "#/definitions/File"
          headers:
            Location:
              description: The location of the newly created item.
              type: string
              format: url
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Importing a file with a blob url as source.:
          $ref: ./examples/import_file.yaml
  /files/{file-id}:
    get:
      tags:
        - "Files:"
      summary: Gets details for a single file specified by the given file-id including status, size, purpose, etc.
      operationId: Files_Get
      produces:
        - application/json
      parameters:
        - in: path
          name: file-id
          description: The identifier of the file.
          required: true
          type: string
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/File"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting a file.:
          $ref: ./examples/get_file.yaml
    delete:
      tags:
        - "Files:"
      summary: "Deletes the file with the given file-id.\r\nDeletion is also allowed if a file was used, e.g., as training file in a fine-tune job."
      operationId: Files_Delete
      produces:
        - application/json
      parameters:
        - in: path
          name: file-id
          description: The identifier of the file.
          required: true
          type: string
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: The file was successfully deleted.
          schema:
            $ref: '#/definitions/FileDelete'
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Deleting a file.:
          $ref: ./examples/delete_file.yaml
  /files/{file-id}/content:
    get:
      tags:
        - "Files:"
      summary: "Gets the content of the file specified by the given file-id.\r\nFiles can be user uploaded content or generated by the service like result metrics of a fine-tune job."
      operationId: Files_GetContent
      produces:
        - application/octet-stream
        - application/json
      parameters:
        - in: path
          name: file-id
          description: The identifier of the file.
          required: true
          type: string
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            type: file
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting the file content.:
          $ref: ./examples/get_file_content.yaml
  /fine_tuning/jobs:
    get:
      tags:
        - "Fine-tuning:"
      summary: "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: FineTuning_List
      produces:
        - application/json
      parameters:
        - in: query
          name: after
          description: Identifier for the last event from the previous pagination request.
          type: string
        - in: query
          name: limit
          description: Number of events to retrieve. Defaults to 20.
          type: integer
          format: int32
          default: 20
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/FineTuningJobList"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting all fine tuning jobs owned by this account.:
          $ref: ./examples/get_finetuning_jobs.yaml
    post:
      tags:
        - "Fine-tuning:"
      summary: "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: FineTuning_Create
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: body
          name: fineTuningJob
          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 be optionally specified.\r\nThese include batch size, learning rate multiplier, number of epochs and others."
          required: true
          schema:
            $ref: "#/definitions/FineTuningJobCreation"
      responses:
        "201":
          description: The fine tune has been successfully created.
          schema:
            $ref: "#/definitions/FineTuningJob"
          headers:
            Location:
              description: The location of the newly created item.
              type: string
              format: url
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Creating a fine tuning job.:
          $ref: ./examples/post_finetuning_job.yaml
  /fine_tuning/jobs/{fine-tuning-job-id}:
    get:
      tags:
        - "Fine-tuning:"
      summary: "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: FineTuning_Get
      produces:
        - application/json
      parameters:
        - in: path
          name: fine-tuning-job-id
          description: The identifier of the fine-tune job.
          required: true
          type: string
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/FineTuningJob"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting a fine tuning job.:
          $ref: ./examples/get_finetuning_job.yaml
    delete:
      tags:
        - "Fine-tuning:"
      summary: Deletes the fine-tune job specified by the given fine-tune-id.
      operationId: FineTuning_Delete
      produces:
        - application/json
      parameters:
        - in: path
          name: fine-tuning-job-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 tuning job.:
          $ref: ./examples/delete_finetuning_job.yaml
  /fine_tuning/jobs/{fine-tuning-job-id}/cancel:
    post:
      tags:
        - "Fine-tuning:"
      summary: Cancels the processing of the fine-tune job specified by the given fine-tune-id.
      operationId: FineTuning_Cancel
      produces:
        - application/json
      parameters:
        - in: path
          name: fine-tuning-job-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/FineTuningJob"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Canceling a fine tuning job.:
          $ref: ./examples/cancel_finetuning_job.yaml
  /fine_tuning/jobs/{fine-tuning-job-id}/checkpoints:
    get:
      tags:
        - "Fine-tuning:"
      summary: "Gets the checkpoints for the fine-tune job specified by the given fine-tune-id.\r\nCheckpoints are created at the end of successful epochs during training."
      operationId: FineTuning_GetCheckpoints
      produces:
        - application/json
      parameters:
        - in: path
          name: fine-tuning-job-id
          description: The identifier of the fine-tune job.
          required: true
          type: string
        - in: query
          name: after
          description: Identifier for the last checkpoint ID from the previous pagination request.
          type: string
        - in: query
          name: limit
          description: Number of checkpoints to retrieve. Defaults to 10.
          type: integer
          format: int32
          default: 10
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/FineTuningJobCheckpointList"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting checkpoints of a fine tuning job.:
          $ref: ./examples/get_finetuning_job_checkpoints.yaml
  /fine_tuning/jobs/{fine-tuning-job-id}/events:
    get:
      tags:
        - "Fine-tuning:"
      summary: "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: FineTuning_GetEvents
      produces:
        - application/json
      parameters:
        - in: path
          name: fine-tuning-job-id
          description: The identifier of the fine-tune job.
          required: true
          type: string
        - in: query
          name: after
          description: Identifier for the last event from the previous pagination request.
          type: string
        - in: query
          name: limit
          description: Number of events to retrieve. Defaults to 20.
          type: integer
          format: int32
          default: 20
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/FineTuningJobEventList"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting events of a fine tuning job.:
          $ref: ./examples/get_finetuning_job_events.yaml
  /ingestion/jobs:
    get:
      tags:
        - "Ingestion:"
      summary: Lists the ingestion jobs.
      operationId: IngestionJobs_List
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: header
          name: mgmt-user-token
          type: string
          description: The token used to access the workspace (needed only for user compute jobs).
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/IngestionJobList"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        List all ingestion jobs:
          $ref: ./examples/list_ingestion_jobs.json
  /ingestion/jobs/{job-id}:
    put:
      tags:
        - "Ingestion:"
      summary: Creates an ingestion job with the specified job id.
      operationId: IngestionJobs_Create
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: path
          name: job-id
          required: true
          type: string
          description: The id of the job that will be created.
        - in: header
          name: mgmt-user-token
          type: string
          description: The token used to access the workspace (needed only for user compute jobs).
        - in: header
          name: aml-user-token
          type: string
          description: The token used to access the resources within the job in the workspace (needed only for user compute jobs).
        - in: body
          name: ingestionJob
          schema:
            $ref: "#/definitions/IngestionJob"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/IngestionJob"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Create a system-compute ingestion job:
          $ref: ./examples/put_ingestion_job_sc.json
        Create a user-compute ingestion job:
          $ref: ./examples/put_ingestion_job_uc.json
    get:
      tags:
        - "Ingestion:"
      summary: Gets the details of the specified job id.
      operationId: IngestionJobs_Get
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: path
          name: job-id
          required: true
          description: The id of the job.
          type: string
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/IngestionJob"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Get ingestion job:
          $ref: ./examples/get_ingestion_job.json
  /ingestion/jobs/{job-id}/runs:
    get:
      tags:
        - "Ingestion:"
      summary: Lists the runs of the specified job id.
      operationId: IngestionJobRuns_List
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: path
          name: job-id
          required: true
          description: The id of the job.
          type: string
        - in: header
          name: mgmt-user-token
          type: string
          description: The token used to access the workspace (needed only for user compute jobs).
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/IngestionJobRunList"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        List ingestion job runs:
          $ref: ./examples/list_ingestion_job_runs.json
  /ingestion/jobs/{job-id}/runs/{run-id}:
    get:
      tags:
        - "Ingestion:"
      summary: Gets the details of the specified run id as part of the specified job id.
      operationId: IngestionJobRuns_Get
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: path
          name: job-id
          required: true
          description: The id of the job.
          type: string
        - in: path
          name: run-id
          required: true
          description: The id of the run.
          type: string
        - in: header
          name: mgmt-user-token
          type: string
          description: The token used to access the workspace (needed only for user compute jobs).
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/IngestionJobRun"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Get ingestion job runs:
          $ref: ./examples/get_ingestion_job_run.json
  /models:
    get:
      tags:
        - "Models:"
      summary: "Gets a list of all models that are accessible by the Azure OpenAI resource.\r\nThese include base models as well as all successfully completed fine-tuned models owned by the Azure OpenAI resource."
      operationId: Models_List
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/ModelList"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting all models owned by account.:
          $ref: ./examples/get_models.yaml
  /models/{model-id}:
    get:
      tags:
        - "Models:"
      summary: Gets details for the model specified by the given modelId.
      operationId: Models_Get
      produces:
        - application/json
      parameters:
        - in: path
          name: model-id
          description: The identifier of the model.
          required: true
          type: string
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/Model"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Getting a base model.:
          $ref: ./examples/get_model_base.yaml
        Getting a fine-tuned model.:
          $ref: ./examples/get_model_finetune.yaml
  /uploads:
    post:
      tags:
        - "UploadFile:"
      summary: "An intermediate Upload object is created, allowing you to add Parts to it. Currently, an Upload size can be a maximum of 9 GB in total and will expire two hours after being created.\r\nAfter the Upload is completed a File object will be generated, containing all the uploaded parts. This File object can then be used across our platform just like any other file."
      operationId: UploadFile_Start
      consumes:
        - application/json
        - text/json
        - application/*+json
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: body
          name: requestBody
          description: The definition of the file to create including its purpose and the location on the local machine.
          required: true
          schema:
            $ref: "#/definitions/UploadFileStartBody"
      responses:
        "200":
          description: The upload has been successfully created.
          schema:
            $ref: "#/definitions/UploadResource"
          headers:
            Location:
              description: The location of the newly created item.
              type: string
              format: url
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Start a large file upload operation.:
          $ref: ./examples/upload_file_start.yaml
  /uploads/{upload-id}/cancel:
    post:
      tags:
        - "UploadFile:"
      summary: "Cancels the Upload, and will lead to all uploaded parts to be deleted asynchronously.\r\nNo Parts may be added after an Upload is cancelled."
      operationId: UploadFile_Cancel
      produces:
        - application/json
      parameters:
        - in: path
          name: upload-id
          description: The identifier of the upload.
          required: true
          type: string
        - $ref: "#/parameters/apiVersionQueryParameter"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/UploadResource"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Cancel a large file upload operation.:
          $ref: ./examples/upload_file_cancel.yaml
  /uploads/{upload-id}/complete:
    post:
      tags:
        - "UploadFile:"
      summary: "This completes the Upload, and the returned Upload object contains a nested File object that is ready for use across the platform.\r\nYou can define the order of the Parts by providing an ordered list of Part IDs.\r\nThe total number of bytes uploaded must match the size originally specified when creating the Upload object.\r\nAfter this operation no additional Parts can be added once the Upload is completed."
      operationId: UploadFile_Complete
      consumes:
        - application/json
        - text/json
        - application/*+json
      produces:
        - application/json
      parameters:
        - in: path
          name: upload-id
          description: The identifier of the upload.
          required: true
          type: string
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: body
          name: requestBody
          description: The definition of the file to create including its purpose and the location on the local machine.
          required: true
          schema:
            $ref: "#/definitions/UploadFileCompleteBody"
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/UploadResource"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Complete and validate a large file upload operation.:
          $ref: ./examples/upload_file_complete.yaml
  /uploads/{upload-id}/parts:
    post:
      tags:
        - "UploadFile:"
      summary: "Adds a Part to an Upload object, where each Part represents a segment of the file you are uploading.\r\nEach Part can be up to the standard size limit for file upload, based on the File Purpose. You can continue adding Parts until reaching the Upload size limit of 9 GB."
      operationId: UploadFile_Part
      consumes:
        - multipart/form-data
      produces:
        - application/json
      parameters:
        - in: path
          name: upload-id
          description: The identifier of the upload.
          required: true
          type: string
        - $ref: "#/parameters/apiVersionQueryParameter"
        - in: formData
          name: data
          required: true
          type: file
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/UploadPartResource"
        default:
          description: An error occurred.
          schema:
            $ref: "#/definitions/ErrorResponse"
      x-ms-examples:
        Upload a part of large file upload operation.:
          $ref: ./examples/upload_file_part.yaml
definitions:
  AzureAISearchIndex:
    description: Azure AI Search Index.
    required:
      - connectionId
    allOf:
      - $ref: "#/definitions/TargetIndex"
      - type: object
        properties:
          connectionId:
            type: string
            description: The id of the connection pointing to the Azure AI Search Index.
    x-ms-discriminator-value: AzureAISearch
  BaseConnection:
    title: BaseConnection
    description: A connection to a resource.
    type: object
    required:
      - kind
    properties:
      kind:
        $ref: "#/definitions/ConnectionType"
    discriminator: kind
  Batch:
    title: Batch
    description: Defines the values of a batch.
    required:
      - id
      - input_file_id
    type: object
    properties:
      id:
        description: The identity of this item.
        type: string
      object:
        $ref: "#/definitions/TypeDiscriminator"
      endpoint:
        description: The API endpoint used by the batch.
        type: string
        readOnly: true
      errors:
        $ref: "#/definitions/BatchErrors"
      input_file_id:
        description: The ID of the input file for the batch.
        minLength: 1
        type: string
      completion_window:
        description: The time frame within which the batch should be processed.
        type: string
      status:
        $ref: "#/definitions/BatchStatus"
      output_file_id:
        description: The ID of the file containing outputs of successfully executed requests.
        type: string
      error_file_id:
        description: The ID of the file containing outputs of requests with errors.
        type: string
      created_at:
        format: unixtime
        description: A timestamp when this batch was created (in unix epochs).
        type: integer
        readOnly: true
      in_progress_at:
        format: unixtime
        description: A timestamp when this batch started progressing (in unix epochs).
        type: integer
        readOnly: true
      expires_at:
        format: unixtime
        description: A timestamp when this batch will expire (in unix epochs).
        type: integer
        readOnly: true
      finalizing_at:
        format: unixtime
        description: A timestamp when this batch started finalizing (in unix epochs).
        type: integer
        readOnly: true
      completed_at:
        format: unixtime
        description: A timestamp when this batch was completed (in unix epochs).
        type: integer
        readOnly: true
      failed_at:
        format: unixtime
        description: A timestamp when this batch failed (in unix epochs).
        type: integer
        readOnly: true
      expired_at:
        format: unixtime
        description: A timestamp when this batch expired (in unix epochs).
        type: integer
        readOnly: true
      cancelling_at:
        format: unixtime
        description: A timestamp when this batch started cancelling (in unix epochs).
        type: integer
        readOnly: true
      cancelled_at:
        format: unixtime
        description: A timestamp when this batch was cancelled (in unix epochs).
        type: integer
        readOnly: true
      request_counts:
        $ref: "#/definitions/BatchRequestCounts"
      metadata:
        description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional infomration about the batch in a structured format.
        type: object
        additionalProperties:
          type: string
  BatchCreateRequest:
    title: BatchCreateRequest
    description: Defines the request to create a batch.
    required:
      - input_file_id
      - endpoint
      - completion_window
    type: object
    properties:
      input_file_id:
        description: The ID if the input file for the batch.
        minLength: 1
        type: string
      endpoint:
        description: The API endpoint used by the batch.
        type: string
      completion_window:
        description: The time frame within which the batch should be processed.
        type: string
      metadata:
        description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional infomration about the batch in a structured format.
        type: object
        additionalProperties:
          type: string
  BatchErrorData:
    title: BatchErrorData
    description: Error information for a failure in batch.
    type: object
    properties:
      code:
        description: An error code identifying the error type.
        type: string
      message:
        description: A human-readable message providing more details about the error.
        type: string
      param:
        description: The name of the parameter that caused the error, if applicable (can be null).
        type: string
      line:
        description: The line number of the input file where the error occurred, if applicable (can be null).
        type: string
  BatchErrors:
    title: BatchErrors
    description: For batches that have failed, this will contain more information on the cause of the failures.
    type: object
    properties:
      object:
        description: The type of the errors object. This is always 'list'.
        type: string
      data:
        $ref: "#/definitions/BatchErrorData"
  BatchRequestCounts:
    title: BatchRequestCounts
    description: The request counts for different statuses within the batch.
    type: object
    properties:
      total:
        description: The total number of requests in the batch.
        type: integer
      completed:
        description: The number of requests in the batch that have been completed successfully.
        type: integer
      failed:
        description: The number of requests in the batch that have failed.
        type: integer
  BatchStatus:
    title: BatchStatus
    description: The status of a batch.
    enum:
      - validating
      - failed
      - in_progress
      - finalizing
      - completed
      - expired
      - cancelling
      - cancelled
    type: string
    readOnly: true
    x-ms-enum:
      name: BatchStatus
      modelAsString: true
      values:
        - value: validating
          description: The input file is being validated before the batch can begin.
        - value: failed
          description: The input file has failed the validation process.
        - value: in_progress
          description: The input file was successfully validated and the batch is currently being executed.
        - value: finalizing
          description: The batch has completed and the results are being prepared.
        - value: completed
          description: The batch has been completed and the results are ready.
        - value: expired
          description: The batch was not able to complete within the 24-hour time window.
        - value: cancelling
          description: Cancellation of the batch has been initiated.
        - value: cancelled
          description: The batch was cancelled.
  BatchesList:
    title: BatchList
    description: Represents a list of batches.
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      data:
        description: The list of items.
        type: array
        items:
          $ref: "#/definitions/Batch"
      first_id:
        description: The id of the first batch in the list of batches returned.
        type: string
      last_id:
        description: The id of the last batch in the list of batches returned.
        type: string
      has_more:
        description: A value indicating whether the list contains more elements than returned.
        type: boolean
  Capabilities:
    title: Capabilities
    description: The capabilities of a base or fine tune model.
    required:
      - chat_completion
      - completion
      - embeddings
      - fine_tune
      - inference
    type: object
    properties:
      fine_tune:
        description: A value indicating whether a model can be used for fine tuning.
        type: boolean
      inference:
        description: A value indicating whether a model can be deployed.
        type: boolean
      completion:
        description: A value indicating whether a model supports completion.
        type: boolean
      chat_completion:
        description: A value indicating whether a model supports chat completion.
        type: boolean
      embeddings:
        description: A value indicating whether a model supports embeddings.
        type: boolean
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



