specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-08-01-preview/azureopenai.yaml [1992:2457]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  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
    type: string
    readOnly: true
    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.
  ServerlessCompute:
    description: Serverless compute.
    allOf:
      - $ref: "#/definitions/JobCompute"
      - type: object
        properties:
          sku:
            type: string
            description: SKU Level
          instanceCount:
            type: integer
            description: The count of instances to run the job on.
    x-ms-discriminator-value: ServerlessCompute
  SystemComputeDatasource:
    title: SystemComputeDatasource
    type: object
    required:
      - kind
    properties:
      kind:
        $ref: "#/definitions/SystemComputeDatasourceType"
    discriminator: kind
  SystemComputeDatasourceType:
    type: string
    description: The datasource type.
    enum:
      - Storage
      - Urls
    x-ms-enum:
      name: SystemComputeDatasourceType
      modelAsString: true
      values:
        - name: Storage
          value: Storage
          description: Azure Storage Account.
        - name: Urls
          value: Urls
          description: URLs.
  SystemComputeStorage:
    title: SystemComputeStorage
    description: Storage account
    required:
      - connection
      - containerName
      - embeddings
    x-ms-discriminator-value: Storage
    allOf:
      - $ref: "#/definitions/SystemComputeDatasource"
      - type: object
        properties:
          connection:
            $ref: "#/definitions/BaseConnection"
          containerName:
            type: string
            description: container name
          chunking:
            $ref: "#/definitions/ChunkingSettings"
          embeddings:
            type: array
            items:
              $ref: "#/definitions/GenericEmbeddingSettings"
  SystemComputeUrl:
    title: SystemComputeUrl
    description: Urls
    required:
      - urls
      - connection
      - containerName
      - embeddings
    x-ms-discriminator-value: Urls
    allOf:
      - $ref: "#/definitions/SystemComputeDatasource"
      - type: object
        properties:
          urls:
            type: array
            items:
              type: string
          connection:
            $ref: "#/definitions/BaseConnection"
          containerName:
            type: string
            description: container name
          crawling:
            $ref: "#/definitions/CrawlingSettings"
          chunking:
            $ref: "#/definitions/ChunkingSettings"
          embeddings:
            type: array
            items:
              $ref: "#/definitions/GenericEmbeddingSettings"
  TargetIndex:
    title: TargetIndex
    description: Information about the index to be created.
    type: object
    discriminator: kind
    required:
      - kind
    properties:
      kind:
        $ref: "#/definitions/TargetType"
  TargetType:
    type: string
    description: The target type.
    enum:
      - AzureAISearch
      - CosmosDB
      - Pinecone
    x-ms-enum:
      name: TargetType
      modelAsString: true
      values:
        - name: AzureAISearch
          value: AzureAISearch
          description: Azure AI Search Index.
        - name: CosmosDB
          value: CosmosDB
          description: CosmosDB Index.
        - name: Pinecone
          value: Pinecone
          description: Pinecone Index.
  TypeDiscriminator:
    title: TypeDiscriminator
    description: Defines the type of an object.
    enum:
      - list
      - fine_tuning.job
      - file
      - fine_tuning.job.event
      - fine_tuning.job.checkpoint
      - model
      - upload
      - upload.part
    type: string
    readOnly: true
    x-ms-enum:
      name: TypeDiscriminator
      modelAsString: true
      values:
        - value: list
          description: This object represents a list of other objects.
        - value: fine_tuning.job
          description: This object represents a fine tune job.
        - value: file
          description: This object represents a file.
        - value: fine_tuning.job.event
          description: This object represents an event of a fine tuning job.
        - value: fine_tuning.job.checkpoint
          description: This object represents a checkpoint of a fine tuning job.
        - value: model
          description: This object represents a model (can be a base model or fine tune job result).
        - value: upload
          description: This object represents a file upload.
        - value: upload.part
          description: This object represents part of a file upload.
  UploadFileCompleteBody:
    title: UploadFileCompleteBody
    required:
      - part_ids
    type: object
    properties:
      part_ids:
        title: IList`1
        type: array
        items:
          type: string
      md5:
        type: string
  UploadFileStartBody:
    title: UploadFileStartBody
    required:
      - bytes
      - filename
      - mime_type
      - purpose
    type: object
    properties:
      purpose:
        $ref: "#/definitions/Purpose"
      filename:
        minLength: 1
        type: string
      bytes:
        format: int64
        type: integer
      mime_type:
        minLength: 1
        type: string
  UploadPartResource:
    title: UploadPartResource
    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
      upload_id:
        type: string
        readOnly: true
      azure_block_id:
        type: string
        readOnly: true
  UploadResource:
    title: UploadResource
    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
      bytes:
        format: int64
        type: integer
        readOnly: true
      filename:
        type: string
        readOnly: true
      purpose:
        $ref: "#/definitions/Purpose"
      status:
        $ref: "#/definitions/UploadStatus"
      expires_at:
        format: unixtime
        type: integer
        readOnly: true
      file:
        $ref: "#/definitions/File"
  UploadStatus:
    title: UploadStatus
    enum:
      - pending
      - expired
      - completed
      - cancelled
    type: string
    readOnly: true
  UserComputeDataset:
    type: object
    title: UserComputeStorage
    description: Storage account
    required:
      - datasetId
      - datasetType
    x-ms-discriminator-value: Dataset
    allOf:
      - $ref: "#/definitions/UserComputeDatasource"
      - type: object
        properties:
          datasetId:
            type: string
          datasetType:
            type: string
          chunking:
            $ref: "#/definitions/ChunkingSettings"
          embeddings:
            type: array
            items:
              $ref: "#/definitions/WorkspaceConnectionEmbeddingSettings"
  UserComputeDatasource:
    title: UserComputeDatasource
    type: object
    discriminator: kind
    required:
      - kind
    properties:
      kind:
        $ref: "#/definitions/UserComputeDatasourceType"
  UserComputeDatasourceType:
    type: string
    description: The datasource type.
    enum:
      - Dataset
      - Urls
    x-ms-enum:
      name: UserComputeDatasourceType
      modelAsString: true
      values:
        - name: Dataset
          value: Dataset
          description: Workspace Dataset.
        - name: Urls
          value: Urls
          description: URLs.
  UserComputeUrl:
    type: object
    title: UserComputeUrl
    description: Urls
    required:
      - urls
      - embeddings
    x-ms-discriminator-value: Urls
    allOf:
      - $ref: "#/definitions/UserComputeDatasource"
      - type: object
        properties:
          urls:
            type: array
            items:
              type: string
          crawling:
            $ref: "#/definitions/CrawlingSettings"
          chunking:
            $ref: "#/definitions/ChunkingSettings"
          embeddings:
            type: array
            items:
              $ref: "#/definitions/WorkspaceConnectionEmbeddingSettings"
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.yaml [2008:2473]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  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
    type: string
    readOnly: true
    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.
  ServerlessCompute:
    description: Serverless compute.
    allOf:
      - $ref: "#/definitions/JobCompute"
      - type: object
        properties:
          sku:
            type: string
            description: SKU Level
          instanceCount:
            type: integer
            description: The count of instances to run the job on.
    x-ms-discriminator-value: ServerlessCompute
  SystemComputeDatasource:
    title: SystemComputeDatasource
    type: object
    required:
      - kind
    properties:
      kind:
        $ref: "#/definitions/SystemComputeDatasourceType"
    discriminator: kind
  SystemComputeDatasourceType:
    type: string
    description: The datasource type.
    enum:
      - Storage
      - Urls
    x-ms-enum:
      name: SystemComputeDatasourceType
      modelAsString: true
      values:
        - name: Storage
          value: Storage
          description: Azure Storage Account.
        - name: Urls
          value: Urls
          description: URLs.
  SystemComputeStorage:
    title: SystemComputeStorage
    description: Storage account
    required:
      - connection
      - containerName
      - embeddings
    x-ms-discriminator-value: Storage
    allOf:
      - $ref: "#/definitions/SystemComputeDatasource"
      - type: object
        properties:
          connection:
            $ref: "#/definitions/BaseConnection"
          containerName:
            type: string
            description: container name
          chunking:
            $ref: "#/definitions/ChunkingSettings"
          embeddings:
            type: array
            items:
              $ref: "#/definitions/GenericEmbeddingSettings"
  SystemComputeUrl:
    title: SystemComputeUrl
    description: Urls
    required:
      - urls
      - connection
      - containerName
      - embeddings
    x-ms-discriminator-value: Urls
    allOf:
      - $ref: "#/definitions/SystemComputeDatasource"
      - type: object
        properties:
          urls:
            type: array
            items:
              type: string
          connection:
            $ref: "#/definitions/BaseConnection"
          containerName:
            type: string
            description: container name
          crawling:
            $ref: "#/definitions/CrawlingSettings"
          chunking:
            $ref: "#/definitions/ChunkingSettings"
          embeddings:
            type: array
            items:
              $ref: "#/definitions/GenericEmbeddingSettings"
  TargetIndex:
    title: TargetIndex
    description: Information about the index to be created.
    type: object
    discriminator: kind
    required:
      - kind
    properties:
      kind:
        $ref: "#/definitions/TargetType"
  TargetType:
    type: string
    description: The target type.
    enum:
      - AzureAISearch
      - CosmosDB
      - Pinecone
    x-ms-enum:
      name: TargetType
      modelAsString: true
      values:
        - name: AzureAISearch
          value: AzureAISearch
          description: Azure AI Search Index.
        - name: CosmosDB
          value: CosmosDB
          description: CosmosDB Index.
        - name: Pinecone
          value: Pinecone
          description: Pinecone Index.
  TypeDiscriminator:
    title: TypeDiscriminator
    description: Defines the type of an object.
    enum:
      - list
      - fine_tuning.job
      - file
      - fine_tuning.job.event
      - fine_tuning.job.checkpoint
      - model
      - upload
      - upload.part
    type: string
    readOnly: true
    x-ms-enum:
      name: TypeDiscriminator
      modelAsString: true
      values:
        - value: list
          description: This object represents a list of other objects.
        - value: fine_tuning.job
          description: This object represents a fine tune job.
        - value: file
          description: This object represents a file.
        - value: fine_tuning.job.event
          description: This object represents an event of a fine tuning job.
        - value: fine_tuning.job.checkpoint
          description: This object represents a checkpoint of a fine tuning job.
        - value: model
          description: This object represents a model (can be a base model or fine tune job result).
        - value: upload
          description: This object represents a file upload.
        - value: upload.part
          description: This object represents part of a file upload.
  UploadFileCompleteBody:
    title: UploadFileCompleteBody
    required:
      - part_ids
    type: object
    properties:
      part_ids:
        title: IList`1
        type: array
        items:
          type: string
      md5:
        type: string
  UploadFileStartBody:
    title: UploadFileStartBody
    required:
      - bytes
      - filename
      - mime_type
      - purpose
    type: object
    properties:
      purpose:
        $ref: "#/definitions/Purpose"
      filename:
        minLength: 1
        type: string
      bytes:
        format: int64
        type: integer
      mime_type:
        minLength: 1
        type: string
  UploadPartResource:
    title: UploadPartResource
    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
      upload_id:
        type: string
        readOnly: true
      azure_block_id:
        type: string
        readOnly: true
  UploadResource:
    title: UploadResource
    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
      bytes:
        format: int64
        type: integer
        readOnly: true
      filename:
        type: string
        readOnly: true
      purpose:
        $ref: "#/definitions/Purpose"
      status:
        $ref: "#/definitions/UploadStatus"
      expires_at:
        format: unixtime
        type: integer
        readOnly: true
      file:
        $ref: "#/definitions/File"
  UploadStatus:
    title: UploadStatus
    enum:
      - pending
      - expired
      - completed
      - cancelled
    type: string
    readOnly: true
  UserComputeDataset:
    type: object
    title: UserComputeStorage
    description: Storage account
    required:
      - datasetId
      - datasetType
    x-ms-discriminator-value: Dataset
    allOf:
      - $ref: "#/definitions/UserComputeDatasource"
      - type: object
        properties:
          datasetId:
            type: string
          datasetType:
            type: string
          chunking:
            $ref: "#/definitions/ChunkingSettings"
          embeddings:
            type: array
            items:
              $ref: "#/definitions/WorkspaceConnectionEmbeddingSettings"
  UserComputeDatasource:
    title: UserComputeDatasource
    type: object
    discriminator: kind
    required:
      - kind
    properties:
      kind:
        $ref: "#/definitions/UserComputeDatasourceType"
  UserComputeDatasourceType:
    type: string
    description: The datasource type.
    enum:
      - Dataset
      - Urls
    x-ms-enum:
      name: UserComputeDatasourceType
      modelAsString: true
      values:
        - name: Dataset
          value: Dataset
          description: Workspace Dataset.
        - name: Urls
          value: Urls
          description: URLs.
  UserComputeUrl:
    type: object
    title: UserComputeUrl
    description: Urls
    required:
      - urls
      - embeddings
    x-ms-discriminator-value: Urls
    allOf:
      - $ref: "#/definitions/UserComputeDatasource"
      - type: object
        properties:
          urls:
            type: array
            items:
              type: string
          crawling:
            $ref: "#/definitions/CrawlingSettings"
          chunking:
            $ref: "#/definitions/ChunkingSettings"
          embeddings:
            type: array
            items:
              $ref: "#/definitions/WorkspaceConnectionEmbeddingSettings"
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



