specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.yaml [1515:2138]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  FileImport:
    title: FileImport
    description: Defines a document to import from an external content url to be usable with Azure OpenAI.
    required:
      - content_url
      - filename
      - purpose
    type: object
    properties:
      purpose:
        $ref: "#/definitions/Purpose"
      filename:
        description: "The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded.\r\nIf the `purpose` is set to \"fine-tune\", each line is a JSON record with \"prompt\" and \"completion\" fields representing your training examples."
        minLength: 1
        type: string
      content_url:
        format: url
        description: The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request).
        type: string
  FileList:
    title: FileList
    description: Represents a list of files.
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      data:
        description: The list of items.
        type: array
        items:
          $ref: "#/definitions/File"
  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.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model."
        type: integer
      learning_rate_multiplier:
        format: double
        description: "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results."
        type: number
  FineTuningJob:
    title: FineTuningJob
    description: Defines the values of a fine tune job.
    required:
      - model
      - training_file
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      created_at:
        format: unixtime
        description: A timestamp when this job or item was created (in unix epochs).
        type: integer
        readOnly: true
      id:
        description: The identity of this item.
        type: string
        readOnly: true
      status:
        $ref: "#/definitions/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.\r\nUse 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.\r\nThe 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
      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
      error:
        $ref: "#/definitions/FineTuningJobError"
      estimated_finish:
        format: int32
        description: The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running.
        type: integer
      hyperparameters:
        $ref: "#/definitions/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
      seed:
        format: int32
        description: The seed used for the finetuning job.
        type: integer
      integrations:
        type: array
        items:
          $ref: "#/definitions/WandBIntegrationRequestWrapper"
          description: "A list configurations for integrations supporting the fine-tuning job.\r\nThere are many integrations planned, so make sure to check and act on the integration type."
  FineTuningJobCheckpoint:
    title: FineTuningJobCheckpoint
    required:
      - created_at
      - fine_tuned_model_checkpoint
      - fine_tuning_job_id
      - metrics
      - step_number
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      id:
        description: The identity of this checkpoint.
        type: string
        readOnly: true
      created_at:
        format: unixtime
        description: The Unix timestamp (in seconds) for when the checkpoint was created.
        type: integer
      fine_tuned_model_checkpoint:
        description: The name of the fine-tuned checkpoint model that is created.
        minLength: 1
        type: string
      step_number:
        format: int32
        description: The step number that the checkpoint was created at.
        type: integer
      metrics:
        title: Dictionary`2
        description: The metrics at the step number during the fine-tuning job.
        type: object
        additionalProperties:
          format: double
          type: number
      fine_tuning_job_id:
        description: The name of the fine-tuning job that this checkpoint was created from..
        minLength: 1
        type: string
  FineTuningJobCheckpointList:
    title: FineTuningJobCheckpointList
    description: Represents a list of checkpoints.
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      data:
        description: The list of items.
        type: array
        items:
          $ref: "#/definitions/FineTuningJobCheckpoint"
      has_more:
        description: A value indicating whether the list contains more elements than returned.
        type: boolean
  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: "#/definitions/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
      seed:
        format: int32
        description: The seed used for the finetuning job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you.
        type: integer
      integrations:
        type: array
        items:
          $ref: "#/definitions/WandBIntegrationRequestWrapper"
          description: "A list configurations for integrations supporting the fine-tuning job.\r\nThere are many integrations planned, so make sure to check and act on the integration type."
  FineTuningJobError:
    title: FineTuningJobError
    description: For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.
    type: object
    properties:
      code:
        description: The machine-readable error code..
        type: string
      message:
        description: The human-readable error message.
        type: string
      param:
        description: The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific.
        type: string
  FineTuningJobEvent:
    title: FineTuningJobEvent
    required:
      - created_at
      - level
      - message
      - type
    type: object
    properties:
      object:
        $ref: "#/definitions/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: "#/definitions/LogLevel"
      message:
        description: The message describing the event. This can be a change of state, e.g., enqueued, started, failed or completed, or other events like uploaded results.
        minLength: 1
        type: string
      type:
        $ref: "#/definitions/EventType"
      data:
        description: Machine readable data of this event.
  FineTuningJobEventList:
    title: FineTuningJobEventList
    description: Represents a list of events.
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      data:
        description: The list of items.
        type: array
        items:
          $ref: "#/definitions/FineTuningJobEvent"
      has_more:
        description: A value indicating whether the list contains more elements than returned.
        type: boolean
  FineTuningJobList:
    title: FineTuningJobList
    description: Represents a list of fine tunes.
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      data:
        description: The list of items.
        type: array
        items:
          $ref: "#/definitions/FineTuningJob"
      has_more:
        description: A value indicating whether the list contains more elements than returned.
        type: boolean
  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.
  GenericEmbeddingSettings:
    title: ConnectionEmbeddingSettings
    description: Connection Embedding Settings
    type: object
    properties:
      connection:
        $ref: "#/definitions/BaseConnection"
      deploymentName:
        type: string
      modelName:
        type: string
  IngestionError:
    title: IngestionError
    description: The details of the ingestion error
    type: object
    properties:
      message:
        type: string
      innerErrors:
        type: array
        items:
          type: string
  IngestionJob:
    title: IngestionJob
    description: Represents the details of a job.
    type: object
    required:
      - kind
    discriminator: kind
    properties:
      kind:
        $ref: "#/definitions/IngestionJobType"
      jobId:
        type: string
  IngestionJobList:
    title: IngestionJobList
    description: Represents a list of ingestion jobs.
    type: object
    properties:
      nextLink:
        description: The link to the next page.
        type: string
      value:
        description: The list of items.
        type: array
        items:
          $ref: "#/definitions/IngestionJob"
  IngestionJobProgress:
    title: IngestionJobProgress
    type: object
    required:
      - stageProgress
    properties:
      stageProgress:
        type: array
        items:
          $ref: "#/definitions/IngestionJobStageProgress"
  IngestionJobRun:
    title: IngestionJobRun
    description: The details of a job run
    type: object
    properties:
      jobId:
        type: string
      runId:
        type: string
      status:
        $ref: "#/definitions/OperationState"
      error:
        $ref: "#/definitions/IngestionError"
      warnings:
        type: array
        items:
          type: string
      progress:
        $ref: "#/definitions/IngestionJobProgress"
  IngestionJobRunList:
    title: IngestionJobRunList
    description: Represents a list of ingestion job runs.
    type: object
    properties:
      nextLink:
        description: The link to the next page.
        type: string
      value:
        description: The list of items.
        type: array
        items:
          $ref: "#/definitions/IngestionJobRun"
  IngestionJobStageProgress:
    title: IngestionJobStageProgress
    type: object
    properties:
      name:
        type: string
      totalItems:
        type: integer
        format: int32
      processedItems:
        type: integer
        format: int32
      state:
        $ref: "#/definitions/OperationState"
      subStageProgress:
        type: array
        items:
          $ref: "#/definitions/IngestionJobStageProgress"
  IngestionJobSystemCompute:
    type: object
    allOf:
      - $ref: "#/definitions/IngestionJob"
      - type: object
        properties:
          searchServiceConnection:
            $ref: "#/definitions/BaseConnection"
          datasource:
            $ref: "#/definitions/SystemComputeDatasource"
          completionAction:
            $ref: "#/definitions/CompletionAction"
          dataRefreshIntervalInHours:
            type: integer
    x-ms-discriminator-value: SystemCompute
  IngestionJobType:
    title: IngestionJobType
    type: string
    description: The job type.
    enum:
      - SystemCompute
      - UserCompute
    x-ms-enum:
      name: IngestionJobType
      modelAsString: true
      values:
        - name: SystemCompute
          value: SystemCompute
          description: Jobs that run on service owned resources.
        - name: UserCompute
          value: UserCompute
          description: Jobs that run on user owned workspace.
  IngestionJobUserCompute:
    type: object
    required:
      - workspaceId
    allOf:
      - $ref: "#/definitions/IngestionJob"
      - type: object
        properties:
          workspaceId:
            type: string
          compute:
            $ref: "#/definitions/JobCompute"
          target:
            $ref: "#/definitions/TargetIndex"
          datasource:
            $ref: "#/definitions/UserComputeDatasource"
          dataRefreshIntervalInHours:
            type: integer
    x-ms-discriminator-value: UserCompute
  InnerError:
    title: InnerError
    description: "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)."
    type: object
    properties:
      code:
        $ref: "#/definitions/InnerErrorCode"
      innererror:
        $ref: "#/definitions/InnerError"
  InnerErrorCode:
    title: InnerErrorCode
    description: "Inner error codes as defined in the Microsoft REST guidelines\r\n(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.
  IntegrationTypes:
    title: IntegrationTypes
    enum:
      - wandb
    type: string
    description: List of Fine Tune integrations available.
  JobCompute:
    title: JobCompute
    description: The compute settings of the job.
    type: object
    discriminator: kind
    required:
      - kind
    properties:
      kind:
        $ref: "#/definitions/ComputeType"
  LifeCycleStatus:
    title: LifeCycleStatus
    description: "The life cycle status of a model.\r\nNote: A model can be promoted from \"preview\" to \"generally-available\", but never from \"generally-available\" to \"preview\"."
    enum:
      - preview
      - generally-available
    type: string
    x-ms-enum:
      name: LifeCycleStatus
      modelAsString: true
      values:
        - value: preview
          description: Model is in preview and covered by the service preview terms.
        - value: generally-available
          description: Model is generally available.
  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.
  Model:
    title: Model
    description: A model is either a base model or the result of a successful fine tune job.
    required:
      - capabilities
      - deprecation
      - lifecycle_status
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      created_at:
        format: unixtime
        description: A timestamp when this job or item was created (in unix epochs).
        type: integer
        readOnly: true
      id:
        description: The identity of this item.
        type: string
        readOnly: true
      status:
        $ref: "#/definitions/FineTuningState"
      model:
        description: The base model identity (model-id) if this is a fine tune model; otherwise `null`.
        type: string
      fine_tune:
        description: The fine tune job identity (fine-tune-id) if this is a fine tune model; otherwise `null`.
        type: string
      capabilities:
        $ref: "#/definitions/Capabilities"
      lifecycle_status:
        $ref: "#/definitions/LifeCycleStatus"
      deprecation:
        $ref: "#/definitions/Deprecation"
  ModelList:
    title: ModelList
    description: Represents a list of models.
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      data:
        description: The list of items.
        type: array
        items:
          $ref: "#/definitions/Model"
  OperationState:
    title: OperationState
    description: The state of a job or item.
    enum:
      - notRunning
      - running
      - succeeded
      - failed
    type: string
    readOnly: true
    x-ms-enum:
      name: OperationState
      modelAsString: true
      values:
        - value: notRunning
          description: The operation is not yet queued to be processed in the future.
        - value: running
          description: The operation has started to be processed.
        - value: succeeded
          description: The operation has successfully be processed and is ready for consumption.
        - value: failed
          description: The operation has completed processing with a failure and cannot be further consumed.
  PineconeIndex:
    description: Pinecone Index.
    required:
      - connectionId
    allOf:
      - $ref: "#/definitions/TargetIndex"
      - type: object
        properties:
          connectionId:
            type: string
            description: The id of the connection pointing to the pinecone.
    x-ms-discriminator-value: Pinecone
  Purpose:
    title: Purpose
    description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file.
    enum:
      - fine-tune
      - fine-tune-results
      - assistants
      - assistants_output
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-10-01-preview/azureopenai.yaml [1554:2177]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  FileImport:
    title: FileImport
    description: Defines a document to import from an external content url to be usable with Azure OpenAI.
    required:
      - content_url
      - filename
      - purpose
    type: object
    properties:
      purpose:
        $ref: "#/definitions/Purpose"
      filename:
        description: "The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded.\r\nIf the `purpose` is set to \"fine-tune\", each line is a JSON record with \"prompt\" and \"completion\" fields representing your training examples."
        minLength: 1
        type: string
      content_url:
        format: url
        description: The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request).
        type: string
  FileList:
    title: FileList
    description: Represents a list of files.
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      data:
        description: The list of items.
        type: array
        items:
          $ref: "#/definitions/File"
  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.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model."
        type: integer
      learning_rate_multiplier:
        format: double
        description: "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results."
        type: number
  FineTuningJob:
    title: FineTuningJob
    description: Defines the values of a fine tune job.
    required:
      - model
      - training_file
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      created_at:
        format: unixtime
        description: A timestamp when this job or item was created (in unix epochs).
        type: integer
        readOnly: true
      id:
        description: The identity of this item.
        type: string
        readOnly: true
      status:
        $ref: "#/definitions/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.\r\nUse 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.\r\nThe 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
      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
      error:
        $ref: "#/definitions/FineTuningJobError"
      estimated_finish:
        format: int32
        description: The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running.
        type: integer
      hyperparameters:
        $ref: "#/definitions/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
      seed:
        format: int32
        description: The seed used for the finetuning job.
        type: integer
      integrations:
        type: array
        items:
          $ref: "#/definitions/WandBIntegrationRequestWrapper"
          description: "A list configurations for integrations supporting the fine-tuning job.\r\nThere are many integrations planned, so make sure to check and act on the integration type."
  FineTuningJobCheckpoint:
    title: FineTuningJobCheckpoint
    required:
      - created_at
      - fine_tuned_model_checkpoint
      - fine_tuning_job_id
      - metrics
      - step_number
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      id:
        description: The identity of this checkpoint.
        type: string
        readOnly: true
      created_at:
        format: unixtime
        description: The Unix timestamp (in seconds) for when the checkpoint was created.
        type: integer
      fine_tuned_model_checkpoint:
        description: The name of the fine-tuned checkpoint model that is created.
        minLength: 1
        type: string
      step_number:
        format: int32
        description: The step number that the checkpoint was created at.
        type: integer
      metrics:
        title: Dictionary`2
        description: The metrics at the step number during the fine-tuning job.
        type: object
        additionalProperties:
          format: double
          type: number
      fine_tuning_job_id:
        description: The name of the fine-tuning job that this checkpoint was created from..
        minLength: 1
        type: string
  FineTuningJobCheckpointList:
    title: FineTuningJobCheckpointList
    description: Represents a list of checkpoints.
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      data:
        description: The list of items.
        type: array
        items:
          $ref: "#/definitions/FineTuningJobCheckpoint"
      has_more:
        description: A value indicating whether the list contains more elements than returned.
        type: boolean
  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: "#/definitions/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
      seed:
        format: int32
        description: The seed used for the finetuning job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you.
        type: integer
      integrations:
        type: array
        items:
          $ref: "#/definitions/WandBIntegrationRequestWrapper"
          description: "A list configurations for integrations supporting the fine-tuning job.\r\nThere are many integrations planned, so make sure to check and act on the integration type."
  FineTuningJobError:
    title: FineTuningJobError
    description: For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.
    type: object
    properties:
      code:
        description: The machine-readable error code..
        type: string
      message:
        description: The human-readable error message.
        type: string
      param:
        description: The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific.
        type: string
  FineTuningJobEvent:
    title: FineTuningJobEvent
    required:
      - created_at
      - level
      - message
      - type
    type: object
    properties:
      object:
        $ref: "#/definitions/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: "#/definitions/LogLevel"
      message:
        description: The message describing the event. This can be a change of state, e.g., enqueued, started, failed or completed, or other events like uploaded results.
        minLength: 1
        type: string
      type:
        $ref: "#/definitions/EventType"
      data:
        description: Machine readable data of this event.
  FineTuningJobEventList:
    title: FineTuningJobEventList
    description: Represents a list of events.
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      data:
        description: The list of items.
        type: array
        items:
          $ref: "#/definitions/FineTuningJobEvent"
      has_more:
        description: A value indicating whether the list contains more elements than returned.
        type: boolean
  FineTuningJobList:
    title: FineTuningJobList
    description: Represents a list of fine tunes.
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      data:
        description: The list of items.
        type: array
        items:
          $ref: "#/definitions/FineTuningJob"
      has_more:
        description: A value indicating whether the list contains more elements than returned.
        type: boolean
  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.
  GenericEmbeddingSettings:
    title: ConnectionEmbeddingSettings
    description: Connection Embedding Settings
    type: object
    properties:
      connection:
        $ref: "#/definitions/BaseConnection"
      deploymentName:
        type: string
      modelName:
        type: string
  IngestionError:
    title: IngestionError
    description: The details of the ingestion error
    type: object
    properties:
      message:
        type: string
      innerErrors:
        type: array
        items:
          type: string
  IngestionJob:
    title: IngestionJob
    description: Represents the details of a job.
    type: object
    required:
      - kind
    discriminator: kind
    properties:
      kind:
        $ref: "#/definitions/IngestionJobType"
      jobId:
        type: string
  IngestionJobList:
    title: IngestionJobList
    description: Represents a list of ingestion jobs.
    type: object
    properties:
      nextLink:
        description: The link to the next page.
        type: string
      value:
        description: The list of items.
        type: array
        items:
          $ref: "#/definitions/IngestionJob"
  IngestionJobProgress:
    title: IngestionJobProgress
    type: object
    required:
      - stageProgress
    properties:
      stageProgress:
        type: array
        items:
          $ref: "#/definitions/IngestionJobStageProgress"
  IngestionJobRun:
    title: IngestionJobRun
    description: The details of a job run
    type: object
    properties:
      jobId:
        type: string
      runId:
        type: string
      status:
        $ref: "#/definitions/OperationState"
      error:
        $ref: "#/definitions/IngestionError"
      warnings:
        type: array
        items:
          type: string
      progress:
        $ref: "#/definitions/IngestionJobProgress"
  IngestionJobRunList:
    title: IngestionJobRunList
    description: Represents a list of ingestion job runs.
    type: object
    properties:
      nextLink:
        description: The link to the next page.
        type: string
      value:
        description: The list of items.
        type: array
        items:
          $ref: "#/definitions/IngestionJobRun"
  IngestionJobStageProgress:
    title: IngestionJobStageProgress
    type: object
    properties:
      name:
        type: string
      totalItems:
        type: integer
        format: int32
      processedItems:
        type: integer
        format: int32
      state:
        $ref: "#/definitions/OperationState"
      subStageProgress:
        type: array
        items:
          $ref: "#/definitions/IngestionJobStageProgress"
  IngestionJobSystemCompute:
    type: object
    allOf:
      - $ref: "#/definitions/IngestionJob"
      - type: object
        properties:
          searchServiceConnection:
            $ref: "#/definitions/BaseConnection"
          datasource:
            $ref: "#/definitions/SystemComputeDatasource"
          completionAction:
            $ref: "#/definitions/CompletionAction"
          dataRefreshIntervalInHours:
            type: integer
    x-ms-discriminator-value: SystemCompute
  IngestionJobType:
    title: IngestionJobType
    type: string
    description: The job type.
    enum:
      - SystemCompute
      - UserCompute
    x-ms-enum:
      name: IngestionJobType
      modelAsString: true
      values:
        - name: SystemCompute
          value: SystemCompute
          description: Jobs that run on service owned resources.
        - name: UserCompute
          value: UserCompute
          description: Jobs that run on user owned workspace.
  IngestionJobUserCompute:
    type: object
    required:
      - workspaceId
    allOf:
      - $ref: "#/definitions/IngestionJob"
      - type: object
        properties:
          workspaceId:
            type: string
          compute:
            $ref: "#/definitions/JobCompute"
          target:
            $ref: "#/definitions/TargetIndex"
          datasource:
            $ref: "#/definitions/UserComputeDatasource"
          dataRefreshIntervalInHours:
            type: integer
    x-ms-discriminator-value: UserCompute
  InnerError:
    title: InnerError
    description: "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)."
    type: object
    properties:
      code:
        $ref: "#/definitions/InnerErrorCode"
      innererror:
        $ref: "#/definitions/InnerError"
  InnerErrorCode:
    title: InnerErrorCode
    description: "Inner error codes as defined in the Microsoft REST guidelines\r\n(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.
  IntegrationTypes:
    title: IntegrationTypes
    enum:
      - wandb
    type: string
    description: List of Fine Tune integrations available.
  JobCompute:
    title: JobCompute
    description: The compute settings of the job.
    type: object
    discriminator: kind
    required:
      - kind
    properties:
      kind:
        $ref: "#/definitions/ComputeType"
  LifeCycleStatus:
    title: LifeCycleStatus
    description: "The life cycle status of a model.\r\nNote: A model can be promoted from \"preview\" to \"generally-available\", but never from \"generally-available\" to \"preview\"."
    enum:
      - preview
      - generally-available
    type: string
    x-ms-enum:
      name: LifeCycleStatus
      modelAsString: true
      values:
        - value: preview
          description: Model is in preview and covered by the service preview terms.
        - value: generally-available
          description: Model is generally available.
  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.
  Model:
    title: Model
    description: A model is either a base model or the result of a successful fine tune job.
    required:
      - capabilities
      - deprecation
      - lifecycle_status
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      created_at:
        format: unixtime
        description: A timestamp when this job or item was created (in unix epochs).
        type: integer
        readOnly: true
      id:
        description: The identity of this item.
        type: string
        readOnly: true
      status:
        $ref: "#/definitions/FineTuningState"
      model:
        description: The base model identity (model-id) if this is a fine tune model; otherwise `null`.
        type: string
      fine_tune:
        description: The fine tune job identity (fine-tune-id) if this is a fine tune model; otherwise `null`.
        type: string
      capabilities:
        $ref: "#/definitions/Capabilities"
      lifecycle_status:
        $ref: "#/definitions/LifeCycleStatus"
      deprecation:
        $ref: "#/definitions/Deprecation"
  ModelList:
    title: ModelList
    description: Represents a list of models.
    type: object
    properties:
      object:
        $ref: "#/definitions/TypeDiscriminator"
      data:
        description: The list of items.
        type: array
        items:
          $ref: "#/definitions/Model"
  OperationState:
    title: OperationState
    description: The state of a job or item.
    enum:
      - notRunning
      - running
      - succeeded
      - failed
    type: string
    readOnly: true
    x-ms-enum:
      name: OperationState
      modelAsString: true
      values:
        - value: notRunning
          description: The operation is not yet queued to be processed in the future.
        - value: running
          description: The operation has started to be processed.
        - value: succeeded
          description: The operation has successfully be processed and is ready for consumption.
        - value: failed
          description: The operation has completed processing with a failure and cannot be further consumed.
  PineconeIndex:
    description: Pinecone Index.
    required:
      - connectionId
    allOf:
      - $ref: "#/definitions/TargetIndex"
      - type: object
        properties:
          connectionId:
            type: string
            description: The id of the connection pointing to the pinecone.
    x-ms-discriminator-value: Pinecone
  Purpose:
    title: Purpose
    description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file.
    enum:
      - fine-tune
      - fine-tune-results
      - assistants
      - assistants_output
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



