{ "swagger": "2.0", "info": { "title": "registry/RegistryService.proto", "version": "version not set" }, "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/model_versions/find": { "post": { "summary": "CRUD for Model Version", "operationId": "RegistryService_FindModelVersion4", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryFindModelVersionRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryFindModelVersionRequest" } } ], "tags": [ "RegistryService" ] } }, "/model_versions/{id.model_version_id}": { "get": { "operationId": "RegistryService_GetModelVersion2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryGetModelVersionRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.model_version_id", "description": "ModelVersion referred to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id.model_id.named_id.name", "description": "Model Name.", "in": "query", "required": false, "type": "string" }, { "name": "id.model_id.named_id.workspace_name", "description": "WorkspaceName.", "in": "query", "required": false, "type": "string" }, { "name": "id.model_id.registered_model_id", "description": "Model refered to by id.", "in": "query", "required": false, "type": "string", "format": "uint64" } ], "tags": [ "RegistryService" ] }, "delete": { "operationId": "RegistryService_DeleteModelVersion3", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryDeleteModelVersionRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.model_version_id", "description": "ModelVersion referred to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id.model_id.named_id.name", "description": "Model Name.", "in": "query", "required": false, "type": "string" }, { "name": "id.model_id.named_id.workspace_name", "description": "WorkspaceName.", "in": "query", "required": false, "type": "string" }, { "name": "id.model_id.registered_model_id", "description": "Model refered to by id.", "in": "query", "required": false, "type": "string", "format": "uint64" } ], "tags": [ "RegistryService" ] } }, "/model_versions/{id.model_version_id}/lock": { "put": { "operationId": "RegistryService_SetLockModelVersion", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registrySetLockModelVersionRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.model_version_id", "description": "ModelVersion referred to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registrySetLockModelVersionRequest" } } ], "tags": [ "RegistryService" ] } }, "/model_versions/{model_version_id}/artifacts/{artifact_key}": { "delete": { "operationId": "RegistryService_DeleteModelVersionArtifact", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/vertaregistryEmpty" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "model_version_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "artifact_key", "in": "path", "required": true, "type": "string" } ], "tags": [ "RegistryService" ] } }, "/model_versions/{model_version_id}/commitArtifactPart": { "post": { "operationId": "RegistryService_commitArtifactPart", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryCommitArtifactPartResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "model_version_id", "description": "id of model version", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryCommitArtifactPart" } } ], "tags": [ "RegistryService" ] } }, "/model_versions/{model_version_id}/commitMultipartArtifact": { "post": { "operationId": "RegistryService_commitMultipartArtifact", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryCommitMultipartArtifactResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "model_version_id", "description": "id of model version", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryCommitMultipartArtifact" } } ], "tags": [ "RegistryService" ] } }, "/model_versions/{model_version_id}/getCommittedArtifactParts": { "get": { "operationId": "RegistryService_getCommittedArtifactParts", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryGetCommittedArtifactPartsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "model_version_id", "description": "id of model version", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "key", "description": "artifact key.", "in": "query", "required": false, "type": "string" } ], "tags": [ "RegistryService" ] } }, "/model_versions/{model_version_id}/getUrlForArtifact": { "post": { "operationId": "RegistryService_getUrlForArtifact", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryGetUrlForArtifactResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "model_version_id", "description": "id of model version", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryGetUrlForArtifact" } } ], "tags": [ "RegistryService" ] } }, "/model_versions/{model_version_id}/logAttributes": { "post": { "operationId": "RegistryService_logAttributesInModelVersion", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryLogAttributesInModelVersionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "model_version_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryLogAttributesInModelVersion" } } ], "tags": [ "RegistryService" ] } }, "/model_versions/{model_version_id}/logCodeBlobInModelVersion": { "post": { "operationId": "RegistryService_logCodeBlobInModelVersion", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryLogCodeBlobInModelVersionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "model_version_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryLogCodeBlobInModelVersion" } } ], "tags": [ "RegistryService" ] } }, "/model_versions/{model_version_id}/logDatasets": { "post": { "operationId": "RegistryService_logDatasetsInModelVersion", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryLogDatasetsInModelVersionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "model_version_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryLogDatasetsInModelVersion" } } ], "tags": [ "RegistryService" ] } }, "/model_versions/{model_version_id}/logDockerMetadata": { "post": { "operationId": "RegistryService_logDockerMetadataInModelVersion", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryLogDockerMetadataInModelVersionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "model_version_id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryLogDockerMetadataInModelVersion" } } ], "tags": [ "RegistryService" ] } }, "/registered_models/count": { "get": { "operationId": "RegistryService_GetRegisteredModelCount", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryGetRegisteredModelCountRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "project_id", "in": "query", "required": false, "type": "string" } ], "tags": [ "RegistryService" ] } }, "/registered_models/find": { "post": { "summary": "CRUD for RegisteredModel", "operationId": "RegistryService_FindRegisteredModel2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryFindRegisteredModelRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryFindRegisteredModelRequest" } } ], "tags": [ "RegistryService" ] } }, "/registered_models/model_versions/external_deployments": { "post": { "operationId": "RegistryService_CreateExternalDeployment", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryExternalDeploymentRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryExternalDeployment" } } ], "tags": [ "RegistryService" ] }, "put": { "operationId": "RegistryService_UpdateExternalDeployment", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryExternalDeploymentRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryExternalDeployment" } } ], "tags": [ "RegistryService" ] } }, "/registered_models/model_versions/external_deployments/{external_deployment_id}": { "get": { "operationId": "RegistryService_GetExternalDeployment", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryExternalDeploymentRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "external_deployment_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "RegistryService" ] }, "delete": { "operationId": "RegistryService_DeleteExternalDeployment", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/vertaregistryEmpty" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "external_deployment_id", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "RegistryService" ] } }, "/registered_models/{id.model_id.registered_model_id}/model_versions": { "post": { "operationId": "RegistryService_CreateModelVersion2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registrySetModelVersionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.model_id.registered_model_id", "description": "Model refered to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryModelVersion" } }, { "name": "id.model_version_id", "description": "ModelVersion referred to by id.", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "id.model_id.named_id.name", "description": "Model Name.", "in": "query", "required": false, "type": "string" }, { "name": "id.model_id.named_id.workspace_name", "description": "WorkspaceName.", "in": "query", "required": false, "type": "string" }, { "name": "update_mask.paths", "description": "The set of field mask paths.", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": [ "RegistryService" ] } }, "/registered_models/{id.model_id.registered_model_id}/model_versions/{id.model_version_id}": { "delete": { "operationId": "RegistryService_DeleteModelVersion2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryDeleteModelVersionRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.model_id.registered_model_id", "description": "Model refered to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id.model_version_id", "description": "ModelVersion referred to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id.model_id.named_id.name", "description": "Model Name.", "in": "query", "required": false, "type": "string" }, { "name": "id.model_id.named_id.workspace_name", "description": "WorkspaceName.", "in": "query", "required": false, "type": "string" } ], "tags": [ "RegistryService" ] }, "put": { "operationId": "RegistryService_UpdateModelVersion6", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registrySetModelVersionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.model_id.registered_model_id", "description": "Model refered to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id.model_version_id", "description": "ModelVersion referred to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryModelVersion" } }, { "name": "id.model_id.named_id.name", "description": "Model Name.", "in": "query", "required": false, "type": "string" }, { "name": "id.model_id.named_id.workspace_name", "description": "WorkspaceName.", "in": "query", "required": false, "type": "string" }, { "name": "update_mask.paths", "description": "The set of field mask paths.", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": [ "RegistryService" ] }, "patch": { "operationId": "RegistryService_UpdateModelVersion2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registrySetModelVersionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.model_id.registered_model_id", "description": "Model refered to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id.model_version_id", "description": "ModelVersion referred to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryModelVersion" } }, { "name": "id.model_id.named_id.name", "description": "Model Name.", "in": "query", "required": false, "type": "string" }, { "name": "id.model_id.named_id.workspace_name", "description": "WorkspaceName.", "in": "query", "required": false, "type": "string" }, { "name": "update_mask.paths", "description": "The set of field mask paths.", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": [ "RegistryService" ] } }, "/registered_models/{id.model_id.registered_model_id}/model_versions/{id.model_version_id}/full_body": { "patch": { "operationId": "RegistryService_UpdateModelVersion4", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registrySetModelVersionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.model_id.registered_model_id", "description": "Model refered to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id.model_version_id", "description": "ModelVersion referred to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registrySetModelVersion" } } ], "tags": [ "RegistryService" ] } }, "/registered_models/{id.registered_model_id}": { "get": { "operationId": "RegistryService_GetRegisteredModel2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryGetRegisteredModelRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.registered_model_id", "description": "Model refered to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id.named_id.name", "description": "Model Name.", "in": "query", "required": false, "type": "string" }, { "name": "id.named_id.workspace_name", "description": "WorkspaceName.", "in": "query", "required": false, "type": "string" } ], "tags": [ "RegistryService" ] }, "delete": { "operationId": "RegistryService_DeleteRegisteredModel2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryDeleteRegisteredModelRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.registered_model_id", "description": "Model refered to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id.named_id.name", "description": "Model Name.", "in": "query", "required": false, "type": "string" }, { "name": "id.named_id.workspace_name", "description": "WorkspaceName.", "in": "query", "required": false, "type": "string" } ], "tags": [ "RegistryService" ] }, "put": { "operationId": "RegistryService_UpdateRegisteredModel6", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registrySetRegisteredModelResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.registered_model_id", "description": "Model refered to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryRegisteredModel" } }, { "name": "id.named_id.name", "description": "Model Name.", "in": "query", "required": false, "type": "string" }, { "name": "id.named_id.workspace_name", "description": "WorkspaceName.", "in": "query", "required": false, "type": "string" }, { "name": "update_mask.paths", "description": "The set of field mask paths.", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": [ "RegistryService" ] }, "patch": { "operationId": "RegistryService_UpdateRegisteredModel2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registrySetRegisteredModelResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.registered_model_id", "description": "Model refered to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryRegisteredModel" } }, { "name": "id.named_id.name", "description": "Model Name.", "in": "query", "required": false, "type": "string" }, { "name": "id.named_id.workspace_name", "description": "WorkspaceName.", "in": "query", "required": false, "type": "string" }, { "name": "update_mask.paths", "description": "The set of field mask paths.", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": [ "RegistryService" ] } }, "/registered_models/{id.registered_model_id}/full_body": { "patch": { "operationId": "RegistryService_UpdateRegisteredModel4", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registrySetRegisteredModelResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.registered_model_id", "description": "Model refered to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registrySetRegisteredModel" } } ], "tags": [ "RegistryService" ] } }, "/registered_models/{id.registered_model_id}/model_versions/find": { "post": { "summary": "CRUD for Model Version", "operationId": "RegistryService_FindModelVersion2", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryFindModelVersionRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.registered_model_id", "description": "Model refered to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryFindModelVersionRequest" } } ], "tags": [ "RegistryService" ] } }, "/workspaces/{id.model_id.named_id.workspace_name}/registered_models/{id.model_id.named_id.name}/model_versions": { "post": { "operationId": "RegistryService_CreateModelVersion", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registrySetModelVersionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.model_id.named_id.workspace_name", "description": "WorkspaceName", "in": "path", "required": true, "type": "string" }, { "name": "id.model_id.named_id.name", "description": "Model Name", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryModelVersion" } }, { "name": "id.model_version_id", "description": "ModelVersion referred to by id.", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "id.model_id.registered_model_id", "description": "Model refered to by id.", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "update_mask.paths", "description": "The set of field mask paths.", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": [ "RegistryService" ] } }, "/workspaces/{id.model_id.named_id.workspace_name}/registered_models/{id.model_id.named_id.name}/model_versions/{id.model_version_id}": { "get": { "operationId": "RegistryService_GetModelVersion", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryGetModelVersionRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.model_id.named_id.workspace_name", "description": "WorkspaceName", "in": "path", "required": true, "type": "string" }, { "name": "id.model_id.named_id.name", "description": "Model Name", "in": "path", "required": true, "type": "string" }, { "name": "id.model_version_id", "description": "ModelVersion referred to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id.model_id.registered_model_id", "description": "Model refered to by id.", "in": "query", "required": false, "type": "string", "format": "uint64" } ], "tags": [ "RegistryService" ] }, "delete": { "operationId": "RegistryService_DeleteModelVersion", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryDeleteModelVersionRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.model_id.named_id.workspace_name", "description": "WorkspaceName", "in": "path", "required": true, "type": "string" }, { "name": "id.model_id.named_id.name", "description": "Model Name", "in": "path", "required": true, "type": "string" }, { "name": "id.model_version_id", "description": "ModelVersion referred to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "id.model_id.registered_model_id", "description": "Model refered to by id.", "in": "query", "required": false, "type": "string", "format": "uint64" } ], "tags": [ "RegistryService" ] }, "put": { "operationId": "RegistryService_UpdateModelVersion5", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registrySetModelVersionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.model_id.named_id.workspace_name", "description": "WorkspaceName", "in": "path", "required": true, "type": "string" }, { "name": "id.model_id.named_id.name", "description": "Model Name", "in": "path", "required": true, "type": "string" }, { "name": "id.model_version_id", "description": "ModelVersion referred to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryModelVersion" } }, { "name": "id.model_id.registered_model_id", "description": "Model refered to by id.", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "update_mask.paths", "description": "The set of field mask paths.", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": [ "RegistryService" ] }, "patch": { "operationId": "RegistryService_UpdateModelVersion", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registrySetModelVersionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.model_id.named_id.workspace_name", "description": "WorkspaceName", "in": "path", "required": true, "type": "string" }, { "name": "id.model_id.named_id.name", "description": "Model Name", "in": "path", "required": true, "type": "string" }, { "name": "id.model_version_id", "description": "ModelVersion referred to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryModelVersion" } }, { "name": "id.model_id.registered_model_id", "description": "Model refered to by id.", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "update_mask.paths", "description": "The set of field mask paths.", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": [ "RegistryService" ] } }, "/workspaces/{id.model_id.named_id.workspace_name}/registered_models/{id.model_id.named_id.name}/model_versions/{id.model_version_id}/full_body": { "patch": { "operationId": "RegistryService_UpdateModelVersion3", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registrySetModelVersionResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.model_id.named_id.workspace_name", "description": "WorkspaceName", "in": "path", "required": true, "type": "string" }, { "name": "id.model_id.named_id.name", "description": "Model Name", "in": "path", "required": true, "type": "string" }, { "name": "id.model_version_id", "description": "ModelVersion referred to by id", "in": "path", "required": true, "type": "string", "format": "uint64" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registrySetModelVersion" } } ], "tags": [ "RegistryService" ] } }, "/workspaces/{id.named_id.workspace_name}/model_versions/find": { "post": { "summary": "CRUD for Model Version", "operationId": "RegistryService_FindModelVersion3", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryFindModelVersionRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.named_id.workspace_name", "description": "WorkspaceName", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryFindModelVersionRequest" } } ], "tags": [ "RegistryService" ] } }, "/workspaces/{id.named_id.workspace_name}/registered_models": { "post": { "operationId": "RegistryService_CreateRegisteredModel", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registrySetRegisteredModelResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.named_id.workspace_name", "description": "WorkspaceName", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryRegisteredModel" } }, { "name": "id.named_id.name", "description": "Model Name.", "in": "query", "required": false, "type": "string" }, { "name": "id.registered_model_id", "description": "Model refered to by id.", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "update_mask.paths", "description": "The set of field mask paths.", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": [ "RegistryService" ] } }, "/workspaces/{id.named_id.workspace_name}/registered_models/{id.named_id.name}": { "get": { "operationId": "RegistryService_GetRegisteredModel", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryGetRegisteredModelRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.named_id.workspace_name", "description": "WorkspaceName", "in": "path", "required": true, "type": "string" }, { "name": "id.named_id.name", "description": "Model Name", "in": "path", "required": true, "type": "string" }, { "name": "id.registered_model_id", "description": "Model refered to by id.", "in": "query", "required": false, "type": "string", "format": "uint64" } ], "tags": [ "RegistryService" ] }, "delete": { "operationId": "RegistryService_DeleteRegisteredModel", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryDeleteRegisteredModelRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.named_id.workspace_name", "description": "WorkspaceName", "in": "path", "required": true, "type": "string" }, { "name": "id.named_id.name", "description": "Model Name", "in": "path", "required": true, "type": "string" }, { "name": "id.registered_model_id", "description": "Model refered to by id.", "in": "query", "required": false, "type": "string", "format": "uint64" } ], "tags": [ "RegistryService" ] }, "put": { "operationId": "RegistryService_UpdateRegisteredModel5", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registrySetRegisteredModelResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.named_id.workspace_name", "description": "WorkspaceName", "in": "path", "required": true, "type": "string" }, { "name": "id.named_id.name", "description": "Model Name", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryRegisteredModel" } }, { "name": "id.registered_model_id", "description": "Model refered to by id.", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "update_mask.paths", "description": "The set of field mask paths.", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": [ "RegistryService" ] }, "patch": { "operationId": "RegistryService_UpdateRegisteredModel", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registrySetRegisteredModelResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.named_id.workspace_name", "description": "WorkspaceName", "in": "path", "required": true, "type": "string" }, { "name": "id.named_id.name", "description": "Model Name", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryRegisteredModel" } }, { "name": "id.registered_model_id", "description": "Model refered to by id.", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "update_mask.paths", "description": "The set of field mask paths.", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": [ "RegistryService" ] } }, "/workspaces/{id.named_id.workspace_name}/registered_models/{id.named_id.name}/full_body": { "patch": { "operationId": "RegistryService_UpdateRegisteredModel3", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registrySetRegisteredModelResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.named_id.workspace_name", "description": "WorkspaceName", "in": "path", "required": true, "type": "string" }, { "name": "id.named_id.name", "description": "Model Name", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registrySetRegisteredModel" } } ], "tags": [ "RegistryService" ] } }, "/workspaces/{id.named_id.workspace_name}/registered_models/{id.named_id.name}/model_versions/find": { "post": { "summary": "CRUD for Model Version", "operationId": "RegistryService_FindModelVersion", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryFindModelVersionRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "id.named_id.workspace_name", "description": "WorkspaceName", "in": "path", "required": true, "type": "string" }, { "name": "id.named_id.name", "description": "Model Name", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryFindModelVersionRequest" } } ], "tags": [ "RegistryService" ] } }, "/workspaces/{workspace_name}/registered_models/find": { "post": { "summary": "CRUD for RegisteredModel", "operationId": "RegistryService_FindRegisteredModel", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/registryFindRegisteredModelRequestResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/runtimeError" } } }, "parameters": [ { "name": "workspace_name", "description": "User or organization name", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/registryFindRegisteredModelRequest" } } ], "tags": [ "RegistryService" ] } } }, "definitions": { "ActionTypeEnumActionType": { "type": "string", "enum": [ "UNKNOWN", "OTHER", "CLASSIFICATION", "CLUSTERING", "DETECTION", "REGRESSION", "TRANSCRIPTION", "TRANSLATION" ], "default": "UNKNOWN" }, "ArtifactTypeEnumArtifactType": { "type": "string", "enum": [ "IMAGE", "MODEL", "TENSORBOARD", "DATA", "BLOB", "STRING", "CODE", "CONTAINER" ], "default": "IMAGE" }, "CollaboratorTypeEnumCollaboratorType": { "type": "string", "enum": [ "READ_ONLY", "READ_WRITE" ], "default": "READ_ONLY" }, "CustomAttributeTargetTypeEnumCustomAttributeTargetType": { "type": "string", "enum": [ "UNKNOWN", "REGISTERED_MODEL", "REGISTERED_MODEL_VERSION", "CHECKLIST_TEMPLATE" ], "default": "UNKNOWN" }, "DataTypeEnumDataType": { "type": "string", "enum": [ "UNKNOWN", "OTHER", "AUDIO", "IMAGE", "TABULAR", "TEXT", "VIDEO" ], "default": "UNKNOWN" }, "LocationTypeEnumLocationType": { "type": "string", "enum": [ "UNKNOWN", "CLOUD_PROVIDER", "INTERNAL_PRIVATE_NETWORK", "DEVICE" ], "default": "UNKNOWN" }, "ModelVersionLockLevelEnumModelVersionLockLevel": { "type": "string", "enum": [ "UNKNOWN", "OPEN", "CLOSED", "REDACT" ], "default": "UNKNOWN" }, "OperatorEnumOperator": { "type": "string", "enum": [ "EQ", "NE", "GT", "GTE", "LT", "LTE", "CONTAIN", "NOT_CONTAIN", "IN", "NOT_IN" ], "default": "EQ" }, "StageEnumStage": { "type": "string", "enum": [ "UNKNOWN", "DEVELOPMENT", "STAGING", "PRODUCTION", "ARCHIVED", "UNASSIGNED" ], "default": "UNKNOWN" }, "TaskTypeEnumTaskType": { "type": "string", "enum": [ "UNKNOWN", "OTHER", "CLASSIFICATION", "CLUSTERING", "DETECTION", "REGRESSION", "TRANSCRIPTION", "TRANSLATION" ], "default": "UNKNOWN" }, "TernaryEnumTernary": { "type": "string", "enum": [ "UNKNOWN", "TRUE", "FALSE" ], "default": "UNKNOWN" }, "ValueTypeEnumValueType": { "type": "string", "enum": [ "STRING", "NUMBER", "LIST", "BLOB" ], "default": "STRING" }, "VisibilityEnumVisibility": { "type": "string", "enum": [ "PRIVATE", "PUBLIC", "ORG_SCOPED_PUBLIC", "ORG_DEFAULT" ], "default": "PRIVATE", "title": "- PRIVATE: Default to private\n - PUBLIC: Not supported\n - ORG_SCOPED_PUBLIC: Public to organization\n - ORG_DEFAULT: Default access for organization" }, "commonArtifact": { "type": "object", "properties": { "key": { "type": "string" }, "path": { "type": "string" }, "path_only": { "type": "boolean" }, "artifact_type": { "$ref": "#/definitions/ArtifactTypeEnumArtifactType" }, "linked_artifact_id": { "type": "string" }, "filename_extension": { "type": "string" }, "serialization": { "type": "string" }, "artifact_subtype": { "type": "string" }, "upload_completed": { "type": "boolean" } } }, "commonArtifactPart": { "type": "object", "properties": { "part_number": { "type": "string", "format": "uint64" }, "etag": { "type": "string" } } }, "commonGroupId": { "type": "object", "properties": { "org_id": { "type": "string" }, "group_id": { "type": "string" } } }, "commonKeyValue": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "object" }, "value_type": { "$ref": "#/definitions/ValueTypeEnumValueType", "description": "As per documentation of proto buffer 3.\n For enums, the default value is the first defined enum value, which must be 0." } } }, "commonKeyValueQuery": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "object" }, "value_type": { "$ref": "#/definitions/ValueTypeEnumValueType" }, "operator": { "$ref": "#/definitions/OperatorEnumOperator" } } }, "commonPagination": { "type": "object", "properties": { "page_number": { "type": "integer", "format": "int32" }, "page_limit": { "type": "integer", "format": "int32" } }, "title": "For pagination" }, "protobufAny": { "type": "object", "properties": { "type_url": { "type": "string" }, "value": { "type": "string", "format": "byte" } } }, "protobufFieldMask": { "type": "object", "properties": { "paths": { "type": "array", "items": { "type": "string" }, "description": "The set of field mask paths." } }, "description": "paths: \"f.a\"\n paths: \"f.b.d\"\n\nHere `f` represents a field in some root message, `a` and `b`\nfields in the message found in `f`, and `d` a field found in the\nmessage in `f.b`.\n\nField masks are used to specify a subset of fields that should be\nreturned by a get operation or modified by an update operation.\nField masks also have a custom JSON encoding (see below).\n\n# Field Masks in Projections\n\nWhen used in the context of a projection, a response message or\nsub-message is filtered by the API to only contain those fields as\nspecified in the mask. For example, if the mask in the previous\nexample is applied to a response message as follows:\n\n f {\n a : 22\n b {\n d : 1\n x : 2\n }\n y : 13\n }\n z: 8\n\nThe result will not contain specific values for fields x,y and z\n(their value will be set to the default, and omitted in proto text\noutput):\n\n\n f {\n a : 22\n b {\n d : 1\n }\n }\n\nA repeated field is not allowed except at the last position of a\npaths string.\n\nIf a FieldMask object is not present in a get operation, the\noperation applies to all fields (as if a FieldMask of all fields\nhad been specified).\n\nNote that a field mask does not necessarily apply to the\ntop-level response message. In case of a REST get operation, the\nfield mask applies directly to the response, but in case of a REST\nlist operation, the mask instead applies to each individual message\nin the returned resource list. In case of a REST custom method,\nother definitions may be used. Where the mask applies will be\nclearly documented together with its declaration in the API. In\nany case, the effect on the returned resource/resources is required\nbehavior for APIs.\n\n# Field Masks in Update Operations\n\nA field mask in update operations specifies which fields of the\ntargeted resource are going to be updated. The API is required\nto only change the values of the fields as specified in the mask\nand leave the others untouched. If a resource is passed in to\ndescribe the updated values, the API ignores the values of all\nfields not covered by the mask.\n\nIf a repeated field is specified for an update operation, new values will\nbe appended to the existing repeated field in the target resource. Note that\na repeated field is only allowed in the last position of a `paths` string.\n\nIf a sub-message is specified in the last position of the field mask for an\nupdate operation, then new value will be merged into the existing sub-message\nin the target resource.\n\nFor example, given the target message:\n\n f {\n b {\n d: 1\n x: 2\n }\n c: [1]\n }\n\nAnd an update message:\n\n f {\n b {\n d: 10\n }\n c: [2]\n }\n\nthen if the field mask is:\n\n paths: [\"f.b\", \"f.c\"]\n\nthen the result will be:\n\n f {\n b {\n d: 10\n x: 2\n }\n c: [1, 2]\n }\n\nAn implementation may provide options to override this default behavior for\nrepeated and message fields.\n\nIn order to reset a field's value to the default, the field must\nbe in the mask and set to the default value in the provided resource.\nHence, in order to reset all fields of a resource, provide a default\ninstance of the resource and set all fields in the mask, or do\nnot provide a mask as described below.\n\nIf a field mask is not present on update, the operation applies to\nall fields (as if a field mask of all fields has been specified).\nNote that in the presence of schema evolution, this may mean that\nfields the client does not know and has therefore not filled into\nthe request will be reset to their default. If this is unwanted\nbehavior, a specific service may require a client to always specify\na field mask, producing an error if not.\n\nAs with get operations, the location of the resource which\ndescribes the updated values in the request message depends on the\noperation kind. In any case, the effect of the field mask is\nrequired to be honored by the API.\n\n## Considerations for HTTP REST\n\nThe HTTP kind of an update operation which uses a field mask must\nbe set to PATCH instead of PUT in order to satisfy HTTP semantics\n(PUT must only be used for full updates).\n\n# JSON Encoding of Field Masks\n\nIn JSON, a field mask is encoded as a single string where paths are\nseparated by a comma. Fields name in each path are converted\nto/from lower-camel naming conventions.\n\nAs an example, consider the following message declarations:\n\n message Profile {\n User user = 1;\n Photo photo = 2;\n }\n message User {\n string display_name = 1;\n string address = 2;\n }\n\nIn proto a field mask for `Profile` may look as such:\n\n mask {\n paths: \"user.display_name\"\n paths: \"photo\"\n }\n\nIn JSON, the same mask is represented as below:\n\n {\n mask: \"user.displayName,photo\"\n }\n\n# Field Masks and Oneof Fields\n\nField masks treat fields in oneofs just as regular fields. Consider the\nfollowing message:\n\n message SampleMessage {\n oneof test_oneof {\n string name = 4;\n SubMessage sub_message = 9;\n }\n }\n\nThe field mask can be:\n\n mask {\n paths: \"name\"\n }\n\nOr:\n\n mask {\n paths: \"sub_message\"\n }\n\nNote that oneof type names (\"test_oneof\" in this case) cannot be used in\npaths.\n\n## Field Mask Verification\n\nThe implementation of any API method which has a FieldMask type field in the\nrequest should verify the included field paths, and return an\n`INVALID_ARGUMENT` error if any path is unmappable.", "title": "`FieldMask` represents a set of symbolic field paths, for example:" }, "protobufNullValue": { "type": "string", "enum": [ "NULL_VALUE" ], "default": "NULL_VALUE", "description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\n The JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value." }, "registryChecklistItemValue": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64", "title": "internal id" }, "completed": { "type": "boolean", "title": "value corresponds to if the item was marked as completed" }, "evidence": { "type": "string", "title": "value corresponds to user given evidence" }, "model_version_id": { "type": "string", "format": "uint64", "title": "id of the model version this belongs to" }, "checklist_template_id": { "type": "string", "format": "uint64", "title": "id of the template(UAC) this is related to" }, "checklist_template_item_id": { "type": "string", "format": "uint64", "title": "id of the template item (UAC) this is related to" }, "time_created": { "type": "string", "format": "int64", "title": "Timestamp recorded when this entity was created" }, "time_updated": { "type": "string", "format": "int64", "title": "Timestamp recorded when metadata for this entity was last updated" }, "created_by_id": { "type": "string", "format": "uint64", "title": "id of user(UAC) that created this entity" }, "updated_by_id": { "type": "string", "format": "uint64", "title": "id of user(UAC) that updated this entity" } } }, "registryCommitArtifactPart": { "type": "object", "properties": { "model_version_id": { "type": "string", "format": "uint64", "title": "id of model version" }, "key": { "type": "string", "title": "artifact key" }, "artifact_part": { "$ref": "#/definitions/commonArtifactPart" } } }, "registryCommitArtifactPartResponse": { "type": "object" }, "registryCommitMultipartArtifact": { "type": "object", "properties": { "model_version_id": { "type": "string", "format": "uint64", "title": "id of model version" }, "key": { "type": "string", "title": "artifact key" } } }, "registryCommitMultipartArtifactResponse": { "type": "object" }, "registryCustomAttributeValue": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64" }, "custom_attribute_definition_id": { "type": "string", "format": "uint64" }, "target_id": { "type": "string" }, "target_type": { "$ref": "#/definitions/CustomAttributeTargetTypeEnumCustomAttributeTargetType" }, "selected_value": { "type": "string" }, "time_created": { "type": "string", "format": "int64" }, "time_updated": { "type": "string", "format": "int64" }, "created_by_id": { "type": "string", "format": "uint64" }, "updated_by_id": { "type": "string", "format": "uint64" } } }, "registryDeleteModelVersionRequestResponse": { "type": "object" }, "registryDeleteRegisteredModelRequestResponse": { "type": "object" }, "registryDockerMetadata": { "type": "object", "properties": { "request_port": { "type": "integer", "format": "int64" }, "request_path": { "type": "string" }, "health_path": { "type": "string" } } }, "registryExternalDeployment": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64", "title": "internal id" }, "model_version_id": { "type": "string", "format": "uint64", "title": "id of the model this belongs to" }, "time_created": { "type": "string", "format": "int64", "description": "Timestamp recorded when this ``external_deployment`` was created." }, "time_updated": { "type": "string", "format": "int64", "description": "Timestamp recorded when metadata for this ``external_deployment`` was last updated." }, "location_deployed": { "type": "string", "title": "Location where container will be deployed" }, "url_path_title": { "type": "string", "title": "Deploy URL, path or title" }, "description": { "type": "string", "title": "Brief description" }, "location_type": { "$ref": "#/definitions/LocationTypeEnumLocationType", "title": "Location Type" }, "cloud_provider": { "type": "string", "title": "Cloud Provider" } } }, "registryExternalDeploymentRequestResponse": { "type": "object", "properties": { "external_deployment": { "$ref": "#/definitions/registryExternalDeployment" } } }, "registryFindModelVersionRequest": { "type": "object", "properties": { "id": { "$ref": "#/definitions/registryRegisteredModelIdentification", "title": "identity of parent registered model" }, "predicates": { "type": "array", "items": { "$ref": "#/definitions/commonKeyValueQuery" }, "title": "Filtering supported on\n1. version\n2. labels\n3. description\n4. model_source\n5. experiment_run_id\n6. status\n7. archived status" }, "pagination": { "$ref": "#/definitions/commonPagination", "title": "If not present will default to page 1 page_size 10" }, "ascending": { "type": "boolean" }, "sort_key": { "type": "string" }, "ids": { "type": "array", "items": { "type": "string", "format": "uint64" } } } }, "registryFindModelVersionRequestResponse": { "type": "object", "properties": { "model_versions": { "type": "array", "items": { "$ref": "#/definitions/registryModelVersion" } }, "total_records": { "type": "string", "format": "int64" } } }, "registryFindRegisteredModelRequest": { "type": "object", "properties": { "workspace_name": { "type": "string", "title": "User or organization name" }, "predicates": { "type": "array", "items": { "$ref": "#/definitions/commonKeyValueQuery" }, "title": "Filtering supported on\n1. name\n2. labels\n3. description" }, "pagination": { "$ref": "#/definitions/commonPagination", "title": "If not present will default to page 1 page_size 10" }, "ascending": { "type": "boolean" }, "sort_key": { "type": "string" }, "ids": { "type": "array", "items": { "type": "string", "format": "uint64" } } }, "title": "CRUD for Registred Models" }, "registryFindRegisteredModelRequestResponse": { "type": "object", "properties": { "registered_models": { "type": "array", "items": { "$ref": "#/definitions/registryRegisteredModel" } }, "total_records": { "type": "string", "format": "int64" } } }, "registryGetCommittedArtifactPartsResponse": { "type": "object", "properties": { "artifact_parts": { "type": "array", "items": { "$ref": "#/definitions/commonArtifactPart" } } } }, "registryGetModelVersionRequestResponse": { "type": "object", "properties": { "model_version": { "$ref": "#/definitions/registryModelVersion" } } }, "registryGetRegisteredModelCountRequestResponse": { "type": "object", "properties": { "registered_model_count": { "type": "string", "format": "int64" } } }, "registryGetRegisteredModelRequestResponse": { "type": "object", "properties": { "registered_model": { "$ref": "#/definitions/registryRegisteredModel" } } }, "registryGetUrlForArtifact": { "type": "object", "properties": { "model_version_id": { "type": "string", "format": "uint64", "title": "id of model version" }, "key": { "type": "string", "title": "artifact key" }, "method": { "type": "string", "title": "GET or PUT" }, "artifact_type": { "$ref": "#/definitions/ArtifactTypeEnumArtifactType", "title": "type of artifact" }, "part_number": { "type": "string", "format": "uint64", "title": "0 if the url is not required to be multi part" } } }, "registryGetUrlForArtifactResponse": { "type": "object", "properties": { "url": { "type": "string", "title": "URL based on action" }, "multipart_upload_ok": { "type": "boolean" }, "fields": { "type": "object", "additionalProperties": { "type": "string" } } } }, "registryLogAttributesInModelVersion": { "type": "object", "properties": { "model_version_id": { "type": "string", "format": "uint64" }, "attributes": { "type": "array", "items": { "$ref": "#/definitions/commonKeyValue" } } } }, "registryLogAttributesInModelVersionResponse": { "type": "object" }, "registryLogCodeBlobInModelVersion": { "type": "object", "properties": { "model_version_id": { "type": "string", "format": "uint64" }, "code_blob_map": { "type": "object", "additionalProperties": { "$ref": "#/definitions/versioningCodeBlob" } } } }, "registryLogCodeBlobInModelVersionResponse": { "type": "object" }, "registryLogDatasetsInModelVersion": { "type": "object", "properties": { "model_version_id": { "type": "string", "format": "uint64" }, "datasets": { "type": "array", "items": { "$ref": "#/definitions/commonArtifact" } } } }, "registryLogDatasetsInModelVersionResponse": { "type": "object" }, "registryLogDockerMetadataInModelVersion": { "type": "object", "properties": { "model_version_id": { "type": "string", "format": "uint64" }, "docker_metadata": { "$ref": "#/definitions/registryDockerMetadata" } } }, "registryLogDockerMetadataInModelVersionResponse": { "type": "object" }, "registryModelVersion": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64", "title": "internal id" }, "registered_model_id": { "type": "string", "format": "uint64", "title": "id of the model this belongs to" }, "version": { "type": "string", "title": "Model's tag. Unique for a model nmae" }, "time_updated": { "type": "string", "format": "int64", "description": "Timestamp recorded when metadata for this ``model_version`` was last updated." }, "time_created": { "type": "string", "format": "int64", "description": "Timestamp recorded when this ``model_version`` was created." }, "description": { "type": "string", "description": "Description of this ``model_version``." }, "experiment_run_id": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" }, "title": "Labels added to the registered models" }, "model": { "$ref": "#/definitions/commonArtifact", "title": "Model" }, "environment": { "$ref": "#/definitions/versioningEnvironmentBlob", "title": "Requirement" }, "docker_metadata": { "$ref": "#/definitions/registryDockerMetadata" }, "artifacts": { "type": "array", "items": { "$ref": "#/definitions/commonArtifact" }, "title": "Other artifacts" }, "archived": { "$ref": "#/definitions/TernaryEnumTernary", "title": "flag to archive a model version currently does nothing other than storing the information in DB" }, "readme_text": { "type": "string", "title": "readme" }, "apis": { "type": "array", "items": { "type": "string" }, "title": "APIs" }, "owner": { "type": "string", "title": "owner's verta_id" }, "owner_id": { "type": "string", "format": "uint64" }, "group_owner_id": { "$ref": "#/definitions/commonGroupId" }, "attributes": { "type": "array", "items": { "$ref": "#/definitions/commonKeyValue" }, "title": "Other attributes" }, "stage": { "$ref": "#/definitions/StageEnumStage", "title": "Stage of the model version. This field must be searchable as per our \"find\" operation" }, "lock_level": { "$ref": "#/definitions/ModelVersionLockLevelEnumModelVersionLockLevel", "title": "Current lock level for this model version" }, "datasets": { "type": "array", "items": { "$ref": "#/definitions/commonArtifact" } }, "code_blob_map": { "type": "object", "additionalProperties": { "$ref": "#/definitions/versioningCodeBlob" } }, "readme_text_updated": { "type": "boolean", "title": "Is true if the readme text has been updated at least once" }, "version_number": { "type": "string", "format": "uint64", "title": "Doc for version_number https://github.com/VertaAI/docs/pull/53" }, "redirect_metadata": { "type": "string", "title": "Reference: https://vertaai.atlassian.net/browse/VRD-329" }, "input_description": { "type": "string", "title": "Reference: https://vertaai.atlassian.net/browse/CAT-84" }, "hide_input_label": { "type": "boolean", "title": "Reference: https://vertaai.atlassian.net/browse/CAT-84" }, "output_description": { "type": "string", "title": "Reference: https://vertaai.atlassian.net/browse/CAT-84" }, "hide_output_label": { "type": "boolean", "title": "Reference: https://vertaai.atlassian.net/browse/CAT-84" }, "external_deployments": { "type": "array", "items": { "$ref": "#/definitions/registryExternalDeployment" } }, "checklist_item_values": { "type": "array", "items": { "$ref": "#/definitions/registryChecklistItemValue" }, "title": "Reference: https://vertaai.atlassian.net/browse/CAT-173" }, "custom_attribute_values": { "type": "array", "items": { "$ref": "#/definitions/registryCustomAttributeValue" } } } }, "registryModelVersionIdentification": { "type": "object", "properties": { "model_version_id": { "type": "string", "format": "uint64", "title": "ModelVersion referred to by id" }, "model_id": { "$ref": "#/definitions/registryRegisteredModelIdentification", "title": "Registered Model referred to by id" } } }, "registryRegisteredModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uint64", "title": "internal id" }, "name": { "type": "string", "description": "Unique name for the model within the workspace." }, "time_created": { "type": "string", "format": "int64", "description": "Timestamp recorded when this ``registered_model`` was created." }, "time_updated": { "type": "string", "format": "int64", "description": "Timestamp recorded when metadata for this ``registered_model`` was last updated." }, "description": { "type": "string", "description": "Description of this ``registered_model``." }, "labels": { "type": "array", "items": { "type": "string" }, "title": "Labels added to the registered models" }, "visibility": { "$ref": "#/definitions/VisibilityEnumVisibility", "title": "Visibility of Registered Models" }, "workspace_id": { "type": "string", "title": "id of the workspace this belongs to\nnot storing workspace_type uac should support https://github.com/VertaAI/protos-all/pull/19/files" }, "readme_text": { "type": "string", "title": "readme" }, "owner": { "type": "string", "title": "owner's verta_id" }, "owner_id": { "type": "string", "format": "uint64" }, "group_owner_id": { "$ref": "#/definitions/commonGroupId" }, "attributes": { "type": "array", "items": { "$ref": "#/definitions/commonKeyValue" }, "title": "Other attributes" }, "workspace_service_id": { "type": "string", "format": "uint64" }, "custom_permission": { "$ref": "#/definitions/uacCollaboratorPermissions", "title": "The next field only makes sense when visibility == ORG_CUSTOM\nThey will be empty otherwise" }, "resource_visibility": { "$ref": "#/definitions/uacResourceVisibility" }, "artifacts": { "type": "array", "items": { "$ref": "#/definitions/commonArtifact" }, "title": "Other artifacts" }, "readme_text_updated": { "type": "boolean", "title": "Is true if the readme text has been updated at least once" }, "version_number": { "type": "string", "format": "uint64", "title": "Doc for version_number https://github.com/VertaAI/docs/pull/53" }, "data_type": { "$ref": "#/definitions/DataTypeEnumDataType", "title": "Fields for model's task_type. Those fields must be searchable as per our \"find\" operation" }, "action_type": { "$ref": "#/definitions/ActionTypeEnumActionType" }, "task_type": { "$ref": "#/definitions/TaskTypeEnumTaskType" }, "custom_attribute_values": { "type": "array", "items": { "$ref": "#/definitions/registryCustomAttributeValue" } }, "pii": { "type": "boolean", "title": "Is true if the model accepts pii as input" } } }, "registryRegisteredModelIdentification": { "type": "object", "properties": { "named_id": { "$ref": "#/definitions/registryRegisteredModelNamedIdentification", "title": "Model refered to by workspace name , model nmae combination" }, "registered_model_id": { "type": "string", "format": "uint64", "title": "Model refered to by id" } }, "title": "changed from oneof because of that bug: https://github.com/grpc-ecosystem/grpc-gateway/issues/753" }, "registryRegisteredModelNamedIdentification": { "type": "object", "properties": { "name": { "type": "string", "title": "Model Name" }, "workspace_name": { "type": "string", "title": "WorkspaceName" } } }, "registrySetLockModelVersionRequest": { "type": "object", "properties": { "id": { "$ref": "#/definitions/registryModelVersionIdentification", "title": "User or organization name" }, "lock_level": { "$ref": "#/definitions/ModelVersionLockLevelEnumModelVersionLockLevel" } } }, "registrySetLockModelVersionRequestResponse": { "type": "object" }, "registrySetModelVersion": { "type": "object", "properties": { "id": { "$ref": "#/definitions/registryModelVersionIdentification" }, "model_version": { "$ref": "#/definitions/registryModelVersion" }, "update_mask": { "$ref": "#/definitions/protobufFieldMask" } } }, "registrySetModelVersionResponse": { "type": "object", "properties": { "model_version": { "$ref": "#/definitions/registryModelVersion" } } }, "registrySetRegisteredModel": { "type": "object", "properties": { "id": { "$ref": "#/definitions/registryRegisteredModelIdentification" }, "registered_model": { "$ref": "#/definitions/registryRegisteredModel" }, "update_mask": { "$ref": "#/definitions/protobufFieldMask" } } }, "registrySetRegisteredModelResponse": { "type": "object", "properties": { "registered_model": { "$ref": "#/definitions/registryRegisteredModel" } } }, "runtimeError": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/definitions/protobufAny" } } } }, "uacCollaboratorPermissions": { "type": "object", "properties": { "collaborator_type": { "$ref": "#/definitions/CollaboratorTypeEnumCollaboratorType" }, "can_deploy": { "$ref": "#/definitions/TernaryEnumTernary" }, "can_predict": { "$ref": "#/definitions/TernaryEnumTernary" } } }, "uacResourceVisibility": { "type": "string", "enum": [ "UNKNOWN", "ORG_DEFAULT", "ORG_CUSTOM", "PRIVATE", "WORKSPACE_DEFAULT" ], "default": "UNKNOWN" }, "versioningAptEnvironmentBlob": { "type": "object", "properties": { "packages": { "type": "array", "items": { "type": "string" } } } }, "versioningCodeBlob": { "type": "object", "properties": { "git": { "$ref": "#/definitions/versioningGitCodeBlob" }, "notebook": { "$ref": "#/definitions/versioningNotebookCodeBlob" } } }, "versioningDockerEnvironmentBlob": { "type": "object", "properties": { "repository": { "type": "string" }, "tag": { "type": "string" }, "sha": { "type": "string" } } }, "versioningEnvironmentBlob": { "type": "object", "properties": { "python": { "$ref": "#/definitions/versioningPythonEnvironmentBlob" }, "docker": { "$ref": "#/definitions/versioningDockerEnvironmentBlob" }, "environment_variables": { "type": "array", "items": { "$ref": "#/definitions/versioningEnvironmentVariablesBlob" } }, "command_line": { "type": "array", "items": { "type": "string" } }, "apt": { "$ref": "#/definitions/versioningAptEnvironmentBlob" } } }, "versioningEnvironmentVariablesBlob": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "versioningGitCodeBlob": { "type": "object", "properties": { "repo": { "type": "string" }, "hash": { "type": "string" }, "branch": { "type": "string" }, "tag": { "type": "string" }, "is_dirty": { "type": "boolean" } } }, "versioningNotebookCodeBlob": { "type": "object", "properties": { "path": { "$ref": "#/definitions/versioningPathDatasetComponentBlob" }, "git_repo": { "$ref": "#/definitions/versioningGitCodeBlob" } } }, "versioningPathDatasetComponentBlob": { "type": "object", "properties": { "path": { "type": "string" }, "size": { "type": "string", "format": "uint64" }, "last_modified_at_source": { "type": "string", "format": "uint64" }, "sha256": { "type": "string" }, "md5": { "type": "string" }, "internal_versioned_path": { "type": "string" }, "base_path": { "type": "string" } } }, "versioningPythonEnvironmentBlob": { "type": "object", "properties": { "version": { "$ref": "#/definitions/versioningVersionEnvironmentBlob" }, "requirements": { "type": "array", "items": { "$ref": "#/definitions/versioningPythonRequirementEnvironmentBlob" } }, "constraints": { "type": "array", "items": { "$ref": "#/definitions/versioningPythonRequirementEnvironmentBlob" } }, "raw_requirements": { "type": "string", "description": "These fields are only present if the parsed versions above are empty. That is, you cannot have both `requirements` and `raw_requirements` for example." }, "raw_constraints": { "type": "string" } } }, "versioningPythonRequirementEnvironmentBlob": { "type": "object", "properties": { "library": { "type": "string" }, "constraint": { "type": "string" }, "version": { "$ref": "#/definitions/versioningVersionEnvironmentBlob" } } }, "versioningVersionEnvironmentBlob": { "type": "object", "properties": { "major": { "type": "integer", "format": "int32" }, "minor": { "type": "integer", "format": "int32" }, "patch": { "type": "integer", "format": "int32" }, "suffix": { "type": "string" } } }, "vertaregistryEmpty": { "type": "object" } }, "basePath": "/v1" }