Unity Catalog Registered Models API

openapi: 3.2.0
info:
  title: Unity Catalog Registered Models API
  version: '0.1'
  description: 'Registered models are machine learning models that are stored within the Unity Catalog model registry. They are comprised of all versions of a single model that a user wishes to keep.

    A registered model resides in the third layer of Unity Catalog’s three-level namespace, and can be referenced with the form __catalog_name__.__schema_name__.__model_name__.'
servers:
- url: http://localhost:8080/api/2.1/unity-catalog
  description: Localhost reference server
tags:
- name: Registered Models
  description: 'Registered models are machine learning models that are stored within the Unity Catalog model registry. They are comprised of all versions of a single model that a user wishes to keep.

    A registered model resides in the third layer of Unity Catalog’s three-level namespace, and can be referenced with the form __catalog_name__.__schema_name__.__model_name__.'
paths:
  /models:
    post:
      operationId: createRegisteredModel
      summary: Create a model.
      tags:
      - Registered Models
      description: 'Creates a new model instance.

        WARNING: This API is experimental and will change in future versions.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRegisteredModel'
      responses:
        '200':
          description: The new registered model was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisteredModelInfo'
    get:
      tags:
      - Registered Models
      parameters:
      - name: catalog_name
        in: query
        description: Name of parent catalog for models of interest.
        required: false
        schema:
          type: string
      - name: schema_name
        in: query
        description: Name of parent schema for models of interest.
        required: false
        schema:
          type: string
      - name: max_results
        in: query
        description: 'Maximum number of models to return.

          - when set to a value greater than 0, the page length is the minimum of this value and a server configured value;

          - when set to 0, the page length is set to a server configured value;

          - when set to a value less than 0, an invalid parameter error is returned;

          '
        required: false
        schema:
          type: integer
          format: int32
          maximum: 50
      - name: page_token
        in: query
        description: Opaque token to send for the next page of results (pagination).
        required: false
        schema:
          type: string
      operationId: listRegisteredModels
      summary: List models
      description: 'Gets a paginated list of all available models either under the specified parent catalog and schema, or all models stored in UC.

        There is no guarantee of a specific ordering of the elements in the array.'
      responses:
        '200':
          description: The models list was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRegisteredModelsResponse'
  /models/{full_name}:
    parameters:
    - name: full_name
      in: path
      description: Full name of the model.
      required: true
      schema:
        type: string
    get:
      tags:
      - Registered Models
      operationId: getRegisteredModel
      summary: Get a specified registered model
      description: Gets a fully specified registered model.
      responses:
        '200':
          description: The registered model was successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisteredModelInfo'
    patch:
      tags:
      - Registered Models
      operationId: updateRegisteredModel
      summary: Update a registered model
      description: Updates the specified registered model.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRegisteredModel'
      responses:
        '200':
          description: The registered model was successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisteredModelInfo'
    delete:
      tags:
      - Registered Models
      parameters:
      - name: force
        in: query
        description: Force deletion even if the registered model still has model versions.
        required: false
        schema:
          type: boolean
      operationId: deleteRegisteredModel
      summary: Delete a specified registered model
      description: Deletes a fully specified registered model. All versions of the model must have already been deleted.
      responses:
        '200':
          description: The registered model was successfully deleted.
          content:
            application/json:
              schema: {}
components:
  schemas:
    RegisteredModelInfo:
      type: object
      properties:
        name:
          description: The name of the registered model
          type: string
        catalog_name:
          description: The name of the catalog where the schema and the registered model reside
          type: string
        schema_name:
          description: The name of the schema where the registered model resides
          type: string
        storage_location:
          description: The storage location on the cloud under which model version data files are stored
          type: string
        full_name:
          description: The three-level (fully qualified) name of the registered model
          type: string
        comment:
          description: The comment attached to the registered model
          type: string
        owner:
          description: The identifier of the user who owns the registered model
          type: string
        created_at:
          description: Creation timestamp of the registered model in milliseconds since the Unix epoch
          type: integer
          format: int64
        created_by:
          description: The identifier of the user who created the registered model
          type: string
        updated_at:
          description: Last-update timestamp of the registered model in milliseconds since the Unix epoch
          type: integer
          format: int64
        updated_by:
          description: The identifier of the user who updated the registered model last time
          type: string
        id:
          description: Unique identifier for the registered model.
          type: string
    UpdateRegisteredModel:
      type: object
      properties:
        comment:
          description: User-provided free-form text description.
          type: string
        new_name:
          description: New name for the model.
          type: string
    ListRegisteredModelsResponse:
      type: object
      properties:
        registered_models:
          description: An array of model information objects.
          type: array
          items:
            $ref: '#/components/schemas/RegisteredModelInfo'
        next_page_token:
          type: string
          description: 'Opaque token to retrieve the next page of results. Absent if there are no more pages.

            __page_token__ should be set to this value for the next request (for the next page of results).

            '
    CreateRegisteredModel:
      type: object
      properties:
        name:
          description: Name of model, relative to parent schema.
          type: string
        catalog_name:
          description: Name of parent catalog.
          type: string
        schema_name:
          description: Name of parent schema relative to its parent catalog.
          type: string
        comment:
          description: User-provided free-form text description.
          type: string
      required:
      - name
      - catalog_name
      - schema_name