Dhs Program Tools#

Configuration File: dhs_program_tools.json Tool Type: Local Tools Count: 2

This page contains all tools defined in the dhs_program_tools.json configuration file.

Available Tools#

DHSProgram_get_data (Type: DHSProgramTool)#

Retrieve DHS Program survey results for one indicator, optionally filtered by country (ISO2-like …

DHSProgram_get_data tool specification

Tool Information:

  • Name: DHSProgram_get_data

  • Type: DHSProgramTool

  • Description: Retrieve DHS Program survey results for one indicator, optionally filtered by country (ISO2-like DHS country code) and survey year range, broken down by subgroup (wealth quintile, region, education) where available. Example: indicator_id=’FE_FRTR_W_TFR’ (total fertility rate), country_code=’EG’ (Egypt) returns 4.5 births per woman from the 1988 survey. Use DHSProgram_search_indicators to find an indicator_id.

Parameters:

  • indicator_id (string) (required) DHS indicator id, e.g. ‘FE_FRTR_W_TFR’.

  • country_code ([‘string’, ‘null’]) (optional) Optional DHS country code, e.g. ‘EG’ (Egypt), ‘KE’ (Kenya).

  • survey_year_start ([‘integer’, ‘null’]) (optional) Optional earliest survey year to include.

  • survey_year_end ([‘integer’, ‘null’]) (optional) Optional latest survey year to include.

  • limit ([‘integer’, ‘null’]) (optional) Max records to return, 1-100. Default 25.

Example Usage:

query = {
    "name": "DHSProgram_get_data",
    "arguments": {
        "indicator_id": "example_value"
    }
}
result = tu.run(query)

DHSProgram_search_indicators (Type: DHSProgramTool)#

Search the DHS Program’s indicator catalog by keyword: fertility, maternal and child mortality, n…

DHSProgram_search_indicators tool specification

Tool Information:

  • Name: DHSProgram_search_indicators

  • Type: DHSProgramTool

  • Description: Search the DHS Program’s indicator catalog by keyword: fertility, maternal and child mortality, nutrition, immunization, and HIV indicators from nationally representative household surveys across ~90 low- and middle-income countries. Example: query=’total fertility rate’. Returns each indicator’s indicator_id for use with DHSProgram_get_data.

Parameters:

  • query (string) (required) Free-text search, e.g. ‘total fertility rate’, ‘child immunization’, ‘stunting’.

  • limit ([‘integer’, ‘null’]) (optional) Max indicators to return, 1-100. Default 25.

Example Usage:

query = {
    "name": "DHSProgram_search_indicators",
    "arguments": {
        "query": "example_value"
    }
}
result = tu.run(query)