Update README.md

README.md

@@ -91,16 +91,26 @@ An instance of `ui_qas` looks like
 
 #### `ui_tables`
 
-* `table_id`: ID of table written as "[chapter no.]-[table no. within chapter]"
+* `table_id`: str, ID of table written as "[chapter no.]-[table no. within chapter]" (derived from DoL report)
 * `table_name`: str, title of the table as noted on the DoL report
 * `table_description`: str, description of the table 
 * `note`: str, any footnotes and other key information stored for this table
 * `table_data`: str, the data from this table as derived from the DoL report
   * `eval(...)` should produce a list of dictionaries corressponding to the table
-* `chapter`:
-* `header`:
-* `prompt_context`: str, context for the prompt derived 
-* `prompt`: str, prompt 
+* `chapter`: str, chapter the table appears in (TODO: replace with descriptor)
+* `header`: str, string representation of headers with their respective datatypes
+  * `eval(...)` should produce a dictionary
+* `prompt_context`: str, context for the table and prompts associated with the table (intended to precede the prompts in queries)
+* `prompts`: str, prompts to be used
+  * It should be that `len(prompts) == len(headers)`
+  * These prompts are used to derive the questions in `ui_tables`
 
 #### `ui_qas`
 
+* `idx`: int, index of question-answer pair
+* `table_id`: str, ID of table the question corresponds to, written as "[chapter no.]-[table no. within chapter]" (derived from DoL report) 
+* `column_num`: str, the column number that the (relative to headers)
+* `jurisdiction`: jurisidction (state or territory)
+* `question_context`: str, context for the table in question (intended to precede the question in queries)
+* `question`: str, question whose response is intended to fill in the entry corressponding to `table_id` and `column_num` for `jurisidiction`
+* `answer`: str, answer to the question (from DoL report)