nemo_microservices.resources.data_designer.data_designer#

Module Contents#

Classes#

AsyncDataDesignerResource

AsyncDataDesignerResourceWithRawResponse

AsyncDataDesignerResourceWithStreamingResponse

DataDesignerResource

DataDesignerResourceWithRawResponse

DataDesignerResourceWithStreamingResponse

API#

class nemo_microservices.resources.data_designer.data_designer.AsyncDataDesignerResource(
client: nemo_microservices._client.AsyncNeMoMicroservices,
)#

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

property jobs: nemo_microservices.resources.data_designer.jobs.jobs.AsyncJobsResource#
async preview(
*,
config: nemo_microservices.types.data_designer.data_designer_config_param.DataDesignerConfigParam,
num_records: int | 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._decoders.jsonl.AsyncJSONLDecoder[nemo_microservices.types.data_designer.preview_message.PreviewMessage]#

Generate preview Data Designer

Args: config: Configuration for NeMo Data Designer.

  This class defines the main configuration structure for NeMo Data Designer,
  which orchestrates the generation of synthetic data.

  Attributes: columns: Required list of column configurations defining how each
  column should be generated. Must contain at least one column. model_configs:
  Optional list of model configurations for LLM-based generation. Each model
  config defines the model, provider, and inference parameters. seed_config:
  Optional seed dataset settings to use for generation. constraints: Optional list
  of column constraints. profilers: Optional list of column profilers for
  analyzing generated data characteristics.

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.data_designer.data_designer.AsyncDataDesignerResourceWithRawResponse#

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.data_designer.data_designer.AsyncDataDesignerResourceWithStreamingResponse#

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.data_designer.data_designer.AsyncDataDesignerResourceWithRawResponse(
data_designer: nemo_microservices.resources.data_designer.data_designer.AsyncDataDesignerResource,
)#

Initialization

property jobs: nemo_microservices.resources.data_designer.jobs.jobs.AsyncJobsResourceWithRawResponse#
class nemo_microservices.resources.data_designer.data_designer.AsyncDataDesignerResourceWithStreamingResponse(
data_designer: nemo_microservices.resources.data_designer.data_designer.AsyncDataDesignerResource,
)#

Initialization

property jobs: nemo_microservices.resources.data_designer.jobs.jobs.AsyncJobsResourceWithStreamingResponse#
class nemo_microservices.resources.data_designer.data_designer.DataDesignerResource(
client: nemo_microservices._client.NeMoMicroservices,
)#

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

property jobs: nemo_microservices.resources.data_designer.jobs.jobs.JobsResource#
preview(
*,
config: nemo_microservices.types.data_designer.data_designer_config_param.DataDesignerConfigParam,
num_records: int | 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._decoders.jsonl.JSONLDecoder[nemo_microservices.types.data_designer.preview_message.PreviewMessage]#

Generate preview Data Designer

Args: config: Configuration for NeMo Data Designer.

  This class defines the main configuration structure for NeMo Data Designer,
  which orchestrates the generation of synthetic data.

  Attributes: columns: Required list of column configurations defining how each
  column should be generated. Must contain at least one column. model_configs:
  Optional list of model configurations for LLM-based generation. Each model
  config defines the model, provider, and inference parameters. seed_config:
  Optional seed dataset settings to use for generation. constraints: Optional list
  of column constraints. profilers: Optional list of column profilers for
  analyzing generated data characteristics.

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.data_designer.data_designer.DataDesignerResourceWithRawResponse#

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.data_designer.data_designer.DataDesignerResourceWithStreamingResponse#

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.data_designer.data_designer.DataDesignerResourceWithRawResponse(
data_designer: nemo_microservices.resources.data_designer.data_designer.DataDesignerResource,
)#

Initialization

property jobs: nemo_microservices.resources.data_designer.jobs.jobs.JobsResourceWithRawResponse#
class nemo_microservices.resources.data_designer.data_designer.DataDesignerResourceWithStreamingResponse(
data_designer: nemo_microservices.resources.data_designer.data_designer.DataDesignerResource,
)#

Initialization

property jobs: nemo_microservices.resources.data_designer.jobs.jobs.JobsResourceWithStreamingResponse#