Microsoft Azure AI Foundry Datasets API

openapi: 3.2.0
info:
  title: Azure AI Datasets API
  version: v1
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- OAuth2Auth:
  - https://ai.azure.com/.default
tags:
- name: Datasets
paths:
  /datasets:
    get:
      operationId: Datasets_ListLatest
      description: List the latest version of each DatasetVersion
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedDatasetVersion'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Datasets
      summary: Datasets list latest
      x-summary-source: derived
  /datasets/{name}/versions:
    get:
      operationId: Datasets_ListVersions
      description: List all versions of the given DatasetVersion
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: The name of the resource
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedDatasetVersion'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Datasets
      summary: Datasets list versions
      x-summary-source: derived
  /datasets/{name}/versions/{version}:
    get:
      operationId: Datasets_GetVersion
      description: Get the specific version of the DatasetVersion. The service returns 404 Not Found error if the DatasetVersion does not exist.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: The name of the resource
        required: true
        schema:
          type: string
      - name: version
        in: path
        description: The specific version id of the DatasetVersion to retrieve.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetVersion'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      tags:
      - Datasets
      summary: Datasets get version
      x-summary-source: derived
    patch:
      operationId: Datasets_CreateOrUpdateVersion
      description: Create a new or update an existing DatasetVersion with the given version id
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: The name of the resource
        required: true
        schema:
          type: string
      - name: version
        in: path
        description: The specific version id of the DatasetVersion to create or update.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetVersion'
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetVersion'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/DatasetVersion'
        description: The DatasetVersion to create or update.
        required: true
      tags:
      - Datasets
      summary: Datasets create or update version
      x-summary-source: derived
    delete:
      operationId: Datasets_DeleteVersion
      description: Delete the specific version of the DatasetVersion. The service returns 204 No Content if the DatasetVersion was deleted successfully or if the DatasetVersion does not exist.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: The name of the resource
        required: true
        schema:
          type: string
      - name: version
        in: path
        description: The version of the DatasetVersion to delete.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: There is no content to send for this request, but the headers may be useful.
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      tags:
      - Datasets
      summary: Datasets delete version
      x-summary-source: derived
  /datasets/{name}/versions/{version}/credentials:
    post:
      operationId: Datasets_GetCredentials
      description: Get the SAS credential to access the storage account associated with a Dataset version.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: The name of the resource
        required: true
        schema:
          type: string
      - name: version
        in: path
        description: The specific version id of the DatasetVersion to operate on.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetCredentialResponse'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      tags:
      - Datasets
      summary: Datasets get credentials
      x-summary-source: derived
  /datasets/{name}/versions/{version}/startPendingUpload:
    post:
      operationId: Datasets_StartPendingUploadVersion
      description: Start a new or get an existing pending upload of a dataset for a specific version.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: The name of the resource
        required: true
        schema:
          type: string
      - name: version
        in: path
        description: The specific version id of the DatasetVersion to operate on.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PendingUploadResponse'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PendingUploadRequest'
        description: The pending upload request parameters
        required: true
      tags:
      - Datasets
      summary: Datasets start pending upload version
      x-summary-source: derived
components:
  schemas:
    PendingUploadResponse:
      type: object
      description: Represents the response for a pending upload request
      properties:
        blobReference:
          $ref: '#/components/schemas/BlobReference'
          description: Container-level read, write, list SAS.
        pendingUploadId:
          type: string
          description: ID for this upload request.
        version:
          type: string
          description: Version of asset to be created if user did not specify version when initially creating upload
        pendingUploadType:
          type: string
          description: BlobReference is the only supported type
          enum:
          - BlobReference
          x-ms-enum:
            modelAsString: false
      required:
      - blobReference
      - pendingUploadId
      - pendingUploadType
    Azure.Core.Foundations.InnerError:
      type: object
      description: An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: Inner error.
    DatasetType:
      type: string
      description: Enum to determine the type of data.
      enum:
      - uri_file
      - uri_folder
      x-ms-enum:
        name: DatasetType
        modelAsString: true
        values:
        - name: uri_file
          value: uri_file
          description: URI file.
        - name: uri_folder
          value: uri_folder
          description: URI folder.
    PendingUploadRequest:
      type: object
      description: Represents a request for a pending upload.
      properties:
        pendingUploadId:
          type: string
          description: If PendingUploadId is not provided, a random GUID will be used.
        connectionName:
          type: string
          description: Azure Storage Account connection name to use for generating temporary SAS token
        pendingUploadType:
          type: string
          description: BlobReference is the only supported type.
          enum:
          - BlobReference
          x-ms-enum:
            modelAsString: false
      required:
      - pendingUploadType
    Azure.Core.Foundations.Error:
      type: object
      description: The error object.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        message:
          type: string
          description: A human-readable representation of the error.
        target:
          type: string
          description: The target of the error.
        details:
          type: array
          description: An array of details about specific errors that led to this reported error.
          items:
            $ref: '#/components/schemas/Azure.Core.Foundations.Error'
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: An object containing more specific information than the current object about the error.
      required:
      - code
      - message
    PagedDatasetVersion:
      type: object
      description: Paged collection of DatasetVersion items
      properties:
        value:
          type: array
          description: The DatasetVersion items on this page
          items:
            $ref: '#/components/schemas/DatasetVersion'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    AssetCredentialResponse:
      type: object
      description: Represents a reference to a blob for consumption
      properties:
        blobReference:
          $ref: '#/components/schemas/BlobReference'
          description: Credential info to access the storage account.
      required:
      - blobReference
    Azure.Core.Foundations.ErrorResponse:
      type: object
      description: A response containing error details.
      properties:
        error:
          $ref: '#/components/schemas/Azure.Core.Foundations.Error'
          description: The error object.
      required:
      - error
    DatasetVersion:
      type: object
      description: DatasetVersion Definition
      properties:
        dataUri:
          type: string
          description: URI of the data ([example](https://go.microsoft.com/fwlink/?linkid=2202330))
          minLength: 1
          pattern: '[a-zA-Z0-9_]'
          x-ms-mutability:
          - read
          - create
        type:
          $ref: '#/components/schemas/DatasetType'
          description: Dataset type
        isReference:
          type: boolean
          description: Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted
          readOnly: true
        connectionName:
          type: string
          description: The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset
          x-ms-mutability:
          - read
          - create
        id:
          type: string
          description: Asset ID, a unique identifier for the asset
          readOnly: true
        name:
          type: string
          description: The name of the resource
          readOnly: true
        version:
          type: string
          description: The version of the resource
          readOnly: true
        description:
          type: string
          description: The asset description text.
          x-ms-mutability:
          - update
          - create
        tags:
          type: object
          description: Tag dictionary. Tags can be added, removed, and updated.
          additionalProperties:
            type: string
          x-ms-mutability:
          - update
          - create
      discriminator:
        propertyName: type
      required:
      - dataUri
      - type
      - name
      - version
    SasCredential:
      type: object
      description: SAS Credential definition
      properties:
        sasUri:
          type: string
          description: SAS uri
          readOnly: true
        type:
          type: string
          description: Type of credential
          enum:
          - SAS
          x-ms-enum:
            modelAsString: false
          readOnly: true
      required:
      - sasUri
      - type
    BlobReference:
      type: object
      description: Blob reference details.
      properties:
        blobUri:
          type: string
          description: 'Blob URI path for client to upload data. Example: `https://blob.windows.core.net/Container/Path`'
        storageAccountArmId:
          type: string
          description: ARM ID of the storage account to use.
        credential:
          $ref: '#/components/schemas/SasCredential'
          description: Credential info to access the storage account.
      required:
      - blobUri
      - storageAccountArmId
      - credential
  parameters:
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
  securitySchemes:
    OAuth2Auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            https://ai.azure.com/.default: ''
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    description: 'Foundry Project endpoint in the form

      "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}".

      If you only have one Project in your Foundry Hub, or to target the default Project

      in your Hub, use the form

      "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"'
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true