nemo_microservices.resources.namespaces#

Module Contents#

Classes#

API#

class nemo_microservices.resources.namespaces.AsyncNamespacesResource(
client: nemo_microservices._client.AsyncNeMoMicroservices,
)#

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

async create(
*,
id: str | nemo_microservices._types.Omit = omit,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | 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.namespace.Namespace#

Create a new namespace.

Namespaces are generic containers for grouping related resources (e.g., models, datasets, customizations, evaluations).

Args: id: The ID of the entity. With the exception of namespaces, this is always a semantically-prefixed base58-encoded uuid4 [-base58(uuid4())].

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

description: The description of the entity.

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 URN of the 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(
namespace_id: 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 Namespace

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.namespace_filter_param.NamespaceFilterParam | nemo_microservices._types.Omit = omit,
page: int | nemo_microservices._types.Omit = omit,
page_size: int | nemo_microservices._types.Omit = omit,
search: nemo_microservices.types.namespace_search_param.NamespaceSearchParam | 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.namespace.Namespace, nemo_microservices.pagination.AsyncDefaultPagination[nemo_microservices.types.namespace.Namespace]]#

Return the list of namespaces.

Args: filter: Filter namespaces on various criteria.

page: Page number.

page_size: Page size.

search: Search namespaces using substring matching. You can combine multiple search fields and filters.

  For example:

  - `?search[id]=research`: searches all namespaces with 'research' in the id.
  - `?search[name]=vision`: searches all namespaces with 'vision' in the name.
  - `?search[id]=research&search[name]=vision`: searches all namespaces with
    'research' in the id AND 'vision' in the name.
  - `?search[id]=research&search[id]=production`: searches all namespaces with
    'research' OR 'production' in the id.
  - `?search[updated_at][start]=2024-01-01T00:00:00` finds all namespaces updated
    on or after the start date
  - `?search[created_at][start]=2022-01-01&search[updated_at][end]=2024-01-01`
    finds all namespaces created from start date up to and including end date

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(
namespace_id: 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.namespace.Namespace#

Retrieve a namespace.

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(
namespace_id: str,
*,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | nemo_microservices._types.Omit = omit,
namespace: str | 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.namespace.Namespace#

Update a namespace.

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

description: The description of the entity.

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

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 URN of the 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.namespaces.AsyncNamespacesResourceWithRawResponse#

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.namespaces.AsyncNamespacesResourceWithStreamingResponse#

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.namespaces.AsyncNamespacesResourceWithRawResponse(
namespaces: nemo_microservices.resources.namespaces.AsyncNamespacesResource,
)#

Initialization

class nemo_microservices.resources.namespaces.AsyncNamespacesResourceWithStreamingResponse(
namespaces: nemo_microservices.resources.namespaces.AsyncNamespacesResource,
)#

Initialization

class nemo_microservices.resources.namespaces.NamespacesResource(
client: nemo_microservices._client.NeMoMicroservices,
)#

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

create(
*,
id: str | nemo_microservices._types.Omit = omit,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | 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.namespace.Namespace#

Create a new namespace.

Namespaces are generic containers for grouping related resources (e.g., models, datasets, customizations, evaluations).

Args: id: The ID of the entity. With the exception of namespaces, this is always a semantically-prefixed base58-encoded uuid4 [-base58(uuid4())].

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

description: The description of the entity.

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 URN of the 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(
namespace_id: 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 Namespace

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.namespace_filter_param.NamespaceFilterParam | nemo_microservices._types.Omit = omit,
page: int | nemo_microservices._types.Omit = omit,
page_size: int | nemo_microservices._types.Omit = omit,
search: nemo_microservices.types.namespace_search_param.NamespaceSearchParam | 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.namespace.Namespace]#

Return the list of namespaces.

Args: filter: Filter namespaces on various criteria.

page: Page number.

page_size: Page size.

search: Search namespaces using substring matching. You can combine multiple search fields and filters.

  For example:

  - `?search[id]=research`: searches all namespaces with 'research' in the id.
  - `?search[name]=vision`: searches all namespaces with 'vision' in the name.
  - `?search[id]=research&search[name]=vision`: searches all namespaces with
    'research' in the id AND 'vision' in the name.
  - `?search[id]=research&search[id]=production`: searches all namespaces with
    'research' OR 'production' in the id.
  - `?search[updated_at][start]=2024-01-01T00:00:00` finds all namespaces updated
    on or after the start date
  - `?search[created_at][start]=2022-01-01&search[updated_at][end]=2024-01-01`
    finds all namespaces created from start date up to and including end date

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(
namespace_id: 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.namespace.Namespace#

Retrieve a namespace.

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(
namespace_id: str,
*,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | nemo_microservices._types.Omit = omit,
namespace: str | 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.namespace.Namespace#

Update a namespace.

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

description: The description of the entity.

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

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 URN of the 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.namespaces.NamespacesResourceWithRawResponse#

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.namespaces.NamespacesResourceWithStreamingResponse#

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.namespaces.NamespacesResourceWithRawResponse(
namespaces: nemo_microservices.resources.namespaces.NamespacesResource,
)#

Initialization

class nemo_microservices.resources.namespaces.NamespacesResourceWithStreamingResponse(
namespaces: nemo_microservices.resources.namespaces.NamespacesResource,
)#

Initialization