From 3f49945e03381d4597c72bb757005e3d0fd15889 Mon Sep 17 00:00:00 2001 From: Isabella Basso Date: Thu, 18 Jul 2024 11:01:57 -0300 Subject: [PATCH] Py: get rid of autogen OAI client docs (#197) * py: add black as dev dependency Necessary for linting Signed-off-by: Isabella do Amaral * py: get rid of autogen OAI client docs Signed-off-by: Isabella do Amaral * OAI: get rid of NextPageToken example This avoids gitleaks warnings. Signed-off-by: Isabella do Amaral * py: fixup ODH -> Kubeflow Signed-off-by: Isabella do Amaral --------- Signed-off-by: Isabella do Amaral --- api/openapi/model-registry.yaml | 3 - clients/python/Makefile | 15 +- clients/python/poetry.lock | 75 +- clients/python/pyproject.toml | 1 + clients/python/src/model_registry/__init__.py | 2 +- .../python/src/mr_openapi/docs/Artifact.md | 44 - .../src/mr_openapi/docs/ArtifactList.md | 33 - .../src/mr_openapi/docs/ArtifactState.md | 12 - .../src/mr_openapi/docs/BaseArtifact.md | 37 - .../src/mr_openapi/docs/BaseArtifactCreate.md | 34 - .../src/mr_openapi/docs/BaseArtifactUpdate.md | 33 - .../src/mr_openapi/docs/BaseExecution.md | 36 - .../mr_openapi/docs/BaseExecutionCreate.md | 33 - .../mr_openapi/docs/BaseExecutionUpdate.md | 32 - .../src/mr_openapi/docs/BaseResource.md | 35 - .../src/mr_openapi/docs/BaseResourceCreate.md | 32 - .../src/mr_openapi/docs/BaseResourceList.md | 31 - .../src/mr_openapi/docs/BaseResourceUpdate.md | 31 - .../python/src/mr_openapi/docs/DocArtifact.md | 39 - clients/python/src/mr_openapi/docs/Error.md | 31 - .../src/mr_openapi/docs/ExecutionState.md | 12 - .../src/mr_openapi/docs/InferenceService.md | 41 - .../mr_openapi/docs/InferenceServiceCreate.md | 38 - .../mr_openapi/docs/InferenceServiceList.md | 33 - .../mr_openapi/docs/InferenceServiceState.md | 12 - .../mr_openapi/docs/InferenceServiceUpdate.md | 35 - .../src/mr_openapi/docs/MetadataBoolValue.md | 31 - .../mr_openapi/docs/MetadataDoubleValue.md | 31 - .../src/mr_openapi/docs/MetadataIntValue.md | 31 - .../src/mr_openapi/docs/MetadataProtoValue.md | 32 - .../mr_openapi/docs/MetadataStringValue.md | 31 - .../mr_openapi/docs/MetadataStructValue.md | 31 - .../src/mr_openapi/docs/MetadataValue.md | 37 - .../src/mr_openapi/docs/ModelArtifact.md | 44 - .../mr_openapi/docs/ModelArtifactCreate.md | 40 - .../src/mr_openapi/docs/ModelArtifactList.md | 33 - .../mr_openapi/docs/ModelArtifactUpdate.md | 39 - .../docs/ModelRegistryServiceApi.md | 3030 ----------------- .../src/mr_openapi/docs/ModelVersion.md | 39 - .../src/mr_openapi/docs/ModelVersionCreate.md | 36 - .../src/mr_openapi/docs/ModelVersionList.md | 33 - .../src/mr_openapi/docs/ModelVersionState.md | 12 - .../src/mr_openapi/docs/ModelVersionUpdate.md | 34 - .../src/mr_openapi/docs/OrderByField.md | 12 - .../src/mr_openapi/docs/RegisteredModel.md | 38 - .../mr_openapi/docs/RegisteredModelCreate.md | 35 - .../mr_openapi/docs/RegisteredModelList.md | 33 - .../mr_openapi/docs/RegisteredModelState.md | 12 - .../mr_openapi/docs/RegisteredModelUpdate.md | 34 - .../python/src/mr_openapi/docs/ServeModel.md | 38 - .../src/mr_openapi/docs/ServeModelCreate.md | 35 - .../src/mr_openapi/docs/ServeModelList.md | 33 - .../src/mr_openapi/docs/ServeModelUpdate.md | 33 - .../src/mr_openapi/docs/ServingEnvironment.md | 36 - .../docs/ServingEnvironmentCreate.md | 33 - .../mr_openapi/docs/ServingEnvironmentList.md | 33 - .../docs/ServingEnvironmentUpdate.md | 32 - .../python/src/mr_openapi/docs/SortOrder.md | 12 - 58 files changed, 85 insertions(+), 4688 deletions(-) delete mode 100644 clients/python/src/mr_openapi/docs/Artifact.md delete mode 100644 clients/python/src/mr_openapi/docs/ArtifactList.md delete mode 100644 clients/python/src/mr_openapi/docs/ArtifactState.md delete mode 100644 clients/python/src/mr_openapi/docs/BaseArtifact.md delete mode 100644 clients/python/src/mr_openapi/docs/BaseArtifactCreate.md delete mode 100644 clients/python/src/mr_openapi/docs/BaseArtifactUpdate.md delete mode 100644 clients/python/src/mr_openapi/docs/BaseExecution.md delete mode 100644 clients/python/src/mr_openapi/docs/BaseExecutionCreate.md delete mode 100644 clients/python/src/mr_openapi/docs/BaseExecutionUpdate.md delete mode 100644 clients/python/src/mr_openapi/docs/BaseResource.md delete mode 100644 clients/python/src/mr_openapi/docs/BaseResourceCreate.md delete mode 100644 clients/python/src/mr_openapi/docs/BaseResourceList.md delete mode 100644 clients/python/src/mr_openapi/docs/BaseResourceUpdate.md delete mode 100644 clients/python/src/mr_openapi/docs/DocArtifact.md delete mode 100644 clients/python/src/mr_openapi/docs/Error.md delete mode 100644 clients/python/src/mr_openapi/docs/ExecutionState.md delete mode 100644 clients/python/src/mr_openapi/docs/InferenceService.md delete mode 100644 clients/python/src/mr_openapi/docs/InferenceServiceCreate.md delete mode 100644 clients/python/src/mr_openapi/docs/InferenceServiceList.md delete mode 100644 clients/python/src/mr_openapi/docs/InferenceServiceState.md delete mode 100644 clients/python/src/mr_openapi/docs/InferenceServiceUpdate.md delete mode 100644 clients/python/src/mr_openapi/docs/MetadataBoolValue.md delete mode 100644 clients/python/src/mr_openapi/docs/MetadataDoubleValue.md delete mode 100644 clients/python/src/mr_openapi/docs/MetadataIntValue.md delete mode 100644 clients/python/src/mr_openapi/docs/MetadataProtoValue.md delete mode 100644 clients/python/src/mr_openapi/docs/MetadataStringValue.md delete mode 100644 clients/python/src/mr_openapi/docs/MetadataStructValue.md delete mode 100644 clients/python/src/mr_openapi/docs/MetadataValue.md delete mode 100644 clients/python/src/mr_openapi/docs/ModelArtifact.md delete mode 100644 clients/python/src/mr_openapi/docs/ModelArtifactCreate.md delete mode 100644 clients/python/src/mr_openapi/docs/ModelArtifactList.md delete mode 100644 clients/python/src/mr_openapi/docs/ModelArtifactUpdate.md delete mode 100644 clients/python/src/mr_openapi/docs/ModelRegistryServiceApi.md delete mode 100644 clients/python/src/mr_openapi/docs/ModelVersion.md delete mode 100644 clients/python/src/mr_openapi/docs/ModelVersionCreate.md delete mode 100644 clients/python/src/mr_openapi/docs/ModelVersionList.md delete mode 100644 clients/python/src/mr_openapi/docs/ModelVersionState.md delete mode 100644 clients/python/src/mr_openapi/docs/ModelVersionUpdate.md delete mode 100644 clients/python/src/mr_openapi/docs/OrderByField.md delete mode 100644 clients/python/src/mr_openapi/docs/RegisteredModel.md delete mode 100644 clients/python/src/mr_openapi/docs/RegisteredModelCreate.md delete mode 100644 clients/python/src/mr_openapi/docs/RegisteredModelList.md delete mode 100644 clients/python/src/mr_openapi/docs/RegisteredModelState.md delete mode 100644 clients/python/src/mr_openapi/docs/RegisteredModelUpdate.md delete mode 100644 clients/python/src/mr_openapi/docs/ServeModel.md delete mode 100644 clients/python/src/mr_openapi/docs/ServeModelCreate.md delete mode 100644 clients/python/src/mr_openapi/docs/ServeModelList.md delete mode 100644 clients/python/src/mr_openapi/docs/ServeModelUpdate.md delete mode 100644 clients/python/src/mr_openapi/docs/ServingEnvironment.md delete mode 100644 clients/python/src/mr_openapi/docs/ServingEnvironmentCreate.md delete mode 100644 clients/python/src/mr_openapi/docs/ServingEnvironmentList.md delete mode 100644 clients/python/src/mr_openapi/docs/ServingEnvironmentUpdate.md delete mode 100644 clients/python/src/mr_openapi/docs/SortOrder.md diff --git a/api/openapi/model-registry.yaml b/api/openapi/model-registry.yaml index 762f7b7e8..362b9f6fa 100644 --- a/api/openapi/model-registry.yaml +++ b/api/openapi/model-registry.yaml @@ -1636,9 +1636,6 @@ components: in: query required: false nextPageToken: - examples: - nextPageToken: - value: IkhlbGxvLCB3b3JsZC4i name: nextPageToken description: Token to use to retrieve next page of results. schema: diff --git a/clients/python/Makefile b/clients/python/Makefile index 839031653..5b60ca9e0 100644 --- a/clients/python/Makefile +++ b/clients/python/Makefile @@ -1,3 +1,5 @@ +all: install tidy + .PHONY: install install: ../../bin/openapi-generator-cli generate -i ../../api/openapi/model-registry.yaml -g python -o src/ --package-name mr_openapi --additional-properties=library=asyncio,generateSourceCodeOnly=true,useOneOfDiscriminatorLookup=true @@ -13,22 +15,23 @@ clean: test: poetry run pytest -s -.PHONY: lint-check -lint-check: +.PHONY: lint +lint: poetry run ruff check poetry run black src/mr_openapi --check -.PHONY: lint-apply -lint-apply: +.PHONY: tidy +tidy: + rm -rf src/mr_openapi/docs poetry run ruff check --fix --unsafe-fixes || true poetry run black src/mr_openapi .PHONY: build -build: install lint-apply +build: install tidy poetry build .PHONY: publish -publish: install +publish: build poetry publish --build -u ${PYPI_USERNAME} -p ${PYPI_PASSWORD} .PHONY: update diff --git a/clients/python/poetry.lock b/clients/python/poetry.lock index c4f25d8c7..a79724994 100644 --- a/clients/python/poetry.lock +++ b/clients/python/poetry.lock @@ -231,6 +231,52 @@ soupsieve = ">1.2" html5lib = ["html5lib"] lxml = ["lxml"] +[[package]] +name = "black" +version = "24.4.2" +description = "The uncompromising code formatter." +optional = false +python-versions = ">=3.8" +files = [ + {file = "black-24.4.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:dd1b5a14e417189db4c7b64a6540f31730713d173f0b63e55fabd52d61d8fdce"}, + {file = "black-24.4.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:8e537d281831ad0e71007dcdcbe50a71470b978c453fa41ce77186bbe0ed6021"}, + {file = "black-24.4.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:eaea3008c281f1038edb473c1aa8ed8143a5535ff18f978a318f10302b254063"}, + {file = "black-24.4.2-cp310-cp310-win_amd64.whl", hash = "sha256:7768a0dbf16a39aa5e9a3ded568bb545c8c2727396d063bbaf847df05b08cd96"}, + {file = "black-24.4.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:257d724c2c9b1660f353b36c802ccece186a30accc7742c176d29c146df6e474"}, + {file = "black-24.4.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:bdde6f877a18f24844e381d45e9947a49e97933573ac9d4345399be37621e26c"}, + {file = "black-24.4.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e151054aa00bad1f4e1f04919542885f89f5f7d086b8a59e5000e6c616896ffb"}, + {file = "black-24.4.2-cp311-cp311-win_amd64.whl", hash = "sha256:7e122b1c4fb252fd85df3ca93578732b4749d9be076593076ef4d07a0233c3e1"}, + {file = "black-24.4.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:accf49e151c8ed2c0cdc528691838afd217c50412534e876a19270fea1e28e2d"}, + {file = "black-24.4.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:88c57dc656038f1ab9f92b3eb5335ee9b021412feaa46330d5eba4e51fe49b04"}, + {file = "black-24.4.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:be8bef99eb46d5021bf053114442914baeb3649a89dc5f3a555c88737e5e98fc"}, + {file = "black-24.4.2-cp312-cp312-win_amd64.whl", hash = "sha256:415e686e87dbbe6f4cd5ef0fbf764af7b89f9057b97c908742b6008cc554b9c0"}, + {file = "black-24.4.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:bf10f7310db693bb62692609b397e8d67257c55f949abde4c67f9cc574492cc7"}, + {file = "black-24.4.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:98e123f1d5cfd42f886624d84464f7756f60ff6eab89ae845210631714f6db94"}, + {file = "black-24.4.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:48a85f2cb5e6799a9ef05347b476cce6c182d6c71ee36925a6c194d074336ef8"}, + {file = "black-24.4.2-cp38-cp38-win_amd64.whl", hash = "sha256:b1530ae42e9d6d5b670a34db49a94115a64596bc77710b1d05e9801e62ca0a7c"}, + {file = "black-24.4.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:37aae07b029fa0174d39daf02748b379399b909652a806e5708199bd93899da1"}, + {file = "black-24.4.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:da33a1a5e49c4122ccdfd56cd021ff1ebc4a1ec4e2d01594fef9b6f267a9e741"}, + {file = "black-24.4.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ef703f83fc32e131e9bcc0a5094cfe85599e7109f896fe8bc96cc402f3eb4b6e"}, + {file = "black-24.4.2-cp39-cp39-win_amd64.whl", hash = "sha256:b9176b9832e84308818a99a561e90aa479e73c523b3f77afd07913380ae2eab7"}, + {file = "black-24.4.2-py3-none-any.whl", hash = "sha256:d36ed1124bb81b32f8614555b34cc4259c3fbc7eec17870e8ff8ded335b58d8c"}, + {file = "black-24.4.2.tar.gz", hash = "sha256:c872b53057f000085da66a19c55d68f6f8ddcac2642392ad3a355878406fbd4d"}, +] + +[package.dependencies] +click = ">=8.0.0" +mypy-extensions = ">=0.4.3" +packaging = ">=22.0" +pathspec = ">=0.9.0" +platformdirs = ">=2" +tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""} +typing-extensions = {version = ">=4.0.1", markers = "python_version < \"3.11\""} + +[package.extras] +colorama = ["colorama (>=0.4.3)"] +d = ["aiohttp (>=3.7.4)", "aiohttp (>=3.7.4,!=3.9.0)"] +jupyter = ["ipython (>=7.8.0)", "tokenize-rt (>=3.2.0)"] +uvloop = ["uvloop (>=0.15.2)"] + [[package]] name = "certifi" version = "2024.7.4" @@ -1089,6 +1135,33 @@ files = [ {file = "packaging-23.2.tar.gz", hash = "sha256:048fb0e9405036518eaaf48a55953c750c11e1a1b68e0dd1a9d62ed0c092cfc5"}, ] +[[package]] +name = "pathspec" +version = "0.12.1" +description = "Utility library for gitignore style pattern matching of file paths." +optional = false +python-versions = ">=3.8" +files = [ + {file = "pathspec-0.12.1-py3-none-any.whl", hash = "sha256:a0d503e138a4c123b27490a4f7beda6a01c6f288df0e4a8b79c7eb0dc7b4cc08"}, + {file = "pathspec-0.12.1.tar.gz", hash = "sha256:a482d51503a1ab33b1c67a6c3813a26953dbdc71c31dacaef9a838c4e29f5712"}, +] + +[[package]] +name = "platformdirs" +version = "4.2.2" +description = "A small Python package for determining appropriate platform-specific dirs, e.g. a `user data dir`." +optional = false +python-versions = ">=3.8" +files = [ + {file = "platformdirs-4.2.2-py3-none-any.whl", hash = "sha256:2d7a1657e36a80ea911db832a8a6ece5ee53d8de21edd5cc5879af6530b1bfee"}, + {file = "platformdirs-4.2.2.tar.gz", hash = "sha256:38b7b51f512eed9e84a22788b4bce1de17c0adb134d6becb09836e37d8654cd3"}, +] + +[package.extras] +docs = ["furo (>=2023.9.10)", "proselint (>=0.13)", "sphinx (>=7.2.6)", "sphinx-autodoc-typehints (>=1.25.2)"] +test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=7.4.3)", "pytest-cov (>=4.1)", "pytest-mock (>=3.12)"] +type = ["mypy (>=1.8)"] + [[package]] name = "pluggy" version = "1.5.0" @@ -2061,4 +2134,4 @@ hf = ["huggingface-hub"] [metadata] lock-version = "2.0" python-versions = ">= 3.9, < 4.0" -content-hash = "93b5354f4f995bcbf199d5083133c552179eb16c33eed5b8d9ff6a60d4d9013c" +content-hash = "52bee21152345aa00eef00b9e2be6e08113ad9cd7bc883c8c339bcf635a1974b" diff --git a/clients/python/pyproject.toml b/clients/python/pyproject.toml index 83aa9c32b..faeb1cdd7 100644 --- a/clients/python/pyproject.toml +++ b/clients/python/pyproject.toml @@ -48,6 +48,7 @@ ruff = "^0.5.2" mypy = "^1.7.0" pytest-asyncio = "^0.23.7" requests = "^2.32.2" +black = "^24.4.2" [tool.coverage.run] branch = true diff --git a/clients/python/src/model_registry/__init__.py b/clients/python/src/model_registry/__init__.py index b7f7c7a16..f7178a307 100644 --- a/clients/python/src/model_registry/__init__.py +++ b/clients/python/src/model_registry/__init__.py @@ -1,4 +1,4 @@ -"""Main package for the ODH model registry.""" +"""Main package for the Kubeflow model registry.""" __version__ = "0.2.3a1" diff --git a/clients/python/src/mr_openapi/docs/Artifact.md b/clients/python/src/mr_openapi/docs/Artifact.md deleted file mode 100644 index c13542ff8..000000000 --- a/clients/python/src/mr_openapi/docs/Artifact.md +++ /dev/null @@ -1,44 +0,0 @@ -# Artifact - -A metadata Artifact Entity. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**artifact_type** | **str** | | [default to 'doc-artifact'] -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**uri** | **str** | The uniform resource identifier of the physical artifact. May be empty if there is no physical artifact. | [optional] -**state** | [**ArtifactState**](ArtifactState.md) | | [optional] -**name** | **str** | 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. | [optional] -**id** | **str** | Output only. The unique server generated id of the resource. | [optional] [readonly] -**create_time_since_epoch** | **str** | Output only. Create time of the resource in millisecond since epoch. | [optional] [readonly] -**last_update_time_since_epoch** | **str** | Output only. Last update time of the resource since epoch in millisecond since epoch. | [optional] [readonly] -**model_format_name** | **str** | Name of the model format. | [optional] -**storage_key** | **str** | Storage secret name. | [optional] -**storage_path** | **str** | Path for model in storage provided by `storageKey`. | [optional] -**model_format_version** | **str** | Version of the model format. | [optional] -**service_account_name** | **str** | Name of the service account with storage secret. | [optional] - -## Example - -```python -from mr_openapi.models.artifact import Artifact - -# TODO update the JSON string below -json = "{}" -# create an instance of Artifact from a JSON string -artifact_instance = Artifact.from_json(json) -# print the JSON string representation of the object -print(Artifact.to_json()) - -# convert the object into a dict -artifact_dict = artifact_instance.to_dict() -# create an instance of Artifact from a dict -artifact_from_dict = Artifact.from_dict(artifact_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ArtifactList.md b/clients/python/src/mr_openapi/docs/ArtifactList.md deleted file mode 100644 index 99f18e8b3..000000000 --- a/clients/python/src/mr_openapi/docs/ArtifactList.md +++ /dev/null @@ -1,33 +0,0 @@ -# ArtifactList - -A list of Artifact entities. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page_token** | **str** | Token to use to retrieve next page of results. | -**page_size** | **int** | Maximum number of resources to return in the result. | -**size** | **int** | Number of items in result list. | -**items** | [**List[Artifact]**](Artifact.md) | Array of `Artifact` entities. | [optional] - -## Example - -```python -from mr_openapi.models.artifact_list import ArtifactList - -# TODO update the JSON string below -json = "{}" -# create an instance of ArtifactList from a JSON string -artifact_list_instance = ArtifactList.from_json(json) -# print the JSON string representation of the object -print(ArtifactList.to_json()) - -# convert the object into a dict -artifact_list_dict = artifact_list_instance.to_dict() -# create an instance of ArtifactList from a dict -artifact_list_from_dict = ArtifactList.from_dict(artifact_list_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ArtifactState.md b/clients/python/src/mr_openapi/docs/ArtifactState.md deleted file mode 100644 index 3c7442e9e..000000000 --- a/clients/python/src/mr_openapi/docs/ArtifactState.md +++ /dev/null @@ -1,12 +0,0 @@ -# ArtifactState - - - 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 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/BaseArtifact.md b/clients/python/src/mr_openapi/docs/BaseArtifact.md deleted file mode 100644 index 9f3b683a8..000000000 --- a/clients/python/src/mr_openapi/docs/BaseArtifact.md +++ /dev/null @@ -1,37 +0,0 @@ -# BaseArtifact - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**uri** | **str** | The uniform resource identifier of the physical artifact. May be empty if there is no physical artifact. | [optional] -**state** | [**ArtifactState**](ArtifactState.md) | | [optional] -**name** | **str** | 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. | [optional] -**id** | **str** | Output only. The unique server generated id of the resource. | [optional] [readonly] -**create_time_since_epoch** | **str** | Output only. Create time of the resource in millisecond since epoch. | [optional] [readonly] -**last_update_time_since_epoch** | **str** | Output only. Last update time of the resource since epoch in millisecond since epoch. | [optional] [readonly] - -## Example - -```python -from mr_openapi.models.base_artifact import BaseArtifact - -# TODO update the JSON string below -json = "{}" -# create an instance of BaseArtifact from a JSON string -base_artifact_instance = BaseArtifact.from_json(json) -# print the JSON string representation of the object -print(BaseArtifact.to_json()) - -# convert the object into a dict -base_artifact_dict = base_artifact_instance.to_dict() -# create an instance of BaseArtifact from a dict -base_artifact_from_dict = BaseArtifact.from_dict(base_artifact_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/BaseArtifactCreate.md b/clients/python/src/mr_openapi/docs/BaseArtifactCreate.md deleted file mode 100644 index f73991062..000000000 --- a/clients/python/src/mr_openapi/docs/BaseArtifactCreate.md +++ /dev/null @@ -1,34 +0,0 @@ -# BaseArtifactCreate - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**uri** | **str** | The uniform resource identifier of the physical artifact. May be empty if there is no physical artifact. | [optional] -**state** | [**ArtifactState**](ArtifactState.md) | | [optional] -**name** | **str** | 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. | [optional] - -## Example - -```python -from mr_openapi.models.base_artifact_create import BaseArtifactCreate - -# TODO update the JSON string below -json = "{}" -# create an instance of BaseArtifactCreate from a JSON string -base_artifact_create_instance = BaseArtifactCreate.from_json(json) -# print the JSON string representation of the object -print(BaseArtifactCreate.to_json()) - -# convert the object into a dict -base_artifact_create_dict = base_artifact_create_instance.to_dict() -# create an instance of BaseArtifactCreate from a dict -base_artifact_create_from_dict = BaseArtifactCreate.from_dict(base_artifact_create_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/BaseArtifactUpdate.md b/clients/python/src/mr_openapi/docs/BaseArtifactUpdate.md deleted file mode 100644 index 60b7d36aa..000000000 --- a/clients/python/src/mr_openapi/docs/BaseArtifactUpdate.md +++ /dev/null @@ -1,33 +0,0 @@ -# BaseArtifactUpdate - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**uri** | **str** | The uniform resource identifier of the physical artifact. May be empty if there is no physical artifact. | [optional] -**state** | [**ArtifactState**](ArtifactState.md) | | [optional] - -## Example - -```python -from mr_openapi.models.base_artifact_update import BaseArtifactUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of BaseArtifactUpdate from a JSON string -base_artifact_update_instance = BaseArtifactUpdate.from_json(json) -# print the JSON string representation of the object -print(BaseArtifactUpdate.to_json()) - -# convert the object into a dict -base_artifact_update_dict = base_artifact_update_instance.to_dict() -# create an instance of BaseArtifactUpdate from a dict -base_artifact_update_from_dict = BaseArtifactUpdate.from_dict(base_artifact_update_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/BaseExecution.md b/clients/python/src/mr_openapi/docs/BaseExecution.md deleted file mode 100644 index e8c9fd531..000000000 --- a/clients/python/src/mr_openapi/docs/BaseExecution.md +++ /dev/null @@ -1,36 +0,0 @@ -# BaseExecution - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**last_known_state** | [**ExecutionState**](ExecutionState.md) | | [optional] -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**name** | **str** | 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. | [optional] -**id** | **str** | Output only. The unique server generated id of the resource. | [optional] [readonly] -**create_time_since_epoch** | **str** | Output only. Create time of the resource in millisecond since epoch. | [optional] [readonly] -**last_update_time_since_epoch** | **str** | Output only. Last update time of the resource since epoch in millisecond since epoch. | [optional] [readonly] - -## Example - -```python -from mr_openapi.models.base_execution import BaseExecution - -# TODO update the JSON string below -json = "{}" -# create an instance of BaseExecution from a JSON string -base_execution_instance = BaseExecution.from_json(json) -# print the JSON string representation of the object -print(BaseExecution.to_json()) - -# convert the object into a dict -base_execution_dict = base_execution_instance.to_dict() -# create an instance of BaseExecution from a dict -base_execution_from_dict = BaseExecution.from_dict(base_execution_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/BaseExecutionCreate.md b/clients/python/src/mr_openapi/docs/BaseExecutionCreate.md deleted file mode 100644 index 020df818e..000000000 --- a/clients/python/src/mr_openapi/docs/BaseExecutionCreate.md +++ /dev/null @@ -1,33 +0,0 @@ -# BaseExecutionCreate - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**last_known_state** | [**ExecutionState**](ExecutionState.md) | | [optional] -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**name** | **str** | 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. | [optional] - -## Example - -```python -from mr_openapi.models.base_execution_create import BaseExecutionCreate - -# TODO update the JSON string below -json = "{}" -# create an instance of BaseExecutionCreate from a JSON string -base_execution_create_instance = BaseExecutionCreate.from_json(json) -# print the JSON string representation of the object -print(BaseExecutionCreate.to_json()) - -# convert the object into a dict -base_execution_create_dict = base_execution_create_instance.to_dict() -# create an instance of BaseExecutionCreate from a dict -base_execution_create_from_dict = BaseExecutionCreate.from_dict(base_execution_create_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/BaseExecutionUpdate.md b/clients/python/src/mr_openapi/docs/BaseExecutionUpdate.md deleted file mode 100644 index f14627cda..000000000 --- a/clients/python/src/mr_openapi/docs/BaseExecutionUpdate.md +++ /dev/null @@ -1,32 +0,0 @@ -# BaseExecutionUpdate - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**last_known_state** | [**ExecutionState**](ExecutionState.md) | | [optional] - -## Example - -```python -from mr_openapi.models.base_execution_update import BaseExecutionUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of BaseExecutionUpdate from a JSON string -base_execution_update_instance = BaseExecutionUpdate.from_json(json) -# print the JSON string representation of the object -print(BaseExecutionUpdate.to_json()) - -# convert the object into a dict -base_execution_update_dict = base_execution_update_instance.to_dict() -# create an instance of BaseExecutionUpdate from a dict -base_execution_update_from_dict = BaseExecutionUpdate.from_dict(base_execution_update_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/BaseResource.md b/clients/python/src/mr_openapi/docs/BaseResource.md deleted file mode 100644 index 7eab714fd..000000000 --- a/clients/python/src/mr_openapi/docs/BaseResource.md +++ /dev/null @@ -1,35 +0,0 @@ -# BaseResource - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**name** | **str** | 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. | [optional] -**id** | **str** | Output only. The unique server generated id of the resource. | [optional] [readonly] -**create_time_since_epoch** | **str** | Output only. Create time of the resource in millisecond since epoch. | [optional] [readonly] -**last_update_time_since_epoch** | **str** | Output only. Last update time of the resource since epoch in millisecond since epoch. | [optional] [readonly] - -## Example - -```python -from mr_openapi.models.base_resource import BaseResource - -# TODO update the JSON string below -json = "{}" -# create an instance of BaseResource from a JSON string -base_resource_instance = BaseResource.from_json(json) -# print the JSON string representation of the object -print(BaseResource.to_json()) - -# convert the object into a dict -base_resource_dict = base_resource_instance.to_dict() -# create an instance of BaseResource from a dict -base_resource_from_dict = BaseResource.from_dict(base_resource_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/BaseResourceCreate.md b/clients/python/src/mr_openapi/docs/BaseResourceCreate.md deleted file mode 100644 index 7d238cf9a..000000000 --- a/clients/python/src/mr_openapi/docs/BaseResourceCreate.md +++ /dev/null @@ -1,32 +0,0 @@ -# BaseResourceCreate - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**name** | **str** | 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. | [optional] - -## Example - -```python -from mr_openapi.models.base_resource_create import BaseResourceCreate - -# TODO update the JSON string below -json = "{}" -# create an instance of BaseResourceCreate from a JSON string -base_resource_create_instance = BaseResourceCreate.from_json(json) -# print the JSON string representation of the object -print(BaseResourceCreate.to_json()) - -# convert the object into a dict -base_resource_create_dict = base_resource_create_instance.to_dict() -# create an instance of BaseResourceCreate from a dict -base_resource_create_from_dict = BaseResourceCreate.from_dict(base_resource_create_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/BaseResourceList.md b/clients/python/src/mr_openapi/docs/BaseResourceList.md deleted file mode 100644 index d60063b0b..000000000 --- a/clients/python/src/mr_openapi/docs/BaseResourceList.md +++ /dev/null @@ -1,31 +0,0 @@ -# BaseResourceList - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page_token** | **str** | Token to use to retrieve next page of results. | -**page_size** | **int** | Maximum number of resources to return in the result. | -**size** | **int** | Number of items in result list. | - -## Example - -```python -from mr_openapi.models.base_resource_list import BaseResourceList - -# TODO update the JSON string below -json = "{}" -# create an instance of BaseResourceList from a JSON string -base_resource_list_instance = BaseResourceList.from_json(json) -# print the JSON string representation of the object -print(BaseResourceList.to_json()) - -# convert the object into a dict -base_resource_list_dict = base_resource_list_instance.to_dict() -# create an instance of BaseResourceList from a dict -base_resource_list_from_dict = BaseResourceList.from_dict(base_resource_list_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/BaseResourceUpdate.md b/clients/python/src/mr_openapi/docs/BaseResourceUpdate.md deleted file mode 100644 index d9b0ac407..000000000 --- a/clients/python/src/mr_openapi/docs/BaseResourceUpdate.md +++ /dev/null @@ -1,31 +0,0 @@ -# BaseResourceUpdate - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] - -## Example - -```python -from mr_openapi.models.base_resource_update import BaseResourceUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of BaseResourceUpdate from a JSON string -base_resource_update_instance = BaseResourceUpdate.from_json(json) -# print the JSON string representation of the object -print(BaseResourceUpdate.to_json()) - -# convert the object into a dict -base_resource_update_dict = base_resource_update_instance.to_dict() -# create an instance of BaseResourceUpdate from a dict -base_resource_update_from_dict = BaseResourceUpdate.from_dict(base_resource_update_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/DocArtifact.md b/clients/python/src/mr_openapi/docs/DocArtifact.md deleted file mode 100644 index cbde80cf6..000000000 --- a/clients/python/src/mr_openapi/docs/DocArtifact.md +++ /dev/null @@ -1,39 +0,0 @@ -# DocArtifact - -A document. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**artifact_type** | **str** | | [default to 'doc-artifact'] -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**uri** | **str** | The uniform resource identifier of the physical artifact. May be empty if there is no physical artifact. | [optional] -**state** | [**ArtifactState**](ArtifactState.md) | | [optional] -**name** | **str** | 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. | [optional] -**id** | **str** | Output only. The unique server generated id of the resource. | [optional] [readonly] -**create_time_since_epoch** | **str** | Output only. Create time of the resource in millisecond since epoch. | [optional] [readonly] -**last_update_time_since_epoch** | **str** | Output only. Last update time of the resource since epoch in millisecond since epoch. | [optional] [readonly] - -## Example - -```python -from mr_openapi.models.doc_artifact import DocArtifact - -# TODO update the JSON string below -json = "{}" -# create an instance of DocArtifact from a JSON string -doc_artifact_instance = DocArtifact.from_json(json) -# print the JSON string representation of the object -print(DocArtifact.to_json()) - -# convert the object into a dict -doc_artifact_dict = doc_artifact_instance.to_dict() -# create an instance of DocArtifact from a dict -doc_artifact_from_dict = DocArtifact.from_dict(doc_artifact_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/Error.md b/clients/python/src/mr_openapi/docs/Error.md deleted file mode 100644 index 20319b227..000000000 --- a/clients/python/src/mr_openapi/docs/Error.md +++ /dev/null @@ -1,31 +0,0 @@ -# Error - -Error code and message. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **str** | Error code | -**message** | **str** | Error message | - -## Example - -```python -from mr_openapi.models.error import Error - -# TODO update the JSON string below -json = "{}" -# create an instance of Error from a JSON string -error_instance = Error.from_json(json) -# print the JSON string representation of the object -print(Error.to_json()) - -# convert the object into a dict -error_dict = error_instance.to_dict() -# create an instance of Error from a dict -error_from_dict = Error.from_dict(error_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ExecutionState.md b/clients/python/src/mr_openapi/docs/ExecutionState.md deleted file mode 100644 index 49bb37cc0..000000000 --- a/clients/python/src/mr_openapi/docs/ExecutionState.md +++ /dev/null @@ -1,12 +0,0 @@ -# ExecutionState - -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 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/InferenceService.md b/clients/python/src/mr_openapi/docs/InferenceService.md deleted file mode 100644 index 9c8dc21d8..000000000 --- a/clients/python/src/mr_openapi/docs/InferenceService.md +++ /dev/null @@ -1,41 +0,0 @@ -# InferenceService - -An `InferenceService` entity in a `ServingEnvironment` represents a deployed `ModelVersion` from a `RegisteredModel` created by Model Serving. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**name** | **str** | 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. | [optional] -**id** | **str** | Output only. The unique server generated id of the resource. | [optional] [readonly] -**create_time_since_epoch** | **str** | Output only. Create time of the resource in millisecond since epoch. | [optional] [readonly] -**last_update_time_since_epoch** | **str** | Output only. Last update time of the resource since epoch in millisecond since epoch. | [optional] [readonly] -**model_version_id** | **str** | ID of the `ModelVersion` to serve. If it's unspecified, then the latest `ModelVersion` by creation order will be served. | [optional] -**runtime** | **str** | Model runtime. | [optional] -**desired_state** | [**InferenceServiceState**](InferenceServiceState.md) | | [optional] -**registered_model_id** | **str** | ID of the `RegisteredModel` to serve. | -**serving_environment_id** | **str** | ID of the parent `ServingEnvironment` for this `InferenceService` entity. | - -## Example - -```python -from mr_openapi.models.inference_service import InferenceService - -# TODO update the JSON string below -json = "{}" -# create an instance of InferenceService from a JSON string -inference_service_instance = InferenceService.from_json(json) -# print the JSON string representation of the object -print(InferenceService.to_json()) - -# convert the object into a dict -inference_service_dict = inference_service_instance.to_dict() -# create an instance of InferenceService from a dict -inference_service_from_dict = InferenceService.from_dict(inference_service_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/InferenceServiceCreate.md b/clients/python/src/mr_openapi/docs/InferenceServiceCreate.md deleted file mode 100644 index c3d745507..000000000 --- a/clients/python/src/mr_openapi/docs/InferenceServiceCreate.md +++ /dev/null @@ -1,38 +0,0 @@ -# InferenceServiceCreate - -An `InferenceService` entity in a `ServingEnvironment` represents a deployed `ModelVersion` from a `RegisteredModel` created by Model Serving. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**name** | **str** | 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. | [optional] -**model_version_id** | **str** | ID of the `ModelVersion` to serve. If it's unspecified, then the latest `ModelVersion` by creation order will be served. | [optional] -**runtime** | **str** | Model runtime. | [optional] -**desired_state** | [**InferenceServiceState**](InferenceServiceState.md) | | [optional] -**registered_model_id** | **str** | ID of the `RegisteredModel` to serve. | -**serving_environment_id** | **str** | ID of the parent `ServingEnvironment` for this `InferenceService` entity. | - -## Example - -```python -from mr_openapi.models.inference_service_create import InferenceServiceCreate - -# TODO update the JSON string below -json = "{}" -# create an instance of InferenceServiceCreate from a JSON string -inference_service_create_instance = InferenceServiceCreate.from_json(json) -# print the JSON string representation of the object -print(InferenceServiceCreate.to_json()) - -# convert the object into a dict -inference_service_create_dict = inference_service_create_instance.to_dict() -# create an instance of InferenceServiceCreate from a dict -inference_service_create_from_dict = InferenceServiceCreate.from_dict(inference_service_create_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/InferenceServiceList.md b/clients/python/src/mr_openapi/docs/InferenceServiceList.md deleted file mode 100644 index 2063707f7..000000000 --- a/clients/python/src/mr_openapi/docs/InferenceServiceList.md +++ /dev/null @@ -1,33 +0,0 @@ -# InferenceServiceList - -List of InferenceServices. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page_token** | **str** | Token to use to retrieve next page of results. | -**page_size** | **int** | Maximum number of resources to return in the result. | -**size** | **int** | Number of items in result list. | -**items** | [**List[InferenceService]**](InferenceService.md) | | [optional] - -## Example - -```python -from mr_openapi.models.inference_service_list import InferenceServiceList - -# TODO update the JSON string below -json = "{}" -# create an instance of InferenceServiceList from a JSON string -inference_service_list_instance = InferenceServiceList.from_json(json) -# print the JSON string representation of the object -print(InferenceServiceList.to_json()) - -# convert the object into a dict -inference_service_list_dict = inference_service_list_instance.to_dict() -# create an instance of InferenceServiceList from a dict -inference_service_list_from_dict = InferenceServiceList.from_dict(inference_service_list_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/InferenceServiceState.md b/clients/python/src/mr_openapi/docs/InferenceServiceState.md deleted file mode 100644 index 6c4276f96..000000000 --- a/clients/python/src/mr_openapi/docs/InferenceServiceState.md +++ /dev/null @@ -1,12 +0,0 @@ -# InferenceServiceState - -- 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. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/InferenceServiceUpdate.md b/clients/python/src/mr_openapi/docs/InferenceServiceUpdate.md deleted file mode 100644 index 238747d7a..000000000 --- a/clients/python/src/mr_openapi/docs/InferenceServiceUpdate.md +++ /dev/null @@ -1,35 +0,0 @@ -# InferenceServiceUpdate - -An `InferenceService` entity in a `ServingEnvironment` represents a deployed `ModelVersion` from a `RegisteredModel` created by Model Serving. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**model_version_id** | **str** | ID of the `ModelVersion` to serve. If it's unspecified, then the latest `ModelVersion` by creation order will be served. | [optional] -**runtime** | **str** | Model runtime. | [optional] -**desired_state** | [**InferenceServiceState**](InferenceServiceState.md) | | [optional] - -## Example - -```python -from mr_openapi.models.inference_service_update import InferenceServiceUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of InferenceServiceUpdate from a JSON string -inference_service_update_instance = InferenceServiceUpdate.from_json(json) -# print the JSON string representation of the object -print(InferenceServiceUpdate.to_json()) - -# convert the object into a dict -inference_service_update_dict = inference_service_update_instance.to_dict() -# create an instance of InferenceServiceUpdate from a dict -inference_service_update_from_dict = InferenceServiceUpdate.from_dict(inference_service_update_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/MetadataBoolValue.md b/clients/python/src/mr_openapi/docs/MetadataBoolValue.md deleted file mode 100644 index 9ed8ace8f..000000000 --- a/clients/python/src/mr_openapi/docs/MetadataBoolValue.md +++ /dev/null @@ -1,31 +0,0 @@ -# MetadataBoolValue - -A bool property value. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bool_value** | **bool** | | -**metadata_type** | **str** | | [default to 'MetadataBoolValue'] - -## Example - -```python -from mr_openapi.models.metadata_bool_value import MetadataBoolValue - -# TODO update the JSON string below -json = "{}" -# create an instance of MetadataBoolValue from a JSON string -metadata_bool_value_instance = MetadataBoolValue.from_json(json) -# print the JSON string representation of the object -print(MetadataBoolValue.to_json()) - -# convert the object into a dict -metadata_bool_value_dict = metadata_bool_value_instance.to_dict() -# create an instance of MetadataBoolValue from a dict -metadata_bool_value_from_dict = MetadataBoolValue.from_dict(metadata_bool_value_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/MetadataDoubleValue.md b/clients/python/src/mr_openapi/docs/MetadataDoubleValue.md deleted file mode 100644 index 735ed72f0..000000000 --- a/clients/python/src/mr_openapi/docs/MetadataDoubleValue.md +++ /dev/null @@ -1,31 +0,0 @@ -# MetadataDoubleValue - -A double property value. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**double_value** | **float** | | -**metadata_type** | **str** | | [default to 'MetadataDoubleValue'] - -## Example - -```python -from mr_openapi.models.metadata_double_value import MetadataDoubleValue - -# TODO update the JSON string below -json = "{}" -# create an instance of MetadataDoubleValue from a JSON string -metadata_double_value_instance = MetadataDoubleValue.from_json(json) -# print the JSON string representation of the object -print(MetadataDoubleValue.to_json()) - -# convert the object into a dict -metadata_double_value_dict = metadata_double_value_instance.to_dict() -# create an instance of MetadataDoubleValue from a dict -metadata_double_value_from_dict = MetadataDoubleValue.from_dict(metadata_double_value_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/MetadataIntValue.md b/clients/python/src/mr_openapi/docs/MetadataIntValue.md deleted file mode 100644 index e7666324d..000000000 --- a/clients/python/src/mr_openapi/docs/MetadataIntValue.md +++ /dev/null @@ -1,31 +0,0 @@ -# MetadataIntValue - -An integer (int64) property value. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**int_value** | **str** | | -**metadata_type** | **str** | | [default to 'MetadataIntValue'] - -## Example - -```python -from mr_openapi.models.metadata_int_value import MetadataIntValue - -# TODO update the JSON string below -json = "{}" -# create an instance of MetadataIntValue from a JSON string -metadata_int_value_instance = MetadataIntValue.from_json(json) -# print the JSON string representation of the object -print(MetadataIntValue.to_json()) - -# convert the object into a dict -metadata_int_value_dict = metadata_int_value_instance.to_dict() -# create an instance of MetadataIntValue from a dict -metadata_int_value_from_dict = MetadataIntValue.from_dict(metadata_int_value_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/MetadataProtoValue.md b/clients/python/src/mr_openapi/docs/MetadataProtoValue.md deleted file mode 100644 index bf90cc943..000000000 --- a/clients/python/src/mr_openapi/docs/MetadataProtoValue.md +++ /dev/null @@ -1,32 +0,0 @@ -# MetadataProtoValue - -A proto property value. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | url describing proto value | -**proto_value** | **str** | Base64 encoded bytes for proto value | -**metadata_type** | **str** | | [default to 'MetadataProtoValue'] - -## Example - -```python -from mr_openapi.models.metadata_proto_value import MetadataProtoValue - -# TODO update the JSON string below -json = "{}" -# create an instance of MetadataProtoValue from a JSON string -metadata_proto_value_instance = MetadataProtoValue.from_json(json) -# print the JSON string representation of the object -print(MetadataProtoValue.to_json()) - -# convert the object into a dict -metadata_proto_value_dict = metadata_proto_value_instance.to_dict() -# create an instance of MetadataProtoValue from a dict -metadata_proto_value_from_dict = MetadataProtoValue.from_dict(metadata_proto_value_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/MetadataStringValue.md b/clients/python/src/mr_openapi/docs/MetadataStringValue.md deleted file mode 100644 index 3288dc2cb..000000000 --- a/clients/python/src/mr_openapi/docs/MetadataStringValue.md +++ /dev/null @@ -1,31 +0,0 @@ -# MetadataStringValue - -A string property value. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**string_value** | **str** | | -**metadata_type** | **str** | | [default to 'MetadataStringValue'] - -## Example - -```python -from mr_openapi.models.metadata_string_value import MetadataStringValue - -# TODO update the JSON string below -json = "{}" -# create an instance of MetadataStringValue from a JSON string -metadata_string_value_instance = MetadataStringValue.from_json(json) -# print the JSON string representation of the object -print(MetadataStringValue.to_json()) - -# convert the object into a dict -metadata_string_value_dict = metadata_string_value_instance.to_dict() -# create an instance of MetadataStringValue from a dict -metadata_string_value_from_dict = MetadataStringValue.from_dict(metadata_string_value_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/MetadataStructValue.md b/clients/python/src/mr_openapi/docs/MetadataStructValue.md deleted file mode 100644 index d3bccba4b..000000000 --- a/clients/python/src/mr_openapi/docs/MetadataStructValue.md +++ /dev/null @@ -1,31 +0,0 @@ -# MetadataStructValue - -A struct property value. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**struct_value** | **str** | Base64 encoded bytes for struct value | -**metadata_type** | **str** | | [default to 'MetadataStructValue'] - -## Example - -```python -from mr_openapi.models.metadata_struct_value import MetadataStructValue - -# TODO update the JSON string below -json = "{}" -# create an instance of MetadataStructValue from a JSON string -metadata_struct_value_instance = MetadataStructValue.from_json(json) -# print the JSON string representation of the object -print(MetadataStructValue.to_json()) - -# convert the object into a dict -metadata_struct_value_dict = metadata_struct_value_instance.to_dict() -# create an instance of MetadataStructValue from a dict -metadata_struct_value_from_dict = MetadataStructValue.from_dict(metadata_struct_value_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/MetadataValue.md b/clients/python/src/mr_openapi/docs/MetadataValue.md deleted file mode 100644 index a2b818f54..000000000 --- a/clients/python/src/mr_openapi/docs/MetadataValue.md +++ /dev/null @@ -1,37 +0,0 @@ -# MetadataValue - -A value in properties. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**int_value** | **str** | | -**metadata_type** | **str** | | [default to 'MetadataBoolValue'] -**double_value** | **float** | | -**string_value** | **str** | | -**struct_value** | **str** | Base64 encoded bytes for struct value | -**type** | **str** | url describing proto value | -**proto_value** | **str** | Base64 encoded bytes for proto value | -**bool_value** | **bool** | | - -## Example - -```python -from mr_openapi.models.metadata_value import MetadataValue - -# TODO update the JSON string below -json = "{}" -# create an instance of MetadataValue from a JSON string -metadata_value_instance = MetadataValue.from_json(json) -# print the JSON string representation of the object -print(MetadataValue.to_json()) - -# convert the object into a dict -metadata_value_dict = metadata_value_instance.to_dict() -# create an instance of MetadataValue from a dict -metadata_value_from_dict = MetadataValue.from_dict(metadata_value_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ModelArtifact.md b/clients/python/src/mr_openapi/docs/ModelArtifact.md deleted file mode 100644 index a29f23862..000000000 --- a/clients/python/src/mr_openapi/docs/ModelArtifact.md +++ /dev/null @@ -1,44 +0,0 @@ -# ModelArtifact - -An ML model artifact. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**artifact_type** | **str** | | [default to 'model-artifact'] -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**uri** | **str** | The uniform resource identifier of the physical artifact. May be empty if there is no physical artifact. | [optional] -**state** | [**ArtifactState**](ArtifactState.md) | | [optional] -**name** | **str** | 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. | [optional] -**id** | **str** | Output only. The unique server generated id of the resource. | [optional] [readonly] -**create_time_since_epoch** | **str** | Output only. Create time of the resource in millisecond since epoch. | [optional] [readonly] -**last_update_time_since_epoch** | **str** | Output only. Last update time of the resource since epoch in millisecond since epoch. | [optional] [readonly] -**model_format_name** | **str** | Name of the model format. | [optional] -**storage_key** | **str** | Storage secret name. | [optional] -**storage_path** | **str** | Path for model in storage provided by `storageKey`. | [optional] -**model_format_version** | **str** | Version of the model format. | [optional] -**service_account_name** | **str** | Name of the service account with storage secret. | [optional] - -## Example - -```python -from mr_openapi.models.model_artifact import ModelArtifact - -# TODO update the JSON string below -json = "{}" -# create an instance of ModelArtifact from a JSON string -model_artifact_instance = ModelArtifact.from_json(json) -# print the JSON string representation of the object -print(ModelArtifact.to_json()) - -# convert the object into a dict -model_artifact_dict = model_artifact_instance.to_dict() -# create an instance of ModelArtifact from a dict -model_artifact_from_dict = ModelArtifact.from_dict(model_artifact_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ModelArtifactCreate.md b/clients/python/src/mr_openapi/docs/ModelArtifactCreate.md deleted file mode 100644 index 24fa8f020..000000000 --- a/clients/python/src/mr_openapi/docs/ModelArtifactCreate.md +++ /dev/null @@ -1,40 +0,0 @@ -# ModelArtifactCreate - -An ML model artifact. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**uri** | **str** | The uniform resource identifier of the physical artifact. May be empty if there is no physical artifact. | [optional] -**state** | [**ArtifactState**](ArtifactState.md) | | [optional] -**name** | **str** | 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. | [optional] -**model_format_name** | **str** | Name of the model format. | [optional] -**storage_key** | **str** | Storage secret name. | [optional] -**storage_path** | **str** | Path for model in storage provided by `storageKey`. | [optional] -**model_format_version** | **str** | Version of the model format. | [optional] -**service_account_name** | **str** | Name of the service account with storage secret. | [optional] - -## Example - -```python -from mr_openapi.models.model_artifact_create import ModelArtifactCreate - -# TODO update the JSON string below -json = "{}" -# create an instance of ModelArtifactCreate from a JSON string -model_artifact_create_instance = ModelArtifactCreate.from_json(json) -# print the JSON string representation of the object -print(ModelArtifactCreate.to_json()) - -# convert the object into a dict -model_artifact_create_dict = model_artifact_create_instance.to_dict() -# create an instance of ModelArtifactCreate from a dict -model_artifact_create_from_dict = ModelArtifactCreate.from_dict(model_artifact_create_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ModelArtifactList.md b/clients/python/src/mr_openapi/docs/ModelArtifactList.md deleted file mode 100644 index f1438408c..000000000 --- a/clients/python/src/mr_openapi/docs/ModelArtifactList.md +++ /dev/null @@ -1,33 +0,0 @@ -# ModelArtifactList - -List of ModelArtifact entities. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page_token** | **str** | Token to use to retrieve next page of results. | -**page_size** | **int** | Maximum number of resources to return in the result. | -**size** | **int** | Number of items in result list. | -**items** | [**List[ModelArtifact]**](ModelArtifact.md) | Array of `ModelArtifact` entities. | [optional] - -## Example - -```python -from mr_openapi.models.model_artifact_list import ModelArtifactList - -# TODO update the JSON string below -json = "{}" -# create an instance of ModelArtifactList from a JSON string -model_artifact_list_instance = ModelArtifactList.from_json(json) -# print the JSON string representation of the object -print(ModelArtifactList.to_json()) - -# convert the object into a dict -model_artifact_list_dict = model_artifact_list_instance.to_dict() -# create an instance of ModelArtifactList from a dict -model_artifact_list_from_dict = ModelArtifactList.from_dict(model_artifact_list_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ModelArtifactUpdate.md b/clients/python/src/mr_openapi/docs/ModelArtifactUpdate.md deleted file mode 100644 index a8ea3add2..000000000 --- a/clients/python/src/mr_openapi/docs/ModelArtifactUpdate.md +++ /dev/null @@ -1,39 +0,0 @@ -# ModelArtifactUpdate - -An ML model artifact. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**uri** | **str** | The uniform resource identifier of the physical artifact. May be empty if there is no physical artifact. | [optional] -**state** | [**ArtifactState**](ArtifactState.md) | | [optional] -**model_format_name** | **str** | Name of the model format. | [optional] -**storage_key** | **str** | Storage secret name. | [optional] -**storage_path** | **str** | Path for model in storage provided by `storageKey`. | [optional] -**model_format_version** | **str** | Version of the model format. | [optional] -**service_account_name** | **str** | Name of the service account with storage secret. | [optional] - -## Example - -```python -from mr_openapi.models.model_artifact_update import ModelArtifactUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of ModelArtifactUpdate from a JSON string -model_artifact_update_instance = ModelArtifactUpdate.from_json(json) -# print the JSON string representation of the object -print(ModelArtifactUpdate.to_json()) - -# convert the object into a dict -model_artifact_update_dict = model_artifact_update_instance.to_dict() -# create an instance of ModelArtifactUpdate from a dict -model_artifact_update_from_dict = ModelArtifactUpdate.from_dict(model_artifact_update_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ModelRegistryServiceApi.md b/clients/python/src/mr_openapi/docs/ModelRegistryServiceApi.md deleted file mode 100644 index f6ebff989..000000000 --- a/clients/python/src/mr_openapi/docs/ModelRegistryServiceApi.md +++ /dev/null @@ -1,3030 +0,0 @@ -# mr_openapi.ModelRegistryServiceApi - -All URIs are relative to *https://localhost:8080* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_environment_inference_service**](ModelRegistryServiceApi.md#create_environment_inference_service) | **POST** /api/model_registry/v1alpha3/serving_environments/{servingenvironmentId}/inference_services | Create a InferenceService in ServingEnvironment -[**create_inference_service**](ModelRegistryServiceApi.md#create_inference_service) | **POST** /api/model_registry/v1alpha3/inference_services | Create a InferenceService -[**create_inference_service_serve**](ModelRegistryServiceApi.md#create_inference_service_serve) | **POST** /api/model_registry/v1alpha3/inference_services/{inferenceserviceId}/serves | Create a ServeModel action in a InferenceService -[**create_model_artifact**](ModelRegistryServiceApi.md#create_model_artifact) | **POST** /api/model_registry/v1alpha3/model_artifacts | Create a ModelArtifact -[**create_model_version**](ModelRegistryServiceApi.md#create_model_version) | **POST** /api/model_registry/v1alpha3/model_versions | Create a ModelVersion -[**create_model_version_artifact**](ModelRegistryServiceApi.md#create_model_version_artifact) | **POST** /api/model_registry/v1alpha3/model_versions/{modelversionId}/artifacts | Create an Artifact in a ModelVersion -[**create_registered_model**](ModelRegistryServiceApi.md#create_registered_model) | **POST** /api/model_registry/v1alpha3/registered_models | Create a RegisteredModel -[**create_registered_model_version**](ModelRegistryServiceApi.md#create_registered_model_version) | **POST** /api/model_registry/v1alpha3/registered_models/{registeredmodelId}/versions | Create a ModelVersion in RegisteredModel -[**create_serving_environment**](ModelRegistryServiceApi.md#create_serving_environment) | **POST** /api/model_registry/v1alpha3/serving_environments | Create a ServingEnvironment -[**find_inference_service**](ModelRegistryServiceApi.md#find_inference_service) | **GET** /api/model_registry/v1alpha3/inference_service | Get an InferenceServices that matches search parameters. -[**find_model_artifact**](ModelRegistryServiceApi.md#find_model_artifact) | **GET** /api/model_registry/v1alpha3/model_artifact | Get a ModelArtifact that matches search parameters. -[**find_model_version**](ModelRegistryServiceApi.md#find_model_version) | **GET** /api/model_registry/v1alpha3/model_version | Get a ModelVersion that matches search parameters. -[**find_registered_model**](ModelRegistryServiceApi.md#find_registered_model) | **GET** /api/model_registry/v1alpha3/registered_model | Get a RegisteredModel that matches search parameters. -[**find_serving_environment**](ModelRegistryServiceApi.md#find_serving_environment) | **GET** /api/model_registry/v1alpha3/serving_environment | Find ServingEnvironment -[**get_environment_inference_services**](ModelRegistryServiceApi.md#get_environment_inference_services) | **GET** /api/model_registry/v1alpha3/serving_environments/{servingenvironmentId}/inference_services | List All ServingEnvironment's InferenceServices -[**get_inference_service**](ModelRegistryServiceApi.md#get_inference_service) | **GET** /api/model_registry/v1alpha3/inference_services/{inferenceserviceId} | Get a InferenceService -[**get_inference_service_model**](ModelRegistryServiceApi.md#get_inference_service_model) | **GET** /api/model_registry/v1alpha3/inference_services/{inferenceserviceId}/model | Get InferenceService's RegisteredModel -[**get_inference_service_serves**](ModelRegistryServiceApi.md#get_inference_service_serves) | **GET** /api/model_registry/v1alpha3/inference_services/{inferenceserviceId}/serves | List All InferenceService's ServeModel actions -[**get_inference_service_version**](ModelRegistryServiceApi.md#get_inference_service_version) | **GET** /api/model_registry/v1alpha3/inference_services/{inferenceserviceId}/version | Get InferenceService's ModelVersion -[**get_inference_services**](ModelRegistryServiceApi.md#get_inference_services) | **GET** /api/model_registry/v1alpha3/inference_services | List All InferenceServices -[**get_model_artifact**](ModelRegistryServiceApi.md#get_model_artifact) | **GET** /api/model_registry/v1alpha3/model_artifacts/{modelartifactId} | Get a ModelArtifact -[**get_model_artifacts**](ModelRegistryServiceApi.md#get_model_artifacts) | **GET** /api/model_registry/v1alpha3/model_artifacts | List All ModelArtifacts -[**get_model_version**](ModelRegistryServiceApi.md#get_model_version) | **GET** /api/model_registry/v1alpha3/model_versions/{modelversionId} | Get a ModelVersion -[**get_model_version_artifacts**](ModelRegistryServiceApi.md#get_model_version_artifacts) | **GET** /api/model_registry/v1alpha3/model_versions/{modelversionId}/artifacts | List all artifacts associated with the `ModelVersion` -[**get_model_versions**](ModelRegistryServiceApi.md#get_model_versions) | **GET** /api/model_registry/v1alpha3/model_versions | List All ModelVersions -[**get_registered_model**](ModelRegistryServiceApi.md#get_registered_model) | **GET** /api/model_registry/v1alpha3/registered_models/{registeredmodelId} | Get a RegisteredModel -[**get_registered_model_versions**](ModelRegistryServiceApi.md#get_registered_model_versions) | **GET** /api/model_registry/v1alpha3/registered_models/{registeredmodelId}/versions | List All RegisteredModel's ModelVersions -[**get_registered_models**](ModelRegistryServiceApi.md#get_registered_models) | **GET** /api/model_registry/v1alpha3/registered_models | List All RegisteredModels -[**get_serving_environment**](ModelRegistryServiceApi.md#get_serving_environment) | **GET** /api/model_registry/v1alpha3/serving_environments/{servingenvironmentId} | Get a ServingEnvironment -[**get_serving_environments**](ModelRegistryServiceApi.md#get_serving_environments) | **GET** /api/model_registry/v1alpha3/serving_environments | List All ServingEnvironments -[**update_inference_service**](ModelRegistryServiceApi.md#update_inference_service) | **PATCH** /api/model_registry/v1alpha3/inference_services/{inferenceserviceId} | Update a InferenceService -[**update_model_artifact**](ModelRegistryServiceApi.md#update_model_artifact) | **PATCH** /api/model_registry/v1alpha3/model_artifacts/{modelartifactId} | Update a ModelArtifact -[**update_model_version**](ModelRegistryServiceApi.md#update_model_version) | **PATCH** /api/model_registry/v1alpha3/model_versions/{modelversionId} | Update a ModelVersion -[**update_registered_model**](ModelRegistryServiceApi.md#update_registered_model) | **PATCH** /api/model_registry/v1alpha3/registered_models/{registeredmodelId} | Update a RegisteredModel -[**update_serving_environment**](ModelRegistryServiceApi.md#update_serving_environment) | **PATCH** /api/model_registry/v1alpha3/serving_environments/{servingenvironmentId} | Update a ServingEnvironment - - -# **create_environment_inference_service** -> InferenceService create_environment_inference_service(servingenvironment_id, inference_service_create) - -Create a InferenceService in ServingEnvironment - -Creates a new instance of a `InferenceService`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.inference_service import InferenceService -from mr_openapi.models.inference_service_create import InferenceServiceCreate -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - servingenvironment_id = 'servingenvironment_id_example' # str | A unique identifier for a `ServingEnvironment`. - inference_service_create = mr_openapi.InferenceServiceCreate() # InferenceServiceCreate | A new `InferenceService` to be created. - - try: - # Create a InferenceService in ServingEnvironment - api_response = await api_instance.create_environment_inference_service(servingenvironment_id, inference_service_create) - print("The response of ModelRegistryServiceApi->create_environment_inference_service:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->create_environment_inference_service: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **servingenvironment_id** | **str**| A unique identifier for a `ServingEnvironment`. | - **inference_service_create** | [**InferenceServiceCreate**](InferenceServiceCreate.md)| A new `InferenceService` to be created. | - -### Return type - -[**InferenceService**](InferenceService.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | A response containing a `InferenceService` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_inference_service** -> InferenceService create_inference_service(inference_service_create) - -Create a InferenceService - -Creates a new instance of a `InferenceService`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.inference_service import InferenceService -from mr_openapi.models.inference_service_create import InferenceServiceCreate -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - inference_service_create = mr_openapi.InferenceServiceCreate() # InferenceServiceCreate | A new `InferenceService` to be created. - - try: - # Create a InferenceService - api_response = await api_instance.create_inference_service(inference_service_create) - print("The response of ModelRegistryServiceApi->create_inference_service:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->create_inference_service: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **inference_service_create** | [**InferenceServiceCreate**](InferenceServiceCreate.md)| A new `InferenceService` to be created. | - -### Return type - -[**InferenceService**](InferenceService.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `InferenceService` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_inference_service_serve** -> ServeModel create_inference_service_serve(inferenceservice_id, serve_model_create) - -Create a ServeModel action in a InferenceService - -Creates a new instance of a `ServeModel` associated with `InferenceService`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.serve_model import ServeModel -from mr_openapi.models.serve_model_create import ServeModelCreate -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - inferenceservice_id = 'inferenceservice_id_example' # str | A unique identifier for a `InferenceService`. - serve_model_create = mr_openapi.ServeModelCreate() # ServeModelCreate | A new `ServeModel` to be associated with the `InferenceService`. - - try: - # Create a ServeModel action in a InferenceService - api_response = await api_instance.create_inference_service_serve(inferenceservice_id, serve_model_create) - print("The response of ModelRegistryServiceApi->create_inference_service_serve:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->create_inference_service_serve: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **inferenceservice_id** | **str**| A unique identifier for a `InferenceService`. | - **serve_model_create** | [**ServeModelCreate**](ServeModelCreate.md)| A new `ServeModel` to be associated with the `InferenceService`. | - -### Return type - -[**ServeModel**](ServeModel.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | A response containing a `ServeModel` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_model_artifact** -> ModelArtifact create_model_artifact(model_artifact_create) - -Create a ModelArtifact - -Creates a new instance of a `ModelArtifact`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.model_artifact import ModelArtifact -from mr_openapi.models.model_artifact_create import ModelArtifactCreate -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - model_artifact_create = mr_openapi.ModelArtifactCreate() # ModelArtifactCreate | A new `ModelArtifact` to be created. - - try: - # Create a ModelArtifact - api_response = await api_instance.create_model_artifact(model_artifact_create) - print("The response of ModelRegistryServiceApi->create_model_artifact:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->create_model_artifact: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **model_artifact_create** | [**ModelArtifactCreate**](ModelArtifactCreate.md)| A new `ModelArtifact` to be created. | - -### Return type - -[**ModelArtifact**](ModelArtifact.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | A response containing a `ModelArtifact` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_model_version** -> ModelVersion create_model_version(model_version_create) - -Create a ModelVersion - -Creates a new instance of a `ModelVersion`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.model_version import ModelVersion -from mr_openapi.models.model_version_create import ModelVersionCreate -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - model_version_create = mr_openapi.ModelVersionCreate() # ModelVersionCreate | A new `ModelVersion` to be created. - - try: - # Create a ModelVersion - api_response = await api_instance.create_model_version(model_version_create) - print("The response of ModelRegistryServiceApi->create_model_version:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->create_model_version: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **model_version_create** | [**ModelVersionCreate**](ModelVersionCreate.md)| A new `ModelVersion` to be created. | - -### Return type - -[**ModelVersion**](ModelVersion.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | A response containing a `ModelVersion` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_model_version_artifact** -> Artifact create_model_version_artifact(modelversion_id, artifact) - -Create an Artifact in a ModelVersion - -Creates a new instance of an Artifact if needed and associates it with `ModelVersion`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.artifact import Artifact -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - modelversion_id = 'modelversion_id_example' # str | A unique identifier for a `ModelVersion`. - artifact = mr_openapi.Artifact() # Artifact | A new or existing `Artifact` to be associated with the `ModelVersion`. - - try: - # Create an Artifact in a ModelVersion - api_response = await api_instance.create_model_version_artifact(modelversion_id, artifact) - print("The response of ModelRegistryServiceApi->create_model_version_artifact:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->create_model_version_artifact: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **modelversion_id** | **str**| A unique identifier for a `ModelVersion`. | - **artifact** | [**Artifact**](Artifact.md)| A new or existing `Artifact` to be associated with the `ModelVersion`. | - -### Return type - -[**Artifact**](Artifact.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing an `Artifact` entity. | - | -**201** | A response containing an `Artifact` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_registered_model** -> RegisteredModel create_registered_model(registered_model_create) - -Create a RegisteredModel - -Creates a new instance of a `RegisteredModel`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.registered_model import RegisteredModel -from mr_openapi.models.registered_model_create import RegisteredModelCreate -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - registered_model_create = mr_openapi.RegisteredModelCreate() # RegisteredModelCreate | A new `RegisteredModel` to be created. - - try: - # Create a RegisteredModel - api_response = await api_instance.create_registered_model(registered_model_create) - print("The response of ModelRegistryServiceApi->create_registered_model:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->create_registered_model: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **registered_model_create** | [**RegisteredModelCreate**](RegisteredModelCreate.md)| A new `RegisteredModel` to be created. | - -### Return type - -[**RegisteredModel**](RegisteredModel.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | A response containing a `RegisteredModel` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_registered_model_version** -> ModelVersion create_registered_model_version(registeredmodel_id, model_version) - -Create a ModelVersion in RegisteredModel - -Creates a new instance of a `ModelVersion`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.model_version import ModelVersion -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - registeredmodel_id = 'registeredmodel_id_example' # str | A unique identifier for a `RegisteredModel`. - model_version = mr_openapi.ModelVersion() # ModelVersion | A new `ModelVersion` to be created. - - try: - # Create a ModelVersion in RegisteredModel - api_response = await api_instance.create_registered_model_version(registeredmodel_id, model_version) - print("The response of ModelRegistryServiceApi->create_registered_model_version:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->create_registered_model_version: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **registeredmodel_id** | **str**| A unique identifier for a `RegisteredModel`. | - **model_version** | [**ModelVersion**](ModelVersion.md)| A new `ModelVersion` to be created. | - -### Return type - -[**ModelVersion**](ModelVersion.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | A response containing a `ModelVersion` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_serving_environment** -> ServingEnvironment create_serving_environment(serving_environment_create) - -Create a ServingEnvironment - -Creates a new instance of a `ServingEnvironment`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.serving_environment import ServingEnvironment -from mr_openapi.models.serving_environment_create import ServingEnvironmentCreate -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - serving_environment_create = mr_openapi.ServingEnvironmentCreate() # ServingEnvironmentCreate | A new `ServingEnvironment` to be created. - - try: - # Create a ServingEnvironment - api_response = await api_instance.create_serving_environment(serving_environment_create) - print("The response of ModelRegistryServiceApi->create_serving_environment:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->create_serving_environment: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **serving_environment_create** | [**ServingEnvironmentCreate**](ServingEnvironmentCreate.md)| A new `ServingEnvironment` to be created. | - -### Return type - -[**ServingEnvironment**](ServingEnvironment.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**201** | A response containing a `ServingEnvironment` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **find_inference_service** -> InferenceService find_inference_service(name=name, external_id=external_id, parent_resource_id=parent_resource_id) - -Get an InferenceServices that matches search parameters. - -Gets the details of a single instance of `InferenceService` that matches search parameters. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.inference_service import InferenceService -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - name = 'entity-name' # str | Name of entity to search. (optional) - external_id = '10' # str | External ID of entity to search. (optional) - parent_resource_id = '10' # str | ID of the parent resource to use for search. (optional) - - try: - # Get an InferenceServices that matches search parameters. - api_response = await api_instance.find_inference_service(name=name, external_id=external_id, parent_resource_id=parent_resource_id) - print("The response of ModelRegistryServiceApi->find_inference_service:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->find_inference_service: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str**| Name of entity to search. | [optional] - **external_id** | **str**| External ID of entity to search. | [optional] - **parent_resource_id** | **str**| ID of the parent resource to use for search. | [optional] - -### Return type - -[**InferenceService**](InferenceService.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `InferenceService` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **find_model_artifact** -> ModelArtifact find_model_artifact(name=name, external_id=external_id, parent_resource_id=parent_resource_id) - -Get a ModelArtifact that matches search parameters. - -Gets the details of a single instance of a `ModelArtifact` that matches search parameters. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.model_artifact import ModelArtifact -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - name = 'entity-name' # str | Name of entity to search. (optional) - external_id = '10' # str | External ID of entity to search. (optional) - parent_resource_id = '10' # str | ID of the parent resource to use for search. (optional) - - try: - # Get a ModelArtifact that matches search parameters. - api_response = await api_instance.find_model_artifact(name=name, external_id=external_id, parent_resource_id=parent_resource_id) - print("The response of ModelRegistryServiceApi->find_model_artifact:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->find_model_artifact: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str**| Name of entity to search. | [optional] - **external_id** | **str**| External ID of entity to search. | [optional] - **parent_resource_id** | **str**| ID of the parent resource to use for search. | [optional] - -### Return type - -[**ModelArtifact**](ModelArtifact.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `ModelArtifact` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **find_model_version** -> ModelVersion find_model_version(name=name, external_id=external_id, parent_resource_id=parent_resource_id) - -Get a ModelVersion that matches search parameters. - -Gets the details of a single instance of a `ModelVersion` that matches search parameters. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.model_version import ModelVersion -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - name = 'entity-name' # str | Name of entity to search. (optional) - external_id = '10' # str | External ID of entity to search. (optional) - parent_resource_id = '10' # str | ID of the parent resource to use for search. (optional) - - try: - # Get a ModelVersion that matches search parameters. - api_response = await api_instance.find_model_version(name=name, external_id=external_id, parent_resource_id=parent_resource_id) - print("The response of ModelRegistryServiceApi->find_model_version:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->find_model_version: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str**| Name of entity to search. | [optional] - **external_id** | **str**| External ID of entity to search. | [optional] - **parent_resource_id** | **str**| ID of the parent resource to use for search. | [optional] - -### Return type - -[**ModelVersion**](ModelVersion.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `ModelVersion` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **find_registered_model** -> RegisteredModel find_registered_model(name=name, external_id=external_id) - -Get a RegisteredModel that matches search parameters. - -Gets the details of a single instance of a `RegisteredModel` that matches search parameters. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.registered_model import RegisteredModel -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - name = 'entity-name' # str | Name of entity to search. (optional) - external_id = '10' # str | External ID of entity to search. (optional) - - try: - # Get a RegisteredModel that matches search parameters. - api_response = await api_instance.find_registered_model(name=name, external_id=external_id) - print("The response of ModelRegistryServiceApi->find_registered_model:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->find_registered_model: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str**| Name of entity to search. | [optional] - **external_id** | **str**| External ID of entity to search. | [optional] - -### Return type - -[**RegisteredModel**](RegisteredModel.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `RegisteredModel` entity. | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **find_serving_environment** -> ServingEnvironment find_serving_environment(name=name, external_id=external_id) - -Find ServingEnvironment - -Finds a `ServingEnvironment` entity that matches query parameters. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.serving_environment import ServingEnvironment -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - name = 'entity-name' # str | Name of entity to search. (optional) - external_id = '10' # str | External ID of entity to search. (optional) - - try: - # Find ServingEnvironment - api_response = await api_instance.find_serving_environment(name=name, external_id=external_id) - print("The response of ModelRegistryServiceApi->find_serving_environment:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->find_serving_environment: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str**| Name of entity to search. | [optional] - **external_id** | **str**| External ID of entity to search. | [optional] - -### Return type - -[**ServingEnvironment**](ServingEnvironment.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `ServingEnvironment` entity. | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_environment_inference_services** -> InferenceServiceList get_environment_inference_services(servingenvironment_id, name=name, external_id=external_id, page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - -List All ServingEnvironment's InferenceServices - -Gets a list of all `InferenceService` entities for the `ServingEnvironment`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.inference_service_list import InferenceServiceList -from mr_openapi.models.order_by_field import OrderByField -from mr_openapi.models.sort_order import SortOrder -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - servingenvironment_id = 'servingenvironment_id_example' # str | A unique identifier for a `ServingEnvironment`. - name = 'entity-name' # str | Name of entity to search. (optional) - external_id = '10' # str | External ID of entity to search. (optional) - page_size = '100' # str | Number of entities in each page. (optional) - order_by = mr_openapi.OrderByField() # OrderByField | Specifies the order by criteria for listing entities. (optional) - sort_order = mr_openapi.SortOrder() # SortOrder | Specifies the sort order for listing entities, defaults to ASC. (optional) - next_page_token = 'IkhlbGxvLCB3b3JsZC4i' # str | Token to use to retrieve next page of results. (optional) - - try: - # List All ServingEnvironment's InferenceServices - api_response = await api_instance.get_environment_inference_services(servingenvironment_id, name=name, external_id=external_id, page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - print("The response of ModelRegistryServiceApi->get_environment_inference_services:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->get_environment_inference_services: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **servingenvironment_id** | **str**| A unique identifier for a `ServingEnvironment`. | - **name** | **str**| Name of entity to search. | [optional] - **external_id** | **str**| External ID of entity to search. | [optional] - **page_size** | **str**| Number of entities in each page. | [optional] - **order_by** | [**OrderByField**](.md)| Specifies the order by criteria for listing entities. | [optional] - **sort_order** | [**SortOrder**](.md)| Specifies the sort order for listing entities, defaults to ASC. | [optional] - **next_page_token** | **str**| Token to use to retrieve next page of results. | [optional] - -### Return type - -[**InferenceServiceList**](InferenceServiceList.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a list of `InferenceService` entities. | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_inference_service** -> InferenceService get_inference_service(inferenceservice_id) - -Get a InferenceService - -Gets the details of a single instance of a `InferenceService`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.inference_service import InferenceService -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - inferenceservice_id = 'inferenceservice_id_example' # str | A unique identifier for a `InferenceService`. - - try: - # Get a InferenceService - api_response = await api_instance.get_inference_service(inferenceservice_id) - print("The response of ModelRegistryServiceApi->get_inference_service:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->get_inference_service: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **inferenceservice_id** | **str**| A unique identifier for a `InferenceService`. | - -### Return type - -[**InferenceService**](InferenceService.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `InferenceService` entity. | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_inference_service_model** -> RegisteredModel get_inference_service_model(inferenceservice_id) - -Get InferenceService's RegisteredModel - -Gets the `RegisteredModel` entity for the `InferenceService`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.registered_model import RegisteredModel -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - inferenceservice_id = 'inferenceservice_id_example' # str | A unique identifier for a `InferenceService`. - - try: - # Get InferenceService's RegisteredModel - api_response = await api_instance.get_inference_service_model(inferenceservice_id) - print("The response of ModelRegistryServiceApi->get_inference_service_model:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->get_inference_service_model: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **inferenceservice_id** | **str**| A unique identifier for a `InferenceService`. | - -### Return type - -[**RegisteredModel**](RegisteredModel.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `RegisteredModel` entity. | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_inference_service_serves** -> ServeModelList get_inference_service_serves(inferenceservice_id, name=name, external_id=external_id, page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - -List All InferenceService's ServeModel actions - -Gets a list of all `ServeModel` entities for the `InferenceService`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.order_by_field import OrderByField -from mr_openapi.models.serve_model_list import ServeModelList -from mr_openapi.models.sort_order import SortOrder -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - inferenceservice_id = 'inferenceservice_id_example' # str | A unique identifier for a `InferenceService`. - name = 'entity-name' # str | Name of entity to search. (optional) - external_id = '10' # str | External ID of entity to search. (optional) - page_size = '100' # str | Number of entities in each page. (optional) - order_by = mr_openapi.OrderByField() # OrderByField | Specifies the order by criteria for listing entities. (optional) - sort_order = mr_openapi.SortOrder() # SortOrder | Specifies the sort order for listing entities, defaults to ASC. (optional) - next_page_token = 'IkhlbGxvLCB3b3JsZC4i' # str | Token to use to retrieve next page of results. (optional) - - try: - # List All InferenceService's ServeModel actions - api_response = await api_instance.get_inference_service_serves(inferenceservice_id, name=name, external_id=external_id, page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - print("The response of ModelRegistryServiceApi->get_inference_service_serves:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->get_inference_service_serves: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **inferenceservice_id** | **str**| A unique identifier for a `InferenceService`. | - **name** | **str**| Name of entity to search. | [optional] - **external_id** | **str**| External ID of entity to search. | [optional] - **page_size** | **str**| Number of entities in each page. | [optional] - **order_by** | [**OrderByField**](.md)| Specifies the order by criteria for listing entities. | [optional] - **sort_order** | [**SortOrder**](.md)| Specifies the sort order for listing entities, defaults to ASC. | [optional] - **next_page_token** | **str**| Token to use to retrieve next page of results. | [optional] - -### Return type - -[**ServeModelList**](ServeModelList.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a list of `ServeModel` entities. | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_inference_service_version** -> ModelVersion get_inference_service_version(inferenceservice_id) - -Get InferenceService's ModelVersion - -Gets the `ModelVersion` entity for the `InferenceService`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.model_version import ModelVersion -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - inferenceservice_id = 'inferenceservice_id_example' # str | A unique identifier for a `InferenceService`. - - try: - # Get InferenceService's ModelVersion - api_response = await api_instance.get_inference_service_version(inferenceservice_id) - print("The response of ModelRegistryServiceApi->get_inference_service_version:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->get_inference_service_version: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **inferenceservice_id** | **str**| A unique identifier for a `InferenceService`. | - -### Return type - -[**ModelVersion**](ModelVersion.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `ModelVersion` entity. | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_inference_services** -> InferenceServiceList get_inference_services(page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - -List All InferenceServices - -Gets a list of all `InferenceService` entities. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.inference_service_list import InferenceServiceList -from mr_openapi.models.order_by_field import OrderByField -from mr_openapi.models.sort_order import SortOrder -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - page_size = '100' # str | Number of entities in each page. (optional) - order_by = mr_openapi.OrderByField() # OrderByField | Specifies the order by criteria for listing entities. (optional) - sort_order = mr_openapi.SortOrder() # SortOrder | Specifies the sort order for listing entities, defaults to ASC. (optional) - next_page_token = 'IkhlbGxvLCB3b3JsZC4i' # str | Token to use to retrieve next page of results. (optional) - - try: - # List All InferenceServices - api_response = await api_instance.get_inference_services(page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - print("The response of ModelRegistryServiceApi->get_inference_services:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->get_inference_services: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **page_size** | **str**| Number of entities in each page. | [optional] - **order_by** | [**OrderByField**](.md)| Specifies the order by criteria for listing entities. | [optional] - **sort_order** | [**SortOrder**](.md)| Specifies the sort order for listing entities, defaults to ASC. | [optional] - **next_page_token** | **str**| Token to use to retrieve next page of results. | [optional] - -### Return type - -[**InferenceServiceList**](InferenceServiceList.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a list of `InferenceService` entities. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_model_artifact** -> ModelArtifact get_model_artifact(modelartifact_id) - -Get a ModelArtifact - -Gets the details of a single instance of a `ModelArtifact`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.model_artifact import ModelArtifact -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - modelartifact_id = 'modelartifact_id_example' # str | A unique identifier for a `ModelArtifact`. - - try: - # Get a ModelArtifact - api_response = await api_instance.get_model_artifact(modelartifact_id) - print("The response of ModelRegistryServiceApi->get_model_artifact:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->get_model_artifact: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **modelartifact_id** | **str**| A unique identifier for a `ModelArtifact`. | - -### Return type - -[**ModelArtifact**](ModelArtifact.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `ModelArtifact` entity. | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_model_artifacts** -> ModelArtifactList get_model_artifacts(page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - -List All ModelArtifacts - -Gets a list of all `ModelArtifact` entities. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.model_artifact_list import ModelArtifactList -from mr_openapi.models.order_by_field import OrderByField -from mr_openapi.models.sort_order import SortOrder -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - page_size = '100' # str | Number of entities in each page. (optional) - order_by = mr_openapi.OrderByField() # OrderByField | Specifies the order by criteria for listing entities. (optional) - sort_order = mr_openapi.SortOrder() # SortOrder | Specifies the sort order for listing entities, defaults to ASC. (optional) - next_page_token = 'IkhlbGxvLCB3b3JsZC4i' # str | Token to use to retrieve next page of results. (optional) - - try: - # List All ModelArtifacts - api_response = await api_instance.get_model_artifacts(page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - print("The response of ModelRegistryServiceApi->get_model_artifacts:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->get_model_artifacts: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **page_size** | **str**| Number of entities in each page. | [optional] - **order_by** | [**OrderByField**](.md)| Specifies the order by criteria for listing entities. | [optional] - **sort_order** | [**SortOrder**](.md)| Specifies the sort order for listing entities, defaults to ASC. | [optional] - **next_page_token** | **str**| Token to use to retrieve next page of results. | [optional] - -### Return type - -[**ModelArtifactList**](ModelArtifactList.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a list of ModelArtifact entities. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_model_version** -> ModelVersion get_model_version(modelversion_id) - -Get a ModelVersion - -Gets the details of a single instance of a `ModelVersion`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.model_version import ModelVersion -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - modelversion_id = 'modelversion_id_example' # str | A unique identifier for a `ModelVersion`. - - try: - # Get a ModelVersion - api_response = await api_instance.get_model_version(modelversion_id) - print("The response of ModelRegistryServiceApi->get_model_version:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->get_model_version: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **modelversion_id** | **str**| A unique identifier for a `ModelVersion`. | - -### Return type - -[**ModelVersion**](ModelVersion.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `ModelVersion` entity. | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_model_version_artifacts** -> ArtifactList get_model_version_artifacts(modelversion_id, name=name, external_id=external_id, page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - -List all artifacts associated with the `ModelVersion` - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.artifact_list import ArtifactList -from mr_openapi.models.order_by_field import OrderByField -from mr_openapi.models.sort_order import SortOrder -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - modelversion_id = 'modelversion_id_example' # str | A unique identifier for a `ModelVersion`. - name = 'entity-name' # str | Name of entity to search. (optional) - external_id = '10' # str | External ID of entity to search. (optional) - page_size = '100' # str | Number of entities in each page. (optional) - order_by = mr_openapi.OrderByField() # OrderByField | Specifies the order by criteria for listing entities. (optional) - sort_order = mr_openapi.SortOrder() # SortOrder | Specifies the sort order for listing entities, defaults to ASC. (optional) - next_page_token = 'IkhlbGxvLCB3b3JsZC4i' # str | Token to use to retrieve next page of results. (optional) - - try: - # List all artifacts associated with the `ModelVersion` - api_response = await api_instance.get_model_version_artifacts(modelversion_id, name=name, external_id=external_id, page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - print("The response of ModelRegistryServiceApi->get_model_version_artifacts:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->get_model_version_artifacts: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **modelversion_id** | **str**| A unique identifier for a `ModelVersion`. | - **name** | **str**| Name of entity to search. | [optional] - **external_id** | **str**| External ID of entity to search. | [optional] - **page_size** | **str**| Number of entities in each page. | [optional] - **order_by** | [**OrderByField**](.md)| Specifies the order by criteria for listing entities. | [optional] - **sort_order** | [**SortOrder**](.md)| Specifies the sort order for listing entities, defaults to ASC. | [optional] - **next_page_token** | **str**| Token to use to retrieve next page of results. | [optional] - -### Return type - -[**ArtifactList**](ArtifactList.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a list of `Artifact` entities. | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_model_versions** -> ModelVersionList get_model_versions(page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - -List All ModelVersions - -Gets a list of all `ModelVersion` entities. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.model_version_list import ModelVersionList -from mr_openapi.models.order_by_field import OrderByField -from mr_openapi.models.sort_order import SortOrder -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - page_size = '100' # str | Number of entities in each page. (optional) - order_by = mr_openapi.OrderByField() # OrderByField | Specifies the order by criteria for listing entities. (optional) - sort_order = mr_openapi.SortOrder() # SortOrder | Specifies the sort order for listing entities, defaults to ASC. (optional) - next_page_token = 'IkhlbGxvLCB3b3JsZC4i' # str | Token to use to retrieve next page of results. (optional) - - try: - # List All ModelVersions - api_response = await api_instance.get_model_versions(page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - print("The response of ModelRegistryServiceApi->get_model_versions:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->get_model_versions: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **page_size** | **str**| Number of entities in each page. | [optional] - **order_by** | [**OrderByField**](.md)| Specifies the order by criteria for listing entities. | [optional] - **sort_order** | [**SortOrder**](.md)| Specifies the sort order for listing entities, defaults to ASC. | [optional] - **next_page_token** | **str**| Token to use to retrieve next page of results. | [optional] - -### Return type - -[**ModelVersionList**](ModelVersionList.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a list of `ModelVersion` entities. | - | -**401** | Unauthorized | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_registered_model** -> RegisteredModel get_registered_model(registeredmodel_id) - -Get a RegisteredModel - -Gets the details of a single instance of a `RegisteredModel`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.registered_model import RegisteredModel -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - registeredmodel_id = 'registeredmodel_id_example' # str | A unique identifier for a `RegisteredModel`. - - try: - # Get a RegisteredModel - api_response = await api_instance.get_registered_model(registeredmodel_id) - print("The response of ModelRegistryServiceApi->get_registered_model:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->get_registered_model: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **registeredmodel_id** | **str**| A unique identifier for a `RegisteredModel`. | - -### Return type - -[**RegisteredModel**](RegisteredModel.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `RegisteredModel` entity. | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_registered_model_versions** -> ModelVersionList get_registered_model_versions(registeredmodel_id, name=name, external_id=external_id, page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - -List All RegisteredModel's ModelVersions - -Gets a list of all `ModelVersion` entities for the `RegisteredModel`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.model_version_list import ModelVersionList -from mr_openapi.models.order_by_field import OrderByField -from mr_openapi.models.sort_order import SortOrder -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - registeredmodel_id = 'registeredmodel_id_example' # str | A unique identifier for a `RegisteredModel`. - name = 'entity-name' # str | Name of entity to search. (optional) - external_id = '10' # str | External ID of entity to search. (optional) - page_size = '100' # str | Number of entities in each page. (optional) - order_by = mr_openapi.OrderByField() # OrderByField | Specifies the order by criteria for listing entities. (optional) - sort_order = mr_openapi.SortOrder() # SortOrder | Specifies the sort order for listing entities, defaults to ASC. (optional) - next_page_token = 'IkhlbGxvLCB3b3JsZC4i' # str | Token to use to retrieve next page of results. (optional) - - try: - # List All RegisteredModel's ModelVersions - api_response = await api_instance.get_registered_model_versions(registeredmodel_id, name=name, external_id=external_id, page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - print("The response of ModelRegistryServiceApi->get_registered_model_versions:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->get_registered_model_versions: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **registeredmodel_id** | **str**| A unique identifier for a `RegisteredModel`. | - **name** | **str**| Name of entity to search. | [optional] - **external_id** | **str**| External ID of entity to search. | [optional] - **page_size** | **str**| Number of entities in each page. | [optional] - **order_by** | [**OrderByField**](.md)| Specifies the order by criteria for listing entities. | [optional] - **sort_order** | [**SortOrder**](.md)| Specifies the sort order for listing entities, defaults to ASC. | [optional] - **next_page_token** | **str**| Token to use to retrieve next page of results. | [optional] - -### Return type - -[**ModelVersionList**](ModelVersionList.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a list of `ModelVersion` entities. | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_registered_models** -> RegisteredModelList get_registered_models(page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - -List All RegisteredModels - -Gets a list of all `RegisteredModel` entities. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.order_by_field import OrderByField -from mr_openapi.models.registered_model_list import RegisteredModelList -from mr_openapi.models.sort_order import SortOrder -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - page_size = '100' # str | Number of entities in each page. (optional) - order_by = mr_openapi.OrderByField() # OrderByField | Specifies the order by criteria for listing entities. (optional) - sort_order = mr_openapi.SortOrder() # SortOrder | Specifies the sort order for listing entities, defaults to ASC. (optional) - next_page_token = 'IkhlbGxvLCB3b3JsZC4i' # str | Token to use to retrieve next page of results. (optional) - - try: - # List All RegisteredModels - api_response = await api_instance.get_registered_models(page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - print("The response of ModelRegistryServiceApi->get_registered_models:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->get_registered_models: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **page_size** | **str**| Number of entities in each page. | [optional] - **order_by** | [**OrderByField**](.md)| Specifies the order by criteria for listing entities. | [optional] - **sort_order** | [**SortOrder**](.md)| Specifies the sort order for listing entities, defaults to ASC. | [optional] - **next_page_token** | **str**| Token to use to retrieve next page of results. | [optional] - -### Return type - -[**RegisteredModelList**](RegisteredModelList.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a list of `RegisteredModel` entities. | - | -**401** | Unauthorized | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_serving_environment** -> ServingEnvironment get_serving_environment(servingenvironment_id) - -Get a ServingEnvironment - -Gets the details of a single instance of a `ServingEnvironment`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.serving_environment import ServingEnvironment -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - servingenvironment_id = 'servingenvironment_id_example' # str | A unique identifier for a `ServingEnvironment`. - - try: - # Get a ServingEnvironment - api_response = await api_instance.get_serving_environment(servingenvironment_id) - print("The response of ModelRegistryServiceApi->get_serving_environment:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->get_serving_environment: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **servingenvironment_id** | **str**| A unique identifier for a `ServingEnvironment`. | - -### Return type - -[**ServingEnvironment**](ServingEnvironment.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `ServingEnvironment` entity. | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_serving_environments** -> ServingEnvironmentList get_serving_environments(page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - -List All ServingEnvironments - -Gets a list of all `ServingEnvironment` entities. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.order_by_field import OrderByField -from mr_openapi.models.serving_environment_list import ServingEnvironmentList -from mr_openapi.models.sort_order import SortOrder -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - page_size = '100' # str | Number of entities in each page. (optional) - order_by = mr_openapi.OrderByField() # OrderByField | Specifies the order by criteria for listing entities. (optional) - sort_order = mr_openapi.SortOrder() # SortOrder | Specifies the sort order for listing entities, defaults to ASC. (optional) - next_page_token = 'IkhlbGxvLCB3b3JsZC4i' # str | Token to use to retrieve next page of results. (optional) - - try: - # List All ServingEnvironments - api_response = await api_instance.get_serving_environments(page_size=page_size, order_by=order_by, sort_order=sort_order, next_page_token=next_page_token) - print("The response of ModelRegistryServiceApi->get_serving_environments:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->get_serving_environments: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **page_size** | **str**| Number of entities in each page. | [optional] - **order_by** | [**OrderByField**](.md)| Specifies the order by criteria for listing entities. | [optional] - **sort_order** | [**SortOrder**](.md)| Specifies the sort order for listing entities, defaults to ASC. | [optional] - **next_page_token** | **str**| Token to use to retrieve next page of results. | [optional] - -### Return type - -[**ServingEnvironmentList**](ServingEnvironmentList.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a list of `ServingEnvironment` entities. | - | -**401** | Unauthorized | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_inference_service** -> InferenceService update_inference_service(inferenceservice_id, inference_service_update) - -Update a InferenceService - -Updates an existing `InferenceService`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.inference_service import InferenceService -from mr_openapi.models.inference_service_update import InferenceServiceUpdate -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - inferenceservice_id = 'inferenceservice_id_example' # str | A unique identifier for a `InferenceService`. - inference_service_update = mr_openapi.InferenceServiceUpdate() # InferenceServiceUpdate | Updated `InferenceService` information. - - try: - # Update a InferenceService - api_response = await api_instance.update_inference_service(inferenceservice_id, inference_service_update) - print("The response of ModelRegistryServiceApi->update_inference_service:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->update_inference_service: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **inferenceservice_id** | **str**| A unique identifier for a `InferenceService`. | - **inference_service_update** | [**InferenceServiceUpdate**](InferenceServiceUpdate.md)| Updated `InferenceService` information. | - -### Return type - -[**InferenceService**](InferenceService.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `InferenceService` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_model_artifact** -> ModelArtifact update_model_artifact(modelartifact_id, model_artifact_update) - -Update a ModelArtifact - -Updates an existing `ModelArtifact`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.model_artifact import ModelArtifact -from mr_openapi.models.model_artifact_update import ModelArtifactUpdate -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - modelartifact_id = 'modelartifact_id_example' # str | A unique identifier for a `ModelArtifact`. - model_artifact_update = mr_openapi.ModelArtifactUpdate() # ModelArtifactUpdate | Updated `ModelArtifact` information. - - try: - # Update a ModelArtifact - api_response = await api_instance.update_model_artifact(modelartifact_id, model_artifact_update) - print("The response of ModelRegistryServiceApi->update_model_artifact:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->update_model_artifact: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **modelartifact_id** | **str**| A unique identifier for a `ModelArtifact`. | - **model_artifact_update** | [**ModelArtifactUpdate**](ModelArtifactUpdate.md)| Updated `ModelArtifact` information. | - -### Return type - -[**ModelArtifact**](ModelArtifact.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `ModelArtifact` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_model_version** -> ModelVersion update_model_version(modelversion_id, model_version_update) - -Update a ModelVersion - -Updates an existing `ModelVersion`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.model_version import ModelVersion -from mr_openapi.models.model_version_update import ModelVersionUpdate -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - modelversion_id = 'modelversion_id_example' # str | A unique identifier for a `ModelVersion`. - model_version_update = mr_openapi.ModelVersionUpdate() # ModelVersionUpdate | Updated `ModelVersion` information. - - try: - # Update a ModelVersion - api_response = await api_instance.update_model_version(modelversion_id, model_version_update) - print("The response of ModelRegistryServiceApi->update_model_version:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->update_model_version: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **modelversion_id** | **str**| A unique identifier for a `ModelVersion`. | - **model_version_update** | [**ModelVersionUpdate**](ModelVersionUpdate.md)| Updated `ModelVersion` information. | - -### Return type - -[**ModelVersion**](ModelVersion.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `ModelVersion` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_registered_model** -> RegisteredModel update_registered_model(registeredmodel_id, registered_model_update) - -Update a RegisteredModel - -Updates an existing `RegisteredModel`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.registered_model import RegisteredModel -from mr_openapi.models.registered_model_update import RegisteredModelUpdate -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - registeredmodel_id = 'registeredmodel_id_example' # str | A unique identifier for a `RegisteredModel`. - registered_model_update = mr_openapi.RegisteredModelUpdate() # RegisteredModelUpdate | Updated `RegisteredModel` information. - - try: - # Update a RegisteredModel - api_response = await api_instance.update_registered_model(registeredmodel_id, registered_model_update) - print("The response of ModelRegistryServiceApi->update_registered_model:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->update_registered_model: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **registeredmodel_id** | **str**| A unique identifier for a `RegisteredModel`. | - **registered_model_update** | [**RegisteredModelUpdate**](RegisteredModelUpdate.md)| Updated `RegisteredModel` information. | - -### Return type - -[**RegisteredModel**](RegisteredModel.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `RegisteredModel` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_serving_environment** -> ServingEnvironment update_serving_environment(servingenvironment_id, serving_environment_update) - -Update a ServingEnvironment - -Updates an existing `ServingEnvironment`. - -### Example - -* Bearer (JWT) Authentication (Bearer): - -```python -import mr_openapi -from mr_openapi.models.serving_environment import ServingEnvironment -from mr_openapi.models.serving_environment_update import ServingEnvironmentUpdate -from mr_openapi.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://localhost:8080 -# See configuration.py for a list of all supported configuration parameters. -configuration = mr_openapi.Configuration( - host = "https://localhost:8080" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure Bearer authorization (JWT): Bearer -configuration = mr_openapi.Configuration( - access_token = os.environ["BEARER_TOKEN"] -) - -# Enter a context with an instance of the API client -async with mr_openapi.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = mr_openapi.ModelRegistryServiceApi(api_client) - servingenvironment_id = 'servingenvironment_id_example' # str | A unique identifier for a `ServingEnvironment`. - serving_environment_update = mr_openapi.ServingEnvironmentUpdate() # ServingEnvironmentUpdate | Updated `ServingEnvironment` information. - - try: - # Update a ServingEnvironment - api_response = await api_instance.update_serving_environment(servingenvironment_id, serving_environment_update) - print("The response of ModelRegistryServiceApi->update_serving_environment:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling ModelRegistryServiceApi->update_serving_environment: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **servingenvironment_id** | **str**| A unique identifier for a `ServingEnvironment`. | - **serving_environment_update** | [**ServingEnvironmentUpdate**](ServingEnvironmentUpdate.md)| Updated `ServingEnvironment` information. | - -### Return type - -[**ServingEnvironment**](ServingEnvironment.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | A response containing a `ServingEnvironment` entity. | - | -**400** | Bad Request parameters | - | -**401** | Unauthorized | - | -**404** | The specified resource was not found | - | -**500** | Unexpected internal server error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/clients/python/src/mr_openapi/docs/ModelVersion.md b/clients/python/src/mr_openapi/docs/ModelVersion.md deleted file mode 100644 index 71995e114..000000000 --- a/clients/python/src/mr_openapi/docs/ModelVersion.md +++ /dev/null @@ -1,39 +0,0 @@ -# ModelVersion - -Represents a ModelVersion belonging to a RegisteredModel. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**name** | **str** | 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. | [optional] -**state** | [**ModelVersionState**](ModelVersionState.md) | | [optional] -**author** | **str** | Name of the author. | [optional] -**registered_model_id** | **str** | ID of the `RegisteredModel` to which this version belongs. | -**id** | **str** | Output only. The unique server generated id of the resource. | [optional] [readonly] -**create_time_since_epoch** | **str** | Output only. Create time of the resource in millisecond since epoch. | [optional] [readonly] -**last_update_time_since_epoch** | **str** | Output only. Last update time of the resource since epoch in millisecond since epoch. | [optional] [readonly] - -## Example - -```python -from mr_openapi.models.model_version import ModelVersion - -# TODO update the JSON string below -json = "{}" -# create an instance of ModelVersion from a JSON string -model_version_instance = ModelVersion.from_json(json) -# print the JSON string representation of the object -print(ModelVersion.to_json()) - -# convert the object into a dict -model_version_dict = model_version_instance.to_dict() -# create an instance of ModelVersion from a dict -model_version_from_dict = ModelVersion.from_dict(model_version_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ModelVersionCreate.md b/clients/python/src/mr_openapi/docs/ModelVersionCreate.md deleted file mode 100644 index 18e6adc52..000000000 --- a/clients/python/src/mr_openapi/docs/ModelVersionCreate.md +++ /dev/null @@ -1,36 +0,0 @@ -# ModelVersionCreate - -Represents a ModelVersion belonging to a RegisteredModel. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**name** | **str** | 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. | [optional] -**state** | [**ModelVersionState**](ModelVersionState.md) | | [optional] -**author** | **str** | Name of the author. | [optional] -**registered_model_id** | **str** | ID of the `RegisteredModel` to which this version belongs. | - -## Example - -```python -from mr_openapi.models.model_version_create import ModelVersionCreate - -# TODO update the JSON string below -json = "{}" -# create an instance of ModelVersionCreate from a JSON string -model_version_create_instance = ModelVersionCreate.from_json(json) -# print the JSON string representation of the object -print(ModelVersionCreate.to_json()) - -# convert the object into a dict -model_version_create_dict = model_version_create_instance.to_dict() -# create an instance of ModelVersionCreate from a dict -model_version_create_from_dict = ModelVersionCreate.from_dict(model_version_create_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ModelVersionList.md b/clients/python/src/mr_openapi/docs/ModelVersionList.md deleted file mode 100644 index 4b09362d4..000000000 --- a/clients/python/src/mr_openapi/docs/ModelVersionList.md +++ /dev/null @@ -1,33 +0,0 @@ -# ModelVersionList - -List of ModelVersion entities. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page_token** | **str** | Token to use to retrieve next page of results. | -**page_size** | **int** | Maximum number of resources to return in the result. | -**size** | **int** | Number of items in result list. | -**items** | [**List[ModelVersion]**](ModelVersion.md) | Array of `ModelVersion` entities. | [optional] - -## Example - -```python -from mr_openapi.models.model_version_list import ModelVersionList - -# TODO update the JSON string below -json = "{}" -# create an instance of ModelVersionList from a JSON string -model_version_list_instance = ModelVersionList.from_json(json) -# print the JSON string representation of the object -print(ModelVersionList.to_json()) - -# convert the object into a dict -model_version_list_dict = model_version_list_instance.to_dict() -# create an instance of ModelVersionList from a dict -model_version_list_from_dict = ModelVersionList.from_dict(model_version_list_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ModelVersionState.md b/clients/python/src/mr_openapi/docs/ModelVersionState.md deleted file mode 100644 index 0686f4809..000000000 --- a/clients/python/src/mr_openapi/docs/ModelVersionState.md +++ /dev/null @@ -1,12 +0,0 @@ -# ModelVersionState - -- LIVE: A state indicating that the `ModelVersion` exists - ARCHIVED: A state indicating that the `ModelVersion` has been archived. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ModelVersionUpdate.md b/clients/python/src/mr_openapi/docs/ModelVersionUpdate.md deleted file mode 100644 index 6b52b668d..000000000 --- a/clients/python/src/mr_openapi/docs/ModelVersionUpdate.md +++ /dev/null @@ -1,34 +0,0 @@ -# ModelVersionUpdate - -Represents a ModelVersion belonging to a RegisteredModel. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**state** | [**ModelVersionState**](ModelVersionState.md) | | [optional] -**author** | **str** | Name of the author. | [optional] - -## Example - -```python -from mr_openapi.models.model_version_update import ModelVersionUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of ModelVersionUpdate from a JSON string -model_version_update_instance = ModelVersionUpdate.from_json(json) -# print the JSON string representation of the object -print(ModelVersionUpdate.to_json()) - -# convert the object into a dict -model_version_update_dict = model_version_update_instance.to_dict() -# create an instance of ModelVersionUpdate from a dict -model_version_update_from_dict = ModelVersionUpdate.from_dict(model_version_update_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/OrderByField.md b/clients/python/src/mr_openapi/docs/OrderByField.md deleted file mode 100644 index 00620847f..000000000 --- a/clients/python/src/mr_openapi/docs/OrderByField.md +++ /dev/null @@ -1,12 +0,0 @@ -# OrderByField - -Supported fields for ordering result entities. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/RegisteredModel.md b/clients/python/src/mr_openapi/docs/RegisteredModel.md deleted file mode 100644 index d66b1fbd0..000000000 --- a/clients/python/src/mr_openapi/docs/RegisteredModel.md +++ /dev/null @@ -1,38 +0,0 @@ -# RegisteredModel - -A registered model in model registry. A registered model has ModelVersion children. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**name** | **str** | 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. | [optional] -**id** | **str** | Output only. The unique server generated id of the resource. | [optional] [readonly] -**create_time_since_epoch** | **str** | Output only. Create time of the resource in millisecond since epoch. | [optional] [readonly] -**last_update_time_since_epoch** | **str** | Output only. Last update time of the resource since epoch in millisecond since epoch. | [optional] [readonly] -**owner** | **str** | | [optional] -**state** | [**RegisteredModelState**](RegisteredModelState.md) | | [optional] - -## Example - -```python -from mr_openapi.models.registered_model import RegisteredModel - -# TODO update the JSON string below -json = "{}" -# create an instance of RegisteredModel from a JSON string -registered_model_instance = RegisteredModel.from_json(json) -# print the JSON string representation of the object -print(RegisteredModel.to_json()) - -# convert the object into a dict -registered_model_dict = registered_model_instance.to_dict() -# create an instance of RegisteredModel from a dict -registered_model_from_dict = RegisteredModel.from_dict(registered_model_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/RegisteredModelCreate.md b/clients/python/src/mr_openapi/docs/RegisteredModelCreate.md deleted file mode 100644 index 0002e3207..000000000 --- a/clients/python/src/mr_openapi/docs/RegisteredModelCreate.md +++ /dev/null @@ -1,35 +0,0 @@ -# RegisteredModelCreate - -A registered model in model registry. A registered model has ModelVersion children. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**name** | **str** | 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. | [optional] -**owner** | **str** | | [optional] -**state** | [**RegisteredModelState**](RegisteredModelState.md) | | [optional] - -## Example - -```python -from mr_openapi.models.registered_model_create import RegisteredModelCreate - -# TODO update the JSON string below -json = "{}" -# create an instance of RegisteredModelCreate from a JSON string -registered_model_create_instance = RegisteredModelCreate.from_json(json) -# print the JSON string representation of the object -print(RegisteredModelCreate.to_json()) - -# convert the object into a dict -registered_model_create_dict = registered_model_create_instance.to_dict() -# create an instance of RegisteredModelCreate from a dict -registered_model_create_from_dict = RegisteredModelCreate.from_dict(registered_model_create_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/RegisteredModelList.md b/clients/python/src/mr_openapi/docs/RegisteredModelList.md deleted file mode 100644 index d29840b12..000000000 --- a/clients/python/src/mr_openapi/docs/RegisteredModelList.md +++ /dev/null @@ -1,33 +0,0 @@ -# RegisteredModelList - -List of RegisteredModels. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page_token** | **str** | Token to use to retrieve next page of results. | -**page_size** | **int** | Maximum number of resources to return in the result. | -**size** | **int** | Number of items in result list. | -**items** | [**List[RegisteredModel]**](RegisteredModel.md) | | [optional] - -## Example - -```python -from mr_openapi.models.registered_model_list import RegisteredModelList - -# TODO update the JSON string below -json = "{}" -# create an instance of RegisteredModelList from a JSON string -registered_model_list_instance = RegisteredModelList.from_json(json) -# print the JSON string representation of the object -print(RegisteredModelList.to_json()) - -# convert the object into a dict -registered_model_list_dict = registered_model_list_instance.to_dict() -# create an instance of RegisteredModelList from a dict -registered_model_list_from_dict = RegisteredModelList.from_dict(registered_model_list_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/RegisteredModelState.md b/clients/python/src/mr_openapi/docs/RegisteredModelState.md deleted file mode 100644 index 77ed5c6ca..000000000 --- a/clients/python/src/mr_openapi/docs/RegisteredModelState.md +++ /dev/null @@ -1,12 +0,0 @@ -# RegisteredModelState - -- LIVE: A state indicating that the `RegisteredModel` exists - ARCHIVED: A state indicating that the `RegisteredModel` has been archived. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/RegisteredModelUpdate.md b/clients/python/src/mr_openapi/docs/RegisteredModelUpdate.md deleted file mode 100644 index b6987971b..000000000 --- a/clients/python/src/mr_openapi/docs/RegisteredModelUpdate.md +++ /dev/null @@ -1,34 +0,0 @@ -# RegisteredModelUpdate - -A registered model in model registry. A registered model has ModelVersion children. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**owner** | **str** | | [optional] -**state** | [**RegisteredModelState**](RegisteredModelState.md) | | [optional] - -## Example - -```python -from mr_openapi.models.registered_model_update import RegisteredModelUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of RegisteredModelUpdate from a JSON string -registered_model_update_instance = RegisteredModelUpdate.from_json(json) -# print the JSON string representation of the object -print(RegisteredModelUpdate.to_json()) - -# convert the object into a dict -registered_model_update_dict = registered_model_update_instance.to_dict() -# create an instance of RegisteredModelUpdate from a dict -registered_model_update_from_dict = RegisteredModelUpdate.from_dict(registered_model_update_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ServeModel.md b/clients/python/src/mr_openapi/docs/ServeModel.md deleted file mode 100644 index a8268842c..000000000 --- a/clients/python/src/mr_openapi/docs/ServeModel.md +++ /dev/null @@ -1,38 +0,0 @@ -# ServeModel - -An ML model serving action. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**last_known_state** | [**ExecutionState**](ExecutionState.md) | | [optional] -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**name** | **str** | 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. | [optional] -**id** | **str** | Output only. The unique server generated id of the resource. | [optional] [readonly] -**create_time_since_epoch** | **str** | Output only. Create time of the resource in millisecond since epoch. | [optional] [readonly] -**last_update_time_since_epoch** | **str** | Output only. Last update time of the resource since epoch in millisecond since epoch. | [optional] [readonly] -**model_version_id** | **str** | ID of the `ModelVersion` that was served in `InferenceService`. | - -## Example - -```python -from mr_openapi.models.serve_model import ServeModel - -# TODO update the JSON string below -json = "{}" -# create an instance of ServeModel from a JSON string -serve_model_instance = ServeModel.from_json(json) -# print the JSON string representation of the object -print(ServeModel.to_json()) - -# convert the object into a dict -serve_model_dict = serve_model_instance.to_dict() -# create an instance of ServeModel from a dict -serve_model_from_dict = ServeModel.from_dict(serve_model_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ServeModelCreate.md b/clients/python/src/mr_openapi/docs/ServeModelCreate.md deleted file mode 100644 index bca344286..000000000 --- a/clients/python/src/mr_openapi/docs/ServeModelCreate.md +++ /dev/null @@ -1,35 +0,0 @@ -# ServeModelCreate - -An ML model serving action. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**last_known_state** | [**ExecutionState**](ExecutionState.md) | | [optional] -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**name** | **str** | 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. | [optional] -**model_version_id** | **str** | ID of the `ModelVersion` that was served in `InferenceService`. | - -## Example - -```python -from mr_openapi.models.serve_model_create import ServeModelCreate - -# TODO update the JSON string below -json = "{}" -# create an instance of ServeModelCreate from a JSON string -serve_model_create_instance = ServeModelCreate.from_json(json) -# print the JSON string representation of the object -print(ServeModelCreate.to_json()) - -# convert the object into a dict -serve_model_create_dict = serve_model_create_instance.to_dict() -# create an instance of ServeModelCreate from a dict -serve_model_create_from_dict = ServeModelCreate.from_dict(serve_model_create_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ServeModelList.md b/clients/python/src/mr_openapi/docs/ServeModelList.md deleted file mode 100644 index 8cc651063..000000000 --- a/clients/python/src/mr_openapi/docs/ServeModelList.md +++ /dev/null @@ -1,33 +0,0 @@ -# ServeModelList - -List of ServeModel entities. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page_token** | **str** | Token to use to retrieve next page of results. | -**page_size** | **int** | Maximum number of resources to return in the result. | -**size** | **int** | Number of items in result list. | -**items** | [**List[ServeModel]**](ServeModel.md) | Array of `ModelArtifact` entities. | [optional] - -## Example - -```python -from mr_openapi.models.serve_model_list import ServeModelList - -# TODO update the JSON string below -json = "{}" -# create an instance of ServeModelList from a JSON string -serve_model_list_instance = ServeModelList.from_json(json) -# print the JSON string representation of the object -print(ServeModelList.to_json()) - -# convert the object into a dict -serve_model_list_dict = serve_model_list_instance.to_dict() -# create an instance of ServeModelList from a dict -serve_model_list_from_dict = ServeModelList.from_dict(serve_model_list_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ServeModelUpdate.md b/clients/python/src/mr_openapi/docs/ServeModelUpdate.md deleted file mode 100644 index 6a80a919f..000000000 --- a/clients/python/src/mr_openapi/docs/ServeModelUpdate.md +++ /dev/null @@ -1,33 +0,0 @@ -# ServeModelUpdate - -An ML model serving action. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**last_known_state** | [**ExecutionState**](ExecutionState.md) | | [optional] -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] - -## Example - -```python -from mr_openapi.models.serve_model_update import ServeModelUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of ServeModelUpdate from a JSON string -serve_model_update_instance = ServeModelUpdate.from_json(json) -# print the JSON string representation of the object -print(ServeModelUpdate.to_json()) - -# convert the object into a dict -serve_model_update_dict = serve_model_update_instance.to_dict() -# create an instance of ServeModelUpdate from a dict -serve_model_update_from_dict = ServeModelUpdate.from_dict(serve_model_update_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ServingEnvironment.md b/clients/python/src/mr_openapi/docs/ServingEnvironment.md deleted file mode 100644 index f7ea335ed..000000000 --- a/clients/python/src/mr_openapi/docs/ServingEnvironment.md +++ /dev/null @@ -1,36 +0,0 @@ -# ServingEnvironment - -A Model Serving environment for serving `RegisteredModels`. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**name** | **str** | 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. | [optional] -**id** | **str** | Output only. The unique server generated id of the resource. | [optional] [readonly] -**create_time_since_epoch** | **str** | Output only. Create time of the resource in millisecond since epoch. | [optional] [readonly] -**last_update_time_since_epoch** | **str** | Output only. Last update time of the resource since epoch in millisecond since epoch. | [optional] [readonly] - -## Example - -```python -from mr_openapi.models.serving_environment import ServingEnvironment - -# TODO update the JSON string below -json = "{}" -# create an instance of ServingEnvironment from a JSON string -serving_environment_instance = ServingEnvironment.from_json(json) -# print the JSON string representation of the object -print(ServingEnvironment.to_json()) - -# convert the object into a dict -serving_environment_dict = serving_environment_instance.to_dict() -# create an instance of ServingEnvironment from a dict -serving_environment_from_dict = ServingEnvironment.from_dict(serving_environment_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ServingEnvironmentCreate.md b/clients/python/src/mr_openapi/docs/ServingEnvironmentCreate.md deleted file mode 100644 index afaaf1342..000000000 --- a/clients/python/src/mr_openapi/docs/ServingEnvironmentCreate.md +++ /dev/null @@ -1,33 +0,0 @@ -# ServingEnvironmentCreate - -A Model Serving environment for serving `RegisteredModels`. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] -**name** | **str** | 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. | [optional] - -## Example - -```python -from mr_openapi.models.serving_environment_create import ServingEnvironmentCreate - -# TODO update the JSON string below -json = "{}" -# create an instance of ServingEnvironmentCreate from a JSON string -serving_environment_create_instance = ServingEnvironmentCreate.from_json(json) -# print the JSON string representation of the object -print(ServingEnvironmentCreate.to_json()) - -# convert the object into a dict -serving_environment_create_dict = serving_environment_create_instance.to_dict() -# create an instance of ServingEnvironmentCreate from a dict -serving_environment_create_from_dict = ServingEnvironmentCreate.from_dict(serving_environment_create_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ServingEnvironmentList.md b/clients/python/src/mr_openapi/docs/ServingEnvironmentList.md deleted file mode 100644 index 43e6e1363..000000000 --- a/clients/python/src/mr_openapi/docs/ServingEnvironmentList.md +++ /dev/null @@ -1,33 +0,0 @@ -# ServingEnvironmentList - -List of ServingEnvironments. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page_token** | **str** | Token to use to retrieve next page of results. | -**page_size** | **int** | Maximum number of resources to return in the result. | -**size** | **int** | Number of items in result list. | -**items** | [**List[ServingEnvironment]**](ServingEnvironment.md) | | [optional] - -## Example - -```python -from mr_openapi.models.serving_environment_list import ServingEnvironmentList - -# TODO update the JSON string below -json = "{}" -# create an instance of ServingEnvironmentList from a JSON string -serving_environment_list_instance = ServingEnvironmentList.from_json(json) -# print the JSON string representation of the object -print(ServingEnvironmentList.to_json()) - -# convert the object into a dict -serving_environment_list_dict = serving_environment_list_instance.to_dict() -# create an instance of ServingEnvironmentList from a dict -serving_environment_list_from_dict = ServingEnvironmentList.from_dict(serving_environment_list_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/ServingEnvironmentUpdate.md b/clients/python/src/mr_openapi/docs/ServingEnvironmentUpdate.md deleted file mode 100644 index 1dac7bd18..000000000 --- a/clients/python/src/mr_openapi/docs/ServingEnvironmentUpdate.md +++ /dev/null @@ -1,32 +0,0 @@ -# ServingEnvironmentUpdate - -A Model Serving environment for serving `RegisteredModels`. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_properties** | [**Dict[str, MetadataValue]**](MetadataValue.md) | User provided custom properties which are not defined by its type. | [optional] -**description** | **str** | An optional description about the resource. | [optional] -**external_id** | **str** | 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. | [optional] - -## Example - -```python -from mr_openapi.models.serving_environment_update import ServingEnvironmentUpdate - -# TODO update the JSON string below -json = "{}" -# create an instance of ServingEnvironmentUpdate from a JSON string -serving_environment_update_instance = ServingEnvironmentUpdate.from_json(json) -# print the JSON string representation of the object -print(ServingEnvironmentUpdate.to_json()) - -# convert the object into a dict -serving_environment_update_dict = serving_environment_update_instance.to_dict() -# create an instance of ServingEnvironmentUpdate from a dict -serving_environment_update_from_dict = ServingEnvironmentUpdate.from_dict(serving_environment_update_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/clients/python/src/mr_openapi/docs/SortOrder.md b/clients/python/src/mr_openapi/docs/SortOrder.md deleted file mode 100644 index 2793df4cb..000000000 --- a/clients/python/src/mr_openapi/docs/SortOrder.md +++ /dev/null @@ -1,12 +0,0 @@ -# SortOrder - -Supported sort direction for ordering result entities. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - -