`nemo_microservices.resources.deployment.configs`#

Module Contents#

Classes#

`AsyncConfigsResource`
`AsyncConfigsResourceWithRawResponse`
`AsyncConfigsResourceWithStreamingResponse`
`ConfigsResource`
`ConfigsResourceWithRawResponse`
`ConfigsResourceWithStreamingResponse`

API#

class nemo_microservices.resources.deployment.configs.AsyncConfigsResource( client: nemo_microservices._client.AsyncNeMoMicroservices, )#

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

async create( *, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, external_endpoint: nemo_microservices.types.external_endpoint_config_param.ExternalEndpointConfigParam | nemo_microservices._types.Omit = omit, model: nemo_microservices.types.deployment.config_create_params.Model | nemo_microservices._types.Omit = omit, name: str | nemo_microservices._types.Omit = omit, namespace: str | nemo_microservices._types.Omit = omit, nim_deployment: nemo_microservices.types.nim_deployment_config_param.NIMDeploymentConfigParam | nemo_microservices._types.Omit = omit, ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit, project: str | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.deployment_config.DeploymentConfig#

Create a new deployment config.

Args: custom_fields: A set of custom fields that the user can define and use for various purposes.

description: The description of the entity.

external_endpoint: Configuration for an external endpoint.

model: The model to be deployed.

name: The name of the identity. Must be unique inside the namespace. If not specified, it will be the same as the automatically generated id.

namespace: The if of the namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.

nim_deployment: Configuration for a NIM deployment.

ownership: Information about ownership of an entity.

  If the entity is a namespace, the `access_policies` will typically apply to all
  entities inside the namespace.

project: The id of project associated with this entity.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async delete( config_name: str, *, namespace: str, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.shared.delete_response.DeleteResponse#

Delete Config

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

list( *, filter: nemo_microservices.types.deployment.deployment_config_filter_param.DeploymentConfigFilterParam | nemo_microservices._types.Omit = omit, page: int | nemo_microservices._types.Omit = omit, page_size: int | nemo_microservices._types.Omit = omit, sort: nemo_microservices.types.shared.generic_sort_field.GenericSortField | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices._base_client.AsyncPaginator[nemo_microservices.types.deployment_config.DeploymentConfig, nemo_microservices.pagination.AsyncDefaultPagination[nemo_microservices.types.deployment_config.DeploymentConfig]]#

List available deployment configs.

Args: filter: Filter configs on various criteria.

page: Page number.

page_size: Page size.

sort: The field to sort by. To sort in decreasing order, use - in front of the field name.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async retrieve( config_name: str, *, namespace: str, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.deployment_config.DeploymentConfig#

Get info about a deployment configuration.

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async update( config_name: str, *, namespace: str, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, external_endpoint: nemo_microservices.types.external_endpoint_config_param.ExternalEndpointConfigParam | nemo_microservices._types.Omit = omit, model: nemo_microservices.types.deployment.config_update_params.Model | nemo_microservices._types.Omit = omit, nim_deployment: nemo_microservices.types.nim_deployment_config_param.NIMDeploymentConfigParam | nemo_microservices._types.Omit = omit, ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit, project: str | nemo_microservices._types.Omit = omit, schema_version: str | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.deployment_config.DeploymentConfig#

Update model metadata.

If the request body has an empty field, keep the old value.

Args: custom_fields: A set of custom fields that the user can define and use for various purposes.

description: The description of the entity.

external_endpoint: Configuration for an external endpoint.

model: The model to be deployed.

nim_deployment: Configuration for a NIM deployment.

ownership: Information about ownership of an entity.

  If the entity is a namespace, the `access_policies` will typically apply to all
  entities inside the namespace.

project: The id of project associated with this entity.

schema_version: The version of the schema for the object. Internal use only.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property with_raw_response: nemo_microservices.resources.deployment.configs.AsyncConfigsResourceWithRawResponse#

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#accessing-raw-response-data-e-g-headers

property with_streaming_response: nemo_microservices.resources.deployment.configs.AsyncConfigsResourceWithStreamingResponse#

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#with_streaming_response

class nemo_microservices.resources.deployment.configs.AsyncConfigsResourceWithRawResponse( configs: nemo_microservices.resources.deployment.configs.AsyncConfigsResource, )#: Initialization

class nemo_microservices.resources.deployment.configs.AsyncConfigsResourceWithStreamingResponse( configs: nemo_microservices.resources.deployment.configs.AsyncConfigsResource, )#: Initialization

class nemo_microservices.resources.deployment.configs.ConfigsResource(client: nemo_microservices._client.NeMoMicroservices)#

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

create( *, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, external_endpoint: nemo_microservices.types.external_endpoint_config_param.ExternalEndpointConfigParam | nemo_microservices._types.Omit = omit, model: nemo_microservices.types.deployment.config_create_params.Model | nemo_microservices._types.Omit = omit, name: str | nemo_microservices._types.Omit = omit, namespace: str | nemo_microservices._types.Omit = omit, nim_deployment: nemo_microservices.types.nim_deployment_config_param.NIMDeploymentConfigParam | nemo_microservices._types.Omit = omit, ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit, project: str | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.deployment_config.DeploymentConfig#

Create a new deployment config.

Args: custom_fields: A set of custom fields that the user can define and use for various purposes.

description: The description of the entity.

external_endpoint: Configuration for an external endpoint.

model: The model to be deployed.

name: The name of the identity. Must be unique inside the namespace. If not specified, it will be the same as the automatically generated id.

namespace: The if of the namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.

nim_deployment: Configuration for a NIM deployment.

ownership: Information about ownership of an entity.

  If the entity is a namespace, the `access_policies` will typically apply to all
  entities inside the namespace.

project: The id of project associated with this entity.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

delete( config_name: str, *, namespace: str, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.shared.delete_response.DeleteResponse#

Delete Config

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

list( *, filter: nemo_microservices.types.deployment.deployment_config_filter_param.DeploymentConfigFilterParam | nemo_microservices._types.Omit = omit, page: int | nemo_microservices._types.Omit = omit, page_size: int | nemo_microservices._types.Omit = omit, sort: nemo_microservices.types.shared.generic_sort_field.GenericSortField | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.pagination.SyncDefaultPagination[nemo_microservices.types.deployment_config.DeploymentConfig]#

List available deployment configs.

Args: filter: Filter configs on various criteria.

page: Page number.

page_size: Page size.

sort: The field to sort by. To sort in decreasing order, use - in front of the field name.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

retrieve( config_name: str, *, namespace: str, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.deployment_config.DeploymentConfig#

Get info about a deployment configuration.

Args: extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

update( config_name: str, *, namespace: str, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, external_endpoint: nemo_microservices.types.external_endpoint_config_param.ExternalEndpointConfigParam | nemo_microservices._types.Omit = omit, model: nemo_microservices.types.deployment.config_update_params.Model | nemo_microservices._types.Omit = omit, nim_deployment: nemo_microservices.types.nim_deployment_config_param.NIMDeploymentConfigParam | nemo_microservices._types.Omit = omit, ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit, project: str | nemo_microservices._types.Omit = omit, schema_version: str | nemo_microservices._types.Omit = omit, extra_headers: nemo_microservices._types.Headers | None = None, extra_query: nemo_microservices._types.Query | None = None, extra_body: nemo_microservices._types.Body | None = None, timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given, ) → nemo_microservices.types.deployment_config.DeploymentConfig#

Update model metadata.

If the request body has an empty field, keep the old value.

Args: custom_fields: A set of custom fields that the user can define and use for various purposes.

description: The description of the entity.

external_endpoint: Configuration for an external endpoint.

model: The model to be deployed.

nim_deployment: Configuration for a NIM deployment.

ownership: Information about ownership of an entity.

  If the entity is a namespace, the `access_policies` will typically apply to all
  entities inside the namespace.

project: The id of project associated with this entity.

schema_version: The version of the schema for the object. Internal use only.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property with_raw_response: nemo_microservices.resources.deployment.configs.ConfigsResourceWithRawResponse#

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#accessing-raw-response-data-e-g-headers

property with_streaming_response: nemo_microservices.resources.deployment.configs.ConfigsResourceWithStreamingResponse#

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#with_streaming_response

class nemo_microservices.resources.deployment.configs.ConfigsResourceWithRawResponse( configs: nemo_microservices.resources.deployment.configs.ConfigsResource, )#: Initialization

class nemo_microservices.resources.deployment.configs.ConfigsResourceWithStreamingResponse( configs: nemo_microservices.resources.deployment.configs.ConfigsResource, )#: Initialization

nemo_microservices.resources.deployment.configs#

Module Contents#

Classes#

API#

`nemo_microservices.resources.deployment.configs`#