Entity Namespaces Resource#
- class nemo_microservices.resources.NamespacesResource(client: NeMoMicroservices)#
Bases:
SyncAPIResource
- property with_raw_response: 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: 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
- create(
- *,
- id: str | NotGiven = NOT_GIVEN,
- custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN,
- description: str | NotGiven = NOT_GIVEN,
- ownership: Ownership | NotGiven = NOT_GIVEN,
- project: str | NotGiven = NOT_GIVEN,
- extra_headers: Headers | None = None,
- extra_query: Query | None = None,
- extra_body: Body | None = None,
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
Create a new namespace.
Namespaces are generic containers for grouping related resources (e.g., models, datasets, customizations, evaluations).
- Parameters:
id – The ID of the entity. With the exception of namespaces, this is always a semantically-prefixed base58-encoded uuid4 [<prefix>-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
- retrieve(
- namespace_id: str,
- *,
- extra_headers: Headers | None = None,
- extra_query: Query | None = None,
- extra_body: Body | None = None,
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
Retrieve a namespace.
- Parameters:
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, str] | NotGiven = NOT_GIVEN,
- description: str | NotGiven = NOT_GIVEN,
- namespace: str | NotGiven = NOT_GIVEN,
- ownership: Ownership | NotGiven = NOT_GIVEN,
- project: str | NotGiven = NOT_GIVEN,
- schema_version: str | NotGiven = NOT_GIVEN,
- extra_headers: Headers | None = None,
- extra_query: Query | None = None,
- extra_body: Body | None = None,
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
Update a namespace.
- Parameters:
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
- list(
- *,
- page: int | NotGiven = NOT_GIVEN,
- page_size: int | NotGiven = NOT_GIVEN,
- sort: GenericSortField | NotGiven = NOT_GIVEN,
- extra_headers: Headers | None = None,
- extra_query: Query | None = None,
- extra_body: Body | None = None,
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
Return the list of namespaces.
- Parameters:
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
- delete(
- namespace_id: str,
- *,
- extra_headers: Headers | None = None,
- extra_query: Query | None = None,
- extra_body: Body | None = None,
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
Delete Namespace
- Parameters:
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
- create_from_dict(data: dict[str, object]) object #
- class nemo_microservices.resources.AsyncNamespacesResource(client: AsyncNeMoMicroservices)#
Bases:
AsyncAPIResource
- property with_raw_response: 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: 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
- async create(
- *,
- id: str | NotGiven = NOT_GIVEN,
- custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN,
- description: str | NotGiven = NOT_GIVEN,
- ownership: Ownership | NotGiven = NOT_GIVEN,
- project: str | NotGiven = NOT_GIVEN,
- extra_headers: Headers | None = None,
- extra_query: Query | None = None,
- extra_body: Body | None = None,
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
Create a new namespace.
Namespaces are generic containers for grouping related resources (e.g., models, datasets, customizations, evaluations).
- Parameters:
id – The ID of the entity. With the exception of namespaces, this is always a semantically-prefixed base58-encoded uuid4 [<prefix>-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 retrieve(
- namespace_id: str,
- *,
- extra_headers: Headers | None = None,
- extra_query: Query | None = None,
- extra_body: Body | None = None,
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
Retrieve a namespace.
- Parameters:
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, str] | NotGiven = NOT_GIVEN,
- description: str | NotGiven = NOT_GIVEN,
- namespace: str | NotGiven = NOT_GIVEN,
- ownership: Ownership | NotGiven = NOT_GIVEN,
- project: str | NotGiven = NOT_GIVEN,
- schema_version: str | NotGiven = NOT_GIVEN,
- extra_headers: Headers | None = None,
- extra_query: Query | None = None,
- extra_body: Body | None = None,
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
Update a namespace.
- Parameters:
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
- list(
- *,
- page: int | NotGiven = NOT_GIVEN,
- page_size: int | NotGiven = NOT_GIVEN,
- sort: GenericSortField | NotGiven = NOT_GIVEN,
- extra_headers: Headers | None = None,
- extra_query: Query | None = None,
- extra_body: Body | None = None,
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
Return the list of namespaces.
- Parameters:
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 delete(
- namespace_id: str,
- *,
- extra_headers: Headers | None = None,
- extra_query: Query | None = None,
- extra_body: Body | None = None,
- timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
Delete Namespace
- Parameters:
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
- create_from_dict(
- data: dict[str, object],