`nemo_microservices.resources.intake.apps.tasks`#

Module Contents#

Classes#

`AsyncTasksResource`
`AsyncTasksResourceWithRawResponse`
`AsyncTasksResourceWithStreamingResponse`
`TasksResource`
`TasksResourceWithRawResponse`
`TasksResourceWithStreamingResponse`

API#

class nemo_microservices.resources.intake.apps.tasks.AsyncTasksResource( client: nemo_microservices._client.AsyncNeMoMicroservices, )#

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

async create( app_name: str, *, namespace: str, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, locked: bool | nemo_microservices._types.Omit = omit, name: 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.intake.apps.task.Task#

Create a new task.

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

description: The description of the entity.

locked: If true, this record cannot be automatically updated when entries are ingested. When an entry is created, the system normally auto-updates the task’s metadata (name, description). Set locked=true to prevent these automatic updates and preserve manually curated information. The record can still be modified via explicit PATCH requests.

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

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( task_name: str, *, namespace: str, app_name: 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, ) → None#

Delete a task.

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( app_name: str, *, namespace: str, filter: nemo_microservices.types.intake.apps.task_filter_param.TaskFilterParam | nemo_microservices._types.Omit = omit, page: int | nemo_microservices._types.Omit = omit, page_size: int | nemo_microservices._types.Omit = omit, search: nemo_microservices.types.intake.apps.task_search_param.TaskSearchParam | nemo_microservices._types.Omit = omit, sort: nemo_microservices.types.intake.apps.task_sort_field.TaskSortField | 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.intake.apps.task.Task, nemo_microservices.pagination.AsyncDefaultPagination[nemo_microservices.types.intake.apps.task.Task]]#

List all tasks for a specific app.

Args: filter: Filter tasks on various criteria.

page: Page number.

page_size: Page size.

search: Search tasks using substring matching.

  For example:

  - `?search[name]=chat`: searches all tasks with 'chat' in the name.
  - `?search[description]=support`: searches all tasks with 'support' in the
    description.

sort: Sort fields for Tasks.

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( task_name: str, *, namespace: str, app_name: 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.intake.apps.task.Task#

Get a specific task.

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( task_name: str, *, namespace: str, app_name: str, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, locked: bool | 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.intake.apps.task.Task#

Update an existing task.

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

description: The description of the entity.

locked: If true, this record cannot be automatically updated when entries are ingested. When an entry is created, the system normally auto-updates the task’s metadata (name, description). Set locked=true to prevent these automatic updates and preserve manually curated information. The record can still be modified via explicit PATCH requests.

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

property with_raw_response: nemo_microservices.resources.intake.apps.tasks.AsyncTasksResourceWithRawResponse#

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.intake.apps.tasks.AsyncTasksResourceWithStreamingResponse#

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.intake.apps.tasks.AsyncTasksResourceWithRawResponse( tasks: nemo_microservices.resources.intake.apps.tasks.AsyncTasksResource, )#: Initialization

class nemo_microservices.resources.intake.apps.tasks.AsyncTasksResourceWithStreamingResponse( tasks: nemo_microservices.resources.intake.apps.tasks.AsyncTasksResource, )#: Initialization

class nemo_microservices.resources.intake.apps.tasks.TasksResource(client: nemo_microservices._client.NeMoMicroservices)#

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

create( app_name: str, *, namespace: str, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, locked: bool | nemo_microservices._types.Omit = omit, name: 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.intake.apps.task.Task#

Create a new task.

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

description: The description of the entity.

locked: If true, this record cannot be automatically updated when entries are ingested. When an entry is created, the system normally auto-updates the task’s metadata (name, description). Set locked=true to prevent these automatic updates and preserve manually curated information. The record can still be modified via explicit PATCH requests.

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

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( task_name: str, *, namespace: str, app_name: 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, ) → None#

Delete a task.

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( app_name: str, *, namespace: str, filter: nemo_microservices.types.intake.apps.task_filter_param.TaskFilterParam | nemo_microservices._types.Omit = omit, page: int | nemo_microservices._types.Omit = omit, page_size: int | nemo_microservices._types.Omit = omit, search: nemo_microservices.types.intake.apps.task_search_param.TaskSearchParam | nemo_microservices._types.Omit = omit, sort: nemo_microservices.types.intake.apps.task_sort_field.TaskSortField | 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.intake.apps.task.Task]#

List all tasks for a specific app.

Args: filter: Filter tasks on various criteria.

page: Page number.

page_size: Page size.

search: Search tasks using substring matching.

  For example:

  - `?search[name]=chat`: searches all tasks with 'chat' in the name.
  - `?search[description]=support`: searches all tasks with 'support' in the
    description.

sort: Sort fields for Tasks.

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( task_name: str, *, namespace: str, app_name: 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.intake.apps.task.Task#

Get a specific task.

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( task_name: str, *, namespace: str, app_name: str, custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, locked: bool | 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.intake.apps.task.Task#

Update an existing task.

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

description: The description of the entity.

locked: If true, this record cannot be automatically updated when entries are ingested. When an entry is created, the system normally auto-updates the task’s metadata (name, description). Set locked=true to prevent these automatic updates and preserve manually curated information. The record can still be modified via explicit PATCH requests.

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

property with_raw_response: nemo_microservices.resources.intake.apps.tasks.TasksResourceWithRawResponse#

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.intake.apps.tasks.TasksResourceWithStreamingResponse#

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.intake.apps.tasks.TasksResourceWithRawResponse( tasks: nemo_microservices.resources.intake.apps.tasks.TasksResource, )#: Initialization

class nemo_microservices.resources.intake.apps.tasks.TasksResourceWithStreamingResponse( tasks: nemo_microservices.resources.intake.apps.tasks.TasksResource, )#: Initialization

nemo_microservices.resources.intake.apps.tasks#

Module Contents#

Classes#

API#

`nemo_microservices.resources.intake.apps.tasks`#