diff --git a/clients/ui/api/openapi/mod-arch.yaml b/clients/ui/api/openapi/mod-arch.yaml new file mode 100644 index 000000000..2085a192d --- /dev/null +++ b/clients/ui/api/openapi/mod-arch.yaml @@ -0,0 +1,1121 @@ +openapi: 3.0.3 +info: + title: Model Registry Mod Arch REST API + version: 1.0.0 + description: REST API Model Registry BFF + 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/v1/model_registry: + summary: Path used to manage the list of Model Registry. + description: >- + The REST endpoint/path used to list `Model Registry` entities. This path contains a `GET` to perform the list of the resource. + get: + tags: + - K8SOperation + responses: + "200": + $ref: "#/components/responses/ModelRegistryRespone" + "401": + $ref: "#/components/responses/Unauthorized" + "500": + $ref: "#/components/responses/InternalServerError" + operationId: getModelRegistries + summary: List All Model Registries + description: Gets a list of all `Model Registry` entities. + /api/v1/model_registry/{modelRegistryName}/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 + parameters: + - $ref: "#/components/parameters/modelRegistryName" + responses: + "200": + $ref: "#/components/responses/ModelVersionResponse" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + "500": + $ref: "#/components/responses/InternalServerError" + 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" + operationId: updateModelVersion + summary: Update a ModelVersion + description: Updates an existing `ModelVersion`. + parameters: + - $ref: "#/components/parameters/modelRegistryName" + - name: modelversionId + description: A unique identifier for a `ModelVersion`. + schema: + type: string + in: path + required: true + /api/v1/model_registry/{modelRegistryName}/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/modelRegistryName" + - $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" + 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 + parameters: + - $ref: "#/components/parameters/modelRegistryName" + responses: + "201": + $ref: "#/components/responses/RegisteredModelResponse" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "500": + $ref: "#/components/responses/InternalServerError" + operationId: createRegisteredModel + summary: Create a RegisteredModel + description: Creates a new instance of a `RegisteredModel`. + /api/v1/model_registry/{modelRegistryName}/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 + parameters: + - $ref: "#/components/parameters/modelRegistryName" + responses: + "200": + $ref: "#/components/responses/RegisteredModelResponse" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + "500": + $ref: "#/components/responses/InternalServerError" + 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" + operationId: updateRegisteredModel + summary: Update a RegisteredModel + description: Updates an existing `RegisteredModel`. + parameters: + - $ref: "#/components/parameters/modelRegistryName" + - name: registeredmodelId + description: A unique identifier for a `RegisteredModel`. + schema: + type: string + in: path + required: true + /api/v1/model_registry/{modelRegistryName}/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/modelRegistryName" + - $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/ArtifactListResponse" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + "500": + $ref: "#/components/responses/InternalServerError" + 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 + parameters: + - $ref: "#/components/parameters/modelRegistryName" + 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" + "500": + $ref: "#/components/responses/InternalServerError" + operationId: createModelVersionArtifact + summary: Create 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/v1/model_registry/{modelRegistryName}/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/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" + 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" + "500": + $ref: "#/components/responses/InternalServerError" + operationId: createRegisteredModelVersion + summary: Create a ModelVersion in RegisteredModel + description: Creates a new instance of a `ModelVersion`. + parameters: + - $ref: "#/components/parameters/modelRegistryName" + - name: registeredmodelId + description: A unique identifier for a `RegisteredModel`. + schema: + type: string + in: path + required: true +components: + schemas: + ModelRegistry: + required: + - name + type: object + properties: + name: + type: string + example: my-model-registry + displayName: + type: string + example: My Model Registry + description: + type: string + example: This is the main model reigstry for the cluster and contains.. + 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 + 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 + 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 + 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 + 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 + ModelArtifact: + description: An ML model artifact. + type: object + required: + - artifactType + properties: + artifactType: + type: string + default: "model-artifact" + allOf: + - $ref: "#/components/schemas/BaseArtifact" + - $ref: "#/components/schemas/ModelArtifactCreate" + DocArtifact: + description: A document. + type: object + required: + - artifactType + properties: + artifactType: + type: string + default: "doc-artifact" + allOf: + - $ref: "#/components/schemas/BaseArtifact" + RegisteredModel: + description: A registered model in model registry. A registered model has ModelVersion children. + allOf: + - $ref: "#/components/schemas/BaseResource" + - type: object + - $ref: "#/components/schemas/RegisteredModelCreate" + ModelVersionList: + description: List of ModelVersion entities. + type: object + allOf: + - type: object + properties: + items: + description: Array of `ModelVersion` entities. + type: array + items: + $ref: "#/components/schemas/ModelVersion" + - $ref: "#/components/schemas/BaseResourceList" + ModelArtifactList: + description: List of ModelArtifact entities. + type: object + allOf: + - type: object + properties: + items: + description: Array of `ModelArtifact` entities. + type: array + items: + $ref: "#/components/schemas/ModelArtifact" + - $ref: "#/components/schemas/BaseResourceList" + RegisteredModelCreate: + description: A registered model in model registry. A registered model has ModelVersion children. + allOf: + - type: object + - $ref: "#/components/schemas/BaseResourceCreate" + - $ref: "#/components/schemas/RegisteredModelUpdate" + RegisteredModelUpdate: + description: A registered model in model registry. A registered model has ModelVersion children. + allOf: + - $ref: "#/components/schemas/BaseResourceUpdate" + - type: object + properties: + owner: + type: string + state: + $ref: "#/components/schemas/RegisteredModelState" + 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: + - 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 + 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 + BaseArtifactCreate: + allOf: + - $ref: "#/components/schemas/BaseArtifactUpdate" + - $ref: "#/components/schemas/BaseResourceCreate" + BaseArtifactUpdate: + allOf: + - $ref: "#/components/schemas/BaseResourceUpdate" + - type: object + properties: + 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" + BaseExecution: + allOf: + - $ref: "#/components/schemas/BaseExecutionCreate" + - type: object + - $ref: "#/components/schemas/BaseResource" + BaseExecutionCreate: + allOf: + - $ref: "#/components/schemas/BaseExecutionUpdate" + - type: object + - $ref: "#/components/schemas/BaseResourceCreate" + BaseExecutionUpdate: + type: object + allOf: + - type: object + properties: + lastKnownState: + $ref: "#/components/schemas/ExecutionState" + - $ref: "#/components/schemas/BaseResourceUpdate" + 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. + 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 + 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 + 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 + 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 + MetadataBoolValue: + description: A bool property value. + type: object + required: + - metadataType + - bool_value + properties: + bool_value: + type: boolean + metadataType: + type: string + example: MetadataBoolValue + default: MetadataBoolValue + BaseResource: + allOf: + - $ref: "#/components/schemas/BaseResourceCreate" + - type: object + properties: + id: + format: int64 + description: Output only. The unique server generated id of the resource. + type: string + readOnly: true + 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 + BaseResourceCreate: + allOf: + - $ref: "#/components/schemas/BaseResourceUpdate" + - type: object + properties: + 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 + 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 + 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 + ArtifactList: + description: A list of Artifact entities. + type: object + allOf: + - type: object + properties: + items: + description: Array of `Artifact` entities. + type: array + items: + $ref: "#/components/schemas/Artifact" + - $ref: "#/components/schemas/BaseResourceList" + ModelArtifactUpdate: + description: An ML model artifact. + allOf: + - $ref: "#/components/schemas/BaseArtifactUpdate" + - type: object + properties: + 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 + ModelArtifactCreate: + description: An ML model artifact. + type: object + allOf: + - $ref: "#/components/schemas/BaseArtifactCreate" + - $ref: "#/components/schemas/ModelArtifactUpdate" + Error: + description: Error code and message. + required: + - code + - message + type: object + properties: + code: + description: Error code + type: string + message: + description: Error message + type: string + SortOrder: + description: Supported sort direction for ordering result entities. + enum: + - ASC + - DESC + type: string + OrderByField: + description: Supported fields for ordering result entities. + enum: + - CREATE_TIME + - LAST_UPDATE_TIME + - Id + type: string + Artifact: + oneOf: + - $ref: "#/components/schemas/ModelArtifact" + - $ref: "#/components/schemas/DocArtifact" + discriminator: + propertyName: artifactType + mapping: + model-artifact: "#/components/schemas/ModelArtifact" + doc-artifact: "#/components/schemas/DocArtifact" + description: A metadata Artifact Entity. + BaseArtifact: + allOf: + - $ref: "#/components/schemas/BaseArtifactCreate" + - $ref: "#/components/schemas/BaseResource" + ServingEnvironmentList: + description: List of ServingEnvironments. + type: object + allOf: + - type: object + properties: + items: + description: "" + type: array + items: + $ref: "#/components/schemas/ServingEnvironment" + readOnly: false + - $ref: "#/components/schemas/BaseResourceList" + RegisteredModelList: + description: List of RegisteredModels. + type: object + allOf: + - type: object + properties: + items: + description: "" + type: array + items: + $ref: "#/components/schemas/RegisteredModel" + readOnly: false + - $ref: "#/components/schemas/BaseResourceList" + ServingEnvironment: + description: A Model Serving environment for serving `RegisteredModels`. + allOf: + - $ref: "#/components/schemas/BaseResource" + - type: object + - $ref: "#/components/schemas/ServingEnvironmentCreate" + ServingEnvironmentUpdate: + description: A Model Serving environment for serving `RegisteredModels`. + allOf: + - $ref: "#/components/schemas/BaseResourceUpdate" + ServingEnvironmentCreate: + description: A Model Serving environment for serving `RegisteredModels`. + allOf: + - type: object + - $ref: "#/components/schemas/BaseResourceCreate" + - $ref: "#/components/schemas/ServingEnvironmentUpdate" + 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" + InferenceServiceList: + description: List of InferenceServices. + type: object + allOf: + - type: object + properties: + items: + description: "" + type: array + items: + $ref: "#/components/schemas/InferenceService" + readOnly: false + - $ref: "#/components/schemas/BaseResourceList" + ServeModelList: + description: List of ServeModel entities. + type: object + allOf: + - type: object + properties: + items: + description: Array of `ModelArtifact` entities. + type: array + items: + $ref: "#/components/schemas/ServeModel" + - $ref: "#/components/schemas/BaseResourceList" + ServeModel: + description: An ML model serving action. + type: object + allOf: + - $ref: "#/components/schemas/BaseExecution" + - $ref: "#/components/schemas/ServeModelCreate" + ServeModelUpdate: + description: An ML model serving action. + allOf: + - $ref: "#/components/schemas/BaseExecutionUpdate" + ServeModelCreate: + description: An ML model serving action. + allOf: + - $ref: "#/components/schemas/BaseExecutionCreate" + - $ref: "#/components/schemas/ServeModelUpdate" + - required: + - modelVersionId + type: object + properties: + modelVersionId: + description: ID of the `ModelVersion` that was served in `InferenceService`. + 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" + InferenceServiceCreate: + description: >- + An `InferenceService` entity in a `ServingEnvironment` represents a deployed `ModelVersion` from a `RegisteredModel` created by Model Serving. + allOf: + - $ref: "#/components/schemas/BaseResourceCreate" + - $ref: "#/components/schemas/InferenceServiceUpdate" + - required: + - registeredModelId + - servingEnvironmentId + 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 + responses: + NotFound: + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + description: The specified resource was not found + BadRequest: + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + description: Bad Request parameters + Unauthorized: + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + description: Unauthorized + InternalServerError: + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + description: Unexpected internal server error + ModelRegistryRespone: + content: + application/json: + schema: + type: array + items: + $ref: "#/components/schemas/ModelRegistry" + description: A response containing a list of ModelArtifact entities. + ModelArtifactListResponse: + content: + application/json: + schema: + $ref: "#/components/schemas/ModelArtifactList" + description: A response containing a list of ModelArtifact entities. + ModelArtifactResponse: + content: + application/json: + schema: + $ref: "#/components/schemas/ModelArtifact" + description: A response containing a `ModelArtifact` entity. + ModelVersionListResponse: + content: + application/json: + schema: + $ref: "#/components/schemas/ModelVersionList" + description: A response containing a list of `ModelVersion` entities. + ModelVersionResponse: + content: + application/json: + schema: + $ref: "#/components/schemas/ModelVersion" + description: A response containing a `ModelVersion` entity. + RegisteredModelListResponse: + content: + application/json: + schema: + $ref: "#/components/schemas/RegisteredModelList" + description: A response containing a list of `RegisteredModel` entities. + RegisteredModelResponse: + content: + application/json: + schema: + $ref: "#/components/schemas/RegisteredModel" + description: A response containing a `RegisteredModel` entity. + ArtifactResponse: + content: + application/json: + schema: + $ref: "#/components/schemas/Artifact" + description: A response containing an `Artifact` entity. + ArtifactListResponse: + content: + application/json: + schema: + $ref: "#/components/schemas/ArtifactList" + description: A response containing a list of `Artifact` entities. + ServingEnvironmentListResponse: + content: + application/json: + schema: + $ref: "#/components/schemas/ServingEnvironmentList" + description: A response containing a list of `ServingEnvironment` entities. + ServingEnvironmentResponse: + content: + application/json: + schema: + $ref: "#/components/schemas/ServingEnvironment" + description: A response containing a `ServingEnvironment` entity. + InferenceServiceListResponse: + content: + application/json: + schema: + $ref: "#/components/schemas/InferenceServiceList" + description: A response containing a list of `InferenceService` entities. + InferenceServiceResponse: + content: + application/json: + schema: + $ref: "#/components/schemas/InferenceService" + description: A response containing a `InferenceService` entity. + 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. + parameters: + modelRegistryName: + name: modelRegistryName + description: Name of the Model Registry selected. + schema: + type: string + in: path + required: true + 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 + 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 + 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 + 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 + securitySchemes: + Bearer: + scheme: bearer + bearerFormat: JWT + type: http + description: Bearer JWT scheme +security: + - Bearer: [] +tags: + - name: ModelRegistryService + description: Model Registry Service REST API + - name: K8SOperation + description: Operation performed in Kubernetes \ No newline at end of file