`nemo_microservices.types.data_designer.person_sampler_params_param`#

Module Contents#

class nemo_microservices.types.data_designer.person_sampler_params_param.PersonSamplerParamsParam#

Bases: typing_extensions.TypedDict

age_range: Iterable[int]#

None

If specified, then only synthetic people within this age range will be sampled.

city: str | nemo_microservices._types.SequenceNotStr[str]#

None

If specified, then only synthetic people from these cities will be sampled.

locale: str#

None

Locale string, determines the language and geographic locale that a synthetic person will be sampled from. E.g, en_US, en_GB, fr_FR, …

sample_dataset_when_available: bool#

None

If True, sample person data from managed dataset when available.

Otherwise, use Faker.

sex: str#

None

If specified, then only synthetic people of the specified sex will be sampled.

state: str | nemo_microservices._types.SequenceNotStr[str]#

None

Only supported for ‘en_US’ locale.

If specified, then only synthetic people from these states will be sampled. States must be given as two-letter abbreviations.

with_synthetic_personas: bool#

None

If True, then append synthetic persona columns to each generated person.