household_survey_gpt¶

class pyrecodes.household.household_survey_gpt.HouseholdOptions(value)¶

Bases: Enum

An enumeration.

DISPLACED_OVER_WEEK = 'LeaveHomeForMoreThanAWeek'¶

DISPLACED_UNDER_WEEK = 'LeaveHomeForLessThanAWeek'¶

class pyrecodes.household.household_survey_gpt.HouseholdSurveyGPT¶

Bases: HouseholdGPTBase

GPT-powered household agent for validating decisions against the Household Pulse Survey.

OPTIONS¶: alias of HouseholdOptions

PROMPTS_FILE = './pyrecodes/household/household_survey_gpt_prompts.json'¶

PUBLICATION_FOLDER = './literature_for_households'¶

create_time_step_narrative(building_damage: str, resource_met_indicators: dict, disaster_type: str) → None¶

decide() → None¶

get_household_options() → str¶

send_socioeconomic_parameters_to_llm(socioeconomic_parameters: dict) → None¶

set_context(disaster_type: str) → None¶

set_parameters(parameters: dict, api_key_filename: str = './openai_api_key.json', temperature: float = 1.0, llm_model: str = 'GPT') → None¶

set_socioeconomic_parameters(parameters: dict) → None¶

class pyrecodes.household.household_survey_gpt.SurveyNarrativeCreator(prompts: dict)¶

Bases: object

Builds the prompt for survey-validation household agents.

add_to_narrative(prompt: str) → None¶

create(building_damage: str, resource_met_indicators: dict, disaster_type: str) → None¶

get_narrative() → str¶

set_building_damage(building_damage: str, disaster_type: str) → None¶

set_resource_met_indicators(resource_met_indicators: dict, disaster_type: str) → None¶

update_household_options(household_options: str) → None¶