3395 lines
127 KiB
YAML
3395 lines
127 KiB
YAML
openapi: 3.0.3
|
||
info:
|
||
title: Model Registry REST API
|
||
version: v1alpha3
|
||
description: REST API for Model Registry to create and manage ML model metadata
|
||
license:
|
||
name: Apache 2.0
|
||
url: "https://www.apache.org/licenses/LICENSE-2.0"
|
||
servers:
|
||
- url: "https://localhost:8080"
|
||
- url: "http://localhost:8080"
|
||
paths:
|
||
/api/model_registry/v1alpha3/artifact:
|
||
summary: Path used to search for an artifact.
|
||
description: >-
|
||
The REST endpoint/path used to search for an `Artifact` entity. This path contains a `GET` operation to perform the find task.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ArtifactResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: findArtifact
|
||
summary: Get an Artifact that matches search parameters.
|
||
description: Gets the details of a single instance of an `Artifact` that matches search parameters.
|
||
parameters:
|
||
- $ref: "#/components/parameters/name"
|
||
- $ref: "#/components/parameters/externalId"
|
||
- $ref: "#/components/parameters/parentResourceId"
|
||
/api/model_registry/v1alpha3/artifacts:
|
||
summary: Path used to manage the list of artifacts.
|
||
description: >-
|
||
The REST endpoint/path used to list and create zero or more `Artifact` entities. This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
parameters:
|
||
- $ref: "#/components/parameters/filterQuery"
|
||
- $ref: "#/components/parameters/artifactType"
|
||
- $ref: "#/components/parameters/pageSize"
|
||
- $ref: "#/components/parameters/orderBy"
|
||
- $ref: "#/components/parameters/sortOrder"
|
||
- $ref: "#/components/parameters/nextPageToken"
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ArtifactListResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getArtifacts
|
||
summary: List All Artifacts
|
||
description: Gets a list of all `Artifact` entities.
|
||
post:
|
||
requestBody:
|
||
description: A new `Artifact` to be created.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ArtifactCreate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"201":
|
||
$ref: "#/components/responses/ArtifactResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"409":
|
||
$ref: "#/components/responses/Conflict"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: createArtifact
|
||
summary: Create an Artifact
|
||
description: Creates a new instance of an `Artifact`.
|
||
/api/model_registry/v1alpha3/artifacts/{id}:
|
||
summary: Path used to manage a single Artifact.
|
||
description: >-
|
||
The REST endpoint/path used to get and update single instances of an `Artifact`. This path contains `GET` and `PATCH` operations used to perform the get and update tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ArtifactResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getArtifact
|
||
summary: Get an Artifact
|
||
description: Gets the details of a single instance of an `Artifact`.
|
||
patch:
|
||
requestBody:
|
||
description: Updated `Artifact` information.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ArtifactUpdate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ArtifactResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: updateArtifact
|
||
summary: Update an Artifact
|
||
description: Updates an existing `Artifact`.
|
||
parameters:
|
||
- name: id
|
||
description: A unique identifier for an `Artifact`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
/api/model_registry/v1alpha3/experiment:
|
||
summary: Path used to search for an experiment.
|
||
description: >-
|
||
The REST endpoint/path used to search for an `Experiment` entity. This path contains a `GET` operation to perform the find task.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ExperimentResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: findExperiment
|
||
summary: Get an Experiment that matches search parameters.
|
||
description: Gets the details of a single instance of an `Experiment` that matches search parameters.
|
||
parameters:
|
||
- $ref: "#/components/parameters/name"
|
||
- $ref: "#/components/parameters/externalId"
|
||
/api/model_registry/v1alpha3/experiment_run:
|
||
summary: Path used to search for an experiment run.
|
||
description: >-
|
||
The REST endpoint/path used to search for an `ExperimentRun` entity. This path contains a `GET` operation to perform the find task.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ExperimentRunResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: findExperimentRun
|
||
summary: Get an ExperimentRun that matches search parameters.
|
||
description: Gets the details of a single instance of an `ExperimentRun` that matches search parameters.
|
||
parameters:
|
||
- $ref: "#/components/parameters/name"
|
||
- $ref: "#/components/parameters/externalId"
|
||
- $ref: "#/components/parameters/parentResourceId"
|
||
/api/model_registry/v1alpha3/experiment_runs:
|
||
summary: Path used to manage the list of experiment runs.
|
||
description: >-
|
||
The REST endpoint/path used to list and create zero or more `ExperimentRun` entities. This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
parameters:
|
||
- $ref: "#/components/parameters/filterQuery"
|
||
- $ref: "#/components/parameters/pageSize"
|
||
- $ref: "#/components/parameters/orderBy"
|
||
- $ref: "#/components/parameters/sortOrder"
|
||
- $ref: "#/components/parameters/nextPageToken"
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ExperimentRunListResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getExperimentRuns
|
||
summary: List All ExperimentRuns
|
||
description: Gets a list of all `ExperimentRun` entities.
|
||
post:
|
||
requestBody:
|
||
description: A new `ExperimentRun` to be created.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ExperimentRunCreate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"201":
|
||
$ref: "#/components/responses/ExperimentRunResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"409":
|
||
$ref: "#/components/responses/Conflict"
|
||
"422":
|
||
$ref: "#/components/responses/UnprocessableEntity"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: createExperimentRun
|
||
summary: Create an ExperimentRun
|
||
description: Creates a new instance of an `ExperimentRun`.
|
||
"/api/model_registry/v1alpha3/experiment_runs/metric_history":
|
||
summary: Path used to get metric history for multiple experiment runs.
|
||
description: >-
|
||
The REST endpoint/path used to get metric history for multiple `ExperimentRun` entities. This path contains a `GET` operation to retrieve metrics with optional filtering.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
parameters:
|
||
- $ref: "#/components/parameters/filterQuery"
|
||
- $ref: "#/components/parameters/name"
|
||
- $ref: "#/components/parameters/stepIds"
|
||
- $ref: "#/components/parameters/pageSize"
|
||
- $ref: "#/components/parameters/orderBy"
|
||
- $ref: "#/components/parameters/sortOrder"
|
||
- $ref: "#/components/parameters/nextPageToken"
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/MetricListResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getExperimentRunsMetricHistory
|
||
summary: Get metric history for multiple ExperimentRuns
|
||
description: Gets the metric history for multiple `ExperimentRun` entities with optional filtering by metric name, step IDs, and experiment run IDs.
|
||
"/api/model_registry/v1alpha3/experiment_runs/{experimentrunId}":
|
||
summary: Path used to manage a single ExperimentRun.
|
||
description: >-
|
||
The REST endpoint/path used to get and update single instances of an `ExperimentRun`. This path contains `GET` and `PATCH` operations used to perform the get and update tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ExperimentRunResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getExperimentRun
|
||
summary: Get an ExperimentRun
|
||
description: Gets the details of a single instance of an `ExperimentRun`.
|
||
patch:
|
||
requestBody:
|
||
description: Updated `ExperimentRun` information.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ExperimentRunUpdate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ExperimentRunResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: updateExperimentRun
|
||
summary: Update an ExperimentRun
|
||
description: Updates an existing `ExperimentRun`.
|
||
parameters:
|
||
- name: experimentrunId
|
||
description: A unique identifier for an `ExperimentRun`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
"/api/model_registry/v1alpha3/experiment_runs/{experimentrunId}/artifacts":
|
||
summary: Path used to manage the list of artifacts for an experiment run.
|
||
description: >-
|
||
The REST endpoint/path used to list and create zero or more `Artifact` entities for an `ExperimentRun`. This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
parameters:
|
||
- $ref: "#/components/parameters/filterQuery"
|
||
- $ref: "#/components/parameters/name"
|
||
- $ref: "#/components/parameters/externalId"
|
||
- $ref: "#/components/parameters/artifactType"
|
||
- $ref: "#/components/parameters/pageSize"
|
||
- $ref: "#/components/parameters/orderBy"
|
||
- $ref: "#/components/parameters/sortOrder"
|
||
- $ref: "#/components/parameters/nextPageToken"
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ArtifactListResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getExperimentRunArtifacts
|
||
summary: List all artifacts associated with the `ExperimentRun`
|
||
post:
|
||
requestBody:
|
||
description: A new or existing `Artifact` to be associated with the `ExperimentRun`.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/Artifact"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ArtifactResponse"
|
||
"201":
|
||
$ref: "#/components/responses/ArtifactResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"409":
|
||
$ref: "#/components/responses/Conflict"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: upsertExperimentRunArtifact
|
||
summary: Upsert an Artifact in an ExperimentRun
|
||
description: Creates a new instance of an Artifact if needed and associates it with `ExperimentRun`.
|
||
parameters:
|
||
- name: experimentrunId
|
||
description: A unique identifier for an `ExperimentRun`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
"/api/model_registry/v1alpha3/experiment_runs/{experimentrunId}/metric_history":
|
||
summary: Path used to get metric history for an experiment run.
|
||
description: >-
|
||
The REST endpoint/path used to get metric history for an `ExperimentRun`. This path contains a `GET` operation to retrieve metrics with optional filtering by name and step IDs.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
parameters:
|
||
- $ref: "#/components/parameters/filterQuery"
|
||
- $ref: "#/components/parameters/name"
|
||
- $ref: "#/components/parameters/stepIds"
|
||
- $ref: "#/components/parameters/pageSize"
|
||
- $ref: "#/components/parameters/orderBy"
|
||
- $ref: "#/components/parameters/sortOrder"
|
||
- $ref: "#/components/parameters/nextPageToken"
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/MetricListResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getExperimentRunMetricHistory
|
||
summary: Get metric history for an ExperimentRun
|
||
description: Gets the metric history for an `ExperimentRun` with optional filtering by metric name and step IDs.
|
||
parameters:
|
||
- name: experimentrunId
|
||
description: A unique identifier for an `ExperimentRun`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
/api/model_registry/v1alpha3/experiments:
|
||
summary: Path used to manage the list of experiments.
|
||
description: >-
|
||
The REST endpoint/path used to list and create zero or more `Experiment` entities. This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
parameters:
|
||
- $ref: "#/components/parameters/filterQuery"
|
||
- $ref: "#/components/parameters/pageSize"
|
||
- $ref: "#/components/parameters/orderBy"
|
||
- $ref: "#/components/parameters/sortOrder"
|
||
- $ref: "#/components/parameters/nextPageToken"
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ExperimentListResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getExperiments
|
||
summary: List All Experiments
|
||
description: Gets a list of all `Experiment` entities.
|
||
post:
|
||
requestBody:
|
||
description: A new `Experiment` to be created.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ExperimentCreate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"201":
|
||
$ref: "#/components/responses/ExperimentResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"409":
|
||
$ref: "#/components/responses/Conflict"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: createExperiment
|
||
summary: Create an Experiment
|
||
description: Creates a new instance of an `Experiment`.
|
||
"/api/model_registry/v1alpha3/experiments/{experimentId}":
|
||
summary: Path used to manage a single Experiment.
|
||
description: >-
|
||
The REST endpoint/path used to get and update single instances of an `Experiment`. This path contains `GET` and `PATCH` operations used to perform the get and update tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ExperimentResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getExperiment
|
||
summary: Get an Experiment
|
||
description: Gets the details of a single instance of an `Experiment`.
|
||
patch:
|
||
requestBody:
|
||
description: Updated `Experiment` information.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ExperimentUpdate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ExperimentResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: updateExperiment
|
||
summary: Update an Experiment
|
||
description: Updates an existing `Experiment`.
|
||
parameters:
|
||
- name: experimentId
|
||
description: A unique identifier for an `Experiment`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
"/api/model_registry/v1alpha3/experiments/{experimentId}/experiment_runs":
|
||
summary: Path used to manage the list of experiment runs for an experiment.
|
||
description: >-
|
||
The REST endpoint/path used to list and create zero or more `ExperimentRun` entities for an `Experiment`. This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
parameters:
|
||
- $ref: "#/components/parameters/name"
|
||
- $ref: "#/components/parameters/externalId"
|
||
- $ref: "#/components/parameters/filterQuery"
|
||
- $ref: "#/components/parameters/pageSize"
|
||
- $ref: "#/components/parameters/orderBy"
|
||
- $ref: "#/components/parameters/sortOrder"
|
||
- $ref: "#/components/parameters/nextPageToken"
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ExperimentRunListResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getExperimentExperimentRuns
|
||
summary: List All Experiment's ExperimentRuns
|
||
description: Gets a list of all `ExperimentRun` entities for the `Experiment`.
|
||
post:
|
||
requestBody:
|
||
description: A new `ExperimentRun` to be created.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ExperimentRun"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"201":
|
||
$ref: "#/components/responses/ExperimentRunResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"409":
|
||
$ref: "#/components/responses/Conflict"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: createExperimentExperimentRun
|
||
summary: Create an ExperimentRun in Experiment
|
||
description: Creates a new instance of an `ExperimentRun`.
|
||
parameters:
|
||
- name: experimentId
|
||
description: A unique identifier for an `Experiment`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
/api/model_registry/v1alpha3/inference_service:
|
||
summary: Path used to manage an instance of inferenceservice.
|
||
description: >-
|
||
The REST endpoint/path used to list and create zero or more `InferenceService` entities. This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/InferenceServiceResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: findInferenceService
|
||
summary: Get an InferenceServices that matches search parameters.
|
||
description: Gets the details of a single instance of `InferenceService` that matches search parameters.
|
||
parameters:
|
||
- $ref: "#/components/parameters/name"
|
||
- $ref: "#/components/parameters/externalId"
|
||
- $ref: "#/components/parameters/parentResourceId"
|
||
/api/model_registry/v1alpha3/inference_services:
|
||
summary: Path used to manage the list of inferenceservices.
|
||
description: >-
|
||
The REST endpoint/path used to list and create zero or more `InferenceService` entities. This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
parameters:
|
||
- $ref: "#/components/parameters/filterQuery"
|
||
- $ref: "#/components/parameters/pageSize"
|
||
- $ref: "#/components/parameters/orderBy"
|
||
- $ref: "#/components/parameters/sortOrder"
|
||
- $ref: "#/components/parameters/nextPageToken"
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/InferenceServiceListResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getInferenceServices
|
||
summary: List All InferenceServices
|
||
description: Gets a list of all `InferenceService` entities.
|
||
post:
|
||
requestBody:
|
||
description: A new `InferenceService` to be created.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/InferenceServiceCreate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/InferenceServiceResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"409":
|
||
$ref: "#/components/responses/Conflict"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: createInferenceService
|
||
summary: Create a InferenceService
|
||
description: Creates a new instance of a `InferenceService`.
|
||
"/api/model_registry/v1alpha3/inference_services/{inferenceserviceId}":
|
||
summary: Path used to manage a single InferenceService.
|
||
description: >-
|
||
The REST endpoint/path used to get and update single instances of an `InferenceService`. This path contains `GET` and `PATCH` operations used to perform the get and update tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/InferenceServiceResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getInferenceService
|
||
summary: Get a InferenceService
|
||
description: Gets the details of a single instance of a `InferenceService`.
|
||
patch:
|
||
requestBody:
|
||
description: Updated `InferenceService` information.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/InferenceServiceUpdate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/InferenceServiceResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: updateInferenceService
|
||
summary: Update a InferenceService
|
||
description: Updates an existing `InferenceService`.
|
||
parameters:
|
||
- name: inferenceserviceId
|
||
description: A unique identifier for a `InferenceService`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
"/api/model_registry/v1alpha3/inference_services/{inferenceserviceId}/model":
|
||
summary: Path used to manage a `RegisteredModel` associated with an `InferenceService`.
|
||
description: >-
|
||
The REST endpoint/path used to list the `RegisteredModel` entity for an `InferenceService`. This path contains a `GET` operation to perform the get task.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/RegisteredModelResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getInferenceServiceModel
|
||
summary: Get InferenceService's RegisteredModel
|
||
description: Gets the `RegisteredModel` entity for the `InferenceService`.
|
||
parameters:
|
||
- name: inferenceserviceId
|
||
description: A unique identifier for a `InferenceService`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
"/api/model_registry/v1alpha3/inference_services/{inferenceserviceId}/serves":
|
||
summary: Path used to manage the list of `ServeModels` for a `InferenceService`.
|
||
description: >-
|
||
The REST endpoint/path used to list and create zero or more `ServeModel` entities for a `InferenceService`. This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
parameters:
|
||
- $ref: "#/components/parameters/filterQuery"
|
||
- $ref: "#/components/parameters/name"
|
||
- $ref: "#/components/parameters/externalId"
|
||
- $ref: "#/components/parameters/pageSize"
|
||
- $ref: "#/components/parameters/orderBy"
|
||
- $ref: "#/components/parameters/sortOrder"
|
||
- $ref: "#/components/parameters/nextPageToken"
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ServeModelListResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getInferenceServiceServes
|
||
summary: List All InferenceService's ServeModel actions
|
||
description: Gets a list of all `ServeModel` entities for the `InferenceService`.
|
||
post:
|
||
requestBody:
|
||
description: A new `ServeModel` to be associated with the `InferenceService`.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ServeModelCreate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"201":
|
||
$ref: "#/components/responses/ServeModelResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"409":
|
||
$ref: "#/components/responses/Conflict"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: createInferenceServiceServe
|
||
summary: Create a ServeModel action in a InferenceService
|
||
description: Creates a new instance of a `ServeModel` associated with `InferenceService`.
|
||
parameters:
|
||
- name: inferenceserviceId
|
||
description: A unique identifier for a `InferenceService`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
"/api/model_registry/v1alpha3/inference_services/{inferenceserviceId}/version":
|
||
summary: Path used to get the current `ModelVersion` associated with an `InferenceService`.
|
||
description: >-
|
||
The REST endpoint/path used to get the current `ModelVersion` entity for a `InferenceService`. This path contains a `GET` operation to perform the get task.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ModelVersionResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getInferenceServiceVersion
|
||
summary: Get InferenceService's ModelVersion
|
||
description: Gets the `ModelVersion` entity for the `InferenceService`.
|
||
parameters:
|
||
- name: inferenceserviceId
|
||
description: A unique identifier for a `InferenceService`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
/api/model_registry/v1alpha3/model_artifact:
|
||
summary: Path used to search for a modelartifact.
|
||
description: >-
|
||
The REST endpoint/path used to search for a `ModelArtifact` entity. This path contains a `GET` operation to perform the find task.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ModelArtifactResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: findModelArtifact
|
||
summary: Get a ModelArtifact that matches search parameters.
|
||
description: Gets the details of a single instance of a `ModelArtifact` that matches search parameters.
|
||
parameters:
|
||
- $ref: "#/components/parameters/name"
|
||
- $ref: "#/components/parameters/externalId"
|
||
- $ref: "#/components/parameters/parentResourceId"
|
||
/api/model_registry/v1alpha3/model_artifacts:
|
||
summary: Path used to manage the list of modelartifacts.
|
||
description: >-
|
||
The REST endpoint/path used to list and create zero or more `ModelArtifact` entities. This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
parameters:
|
||
- $ref: "#/components/parameters/filterQuery"
|
||
- $ref: "#/components/parameters/pageSize"
|
||
- $ref: "#/components/parameters/orderBy"
|
||
- $ref: "#/components/parameters/sortOrder"
|
||
- $ref: "#/components/parameters/nextPageToken"
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ModelArtifactListResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getModelArtifacts
|
||
summary: List All ModelArtifacts
|
||
description: Gets a list of all `ModelArtifact` entities.
|
||
post:
|
||
requestBody:
|
||
description: A new `ModelArtifact` to be created.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ModelArtifactCreate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"201":
|
||
$ref: "#/components/responses/ModelArtifactResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"409":
|
||
$ref: "#/components/responses/Conflict"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: createModelArtifact
|
||
summary: Create a ModelArtifact
|
||
description: Creates a new instance of a `ModelArtifact`.
|
||
"/api/model_registry/v1alpha3/model_artifacts/{modelartifactId}":
|
||
summary: Path used to manage a single ModelArtifact.
|
||
description: >-
|
||
The REST endpoint/path used to get and update single instances of an `ModelArtifact`. This path contains `GET` and `PATCH` operations used to perform the get and update tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ModelArtifactResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getModelArtifact
|
||
summary: Get a ModelArtifact
|
||
description: Gets the details of a single instance of a `ModelArtifact`.
|
||
patch:
|
||
requestBody:
|
||
description: Updated `ModelArtifact` information.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ModelArtifactUpdate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ModelArtifactResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: updateModelArtifact
|
||
summary: Update a ModelArtifact
|
||
description: Updates an existing `ModelArtifact`.
|
||
parameters:
|
||
- name: modelartifactId
|
||
description: A unique identifier for a `ModelArtifact`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
/api/model_registry/v1alpha3/model_version:
|
||
summary: Path used to search for a modelversion.
|
||
description: >-
|
||
The REST endpoint/path used to search for a `ModelVersion` entity. This path contains a `GET` operation to perform the find task.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ModelVersionResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: findModelVersion
|
||
summary: Get a ModelVersion that matches search parameters.
|
||
description: Gets the details of a single instance of a `ModelVersion` that matches search parameters.
|
||
parameters:
|
||
- $ref: "#/components/parameters/name"
|
||
- $ref: "#/components/parameters/externalId"
|
||
- $ref: "#/components/parameters/parentResourceId"
|
||
/api/model_registry/v1alpha3/model_versions:
|
||
summary: Path used to manage the list of modelversions.
|
||
description: >-
|
||
The REST endpoint/path used to list and create zero or more `ModelVersion` entities. This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
parameters:
|
||
- $ref: "#/components/parameters/filterQuery"
|
||
- $ref: "#/components/parameters/pageSize"
|
||
- $ref: "#/components/parameters/orderBy"
|
||
- $ref: "#/components/parameters/sortOrder"
|
||
- $ref: "#/components/parameters/nextPageToken"
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ModelVersionListResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getModelVersions
|
||
summary: List All ModelVersions
|
||
description: Gets a list of all `ModelVersion` entities.
|
||
post:
|
||
requestBody:
|
||
description: A new `ModelVersion` to be created.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ModelVersionCreate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"201":
|
||
$ref: "#/components/responses/ModelVersionResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"409":
|
||
$ref: "#/components/responses/Conflict"
|
||
"422":
|
||
$ref: "#/components/responses/UnprocessableEntity"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: createModelVersion
|
||
summary: Create a ModelVersion
|
||
description: Creates a new instance of a `ModelVersion`.
|
||
"/api/model_registry/v1alpha3/model_versions/{modelversionId}":
|
||
summary: Path used to manage a single ModelVersion.
|
||
description: >-
|
||
The REST endpoint/path used to get and update single instances of an `ModelVersion`. This path contains `GET` and `PATCH` operations used to perform the get and update tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ModelVersionResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getModelVersion
|
||
summary: Get a ModelVersion
|
||
description: Gets the details of a single instance of a `ModelVersion`.
|
||
patch:
|
||
requestBody:
|
||
description: Updated `ModelVersion` information.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ModelVersionUpdate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ModelVersionResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: updateModelVersion
|
||
summary: Update a ModelVersion
|
||
description: Updates an existing `ModelVersion`.
|
||
parameters:
|
||
- name: modelversionId
|
||
description: A unique identifier for a `ModelVersion`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
"/api/model_registry/v1alpha3/model_versions/{modelversionId}/artifacts":
|
||
summary: Path used to manage the list of artifacts for a modelversion.
|
||
description: >-
|
||
The REST endpoint/path used to list and create zero or more `Artifact` entities for a `ModelVersion`. This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
parameters:
|
||
- $ref: "#/components/parameters/filterQuery"
|
||
- $ref: "#/components/parameters/name"
|
||
- $ref: "#/components/parameters/externalId"
|
||
- $ref: "#/components/parameters/artifactType"
|
||
- $ref: "#/components/parameters/pageSize"
|
||
- $ref: "#/components/parameters/orderBy"
|
||
- $ref: "#/components/parameters/sortOrder"
|
||
- $ref: "#/components/parameters/nextPageToken"
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ArtifactListResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getModelVersionArtifacts
|
||
summary: List all artifacts associated with the `ModelVersion`
|
||
post:
|
||
requestBody:
|
||
description: A new or existing `Artifact` to be associated with the `ModelVersion`.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/Artifact"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ArtifactResponse"
|
||
"201":
|
||
$ref: "#/components/responses/ArtifactResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"409":
|
||
$ref: "#/components/responses/Conflict"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: upsertModelVersionArtifact
|
||
summary: Upsert an Artifact in a ModelVersion
|
||
description: Creates a new instance of an Artifact if needed and associates it with `ModelVersion`.
|
||
parameters:
|
||
- name: modelversionId
|
||
description: A unique identifier for a `ModelVersion`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
/api/model_registry/v1alpha3/registered_model:
|
||
summary: Path used to search for a registeredmodel.
|
||
description: >-
|
||
The REST endpoint/path used to search for a `RegisteredModel` entity. This path contains a `GET` operation to perform the find task.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/RegisteredModelResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: findRegisteredModel
|
||
summary: Get a RegisteredModel that matches search parameters.
|
||
description: Gets the details of a single instance of a `RegisteredModel` that matches search parameters.
|
||
parameters:
|
||
- $ref: "#/components/parameters/name"
|
||
- $ref: "#/components/parameters/externalId"
|
||
/api/model_registry/v1alpha3/registered_models:
|
||
summary: Path used to manage the list of registeredmodels.
|
||
description: >-
|
||
The REST endpoint/path used to list and create zero or more `RegisteredModel` entities. This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
parameters:
|
||
- $ref: "#/components/parameters/filterQuery"
|
||
- $ref: "#/components/parameters/pageSize"
|
||
- $ref: "#/components/parameters/orderBy"
|
||
- $ref: "#/components/parameters/sortOrder"
|
||
- $ref: "#/components/parameters/nextPageToken"
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/RegisteredModelListResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getRegisteredModels
|
||
summary: List All RegisteredModels
|
||
description: Gets a list of all `RegisteredModel` entities.
|
||
post:
|
||
requestBody:
|
||
description: A new `RegisteredModel` to be created.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/RegisteredModelCreate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"201":
|
||
$ref: "#/components/responses/RegisteredModelResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"409":
|
||
$ref: "#/components/responses/Conflict"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: createRegisteredModel
|
||
summary: Create a RegisteredModel
|
||
description: Creates a new instance of a `RegisteredModel`.
|
||
"/api/model_registry/v1alpha3/registered_models/{registeredmodelId}":
|
||
summary: Path used to manage a single RegisteredModel.
|
||
description: >-
|
||
The REST endpoint/path used to get and update single instances of an `RegisteredModel`. This path contains `GET` and `PATCH` operations used to perform the get and update tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/RegisteredModelResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getRegisteredModel
|
||
summary: Get a RegisteredModel
|
||
description: Gets the details of a single instance of a `RegisteredModel`.
|
||
patch:
|
||
requestBody:
|
||
description: Updated `RegisteredModel` information.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/RegisteredModelUpdate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/RegisteredModelResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: updateRegisteredModel
|
||
summary: Update a RegisteredModel
|
||
description: Updates an existing `RegisteredModel`.
|
||
parameters:
|
||
- name: registeredmodelId
|
||
description: A unique identifier for a `RegisteredModel`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
"/api/model_registry/v1alpha3/registered_models/{registeredmodelId}/versions":
|
||
summary: Path used to manage the list of modelversions for a registeredmodel.
|
||
description: >-
|
||
The REST endpoint/path used to list and create zero or more `ModelVersion` entities for a `RegisteredModel`. This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
parameters:
|
||
- $ref: "#/components/parameters/name"
|
||
- $ref: "#/components/parameters/externalId"
|
||
- $ref: "#/components/parameters/filterQuery"
|
||
- $ref: "#/components/parameters/pageSize"
|
||
- $ref: "#/components/parameters/orderBy"
|
||
- $ref: "#/components/parameters/sortOrder"
|
||
- $ref: "#/components/parameters/nextPageToken"
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ModelVersionListResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getRegisteredModelVersions
|
||
summary: List All RegisteredModel's ModelVersions
|
||
description: Gets a list of all `ModelVersion` entities for the `RegisteredModel`.
|
||
post:
|
||
requestBody:
|
||
description: A new `ModelVersion` to be created.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ModelVersion"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"201":
|
||
$ref: "#/components/responses/ModelVersionResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"409":
|
||
$ref: "#/components/responses/Conflict"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: createRegisteredModelVersion
|
||
summary: Create a ModelVersion in RegisteredModel
|
||
description: Creates a new instance of a `ModelVersion`.
|
||
parameters:
|
||
- name: registeredmodelId
|
||
description: A unique identifier for a `RegisteredModel`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
/api/model_registry/v1alpha3/serving_environment:
|
||
summary: Path used to find a servingenvironment.
|
||
description: >-
|
||
The REST endpoint/path used to search for a `ServingEnvironment` entity. This path contains a `GET` operation to perform the find task.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ServingEnvironmentResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: findServingEnvironment
|
||
summary: Find ServingEnvironment
|
||
description: Finds a `ServingEnvironment` entity that matches query parameters.
|
||
parameters:
|
||
- $ref: "#/components/parameters/name"
|
||
- $ref: "#/components/parameters/externalId"
|
||
/api/model_registry/v1alpha3/serving_environments:
|
||
summary: Path used to manage the list of servingenvironments.
|
||
description: >-
|
||
The REST endpoint/path used to list and create zero or more `ServingEnvironment` entities. This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
parameters:
|
||
- $ref: "#/components/parameters/filterQuery"
|
||
- $ref: "#/components/parameters/pageSize"
|
||
- $ref: "#/components/parameters/orderBy"
|
||
- $ref: "#/components/parameters/sortOrder"
|
||
- $ref: "#/components/parameters/nextPageToken"
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ServingEnvironmentListResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getServingEnvironments
|
||
summary: List All ServingEnvironments
|
||
description: Gets a list of all `ServingEnvironment` entities.
|
||
post:
|
||
requestBody:
|
||
description: A new `ServingEnvironment` to be created.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ServingEnvironmentCreate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"201":
|
||
$ref: "#/components/responses/ServingEnvironmentResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"409":
|
||
$ref: "#/components/responses/Conflict"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: createServingEnvironment
|
||
summary: Create a ServingEnvironment
|
||
description: Creates a new instance of a `ServingEnvironment`.
|
||
"/api/model_registry/v1alpha3/serving_environments/{servingenvironmentId}":
|
||
summary: Path used to manage a single ServingEnvironment.
|
||
description: >-
|
||
The REST endpoint/path used to get and update single instances of an `ServingEnvironment`. This path contains `GET` and `PATCH` operations used to perform the get and update tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ServingEnvironmentResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getServingEnvironment
|
||
summary: Get a ServingEnvironment
|
||
description: Gets the details of a single instance of a `ServingEnvironment`.
|
||
patch:
|
||
requestBody:
|
||
description: Updated `ServingEnvironment` information.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ServingEnvironmentUpdate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/ServingEnvironmentResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: updateServingEnvironment
|
||
summary: Update a ServingEnvironment
|
||
description: Updates an existing `ServingEnvironment`.
|
||
parameters:
|
||
- name: servingenvironmentId
|
||
description: A unique identifier for a `ServingEnvironment`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
"/api/model_registry/v1alpha3/serving_environments/{servingenvironmentId}/inference_services":
|
||
summary: Path used to manage the list of `InferenceServices` for a `ServingEnvironment`.
|
||
description: >-
|
||
The REST endpoint/path used to list and create zero or more `InferenceService` entities for a `ServingEnvironment`. This path contains a `GET` and `POST` operation to perform the list and create tasks, respectively.
|
||
get:
|
||
tags:
|
||
- ModelRegistryService
|
||
parameters:
|
||
- $ref: "#/components/parameters/filterQuery"
|
||
- $ref: "#/components/parameters/name"
|
||
- $ref: "#/components/parameters/externalId"
|
||
- $ref: "#/components/parameters/pageSize"
|
||
- $ref: "#/components/parameters/orderBy"
|
||
- $ref: "#/components/parameters/sortOrder"
|
||
- $ref: "#/components/parameters/nextPageToken"
|
||
responses:
|
||
"200":
|
||
$ref: "#/components/responses/InferenceServiceListResponse"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: getEnvironmentInferenceServices
|
||
summary: List All ServingEnvironment's InferenceServices
|
||
description: Gets a list of all `InferenceService` entities for the `ServingEnvironment`.
|
||
post:
|
||
requestBody:
|
||
description: A new `InferenceService` to be created.
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/InferenceServiceCreate"
|
||
required: true
|
||
tags:
|
||
- ModelRegistryService
|
||
responses:
|
||
"201":
|
||
$ref: "#/components/responses/InferenceServiceResponse"
|
||
"400":
|
||
$ref: "#/components/responses/BadRequest"
|
||
"401":
|
||
$ref: "#/components/responses/Unauthorized"
|
||
"404":
|
||
$ref: "#/components/responses/NotFound"
|
||
"409":
|
||
$ref: "#/components/responses/Conflict"
|
||
"500":
|
||
$ref: "#/components/responses/InternalServerError"
|
||
"503":
|
||
$ref: "#/components/responses/ServiceUnavailable"
|
||
operationId: createEnvironmentInferenceService
|
||
summary: Create a InferenceService in ServingEnvironment
|
||
description: Creates a new instance of a `InferenceService`.
|
||
parameters:
|
||
- name: servingenvironmentId
|
||
description: A unique identifier for a `ServingEnvironment`.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
components:
|
||
schemas:
|
||
Artifact:
|
||
oneOf:
|
||
- $ref: "#/components/schemas/ModelArtifact"
|
||
- $ref: "#/components/schemas/DocArtifact"
|
||
- $ref: "#/components/schemas/DataSet"
|
||
- $ref: "#/components/schemas/Metric"
|
||
- $ref: "#/components/schemas/Parameter"
|
||
discriminator:
|
||
propertyName: artifactType
|
||
mapping:
|
||
model-artifact: "#/components/schemas/ModelArtifact"
|
||
doc-artifact: "#/components/schemas/DocArtifact"
|
||
dataset-artifact: "#/components/schemas/DataSet"
|
||
metric: "#/components/schemas/Metric"
|
||
parameter: "#/components/schemas/Parameter"
|
||
description: A metadata Artifact Entity.
|
||
ArtifactCreate:
|
||
description: An Artifact to be created.
|
||
oneOf:
|
||
- $ref: "#/components/schemas/ModelArtifactCreate"
|
||
- $ref: "#/components/schemas/DocArtifactCreate"
|
||
- $ref: "#/components/schemas/DataSetCreate"
|
||
- $ref: "#/components/schemas/MetricCreate"
|
||
- $ref: "#/components/schemas/ParameterCreate"
|
||
discriminator:
|
||
propertyName: artifactType
|
||
mapping:
|
||
model-artifact: "#/components/schemas/ModelArtifactCreate"
|
||
doc-artifact: "#/components/schemas/DocArtifactCreate"
|
||
dataset-artifact: "#/components/schemas/DataSetCreate"
|
||
metric: "#/components/schemas/MetricCreate"
|
||
parameter: "#/components/schemas/ParameterCreate"
|
||
ArtifactList:
|
||
description: A list of Artifact entities.
|
||
allOf:
|
||
- type: object
|
||
properties:
|
||
items:
|
||
description: Array of `Artifact` entities.
|
||
type: array
|
||
items:
|
||
$ref: "#/components/schemas/Artifact"
|
||
required:
|
||
- items
|
||
- $ref: "#/components/schemas/BaseResourceList"
|
||
ArtifactState:
|
||
description: |2-
|
||
- PENDING: A state indicating that the artifact may exist.
|
||
- LIVE: A state indicating that the artifact should exist, unless something
|
||
external to the system deletes it.
|
||
- MARKED_FOR_DELETION: A state indicating that the artifact should be deleted.
|
||
- DELETED: A state indicating that the artifact has been deleted.
|
||
- ABANDONED: A state indicating that the artifact has been abandoned, which may be
|
||
due to a failed or cancelled execution.
|
||
- REFERENCE: A state indicating that the artifact is a reference artifact. At
|
||
execution start time, the orchestrator produces an output artifact for
|
||
each output key with state PENDING. However, for an intermediate
|
||
artifact, this first artifact's state will be REFERENCE. Intermediate
|
||
artifacts emitted during a component's execution will copy the REFERENCE
|
||
artifact's attributes. At the end of an execution, the artifact state
|
||
should remain REFERENCE instead of being changed to LIVE.
|
||
|
||
See also: ml-metadata Artifact.State
|
||
default: UNKNOWN
|
||
enum:
|
||
- UNKNOWN
|
||
- PENDING
|
||
- LIVE
|
||
- MARKED_FOR_DELETION
|
||
- DELETED
|
||
- ABANDONED
|
||
- REFERENCE
|
||
type: string
|
||
ArtifactTypeQueryParam:
|
||
description: Supported artifact types for querying.
|
||
enum:
|
||
- model-artifact
|
||
- doc-artifact
|
||
- dataset-artifact
|
||
- metric
|
||
- parameter
|
||
type: string
|
||
ArtifactUpdate:
|
||
description: An Artifact to be updated.
|
||
oneOf:
|
||
- $ref: "#/components/schemas/ModelArtifactUpdate"
|
||
- $ref: "#/components/schemas/DocArtifactUpdate"
|
||
- $ref: "#/components/schemas/DataSetUpdate"
|
||
- $ref: "#/components/schemas/MetricUpdate"
|
||
- $ref: "#/components/schemas/ParameterUpdate"
|
||
discriminator:
|
||
propertyName: artifactType
|
||
mapping:
|
||
model-artifact: "#/components/schemas/ModelArtifactUpdate"
|
||
doc-artifact: "#/components/schemas/DocArtifactUpdate"
|
||
dataset-artifact: "#/components/schemas/DataSetUpdate"
|
||
metric: "#/components/schemas/MetricUpdate"
|
||
parameter: "#/components/schemas/ParameterUpdate"
|
||
BaseArtifact:
|
||
description: Base schema for all artifact types with common server generated properties.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResource"
|
||
- type: object
|
||
properties:
|
||
experimentId:
|
||
description: |-
|
||
Optional id of the experiment that produced this artifact.
|
||
type: string
|
||
experimentRunId:
|
||
description: |-
|
||
Optional id of the experiment run that produced this artifact.
|
||
type: string
|
||
BaseModel:
|
||
type: object
|
||
properties:
|
||
description:
|
||
type: string
|
||
description: Human-readable description of the model.
|
||
readme:
|
||
type: string
|
||
description: Model documentation in Markdown.
|
||
maturity:
|
||
type: string
|
||
description: Maturity level of the model.
|
||
example: Generally Available
|
||
language:
|
||
type: array
|
||
description: List of supported languages (https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).
|
||
items:
|
||
type: string
|
||
example:
|
||
- en
|
||
- es
|
||
- cz
|
||
tasks:
|
||
type: array
|
||
description: List of tasks the model is designed for.
|
||
items:
|
||
type: string
|
||
example:
|
||
- text-generation
|
||
provider:
|
||
type: string
|
||
description: Name of the organization or entity that provides the model.
|
||
example: IBM
|
||
logo:
|
||
type: string
|
||
format: uri
|
||
description: |-
|
||
URL to the model's logo. A [data
|
||
URL](https://developer.mozilla.org/en-US/docs/Web/URI/Schemes/data)
|
||
is recommended.
|
||
license:
|
||
type: string
|
||
description: Short name of the model's license.
|
||
example: apache-2.0
|
||
licenseLink:
|
||
type: string
|
||
format: uri
|
||
description: URL to the license text.
|
||
libraryName:
|
||
type: string
|
||
example: transformers
|
||
customProperties:
|
||
description: User provided custom properties which are not defined by its type.
|
||
type: object
|
||
additionalProperties:
|
||
$ref: "#/components/schemas/MetadataValue"
|
||
BaseResource:
|
||
allOf:
|
||
- type: object
|
||
properties:
|
||
customProperties:
|
||
description: User provided custom properties which are not defined by its type.
|
||
type: object
|
||
additionalProperties:
|
||
$ref: "#/components/schemas/MetadataValue"
|
||
description:
|
||
description: |-
|
||
An optional description about the resource.
|
||
type: string
|
||
externalId:
|
||
description: |-
|
||
The external id that come from the clients’ system. This field is optional.
|
||
If set, it must be unique among all resources within a database instance.
|
||
type: string
|
||
name:
|
||
description: |-
|
||
The client provided name of the artifact. This field is optional. If set,
|
||
it must be unique among all the artifacts of the same artifact type within
|
||
a database instance and cannot be changed once set.
|
||
type: string
|
||
id:
|
||
format: int64
|
||
description: The unique server generated id of the resource.
|
||
type: string
|
||
- $ref: "#/components/schemas/BaseResourceDates"
|
||
BaseResourceCreate:
|
||
type: object
|
||
properties:
|
||
customProperties:
|
||
description: User provided custom properties which are not defined by its type.
|
||
type: object
|
||
additionalProperties:
|
||
$ref: "#/components/schemas/MetadataValue"
|
||
description:
|
||
description: |-
|
||
An optional description about the resource.
|
||
type: string
|
||
externalId:
|
||
description: |-
|
||
The external id that come from the clients’ system. This field is optional.
|
||
If set, it must be unique among all resources within a database instance.
|
||
type: string
|
||
name:
|
||
description: |-
|
||
The client provided name of the artifact. This field is optional. If set,
|
||
it must be unique among all the artifacts of the same artifact type within
|
||
a database instance and cannot be changed once set.
|
||
type: string
|
||
BaseResourceDates:
|
||
description: Common timestamp fields for resources
|
||
type: object
|
||
properties:
|
||
createTimeSinceEpoch:
|
||
format: int64
|
||
description: Output only. Create time of the resource in millisecond since epoch.
|
||
type: string
|
||
readOnly: true
|
||
lastUpdateTimeSinceEpoch:
|
||
format: int64
|
||
description: Output only. Last update time of the resource since epoch in millisecond since epoch.
|
||
type: string
|
||
readOnly: true
|
||
BaseResourceList:
|
||
required:
|
||
- nextPageToken
|
||
- pageSize
|
||
- size
|
||
type: object
|
||
properties:
|
||
nextPageToken:
|
||
description: Token to use to retrieve next page of results.
|
||
type: string
|
||
pageSize:
|
||
format: int32
|
||
description: Maximum number of resources to return in the result.
|
||
type: integer
|
||
size:
|
||
format: int32
|
||
description: Number of items in result list.
|
||
type: integer
|
||
BaseResourceUpdate:
|
||
type: object
|
||
properties:
|
||
customProperties:
|
||
description: User provided custom properties which are not defined by its type.
|
||
type: object
|
||
additionalProperties:
|
||
$ref: "#/components/schemas/MetadataValue"
|
||
description:
|
||
description: |-
|
||
An optional description about the resource.
|
||
type: string
|
||
externalId:
|
||
description: |-
|
||
The external id that come from the clients’ system. This field is optional.
|
||
If set, it must be unique among all resources within a database instance.
|
||
type: string
|
||
DataSet:
|
||
description: A dataset artifact representing training or test data.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseArtifact"
|
||
- $ref: "#/components/schemas/DataSetCreate"
|
||
- type: object
|
||
properties:
|
||
artifactType:
|
||
type: string
|
||
default: "dataset-artifact"
|
||
DataSetCreate:
|
||
description: A dataset artifact to be created.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceCreate"
|
||
- $ref: "#/components/schemas/DataSetUpdate"
|
||
- type: object
|
||
properties:
|
||
artifactType:
|
||
type: string
|
||
default: "dataset-artifact"
|
||
DataSetUpdate:
|
||
description: A dataset artifact to be updated.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceUpdate"
|
||
- type: object
|
||
properties:
|
||
artifactType:
|
||
type: string
|
||
default: "dataset-artifact"
|
||
digest:
|
||
description: A unique hash or identifier for the dataset content.
|
||
type: string
|
||
sourceType:
|
||
description: The type of data source (e.g., "s3", "hdfs", "local", "database").
|
||
type: string
|
||
source:
|
||
description: The location or connection string for the dataset source.
|
||
type: string
|
||
schema:
|
||
description: JSON schema or description of the dataset structure.
|
||
type: string
|
||
profile:
|
||
description: Statistical profile or summary of the dataset.
|
||
type: string
|
||
uri:
|
||
description: |-
|
||
The uniform resource identifier of the physical dataset.
|
||
May be empty if there is no physical dataset.
|
||
type: string
|
||
state:
|
||
$ref: "#/components/schemas/ArtifactState"
|
||
DocArtifact:
|
||
description: A document.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseArtifact"
|
||
- $ref: "#/components/schemas/DocArtifactCreate"
|
||
- type: object
|
||
properties:
|
||
artifactType:
|
||
type: string
|
||
default: "doc-artifact"
|
||
DocArtifactCreate:
|
||
description: A document artifact to be created.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceCreate"
|
||
- $ref: "#/components/schemas/DocArtifactUpdate"
|
||
- type: object
|
||
properties:
|
||
artifactType:
|
||
type: string
|
||
default: "doc-artifact"
|
||
DocArtifactUpdate:
|
||
description: A document artifact to be updated.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceUpdate"
|
||
- type: object
|
||
properties:
|
||
artifactType:
|
||
type: string
|
||
default: "doc-artifact"
|
||
uri:
|
||
description: |-
|
||
The uniform resource identifier of the physical artifact.
|
||
May be empty if there is no physical artifact.
|
||
type: string
|
||
state:
|
||
$ref: "#/components/schemas/ArtifactState"
|
||
Error:
|
||
description: Error code and message.
|
||
required:
|
||
- code
|
||
- message
|
||
type: object
|
||
properties:
|
||
code:
|
||
description: Error code
|
||
type: string
|
||
message:
|
||
description: Error message
|
||
type: string
|
||
ExecutionState:
|
||
description: |-
|
||
The state of the Execution. The state transitions are
|
||
NEW -> RUNNING -> COMPLETE | CACHED | FAILED | CANCELED
|
||
CACHED means the execution is skipped due to cached results.
|
||
CANCELED means the execution is skipped due to precondition not met. It is
|
||
different from CACHED in that a CANCELED execution will not have any event
|
||
associated with it. It is different from FAILED in that there is no
|
||
unexpected error happened and it is regarded as a normal state.
|
||
|
||
See also: ml-metadata Execution.State
|
||
default: UNKNOWN
|
||
enum:
|
||
- UNKNOWN
|
||
- NEW
|
||
- RUNNING
|
||
- COMPLETE
|
||
- FAILED
|
||
- CACHED
|
||
- CANCELED
|
||
type: string
|
||
Experiment:
|
||
description: An experiment in model registry. An experiment has ExperimentRun children.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResource"
|
||
- $ref: "#/components/schemas/ExperimentCreate"
|
||
ExperimentCreate:
|
||
description: An experiment in model registry. An experiment has ExperimentRun children.
|
||
required:
|
||
- name
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceCreate"
|
||
- $ref: "#/components/schemas/ExperimentUpdate"
|
||
- type: object
|
||
properties:
|
||
name:
|
||
description: |-
|
||
The client provided name of the experiment. It must be unique among all the Experiments of the same
|
||
type within a Model Registry instance and cannot be changed once set.
|
||
type: string
|
||
ExperimentList:
|
||
description: List of Experiments.
|
||
allOf:
|
||
- type: object
|
||
properties:
|
||
items:
|
||
description: ""
|
||
type: array
|
||
items:
|
||
$ref: "#/components/schemas/Experiment"
|
||
readOnly: false
|
||
required:
|
||
- items
|
||
- $ref: "#/components/schemas/BaseResourceList"
|
||
ExperimentRun:
|
||
description: Represents an ExperimentRun belonging to an Experiment.
|
||
allOf:
|
||
- $ref: "#/components/schemas/ExperimentRunCreate"
|
||
- $ref: "#/components/schemas/BaseResource"
|
||
ExperimentRunCreate:
|
||
description: Represents an ExperimentRun belonging to an Experiment.
|
||
required:
|
||
- experimentId
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceCreate"
|
||
- $ref: "#/components/schemas/ExperimentRunUpdate"
|
||
- type: object
|
||
properties:
|
||
experimentId:
|
||
description: ID of the `Experiment` to which this experiment run belongs.
|
||
type: string
|
||
startTimeSinceEpoch:
|
||
description: |-
|
||
Start time of the experiment run in milliseconds since epoch.
|
||
Different from createTimeSinceEpoch, which is registry resource creation time.
|
||
format: int64
|
||
type: string
|
||
name:
|
||
description: |-
|
||
The client provided name of the experiment run. It must be unique among all the ExperimentRuns of the same
|
||
type within a Model Registry instance and cannot be changed once set.
|
||
type: string
|
||
ExperimentRunList:
|
||
description: List of ExperimentRun entities.
|
||
allOf:
|
||
- type: object
|
||
properties:
|
||
items:
|
||
description: Array of `ExperimentRun` entities.
|
||
type: array
|
||
items:
|
||
$ref: "#/components/schemas/ExperimentRun"
|
||
required:
|
||
- items
|
||
- $ref: "#/components/schemas/BaseResourceList"
|
||
ExperimentRunState:
|
||
description: |-
|
||
- LIVE: A state indicating that the `ExperimentRun` exists
|
||
- ARCHIVED: A state indicating that the `ExperimentRun` has been archived.
|
||
default: LIVE
|
||
enum:
|
||
- LIVE
|
||
- ARCHIVED
|
||
type: string
|
||
ExperimentRunStatus:
|
||
description: |-
|
||
The state of the Experiment Run. The state transitions are
|
||
[SCHEDULED ->] RUNNING -> FINISHED | FAILED | KILLED
|
||
RUNNING: Run has been initiated.
|
||
SCHEDULED: Run is scheduled to run at a later time.
|
||
FINISHED: Run has completed.
|
||
FAILED: Run execution failed.
|
||
KILLED: Run killed by user.
|
||
default: RUNNING
|
||
enum:
|
||
- RUNNING
|
||
- SCHEDULED
|
||
- FINISHED
|
||
- FAILED
|
||
- KILLED
|
||
type: string
|
||
ExperimentRunUpdate:
|
||
description: Represents an ExperimentRun belonging to an Experiment.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceUpdate"
|
||
- type: object
|
||
properties:
|
||
endTimeSinceEpoch:
|
||
description: |-
|
||
End time of the actual experiment run in milliseconds since epoch.
|
||
Different from lastUpdateTimeSinceEpoch, which is registry resource update time.
|
||
format: int64
|
||
type: string
|
||
status:
|
||
$ref: "#/components/schemas/ExperimentRunStatus"
|
||
state:
|
||
$ref: "#/components/schemas/ExperimentRunState"
|
||
owner:
|
||
description: Experiment run owner id or name.
|
||
type: string
|
||
ExperimentState:
|
||
description: |-
|
||
- LIVE: A state indicating that the `Experiment` exists
|
||
- ARCHIVED: A state indicating that the `Experiment` has been archived.
|
||
default: LIVE
|
||
enum:
|
||
- LIVE
|
||
- ARCHIVED
|
||
type: string
|
||
ExperimentUpdate:
|
||
description: An experiment in model registry. An experiment has ExperimentRun children.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceUpdate"
|
||
- type: object
|
||
properties:
|
||
owner:
|
||
type: string
|
||
state:
|
||
$ref: "#/components/schemas/ExperimentState"
|
||
InferenceService:
|
||
description: >-
|
||
An `InferenceService` entity in a `ServingEnvironment` represents a deployed `ModelVersion` from a `RegisteredModel` created by Model Serving.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResource"
|
||
- $ref: "#/components/schemas/InferenceServiceCreate"
|
||
InferenceServiceCreate:
|
||
description: >-
|
||
An `InferenceService` entity in a `ServingEnvironment` represents a deployed `ModelVersion` from a `RegisteredModel` created by Model Serving.
|
||
required:
|
||
- registeredModelId
|
||
- servingEnvironmentId
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceCreate"
|
||
- $ref: "#/components/schemas/InferenceServiceUpdate"
|
||
- type: object
|
||
properties:
|
||
registeredModelId:
|
||
description: ID of the `RegisteredModel` to serve.
|
||
type: string
|
||
servingEnvironmentId:
|
||
description: ID of the parent `ServingEnvironment` for this `InferenceService` entity.
|
||
type: string
|
||
InferenceServiceList:
|
||
description: List of InferenceServices.
|
||
allOf:
|
||
- type: object
|
||
properties:
|
||
items:
|
||
description: ""
|
||
type: array
|
||
items:
|
||
$ref: "#/components/schemas/InferenceService"
|
||
readOnly: false
|
||
required:
|
||
- items
|
||
- $ref: "#/components/schemas/BaseResourceList"
|
||
InferenceServiceState:
|
||
description: |-
|
||
- DEPLOYED: A state indicating that the `InferenceService` should be deployed.
|
||
- UNDEPLOYED: A state indicating that the `InferenceService` should be un-deployed.
|
||
The state indicates the desired state of inference service.
|
||
See the associated `ServeModel` for the actual status of service deployment action.
|
||
default: DEPLOYED
|
||
enum:
|
||
- DEPLOYED
|
||
- UNDEPLOYED
|
||
type: string
|
||
InferenceServiceUpdate:
|
||
description: >-
|
||
An `InferenceService` entity in a `ServingEnvironment` represents a deployed `ModelVersion` from a `RegisteredModel` created by Model Serving.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceUpdate"
|
||
- type: object
|
||
properties:
|
||
modelVersionId:
|
||
description: >-
|
||
ID of the `ModelVersion` to serve. If it's unspecified, then the latest `ModelVersion` by creation order will be served.
|
||
type: string
|
||
runtime:
|
||
description: Model runtime.
|
||
type: string
|
||
desiredState:
|
||
$ref: "#/components/schemas/InferenceServiceState"
|
||
MetadataBoolValue:
|
||
description: A bool property value.
|
||
type: object
|
||
required:
|
||
- metadataType
|
||
- bool_value
|
||
properties:
|
||
bool_value:
|
||
type: boolean
|
||
metadataType:
|
||
type: string
|
||
example: MetadataBoolValue
|
||
default: MetadataBoolValue
|
||
MetadataDoubleValue:
|
||
description: A double property value.
|
||
type: object
|
||
required:
|
||
- metadataType
|
||
- double_value
|
||
properties:
|
||
double_value:
|
||
format: double
|
||
type: number
|
||
metadataType:
|
||
type: string
|
||
example: MetadataDoubleValue
|
||
default: MetadataDoubleValue
|
||
MetadataIntValue:
|
||
description: An integer (int64) property value.
|
||
type: object
|
||
required:
|
||
- metadataType
|
||
- int_value
|
||
properties:
|
||
int_value:
|
||
format: int64
|
||
type: string
|
||
metadataType:
|
||
type: string
|
||
example: MetadataIntValue
|
||
default: MetadataIntValue
|
||
MetadataProtoValue:
|
||
description: A proto property value.
|
||
type: object
|
||
required:
|
||
- metadataType
|
||
- type
|
||
- proto_value
|
||
properties:
|
||
type:
|
||
description: url describing proto value
|
||
type: string
|
||
proto_value:
|
||
description: Base64 encoded bytes for proto value
|
||
type: string
|
||
metadataType:
|
||
type: string
|
||
example: MetadataProtoValue
|
||
default: MetadataProtoValue
|
||
MetadataStringValue:
|
||
description: A string property value.
|
||
type: object
|
||
required:
|
||
- metadataType
|
||
- string_value
|
||
properties:
|
||
string_value:
|
||
type: string
|
||
metadataType:
|
||
type: string
|
||
example: MetadataStringValue
|
||
default: MetadataStringValue
|
||
MetadataStructValue:
|
||
description: A struct property value.
|
||
type: object
|
||
required:
|
||
- metadataType
|
||
- struct_value
|
||
properties:
|
||
struct_value:
|
||
description: Base64 encoded bytes for struct value
|
||
type: string
|
||
metadataType:
|
||
type: string
|
||
example: MetadataStructValue
|
||
default: MetadataStructValue
|
||
MetadataValue:
|
||
oneOf:
|
||
- $ref: "#/components/schemas/MetadataIntValue"
|
||
- $ref: "#/components/schemas/MetadataDoubleValue"
|
||
- $ref: "#/components/schemas/MetadataStringValue"
|
||
- $ref: "#/components/schemas/MetadataStructValue"
|
||
- $ref: "#/components/schemas/MetadataProtoValue"
|
||
- $ref: "#/components/schemas/MetadataBoolValue"
|
||
discriminator:
|
||
propertyName: metadataType
|
||
mapping:
|
||
MetadataBoolValue: "#/components/schemas/MetadataBoolValue"
|
||
MetadataDoubleValue: "#/components/schemas/MetadataDoubleValue"
|
||
MetadataIntValue: "#/components/schemas/MetadataIntValue"
|
||
MetadataProtoValue: "#/components/schemas/MetadataProtoValue"
|
||
MetadataStringValue: "#/components/schemas/MetadataStringValue"
|
||
MetadataStructValue: "#/components/schemas/MetadataStructValue"
|
||
description: A value in properties.
|
||
example:
|
||
string_value: my_value
|
||
metadataType: MetadataStringValue
|
||
Metric:
|
||
description: A metric representing a numerical measurement from model training or evaluation.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseArtifact"
|
||
- $ref: "#/components/schemas/MetricCreate"
|
||
- type: object
|
||
properties:
|
||
artifactType:
|
||
type: string
|
||
default: "metric"
|
||
MetricCreate:
|
||
description: A metric to be created.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceCreate"
|
||
- $ref: "#/components/schemas/MetricUpdate"
|
||
- type: object
|
||
properties:
|
||
artifactType:
|
||
type: string
|
||
default: "metric"
|
||
name:
|
||
description: The name/key of the metric (e.g., "accuracy", "loss", "f1_score").
|
||
type: string
|
||
MetricList:
|
||
description: List of Metric entities.
|
||
allOf:
|
||
- type: object
|
||
properties:
|
||
items:
|
||
description: Array of `Metric` entities.
|
||
type: array
|
||
items:
|
||
$ref: "#/components/schemas/Metric"
|
||
required:
|
||
- items
|
||
- $ref: "#/components/schemas/BaseResourceList"
|
||
MetricUpdate:
|
||
description: A metric to be updated.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceUpdate"
|
||
- type: object
|
||
properties:
|
||
artifactType:
|
||
type: string
|
||
default: "metric"
|
||
value:
|
||
description: The numeric value of the metric.
|
||
type: number
|
||
format: double
|
||
timestamp:
|
||
description: Unix timestamp in milliseconds when the metric was recorded.
|
||
type: string
|
||
format: int64
|
||
step:
|
||
description: The step number for multi-step metrics (e.g., training epochs).
|
||
type: integer
|
||
format: int64
|
||
state:
|
||
$ref: "#/components/schemas/ArtifactState"
|
||
ModelArtifact:
|
||
description: An ML model artifact.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseArtifact"
|
||
- $ref: "#/components/schemas/ModelArtifactCreate"
|
||
- type: object
|
||
properties:
|
||
artifactType:
|
||
type: string
|
||
default: "model-artifact"
|
||
ModelArtifactCreate:
|
||
description: An ML model artifact.
|
||
properties:
|
||
artifactType:
|
||
type: string
|
||
default: "model-artifact"
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceCreate"
|
||
- $ref: "#/components/schemas/ModelArtifactUpdate"
|
||
ModelArtifactList:
|
||
description: List of ModelArtifact entities.
|
||
allOf:
|
||
- type: object
|
||
properties:
|
||
items:
|
||
description: Array of `ModelArtifact` entities.
|
||
type: array
|
||
items:
|
||
$ref: "#/components/schemas/ModelArtifact"
|
||
required:
|
||
- items
|
||
- $ref: "#/components/schemas/BaseResourceList"
|
||
ModelArtifactUpdate:
|
||
description: An ML model artifact to be updated.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceUpdate"
|
||
- type: object
|
||
properties:
|
||
artifactType:
|
||
type: string
|
||
default: "model-artifact"
|
||
modelFormatName:
|
||
description: Name of the model format.
|
||
type: string
|
||
storageKey:
|
||
description: Storage secret name.
|
||
type: string
|
||
storagePath:
|
||
description: Path for model in storage provided by `storageKey`.
|
||
type: string
|
||
modelFormatVersion:
|
||
description: Version of the model format.
|
||
type: string
|
||
serviceAccountName:
|
||
description: Name of the service account with storage secret.
|
||
type: string
|
||
modelSourceKind:
|
||
type: string
|
||
description: "A string identifier describing the source kind. It differentiates various sources of model artifacts.\nThis identifier should be agreed upon by producers and consumers of source model metadata.\nIt is not an enumeration to keep the source of model metadata open ended. \nE.g. Kubeflow pipelines could use `pipelines` to identify models it produces."
|
||
modelSourceClass:
|
||
type: string
|
||
description: |-
|
||
A subgroup within the source kind. It is a specific sub-component or instance within the source kind.
|
||
E.g. `pipelinerun` for a Kubeflow pipeline run.
|
||
modelSourceGroup:
|
||
type: string
|
||
description: "Unique identifier for a source group for models from source class. \nIt maps to a physical group of source models. \nE.g. a Kubernetes namespace where the pipeline run was executed."
|
||
modelSourceId:
|
||
type: string
|
||
description: |-
|
||
A unique identifier for a source model within kind, class, and group.
|
||
It should be a url friendly string if source supports using URLs to locate source models.
|
||
E.g. a pipeline run ID.
|
||
modelSourceName:
|
||
type: string
|
||
description: "A human-readable name for the source model. \nE.g. `my-project/1`, `ibm-granite/granite-3.1-8b-base:2.1.2`."
|
||
uri:
|
||
description: |-
|
||
The uniform resource identifier of the physical artifact.
|
||
May be empty if there is no physical artifact.
|
||
type: string
|
||
state:
|
||
$ref: "#/components/schemas/ArtifactState"
|
||
ModelVersion:
|
||
description: Represents a ModelVersion belonging to a RegisteredModel.
|
||
allOf:
|
||
- $ref: "#/components/schemas/ModelVersionCreate"
|
||
- $ref: "#/components/schemas/BaseResource"
|
||
ModelVersionCreate:
|
||
description: Represents a ModelVersion belonging to a RegisteredModel.
|
||
required:
|
||
- name
|
||
- registeredModelId
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceCreate"
|
||
- $ref: "#/components/schemas/ModelVersionUpdate"
|
||
- type: object
|
||
properties:
|
||
registeredModelId:
|
||
description: ID of the `RegisteredModel` to which this version belongs.
|
||
type: string
|
||
name:
|
||
description: |-
|
||
The client provided name of the model's version. It must be unique among all the ModelVersions of the same
|
||
type within a Model Registry instance and cannot be changed once set.
|
||
type: string
|
||
ModelVersionList:
|
||
description: List of ModelVersion entities.
|
||
allOf:
|
||
- type: object
|
||
properties:
|
||
items:
|
||
description: Array of `ModelVersion` entities.
|
||
type: array
|
||
items:
|
||
$ref: "#/components/schemas/ModelVersion"
|
||
required:
|
||
- items
|
||
- $ref: "#/components/schemas/BaseResourceList"
|
||
ModelVersionState:
|
||
description: |-
|
||
- LIVE: A state indicating that the `ModelVersion` exists
|
||
- ARCHIVED: A state indicating that the `ModelVersion` has been archived.
|
||
default: LIVE
|
||
enum:
|
||
- LIVE
|
||
- ARCHIVED
|
||
type: string
|
||
ModelVersionUpdate:
|
||
description: Represents a ModelVersion belonging to a RegisteredModel.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceUpdate"
|
||
- type: object
|
||
properties:
|
||
state:
|
||
$ref: "#/components/schemas/ModelVersionState"
|
||
author:
|
||
description: Name of the author.
|
||
type: string
|
||
OrderByField:
|
||
description: Supported fields for ordering result entities.
|
||
enum:
|
||
- CREATE_TIME
|
||
- LAST_UPDATE_TIME
|
||
- ID
|
||
type: string
|
||
Parameter:
|
||
description: A parameter representing a configuration parameter used in model training or execution.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseArtifact"
|
||
- $ref: "#/components/schemas/ParameterCreate"
|
||
- type: object
|
||
properties:
|
||
artifactType:
|
||
type: string
|
||
default: "parameter"
|
||
ParameterCreate:
|
||
description: A parameter to be created.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceCreate"
|
||
- $ref: "#/components/schemas/ParameterUpdate"
|
||
- type: object
|
||
properties:
|
||
artifactType:
|
||
type: string
|
||
default: "parameter"
|
||
name:
|
||
description: The name/key of the parameter (e.g., "learning_rate", "batch_size", "epochs").
|
||
type: string
|
||
ParameterType:
|
||
description: The data type of the parameter (e.g., "string", "number", "boolean", "object").
|
||
enum:
|
||
- string
|
||
- number
|
||
- boolean
|
||
- object
|
||
ParameterUpdate:
|
||
description: A parameter to be updated.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceUpdate"
|
||
- type: object
|
||
properties:
|
||
artifactType:
|
||
type: string
|
||
default: "parameter"
|
||
value:
|
||
description: The value of the parameter.
|
||
type: string
|
||
parameterType:
|
||
$ref: "#/components/schemas/ParameterType"
|
||
default: "string"
|
||
state:
|
||
$ref: "#/components/schemas/ArtifactState"
|
||
RegisteredModel:
|
||
description: A registered model in model registry. A registered model has ModelVersion children.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResource"
|
||
- $ref: "#/components/schemas/RegisteredModelCreate"
|
||
RegisteredModelCreate:
|
||
description: A registered model in model registry. A registered model has ModelVersion children.
|
||
required:
|
||
- name
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceCreate"
|
||
- $ref: "#/components/schemas/RegisteredModelUpdate"
|
||
- type: object
|
||
properties:
|
||
name:
|
||
description: |-
|
||
The client provided name of the model. It must be unique among all the RegisteredModels of the same
|
||
type within a Model Registry instance and cannot be changed once set.
|
||
type: string
|
||
RegisteredModelList:
|
||
description: List of RegisteredModels.
|
||
allOf:
|
||
- type: object
|
||
properties:
|
||
items:
|
||
description: ""
|
||
type: array
|
||
items:
|
||
$ref: "#/components/schemas/RegisteredModel"
|
||
readOnly: false
|
||
required:
|
||
- items
|
||
- $ref: "#/components/schemas/BaseResourceList"
|
||
RegisteredModelState:
|
||
description: |-
|
||
- LIVE: A state indicating that the `RegisteredModel` exists
|
||
- ARCHIVED: A state indicating that the `RegisteredModel` has been archived.
|
||
default: LIVE
|
||
enum:
|
||
- LIVE
|
||
- ARCHIVED
|
||
type: string
|
||
RegisteredModelUpdate:
|
||
description: A registered model in model registry. A registered model has ModelVersion children.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceUpdate"
|
||
- $ref: "#/components/schemas/BaseModel"
|
||
- type: object
|
||
properties:
|
||
owner:
|
||
type: string
|
||
state:
|
||
$ref: "#/components/schemas/RegisteredModelState"
|
||
ServeModel:
|
||
description: An ML model serving action.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResource"
|
||
- $ref: "#/components/schemas/ServeModelCreate"
|
||
ServeModelCreate:
|
||
description: An ML model serving action.
|
||
required:
|
||
- modelVersionId
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceCreate"
|
||
- $ref: "#/components/schemas/ServeModelUpdate"
|
||
- type: object
|
||
properties:
|
||
modelVersionId:
|
||
description: ID of the `ModelVersion` that was served in `InferenceService`.
|
||
type: string
|
||
ServeModelList:
|
||
description: List of ServeModel entities.
|
||
allOf:
|
||
- type: object
|
||
properties:
|
||
items:
|
||
description: Array of `ModelArtifact` entities.
|
||
type: array
|
||
items:
|
||
$ref: "#/components/schemas/ServeModel"
|
||
required:
|
||
- items
|
||
- $ref: "#/components/schemas/BaseResourceList"
|
||
ServeModelUpdate:
|
||
description: An ML model serving action.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceUpdate"
|
||
- type: object
|
||
properties:
|
||
lastKnownState:
|
||
$ref: "#/components/schemas/ExecutionState"
|
||
ServingEnvironment:
|
||
description: A Model Serving environment for serving `RegisteredModels`.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResource"
|
||
- $ref: "#/components/schemas/ServingEnvironmentCreate"
|
||
ServingEnvironmentCreate:
|
||
description: A Model Serving environment for serving `RegisteredModels`.
|
||
required:
|
||
- name
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceCreate"
|
||
- $ref: "#/components/schemas/ServingEnvironmentUpdate"
|
||
- type: object
|
||
properties:
|
||
name:
|
||
description: The name of the ServingEnvironment.
|
||
type: string
|
||
ServingEnvironmentList:
|
||
description: List of ServingEnvironments.
|
||
allOf:
|
||
- type: object
|
||
properties:
|
||
items:
|
||
description: ""
|
||
type: array
|
||
items:
|
||
$ref: "#/components/schemas/ServingEnvironment"
|
||
readOnly: false
|
||
required:
|
||
- items
|
||
- $ref: "#/components/schemas/BaseResourceList"
|
||
ServingEnvironmentUpdate:
|
||
description: A Model Serving environment for serving `RegisteredModels`.
|
||
allOf:
|
||
- $ref: "#/components/schemas/BaseResourceUpdate"
|
||
SortOrder:
|
||
description: Supported sort direction for ordering result entities.
|
||
enum:
|
||
- ASC
|
||
- DESC
|
||
type: string
|
||
responses:
|
||
ArtifactListResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ArtifactList"
|
||
description: A response containing a list of `Artifact` entities.
|
||
links:
|
||
GetArtifactById:
|
||
$ref: '#/components/links/GetArtifactById'
|
||
PatchArtifactById:
|
||
$ref: '#/components/links/PatchArtifactById'
|
||
SearchArtifactByExternalId:
|
||
$ref: '#/components/links/SearchArtifactByExternalId'
|
||
SearchArtifactByName:
|
||
$ref: '#/components/links/SearchArtifactByName'
|
||
SearchArtifactByParentResourceId:
|
||
$ref: '#/components/links/SearchArtifactByParentResourceId'
|
||
ArtifactResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/Artifact"
|
||
description: A response containing an `Artifact` entity.
|
||
links:
|
||
GetArtifactById:
|
||
$ref: '#/components/links/GetArtifactById'
|
||
PatchArtifactById:
|
||
$ref: '#/components/links/PatchArtifactById'
|
||
SearchArtifactByExternalId:
|
||
$ref: '#/components/links/SearchArtifactByExternalId'
|
||
SearchArtifactByName:
|
||
$ref: '#/components/links/SearchArtifactByName'
|
||
SearchArtifactByParentResourceId:
|
||
$ref: '#/components/links/SearchArtifactByParentResourceId'
|
||
BadRequest:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/Error"
|
||
description: Bad Request parameters
|
||
Conflict:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/Error"
|
||
description: Conflict with current state of target resource
|
||
ExperimentListResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ExperimentList"
|
||
description: A response containing a list of `Experiment` entities.
|
||
links:
|
||
GetExperimentById:
|
||
$ref: '#/components/links/GetExperimentById'
|
||
PatchExperimentById:
|
||
$ref: '#/components/links/PatchExperimentById'
|
||
SearchExperimentByExternalId:
|
||
$ref: '#/components/links/SearchExperimentByExternalId'
|
||
SearchExperimentByName:
|
||
$ref: '#/components/links/SearchExperimentByName'
|
||
ExperimentResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/Experiment"
|
||
description: A response containing an `Experiment` entity.
|
||
links:
|
||
GetExperimentById:
|
||
$ref: '#/components/links/GetExperimentById'
|
||
PatchExperimentById:
|
||
$ref: '#/components/links/PatchExperimentById'
|
||
SearchExperimentByExternalId:
|
||
$ref: '#/components/links/SearchExperimentByExternalId'
|
||
SearchExperimentByName:
|
||
$ref: '#/components/links/SearchExperimentByName'
|
||
ExperimentRunListResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ExperimentRunList"
|
||
description: A response containing a list of `ExperimentRun` entities.
|
||
links:
|
||
GetExperimentRunById:
|
||
$ref: '#/components/links/GetExperimentRunById'
|
||
PatchExperimentRunById:
|
||
$ref: '#/components/links/PatchExperimentRunById'
|
||
SearchExperimentRunByExternalId:
|
||
$ref: '#/components/links/SearchExperimentRunByExternalId'
|
||
SearchExperimentRunByName:
|
||
$ref: '#/components/links/SearchExperimentRunByName'
|
||
ExperimentRunResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ExperimentRun"
|
||
description: A response containing an `ExperimentRun` entity.
|
||
links:
|
||
GetExperimentRunById:
|
||
$ref: '#/components/links/GetExperimentRunById'
|
||
PatchExperimentRunById:
|
||
$ref: '#/components/links/PatchExperimentRunById'
|
||
SearchExperimentRunByExternalId:
|
||
$ref: '#/components/links/SearchExperimentRunByExternalId'
|
||
SearchExperimentRunByName:
|
||
$ref: '#/components/links/SearchExperimentRunByName'
|
||
InferenceServiceListResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/InferenceServiceList"
|
||
description: A response containing a list of `InferenceService` entities.
|
||
links:
|
||
GetISById:
|
||
$ref: '#/components/links/GetISById'
|
||
PatchISById:
|
||
$ref: '#/components/links/PatchISById'
|
||
SearchISByExternalId:
|
||
$ref: '#/components/links/SearchISByExternalId'
|
||
SearchISByName:
|
||
$ref: '#/components/links/SearchISByName'
|
||
SearchISByParentResourceId:
|
||
$ref: '#/components/links/SearchISByParentResourceId'
|
||
InferenceServiceResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/InferenceService"
|
||
description: A response containing a `InferenceService` entity.
|
||
links:
|
||
GetISById:
|
||
$ref: '#/components/links/GetISById'
|
||
PatchISById:
|
||
$ref: '#/components/links/PatchISById'
|
||
SearchISByExternalId:
|
||
$ref: '#/components/links/SearchISByExternalId'
|
||
SearchISByName:
|
||
$ref: '#/components/links/SearchISByName'
|
||
SearchISByParentResourceId:
|
||
$ref: '#/components/links/SearchISByParentResourceId'
|
||
InternalServerError:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/Error"
|
||
description: Unexpected internal server error
|
||
MetricListResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/MetricList"
|
||
description: A response containing a list of Metric entities.
|
||
ModelArtifactListResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ModelArtifactList"
|
||
description: A response containing a list of ModelArtifact entities.
|
||
links:
|
||
GetModelArtifactById:
|
||
$ref: '#/components/links/GetModelArtifactById'
|
||
PatchModelArtifactById:
|
||
$ref: '#/components/links/PatchModelArtifactById'
|
||
SearchModelArtifactByExternalId:
|
||
$ref: '#/components/links/SearchModelArtifactByExternalId'
|
||
SearchModelArtifactByName:
|
||
$ref: '#/components/links/SearchModelArtifactByName'
|
||
SearchModelArtifactByParentResourceId:
|
||
$ref: '#/components/links/SearchModelArtifactByParentResourceId'
|
||
ModelArtifactResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ModelArtifact"
|
||
description: A response containing a `ModelArtifact` entity.
|
||
links:
|
||
GetModelArtifactById:
|
||
$ref: '#/components/links/GetModelArtifactById'
|
||
PatchModelArtifactById:
|
||
$ref: '#/components/links/PatchModelArtifactById'
|
||
SearchModelArtifactByExternalId:
|
||
$ref: '#/components/links/SearchModelArtifactByExternalId'
|
||
SearchModelArtifactByName:
|
||
$ref: '#/components/links/SearchModelArtifactByName'
|
||
SearchModelArtifactByParentResourceId:
|
||
$ref: '#/components/links/SearchModelArtifactByParentResourceId'
|
||
ModelVersionListResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ModelVersionList"
|
||
description: A response containing a list of `ModelVersion` entities.
|
||
links:
|
||
GetModelVersionById:
|
||
$ref: '#/components/links/GetModelVersionById'
|
||
PatchModelVersionById:
|
||
$ref: '#/components/links/PatchModelVersionById'
|
||
SearchModelVersionByExternalId:
|
||
$ref: '#/components/links/SearchModelVersionByExternalId'
|
||
SearchModelVersionByName:
|
||
$ref: '#/components/links/SearchModelVersionByName'
|
||
ModelVersionResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ModelVersion"
|
||
description: A response containing a `ModelVersion` entity.
|
||
links:
|
||
GetModelVersionById:
|
||
$ref: '#/components/links/GetModelVersionById'
|
||
PatchModelVersionById:
|
||
$ref: '#/components/links/PatchModelVersionById'
|
||
SearchModelVersionByExternalId:
|
||
$ref: '#/components/links/SearchModelVersionByExternalId'
|
||
SearchModelVersionByName:
|
||
$ref: '#/components/links/SearchModelVersionByName'
|
||
NotFound:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/Error"
|
||
description: The specified resource was not found
|
||
RegisteredModelListResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/RegisteredModelList"
|
||
description: A response containing a list of `RegisteredModel` entities.
|
||
links:
|
||
GetRegisteredModelById:
|
||
$ref: '#/components/links/GetRegisteredModelById'
|
||
PatchRegisteredModelById:
|
||
$ref: '#/components/links/PatchRegisteredModelById'
|
||
SearchRegisteredModelByExternalId:
|
||
$ref: '#/components/links/SearchRegisteredModelByExternalId'
|
||
SearchRegisteredModelByName:
|
||
$ref: '#/components/links/SearchRegisteredModelByName'
|
||
RegisteredModelResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/RegisteredModel"
|
||
description: A response containing a `RegisteredModel` entity.
|
||
links:
|
||
GetRegisteredModelById:
|
||
$ref: '#/components/links/GetRegisteredModelById'
|
||
PatchRegisteredModelById:
|
||
$ref: '#/components/links/PatchRegisteredModelById'
|
||
SearchRegisteredModelByExternalId:
|
||
$ref: '#/components/links/SearchRegisteredModelByExternalId'
|
||
SearchRegisteredModelByName:
|
||
$ref: '#/components/links/SearchRegisteredModelByName'
|
||
ServeModelListResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ServeModelList"
|
||
description: A response containing a list of `ServeModel` entities.
|
||
ServeModelResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ServeModel"
|
||
description: A response containing a `ServeModel` entity.
|
||
ServiceUnavailable:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/Error"
|
||
description: Service is unavailable
|
||
ServingEnvironmentListResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ServingEnvironmentList"
|
||
description: A response containing a list of `ServingEnvironment` entities.
|
||
links:
|
||
GetServingEnvironmentById:
|
||
$ref: '#/components/links/GetServingEnvironmentById'
|
||
PatchServingEnvironmentById:
|
||
$ref: '#/components/links/PatchServingEnvironmentById'
|
||
SearchServingEnvironmentByExternalId:
|
||
$ref: '#/components/links/SearchServingEnvironmentByExternalId'
|
||
SearchServingEnvironmentByName:
|
||
$ref: '#/components/links/SearchServingEnvironmentByName'
|
||
ServingEnvironmentResponse:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/ServingEnvironment"
|
||
description: A response containing a `ServingEnvironment` entity.
|
||
links:
|
||
GetServingEnvironmentById:
|
||
$ref: '#/components/links/GetServingEnvironmentById'
|
||
PatchServingEnvironmentById:
|
||
$ref: '#/components/links/PatchServingEnvironmentById'
|
||
SearchServingEnvironmentByExternalId:
|
||
$ref: '#/components/links/SearchServingEnvironmentByExternalId'
|
||
SearchServingEnvironmentByName:
|
||
$ref: '#/components/links/SearchServingEnvironmentByName'
|
||
Unauthorized:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/Error"
|
||
description: Unauthorized
|
||
UnprocessableEntity:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: "#/components/schemas/Error"
|
||
description: Unprocessable Entity error
|
||
parameters:
|
||
orderBy:
|
||
style: form
|
||
explode: true
|
||
examples:
|
||
orderBy:
|
||
value: ID
|
||
name: orderBy
|
||
description: Specifies the order by criteria for listing entities.
|
||
schema:
|
||
$ref: "#/components/schemas/OrderByField"
|
||
in: query
|
||
required: false
|
||
id:
|
||
name: id
|
||
description: The ID of resource.
|
||
schema:
|
||
type: string
|
||
in: path
|
||
required: true
|
||
name:
|
||
examples:
|
||
name:
|
||
value: entity-name
|
||
name: name
|
||
description: Name of entity to search.
|
||
schema:
|
||
type: string
|
||
in: query
|
||
required: false
|
||
externalId:
|
||
examples:
|
||
externalId:
|
||
value: "10"
|
||
name: externalId
|
||
description: External ID of entity to search.
|
||
schema:
|
||
type: string
|
||
in: query
|
||
required: false
|
||
parentResourceId:
|
||
examples:
|
||
parentResourceId:
|
||
value: "10"
|
||
name: parentResourceId
|
||
description: ID of the parent resource to use for search.
|
||
schema:
|
||
type: string
|
||
in: query
|
||
required: false
|
||
filterQuery:
|
||
examples:
|
||
filterQuery:
|
||
value: "name='my-model' AND state='LIVE'"
|
||
name: filterQuery
|
||
description: |
|
||
A SQL-like query string to filter the list of entities. The query supports rich filtering capabilities with automatic type inference.
|
||
|
||
**Supported Operators:**
|
||
- Comparison: `=`, `!=`, `<>`, `>`, `<`, `>=`, `<=`
|
||
- Pattern matching: `LIKE`, `ILIKE` (case-insensitive)
|
||
- Set membership: `IN`
|
||
- Logical: `AND`, `OR`
|
||
- Grouping: `()` for complex expressions
|
||
|
||
**Data Types:**
|
||
- Strings: `"value"` or `'value'`
|
||
- Numbers: `42`, `3.14`, `1e-5`
|
||
- Booleans: `true`, `false` (case-insensitive)
|
||
|
||
**Property Access:**
|
||
- Standard properties: `name`, `id`, `state`, `createTimeSinceEpoch`
|
||
- Custom properties: Any user-defined property name
|
||
- Escaped properties: Use backticks for special characters: `` `custom-property` ``
|
||
- Type-specific access: `property.string_value`, `property.double_value`, `property.int_value`, `property.bool_value`
|
||
|
||
**Examples:**
|
||
- Basic: `name = "my-model"`
|
||
- Comparison: `accuracy > 0.95`
|
||
- Pattern: `name LIKE "%tensorflow%"`
|
||
- Complex: `(name = "model-a" OR name = "model-b") AND state = "LIVE"`
|
||
- Custom property: `framework.string_value = "pytorch"`
|
||
- Escaped property: `` `mlflow.source.type` = "notebook" ``
|
||
schema:
|
||
type: string
|
||
in: query
|
||
required: false
|
||
pageSize:
|
||
examples:
|
||
pageSize:
|
||
value: "100"
|
||
name: pageSize
|
||
description: Number of entities in each page.
|
||
schema:
|
||
type: string
|
||
in: query
|
||
required: false
|
||
nextPageToken:
|
||
name: nextPageToken
|
||
description: Token to use to retrieve next page of results.
|
||
schema:
|
||
type: string
|
||
in: query
|
||
required: false
|
||
sortOrder:
|
||
style: form
|
||
explode: true
|
||
examples:
|
||
sortOrder:
|
||
value: DESC
|
||
name: sortOrder
|
||
description: "Specifies the sort order for listing entities, defaults to ASC."
|
||
schema:
|
||
$ref: "#/components/schemas/SortOrder"
|
||
in: query
|
||
required: false
|
||
artifactType:
|
||
style: form
|
||
explode: true
|
||
examples:
|
||
artifactType:
|
||
value: model-artifact
|
||
name: artifactType
|
||
description: "Specifies the artifact type for listing artifacts."
|
||
schema:
|
||
$ref: "#/components/schemas/ArtifactTypeQueryParam"
|
||
in: query
|
||
required: false
|
||
stepIds:
|
||
style: form
|
||
explode: true
|
||
examples:
|
||
stepIds:
|
||
value: "1,2,3"
|
||
name: stepIds
|
||
description: "Comma-separated list of step IDs to filter metrics by."
|
||
schema:
|
||
type: string
|
||
in: query
|
||
required: false
|
||
securitySchemes:
|
||
Bearer:
|
||
scheme: bearer
|
||
bearerFormat: JWT
|
||
type: http
|
||
description: Bearer JWT scheme
|
||
links:
|
||
# Artifact
|
||
GetArtifactById:
|
||
operationId: getArtifact
|
||
parameters:
|
||
id: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `id` parameter in `GET /api/model_registry/v1alpha3/artifacts/{id}`.
|
||
|
||
PatchArtifactById:
|
||
operationId: updateArtifact
|
||
parameters:
|
||
id: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `id` parameter in `PATCH /api/model_registry/v1alpha3/artifacts/{id}`.
|
||
|
||
SearchArtifactByExternalId:
|
||
operationId: findArtifact
|
||
parameters:
|
||
externalId: "$response.body#/externalId"
|
||
description: >
|
||
The `externalId` value returned in the response can be used as the `externalId` parameter in `GET /api/model_registry/v1alpha3/artifact`.
|
||
|
||
SearchArtifactByName:
|
||
operationId: findArtifact
|
||
parameters:
|
||
name: "$response.body#/name"
|
||
description: >
|
||
The `name` value returned in the response can be used as the `name` parameter in `GET /api/model_registry/v1alpha3/artifact`.
|
||
|
||
# Unsure about this one
|
||
SearchArtifactByParentResourceId:
|
||
operationId: findArtifact
|
||
parameters:
|
||
parentResourceId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `parentResourceId` parameter in `GET /api/model_registry/v1alpha3/artifact`, assuming that the 'Artifact' entity is a parent to another 'Artifact' entity.
|
||
|
||
# InferenceService
|
||
GetISById:
|
||
operationId: getInferenceService
|
||
parameters:
|
||
inferenceserviceId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `id` parameter in `GET /api/model_registry/v1alpha3/inference_services/{inferenceserviceId}`.
|
||
|
||
PatchISById:
|
||
operationId: updateInferenceService
|
||
parameters:
|
||
inferenceserviceId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `id` parameter in `PATCH /api/model_registry/v1alpha3/inference_services/{inferenceserviceId}`.
|
||
|
||
SearchISByExternalId:
|
||
operationId: findInferenceService
|
||
parameters:
|
||
externalId: "$response.body#/externalId"
|
||
description: >
|
||
The `externalId` value returned in the response can be used as the `externalId` parameter in `GET /api/model_registry/v1alpha3/inference_service`.
|
||
|
||
SearchISByName:
|
||
operationId: findInferenceService
|
||
parameters:
|
||
name: "$response.body#/name"
|
||
description: >
|
||
The `name` value returned in the response can be used as the `name` parameter in `GET /api/model_registry/v1alpha3/inference_service`.
|
||
|
||
# Unsure about this one
|
||
SearchISByParentResourceId:
|
||
operationId: findInferenceService
|
||
parameters:
|
||
parentResourceId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `parentResourceId` parameter in GET /api/model_registry/v1alpha3/inference_service`, assuming that the 'InferenceService' entity is a parent to another 'InferenceService' entity.
|
||
|
||
# ModelArtifact
|
||
GetModelArtifactById:
|
||
operationId: getModelArtifact
|
||
parameters:
|
||
modelartifactId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `id` parameter in `GET "/api/model_registry/v1alpha3/model_artifacts/{modelartifactId}`.
|
||
|
||
PatchModelArtifactById:
|
||
operationId: updateModelArtifact
|
||
parameters:
|
||
modelartifactId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `id` parameter in `PATCH "/api/model_registry/v1alpha3/model_artifacts/{modelartifactId}`.
|
||
|
||
SearchModelArtifactByExternalId:
|
||
operationId: findModelArtifact
|
||
parameters:
|
||
externalId: "$response.body#/externalId"
|
||
description: >
|
||
The `externalId` value returned in the response can be used as the `externalId` parameter in `GET /api/model_registry/v1alpha3/model_artifact`.
|
||
|
||
SearchModelArtifactByName:
|
||
operationId: findModelArtifact
|
||
parameters:
|
||
name: "$response.body#/name"
|
||
description: >
|
||
The `name` value returned in the response can be used as the `name` parameter in `GET /api/model_registry/v1alpha3/model_artifact`.
|
||
|
||
# Unsure about this one
|
||
SearchModelArtifactByParentResourceId:
|
||
operationId: findModelArtifact
|
||
parameters:
|
||
parentResourceId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `parentResourceId` parameter in `GET /api/model_registry/v1alpha3/model_artifact`, assuming that the 'ModelArtifact' entity is a parent to another 'ModelArtifact' entity.
|
||
|
||
# RegisteredModel
|
||
GetRegisteredModelById:
|
||
operationId: getRegisteredModel
|
||
parameters:
|
||
registeredmodelId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `registeredmodelId` parameter in `GET /api/model_registry/v1alpha3/registered_models/{registeredmodelId}`.
|
||
|
||
PatchRegisteredModelById:
|
||
operationId: updateRegisteredModel
|
||
parameters:
|
||
registeredmodelId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `registeredmodelId` parameter in `PATCH /api/model_registry/v1alpha3/registered_models/{registeredmodelId}`.
|
||
|
||
SearchRegisteredModelByExternalId:
|
||
operationId: findRegisteredModel
|
||
parameters:
|
||
externalId: "$response.body#/externalId"
|
||
description: >
|
||
The `externalId` value returned in the response can be used as the `externalId` parameter in `GET /api/model_registry/v1alpha3/registered_model`.
|
||
|
||
SearchRegisteredModelByName:
|
||
operationId: findRegisteredModel
|
||
parameters:
|
||
name: "$response.body#/name"
|
||
description: >
|
||
The `name` value returned in the response can be used as the `name` parameter in `GET /api/model_registry/v1alpha3/registered_model`.
|
||
|
||
# ModelVersion
|
||
GetModelVersionById:
|
||
operationId: getModelVersion
|
||
parameters:
|
||
modelversionId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `modelversionId` parameter in `GET /api/model_registry/v1alpha3/model_versions/{modelversionId}`.
|
||
|
||
PatchModelVersionById:
|
||
operationId: updateModelVersion
|
||
parameters:
|
||
modelversionId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `modelversionId` parameter in `PATCH /api/model_registry/v1alpha3/model_versions/{modelversionId}`.
|
||
|
||
SearchModelVersionByExternalId:
|
||
operationId: findModelVersion
|
||
parameters:
|
||
externalId: "$response.body#/externalId"
|
||
description: >
|
||
The `externalId` value returned in the response can be used as the `externalId` parameter in `GET /api/model_registry/v1alpha3/model_version`.
|
||
|
||
SearchModelVersionByName:
|
||
operationId: findModelVersion
|
||
parameters:
|
||
name: "$response.body#/name"
|
||
description: >
|
||
The `name` value returned in the response can be used as the `name` parameter in `GET /api/model_registry/v1alpha3/model_version`.
|
||
|
||
# ServingEnvironment
|
||
GetServingEnvironmentById:
|
||
operationId: getServingEnvironment
|
||
parameters:
|
||
servingenvironmentId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `servingenvironmentId` parameter in `GET /api/model_registry/v1alpha3/serving_environments/{servingenvironmentId}`.
|
||
|
||
PatchServingEnvironmentById:
|
||
operationId: updateServingEnvironment
|
||
parameters:
|
||
servingenvironmentId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `servingenvironmentId` parameter in `PATCH /api/model_registry/v1alpha3/serving_environments/{servingenvironmentId}`.
|
||
|
||
SearchServingEnvironmentByExternalId:
|
||
operationId: findServingEnvironment
|
||
parameters:
|
||
externalId: "$response.body#/externalId"
|
||
description: >
|
||
The `externalId` value returned in the response can be used as the `externalId` parameter in `GET /api/model_registry/v1alpha3/serving_environment`.
|
||
|
||
SearchServingEnvironmentByName:
|
||
operationId: findServingEnvironment
|
||
parameters:
|
||
name: "$response.body#/name"
|
||
description: >
|
||
The `name` value returned in the response can be used as the `name` parameter in `GET /api/model_registry/v1alpha3/serving_environment`.
|
||
|
||
#What about ServeModel?
|
||
# Experiment
|
||
GetExperimentById:
|
||
operationId: getExperiment
|
||
parameters:
|
||
experimentId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `experimentId` parameter in `GET /api/model_registry/v1alpha3/experiments/{experimentId}`.
|
||
|
||
PatchExperimentById:
|
||
operationId: updateExperiment
|
||
parameters:
|
||
experimentId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `experimentId` parameter in `PATCH /api/model_registry/v1alpha3/experiments/{experimentId}`.
|
||
|
||
SearchExperimentByExternalId:
|
||
operationId: findExperiment
|
||
parameters:
|
||
externalId: "$response.body#/externalId"
|
||
description: >
|
||
The `externalId` value returned in the response can be used as the `externalId` parameter in `GET /api/model_registry/v1alpha3/experiment`.
|
||
|
||
SearchExperimentByName:
|
||
operationId: findExperiment
|
||
parameters:
|
||
name: "$response.body#/name"
|
||
description: >
|
||
The `name` value returned in the response can be used as the `name` parameter in `GET /api/model_registry/v1alpha3/experiment`.
|
||
|
||
# ExperimentRun
|
||
GetExperimentRunById:
|
||
operationId: getExperimentRun
|
||
parameters:
|
||
experimentrunId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `experimentrunId` parameter in `GET /api/model_registry/v1alpha3/experiment_runs/{experimentrunId}`.
|
||
|
||
PatchExperimentRunById:
|
||
operationId: updateExperimentRun
|
||
parameters:
|
||
experimentrunId: "$response.body#/id"
|
||
description: >
|
||
The `id` value returned in the response can be used as the `experimentrunId` parameter in `PATCH /api/model_registry/v1alpha3/experiment_runs/{experimentrunId}`.
|
||
|
||
SearchExperimentRunByExternalId:
|
||
operationId: findExperimentRun
|
||
parameters:
|
||
externalId: "$response.body#/externalId"
|
||
description: >
|
||
The `externalId` value returned in the response can be used as the `externalId` parameter in `GET /api/model_registry/v1alpha3/experiment_run`.
|
||
|
||
SearchExperimentRunByName:
|
||
operationId: findExperimentRun
|
||
parameters:
|
||
name: "$response.body#/name"
|
||
description: >
|
||
The `name` value returned in the response can be used as the `name` parameter in `GET /api/model_registry/v1alpha3/experiment_run`.
|
||
|
||
security:
|
||
- Bearer: []
|
||
tags:
|
||
- name: ModelRegistryService
|
||
description: Model Registry Service REST API
|