Is this page helpful?

nemo_microservices.resources.intake.export.jobs#

Module Contents#

Classes#

AsyncJobsResource

AsyncJobsResourceWithRawResponse

AsyncJobsResourceWithStreamingResponse

JobsResource

JobsResourceWithRawResponse

JobsResourceWithStreamingResponse

API#

class nemo_microservices.resources.intake.export.jobs.AsyncJobsResource(
client: nemo_microservices._client.AsyncNeMoMicroservices,
)#

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

async create(
*,
config: nemo_microservices.types.intake.export.export_config_param.ExportConfigParam,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | nemo_microservices._types.Omit = omit,
namespace: str | nemo_microservices._types.Omit = omit,
output_file_url: 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.export.export_job.ExportJob#

Export entries to an external file.

Use the longest_per_thread filter to export only the longest entry per thread, which is useful for thread-based exports.

Supported output file URLs:

  • NeMo Datastore: nds://namespace/dataset_name

  • HuggingFace Dataset: hf://datasets/namespace/name/path/to/file

  • Local filesystem: file:///path/to/export (for development)

Args: config: Configuration for an export job.

  Defines what entries to export and how to format them.

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.

output_file_url: The place where the exported file should be written (file://, hf://, nds://, etc.)

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(
job_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.intake.export.export_job.ExportJob#

Check the status of an export job.

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

property with_raw_response: nemo_microservices.resources.intake.export.jobs.AsyncJobsResourceWithRawResponse#

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.export.jobs.AsyncJobsResourceWithStreamingResponse#

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.export.jobs.AsyncJobsResourceWithRawResponse(
jobs: nemo_microservices.resources.intake.export.jobs.AsyncJobsResource,
)#

Initialization

class nemo_microservices.resources.intake.export.jobs.AsyncJobsResourceWithStreamingResponse(
jobs: nemo_microservices.resources.intake.export.jobs.AsyncJobsResource,
)#

Initialization

class nemo_microservices.resources.intake.export.jobs.JobsResource(client: nemo_microservices._client.NeMoMicroservices)#

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

create(
*,
config: nemo_microservices.types.intake.export.export_config_param.ExportConfigParam,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | nemo_microservices._types.Omit = omit,
namespace: str | nemo_microservices._types.Omit = omit,
output_file_url: 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.export.export_job.ExportJob#

Export entries to an external file.

Use the longest_per_thread filter to export only the longest entry per thread, which is useful for thread-based exports.

Supported output file URLs:

  • NeMo Datastore: nds://namespace/dataset_name

  • HuggingFace Dataset: hf://datasets/namespace/name/path/to/file

  • Local filesystem: file:///path/to/export (for development)

Args: config: Configuration for an export job.

  Defines what entries to export and how to format them.

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.

output_file_url: The place where the exported file should be written (file://, hf://, nds://, etc.)

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(
job_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.intake.export.export_job.ExportJob#

Check the status of an export job.

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

property with_raw_response: nemo_microservices.resources.intake.export.jobs.JobsResourceWithRawResponse#

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.export.jobs.JobsResourceWithStreamingResponse#

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.export.jobs.JobsResourceWithRawResponse(
jobs: nemo_microservices.resources.intake.export.jobs.JobsResource,
)#

Initialization

class nemo_microservices.resources.intake.export.jobs.JobsResourceWithStreamingResponse(
jobs: nemo_microservices.resources.intake.export.jobs.JobsResource,
)#

Initialization