edsl 0.1.39.dev2__py3-none-any.whl → 0.1.39.dev3__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (334) hide show
  1. edsl/Base.py +332 -385
  2. edsl/BaseDiff.py +260 -260
  3. edsl/TemplateLoader.py +24 -24
  4. edsl/__init__.py +49 -57
  5. edsl/__version__.py +1 -1
  6. edsl/agents/Agent.py +867 -1079
  7. edsl/agents/AgentList.py +413 -551
  8. edsl/agents/Invigilator.py +233 -285
  9. edsl/agents/InvigilatorBase.py +270 -254
  10. edsl/agents/PromptConstructor.py +354 -252
  11. edsl/agents/__init__.py +3 -2
  12. edsl/agents/descriptors.py +99 -99
  13. edsl/agents/prompt_helpers.py +129 -129
  14. edsl/auto/AutoStudy.py +117 -117
  15. edsl/auto/StageBase.py +230 -230
  16. edsl/auto/StageGenerateSurvey.py +178 -178
  17. edsl/auto/StageLabelQuestions.py +125 -125
  18. edsl/auto/StagePersona.py +61 -61
  19. edsl/auto/StagePersonaDimensionValueRanges.py +88 -88
  20. edsl/auto/StagePersonaDimensionValues.py +74 -74
  21. edsl/auto/StagePersonaDimensions.py +69 -69
  22. edsl/auto/StageQuestions.py +73 -73
  23. edsl/auto/SurveyCreatorPipeline.py +21 -21
  24. edsl/auto/utilities.py +224 -224
  25. edsl/base/Base.py +279 -279
  26. edsl/config.py +157 -177
  27. edsl/conversation/Conversation.py +290 -290
  28. edsl/conversation/car_buying.py +58 -59
  29. edsl/conversation/chips.py +95 -95
  30. edsl/conversation/mug_negotiation.py +81 -81
  31. edsl/conversation/next_speaker_utilities.py +93 -93
  32. edsl/coop/PriceFetcher.py +54 -54
  33. edsl/coop/__init__.py +2 -2
  34. edsl/coop/coop.py +1028 -1090
  35. edsl/coop/utils.py +131 -131
  36. edsl/data/Cache.py +555 -562
  37. edsl/data/CacheEntry.py +233 -230
  38. edsl/data/CacheHandler.py +149 -170
  39. edsl/data/RemoteCacheSync.py +78 -78
  40. edsl/data/SQLiteDict.py +292 -292
  41. edsl/data/__init__.py +4 -5
  42. edsl/data/orm.py +10 -10
  43. edsl/data_transfer_models.py +73 -74
  44. edsl/enums.py +175 -195
  45. edsl/exceptions/BaseException.py +21 -21
  46. edsl/exceptions/__init__.py +54 -54
  47. edsl/exceptions/agents.py +42 -54
  48. edsl/exceptions/cache.py +5 -5
  49. edsl/exceptions/configuration.py +16 -16
  50. edsl/exceptions/coop.py +10 -10
  51. edsl/exceptions/data.py +14 -14
  52. edsl/exceptions/general.py +34 -34
  53. edsl/exceptions/jobs.py +33 -33
  54. edsl/exceptions/language_models.py +63 -63
  55. edsl/exceptions/prompts.py +15 -15
  56. edsl/exceptions/questions.py +91 -109
  57. edsl/exceptions/results.py +29 -29
  58. edsl/exceptions/scenarios.py +22 -29
  59. edsl/exceptions/surveys.py +37 -37
  60. edsl/inference_services/AnthropicService.py +87 -84
  61. edsl/inference_services/AwsBedrock.py +120 -118
  62. edsl/inference_services/AzureAI.py +217 -215
  63. edsl/inference_services/DeepInfraService.py +18 -18
  64. edsl/inference_services/GoogleService.py +148 -139
  65. edsl/inference_services/GroqService.py +20 -20
  66. edsl/inference_services/InferenceServiceABC.py +147 -80
  67. edsl/inference_services/InferenceServicesCollection.py +97 -122
  68. edsl/inference_services/MistralAIService.py +123 -120
  69. edsl/inference_services/OllamaService.py +18 -18
  70. edsl/inference_services/OpenAIService.py +224 -221
  71. edsl/inference_services/PerplexityService.py +163 -160
  72. edsl/inference_services/TestService.py +89 -92
  73. edsl/inference_services/TogetherAIService.py +170 -170
  74. edsl/inference_services/models_available_cache.py +118 -118
  75. edsl/inference_services/rate_limits_cache.py +25 -25
  76. edsl/inference_services/registry.py +41 -41
  77. edsl/inference_services/write_available.py +10 -10
  78. edsl/jobs/Answers.py +56 -43
  79. edsl/jobs/Jobs.py +898 -757
  80. edsl/jobs/JobsChecks.py +147 -172
  81. edsl/jobs/JobsPrompts.py +268 -270
  82. edsl/jobs/JobsRemoteInferenceHandler.py +239 -287
  83. edsl/jobs/__init__.py +1 -1
  84. edsl/jobs/buckets/BucketCollection.py +63 -104
  85. edsl/jobs/buckets/ModelBuckets.py +65 -65
  86. edsl/jobs/buckets/TokenBucket.py +251 -283
  87. edsl/jobs/interviews/Interview.py +661 -358
  88. edsl/jobs/interviews/InterviewExceptionCollection.py +99 -99
  89. edsl/jobs/interviews/InterviewExceptionEntry.py +186 -186
  90. edsl/jobs/interviews/InterviewStatistic.py +63 -63
  91. edsl/jobs/interviews/InterviewStatisticsCollection.py +25 -25
  92. edsl/jobs/interviews/InterviewStatusDictionary.py +78 -78
  93. edsl/jobs/interviews/InterviewStatusLog.py +92 -92
  94. edsl/jobs/interviews/ReportErrors.py +66 -66
  95. edsl/jobs/interviews/interview_status_enum.py +9 -9
  96. edsl/jobs/runners/JobsRunnerAsyncio.py +466 -421
  97. edsl/jobs/runners/JobsRunnerStatus.py +330 -330
  98. edsl/jobs/tasks/QuestionTaskCreator.py +242 -244
  99. edsl/jobs/tasks/TaskCreators.py +64 -64
  100. edsl/jobs/tasks/TaskHistory.py +450 -449
  101. edsl/jobs/tasks/TaskStatusLog.py +23 -23
  102. edsl/jobs/tasks/task_status_enum.py +163 -161
  103. edsl/jobs/tokens/InterviewTokenUsage.py +27 -27
  104. edsl/jobs/tokens/TokenUsage.py +34 -34
  105. edsl/language_models/KeyLookup.py +30 -0
  106. edsl/language_models/LanguageModel.py +668 -571
  107. edsl/language_models/ModelList.py +155 -153
  108. edsl/language_models/RegisterLanguageModelsMeta.py +184 -184
  109. edsl/language_models/__init__.py +3 -2
  110. edsl/language_models/fake_openai_call.py +15 -15
  111. edsl/language_models/fake_openai_service.py +61 -61
  112. edsl/language_models/registry.py +190 -180
  113. edsl/language_models/repair.py +156 -156
  114. edsl/language_models/unused/ReplicateBase.py +83 -0
  115. edsl/language_models/utilities.py +64 -65
  116. edsl/notebooks/Notebook.py +258 -263
  117. edsl/notebooks/__init__.py +1 -1
  118. edsl/prompts/Prompt.py +362 -352
  119. edsl/prompts/__init__.py +2 -2
  120. edsl/questions/AnswerValidatorMixin.py +289 -334
  121. edsl/questions/QuestionBase.py +664 -509
  122. edsl/questions/QuestionBaseGenMixin.py +161 -165
  123. edsl/questions/QuestionBasePromptsMixin.py +217 -221
  124. edsl/questions/QuestionBudget.py +227 -227
  125. edsl/questions/QuestionCheckBox.py +359 -359
  126. edsl/questions/QuestionExtract.py +182 -182
  127. edsl/questions/QuestionFreeText.py +114 -113
  128. edsl/questions/QuestionFunctional.py +166 -166
  129. edsl/questions/QuestionList.py +231 -229
  130. edsl/questions/QuestionMultipleChoice.py +286 -330
  131. edsl/questions/QuestionNumerical.py +153 -151
  132. edsl/questions/QuestionRank.py +324 -314
  133. edsl/questions/Quick.py +41 -41
  134. edsl/questions/RegisterQuestionsMeta.py +71 -71
  135. edsl/questions/ResponseValidatorABC.py +174 -200
  136. edsl/questions/SimpleAskMixin.py +73 -74
  137. edsl/questions/__init__.py +26 -27
  138. edsl/questions/compose_questions.py +98 -98
  139. edsl/questions/decorators.py +21 -21
  140. edsl/questions/derived/QuestionLikertFive.py +76 -76
  141. edsl/questions/derived/QuestionLinearScale.py +87 -90
  142. edsl/questions/derived/QuestionTopK.py +93 -93
  143. edsl/questions/derived/QuestionYesNo.py +82 -82
  144. edsl/questions/descriptors.py +413 -427
  145. edsl/questions/prompt_templates/question_budget.jinja +13 -13
  146. edsl/questions/prompt_templates/question_checkbox.jinja +32 -32
  147. edsl/questions/prompt_templates/question_extract.jinja +11 -11
  148. edsl/questions/prompt_templates/question_free_text.jinja +3 -3
  149. edsl/questions/prompt_templates/question_linear_scale.jinja +11 -11
  150. edsl/questions/prompt_templates/question_list.jinja +17 -17
  151. edsl/questions/prompt_templates/question_multiple_choice.jinja +33 -33
  152. edsl/questions/prompt_templates/question_numerical.jinja +36 -36
  153. edsl/questions/question_registry.py +177 -177
  154. edsl/questions/settings.py +12 -12
  155. edsl/questions/templates/budget/answering_instructions.jinja +7 -7
  156. edsl/questions/templates/budget/question_presentation.jinja +7 -7
  157. edsl/questions/templates/checkbox/answering_instructions.jinja +10 -10
  158. edsl/questions/templates/checkbox/question_presentation.jinja +22 -22
  159. edsl/questions/templates/extract/answering_instructions.jinja +7 -7
  160. edsl/questions/templates/likert_five/answering_instructions.jinja +10 -10
  161. edsl/questions/templates/likert_five/question_presentation.jinja +11 -11
  162. edsl/questions/templates/linear_scale/answering_instructions.jinja +5 -5
  163. edsl/questions/templates/linear_scale/question_presentation.jinja +5 -5
  164. edsl/questions/templates/list/answering_instructions.jinja +3 -3
  165. edsl/questions/templates/list/question_presentation.jinja +5 -5
  166. edsl/questions/templates/multiple_choice/answering_instructions.jinja +9 -9
  167. edsl/questions/templates/multiple_choice/question_presentation.jinja +11 -11
  168. edsl/questions/templates/numerical/answering_instructions.jinja +6 -6
  169. edsl/questions/templates/numerical/question_presentation.jinja +6 -6
  170. edsl/questions/templates/rank/answering_instructions.jinja +11 -11
  171. edsl/questions/templates/rank/question_presentation.jinja +15 -15
  172. edsl/questions/templates/top_k/answering_instructions.jinja +8 -8
  173. edsl/questions/templates/top_k/question_presentation.jinja +22 -22
  174. edsl/questions/templates/yes_no/answering_instructions.jinja +6 -6
  175. edsl/questions/templates/yes_no/question_presentation.jinja +11 -11
  176. edsl/results/CSSParameterizer.py +108 -108
  177. edsl/results/Dataset.py +424 -587
  178. edsl/results/DatasetExportMixin.py +731 -653
  179. edsl/results/DatasetTree.py +275 -295
  180. edsl/results/Result.py +465 -451
  181. edsl/results/Results.py +1165 -1172
  182. edsl/results/ResultsDBMixin.py +238 -0
  183. edsl/results/ResultsExportMixin.py +43 -45
  184. edsl/results/ResultsFetchMixin.py +33 -33
  185. edsl/results/ResultsGGMixin.py +121 -121
  186. edsl/results/ResultsToolsMixin.py +98 -98
  187. edsl/results/Selector.py +135 -145
  188. edsl/results/TableDisplay.py +198 -125
  189. edsl/results/__init__.py +2 -2
  190. edsl/results/table_display.css +77 -77
  191. edsl/results/tree_explore.py +115 -115
  192. edsl/scenarios/FileStore.py +632 -511
  193. edsl/scenarios/Scenario.py +601 -498
  194. edsl/scenarios/ScenarioHtmlMixin.py +64 -65
  195. edsl/scenarios/ScenarioJoin.py +127 -131
  196. edsl/scenarios/ScenarioList.py +1287 -1430
  197. edsl/scenarios/ScenarioListExportMixin.py +52 -45
  198. edsl/scenarios/ScenarioListPdfMixin.py +261 -239
  199. edsl/scenarios/__init__.py +4 -3
  200. edsl/shared.py +1 -1
  201. edsl/study/ObjectEntry.py +173 -173
  202. edsl/study/ProofOfWork.py +113 -113
  203. edsl/study/SnapShot.py +80 -80
  204. edsl/study/Study.py +528 -521
  205. edsl/study/__init__.py +4 -4
  206. edsl/surveys/DAG.py +148 -148
  207. edsl/surveys/Memory.py +31 -31
  208. edsl/surveys/MemoryPlan.py +244 -244
  209. edsl/surveys/Rule.py +326 -327
  210. edsl/surveys/RuleCollection.py +387 -385
  211. edsl/surveys/Survey.py +1801 -1229
  212. edsl/surveys/SurveyCSS.py +261 -273
  213. edsl/surveys/SurveyExportMixin.py +259 -259
  214. edsl/surveys/{SurveyFlowVisualization.py → SurveyFlowVisualizationMixin.py} +179 -181
  215. edsl/surveys/SurveyQualtricsImport.py +284 -284
  216. edsl/surveys/__init__.py +3 -5
  217. edsl/surveys/base.py +53 -53
  218. edsl/surveys/descriptors.py +56 -60
  219. edsl/surveys/instructions/ChangeInstruction.py +49 -48
  220. edsl/surveys/instructions/Instruction.py +65 -56
  221. edsl/surveys/instructions/InstructionCollection.py +77 -82
  222. edsl/templates/error_reporting/base.html +23 -23
  223. edsl/templates/error_reporting/exceptions_by_model.html +34 -34
  224. edsl/templates/error_reporting/exceptions_by_question_name.html +16 -16
  225. edsl/templates/error_reporting/exceptions_by_type.html +16 -16
  226. edsl/templates/error_reporting/interview_details.html +115 -115
  227. edsl/templates/error_reporting/interviews.html +19 -19
  228. edsl/templates/error_reporting/overview.html +4 -4
  229. edsl/templates/error_reporting/performance_plot.html +1 -1
  230. edsl/templates/error_reporting/report.css +73 -73
  231. edsl/templates/error_reporting/report.html +117 -117
  232. edsl/templates/error_reporting/report.js +25 -25
  233. edsl/tools/__init__.py +1 -1
  234. edsl/tools/clusters.py +192 -192
  235. edsl/tools/embeddings.py +27 -27
  236. edsl/tools/embeddings_plotting.py +118 -118
  237. edsl/tools/plotting.py +112 -112
  238. edsl/tools/summarize.py +18 -18
  239. edsl/utilities/SystemInfo.py +28 -28
  240. edsl/utilities/__init__.py +22 -22
  241. edsl/utilities/ast_utilities.py +25 -25
  242. edsl/utilities/data/Registry.py +6 -6
  243. edsl/utilities/data/__init__.py +1 -1
  244. edsl/utilities/data/scooter_results.json +1 -1
  245. edsl/utilities/decorators.py +77 -77
  246. edsl/utilities/gcp_bucket/cloud_storage.py +96 -96
  247. edsl/utilities/interface.py +627 -627
  248. edsl/utilities/naming_utilities.py +263 -263
  249. edsl/utilities/repair_functions.py +28 -28
  250. edsl/utilities/restricted_python.py +70 -70
  251. edsl/utilities/utilities.py +424 -436
  252. {edsl-0.1.39.dev2.dist-info → edsl-0.1.39.dev3.dist-info}/LICENSE +21 -21
  253. {edsl-0.1.39.dev2.dist-info → edsl-0.1.39.dev3.dist-info}/METADATA +10 -12
  254. edsl-0.1.39.dev3.dist-info/RECORD +277 -0
  255. edsl/agents/QuestionInstructionPromptBuilder.py +0 -128
  256. edsl/agents/QuestionOptionProcessor.py +0 -172
  257. edsl/agents/QuestionTemplateReplacementsBuilder.py +0 -137
  258. edsl/coop/CoopFunctionsMixin.py +0 -15
  259. edsl/coop/ExpectedParrotKeyHandler.py +0 -125
  260. edsl/exceptions/inference_services.py +0 -5
  261. edsl/inference_services/AvailableModelCacheHandler.py +0 -184
  262. edsl/inference_services/AvailableModelFetcher.py +0 -209
  263. edsl/inference_services/ServiceAvailability.py +0 -135
  264. edsl/inference_services/data_structures.py +0 -62
  265. edsl/jobs/AnswerQuestionFunctionConstructor.py +0 -188
  266. edsl/jobs/FetchInvigilator.py +0 -40
  267. edsl/jobs/InterviewTaskManager.py +0 -98
  268. edsl/jobs/InterviewsConstructor.py +0 -48
  269. edsl/jobs/JobsComponentConstructor.py +0 -189
  270. edsl/jobs/JobsRemoteInferenceLogger.py +0 -239
  271. edsl/jobs/RequestTokenEstimator.py +0 -30
  272. edsl/jobs/buckets/TokenBucketAPI.py +0 -211
  273. edsl/jobs/buckets/TokenBucketClient.py +0 -191
  274. edsl/jobs/decorators.py +0 -35
  275. edsl/jobs/jobs_status_enums.py +0 -9
  276. edsl/jobs/loggers/HTMLTableJobLogger.py +0 -304
  277. edsl/language_models/ComputeCost.py +0 -63
  278. edsl/language_models/PriceManager.py +0 -127
  279. edsl/language_models/RawResponseHandler.py +0 -106
  280. edsl/language_models/ServiceDataSources.py +0 -0
  281. edsl/language_models/key_management/KeyLookup.py +0 -63
  282. edsl/language_models/key_management/KeyLookupBuilder.py +0 -273
  283. edsl/language_models/key_management/KeyLookupCollection.py +0 -38
  284. edsl/language_models/key_management/__init__.py +0 -0
  285. edsl/language_models/key_management/models.py +0 -131
  286. edsl/notebooks/NotebookToLaTeX.py +0 -142
  287. edsl/questions/ExceptionExplainer.py +0 -77
  288. edsl/questions/HTMLQuestion.py +0 -103
  289. edsl/questions/LoopProcessor.py +0 -149
  290. edsl/questions/QuestionMatrix.py +0 -265
  291. edsl/questions/ResponseValidatorFactory.py +0 -28
  292. edsl/questions/templates/matrix/__init__.py +0 -1
  293. edsl/questions/templates/matrix/answering_instructions.jinja +0 -5
  294. edsl/questions/templates/matrix/question_presentation.jinja +0 -20
  295. edsl/results/MarkdownToDocx.py +0 -122
  296. edsl/results/MarkdownToPDF.py +0 -111
  297. edsl/results/TextEditor.py +0 -50
  298. edsl/results/smart_objects.py +0 -96
  299. edsl/results/table_data_class.py +0 -12
  300. edsl/results/table_renderers.py +0 -118
  301. edsl/scenarios/ConstructDownloadLink.py +0 -109
  302. edsl/scenarios/DirectoryScanner.py +0 -96
  303. edsl/scenarios/DocumentChunker.py +0 -102
  304. edsl/scenarios/DocxScenario.py +0 -16
  305. edsl/scenarios/PdfExtractor.py +0 -40
  306. edsl/scenarios/ScenarioSelector.py +0 -156
  307. edsl/scenarios/file_methods.py +0 -85
  308. edsl/scenarios/handlers/__init__.py +0 -13
  309. edsl/scenarios/handlers/csv.py +0 -38
  310. edsl/scenarios/handlers/docx.py +0 -76
  311. edsl/scenarios/handlers/html.py +0 -37
  312. edsl/scenarios/handlers/json.py +0 -111
  313. edsl/scenarios/handlers/latex.py +0 -5
  314. edsl/scenarios/handlers/md.py +0 -51
  315. edsl/scenarios/handlers/pdf.py +0 -68
  316. edsl/scenarios/handlers/png.py +0 -39
  317. edsl/scenarios/handlers/pptx.py +0 -105
  318. edsl/scenarios/handlers/py.py +0 -294
  319. edsl/scenarios/handlers/sql.py +0 -313
  320. edsl/scenarios/handlers/sqlite.py +0 -149
  321. edsl/scenarios/handlers/txt.py +0 -33
  322. edsl/surveys/ConstructDAG.py +0 -92
  323. edsl/surveys/EditSurvey.py +0 -221
  324. edsl/surveys/InstructionHandler.py +0 -100
  325. edsl/surveys/MemoryManagement.py +0 -72
  326. edsl/surveys/RuleManager.py +0 -172
  327. edsl/surveys/Simulator.py +0 -75
  328. edsl/surveys/SurveyToApp.py +0 -141
  329. edsl/utilities/PrettyList.py +0 -56
  330. edsl/utilities/is_notebook.py +0 -18
  331. edsl/utilities/is_valid_variable_name.py +0 -11
  332. edsl/utilities/remove_edsl_version.py +0 -24
  333. edsl-0.1.39.dev2.dist-info/RECORD +0 -352
  334. {edsl-0.1.39.dev2.dist-info → edsl-0.1.39.dev3.dist-info}/WHEEL +0 -0
@@ -1,358 +1,661 @@
1
- """This module contains the Interview class, which is responsible for conducting an interview asynchronously."""
2
-
3
- from __future__ import annotations
4
- import asyncio
5
- from typing import Any, Type, List, Generator, Optional, Union, TYPE_CHECKING
6
- import copy
7
-
8
- # from edsl.config import CONFIG
9
-
10
- from edsl.jobs.Answers import Answers
11
- from edsl.jobs.interviews.InterviewStatusLog import InterviewStatusLog
12
- from edsl.jobs.interviews.InterviewStatusDictionary import InterviewStatusDictionary
13
- from edsl.jobs.interviews.InterviewExceptionCollection import (
14
- InterviewExceptionCollection,
15
- )
16
- from edsl.jobs.interviews.InterviewExceptionEntry import InterviewExceptionEntry
17
- from edsl.jobs.buckets.ModelBuckets import ModelBuckets
18
- from edsl.jobs.AnswerQuestionFunctionConstructor import (
19
- AnswerQuestionFunctionConstructor,
20
- )
21
- from edsl.jobs.InterviewTaskManager import InterviewTaskManager
22
- from edsl.jobs.FetchInvigilator import FetchInvigilator
23
- from edsl.jobs.RequestTokenEstimator import RequestTokenEstimator
24
-
25
- if TYPE_CHECKING:
26
- from edsl.agents.Agent import Agent
27
- from edsl.surveys.Survey import Survey
28
- from edsl.scenarios.Scenario import Scenario
29
- from edsl.data.Cache import Cache
30
- from edsl.language_models.LanguageModel import LanguageModel
31
- from edsl.jobs.tokens.InterviewTokenUsage import InterviewTokenUsage
32
-
33
-
34
- class Interview:
35
- """
36
- An 'interview' is one agent answering one survey, with one language model, for a given scenario.
37
-
38
- The main method is `async_conduct_interview`, which conducts the interview asynchronously.
39
- Most of the class is dedicated to creating the tasks for each question in the survey, and then running them.
40
- """
41
-
42
- def __init__(
43
- self,
44
- agent: Agent,
45
- survey: Survey,
46
- scenario: Scenario,
47
- model: Type["LanguageModel"],
48
- debug: Optional[bool] = False, # DEPRECATE
49
- iteration: int = 0,
50
- cache: Optional["Cache"] = None,
51
- sidecar_model: Optional["LanguageModel"] = None, # DEPRECATE
52
- skip_retry: bool = False, # COULD BE SET WITH CONFIG
53
- raise_validation_errors: bool = True,
54
- indices: dict = None, # explain?
55
- ):
56
- """Initialize the Interview instance.
57
-
58
- :param agent: the agent being interviewed.
59
- :param survey: the survey being administered to the agent.
60
- :param scenario: the scenario that populates the survey questions.
61
- :param model: the language model used to answer the questions.
62
- :param debug: if True, run without calls to the language model.
63
- :param iteration: the iteration number of the interview.
64
- :param cache: the cache used to store the answers.
65
- :param sidecar_model: a sidecar model used to answer questions.
66
-
67
- >>> i = Interview.example()
68
- >>> i.task_manager.task_creators
69
- {}
70
-
71
- >>> i.exceptions
72
- {}
73
-
74
- >>> _ = asyncio.run(i.async_conduct_interview())
75
- >>> i.task_status_logs['q0']
76
- [{'log_time': ..., 'value': <TaskStatus.NOT_STARTED: 1>}, {'log_time': ..., 'value': <TaskStatus.WAITING_FOR_DEPENDENCIES: 2>}, {'log_time': ..., 'value': <TaskStatus.API_CALL_IN_PROGRESS: 7>}, {'log_time': ..., 'value': <TaskStatus.SUCCESS: 8>}]
77
-
78
- >>> i.to_index
79
- {'q0': 0, 'q1': 1, 'q2': 2}
80
-
81
- """
82
- self.agent = agent
83
- self.survey = copy.deepcopy(survey) # why do we need to deepcopy the survey?
84
- self.scenario = scenario
85
- self.model = model
86
- self.debug = debug
87
- self.iteration = iteration
88
- self.cache = cache
89
-
90
- self.answers = Answers() # will get filled in as interview progresses
91
- self.sidecar_model = sidecar_model
92
-
93
- self.task_manager = InterviewTaskManager(
94
- survey=self.survey,
95
- iteration=iteration,
96
- )
97
-
98
- self.exceptions = InterviewExceptionCollection()
99
-
100
- self.skip_retry = skip_retry
101
- self.raise_validation_errors = raise_validation_errors
102
-
103
- # dictionary mapping question names to their index in the survey.
104
- self.to_index = {
105
- question_name: index
106
- for index, question_name in enumerate(self.survey.question_names)
107
- }
108
-
109
- self.failed_questions = []
110
-
111
- self.indices = indices
112
-
113
- @property
114
- def has_exceptions(self) -> bool:
115
- """Return True if there are exceptions."""
116
- return len(self.exceptions) > 0
117
-
118
- @property
119
- def task_status_logs(self) -> InterviewStatusLog:
120
- """Return the task status logs for the interview.
121
-
122
- The keys are the question names; the values are the lists of status log changes for each task.
123
- """
124
- return self.task_manager.task_status_logs
125
-
126
- @property
127
- def token_usage(self) -> InterviewTokenUsage:
128
- """Determine how many tokens were used for the interview."""
129
- return self.task_manager.token_usage # task_creators.token_usage
130
-
131
- @property
132
- def interview_status(self) -> InterviewStatusDictionary:
133
- """Return a dictionary mapping task status codes to counts."""
134
- # return self.task_creators.interview_status
135
- return self.task_manager.interview_status
136
-
137
- # region: Serialization
138
- def to_dict(self, include_exceptions=True, add_edsl_version=True) -> dict[str, Any]:
139
- """Return a dictionary representation of the Interview instance.
140
- This is just for hashing purposes.
141
-
142
- >>> i = Interview.example()
143
- >>> hash(i)
144
- 193593189022259693
145
- """
146
- d = {
147
- "agent": self.agent.to_dict(add_edsl_version=add_edsl_version),
148
- "survey": self.survey.to_dict(add_edsl_version=add_edsl_version),
149
- "scenario": self.scenario.to_dict(add_edsl_version=add_edsl_version),
150
- "model": self.model.to_dict(add_edsl_version=add_edsl_version),
151
- "iteration": self.iteration,
152
- "exceptions": {},
153
- }
154
- if include_exceptions:
155
- d["exceptions"] = self.exceptions.to_dict()
156
- if hasattr(self, "indices"):
157
- d["indices"] = self.indices
158
- return d
159
-
160
- @classmethod
161
- def from_dict(cls, d: dict[str, Any]) -> "Interview":
162
- """Return an Interview instance from a dictionary."""
163
-
164
- from edsl.agents.Agent import Agent
165
- from edsl.surveys.Survey import Survey
166
- from edsl.scenarios.Scenario import Scenario
167
- from edsl.language_models.LanguageModel import LanguageModel
168
-
169
- agent = Agent.from_dict(d["agent"])
170
- survey = Survey.from_dict(d["survey"])
171
- scenario = Scenario.from_dict(d["scenario"])
172
- model = LanguageModel.from_dict(d["model"])
173
- iteration = d["iteration"]
174
- params = {
175
- "agent": agent,
176
- "survey": survey,
177
- "scenario": scenario,
178
- "model": model,
179
- "iteration": iteration,
180
- }
181
- if "indices" in d:
182
- params["indices"] = d["indices"]
183
- interview = cls(**params)
184
- if "exceptions" in d:
185
- exceptions = InterviewExceptionCollection.from_dict(d["exceptions"])
186
- interview.exceptions = exceptions
187
- return interview
188
-
189
- def __hash__(self) -> int:
190
- from edsl.utilities.utilities import dict_hash
191
-
192
- return dict_hash(self.to_dict(include_exceptions=False, add_edsl_version=False))
193
-
194
- def __eq__(self, other: "Interview") -> bool:
195
- """
196
- >>> from edsl.jobs.interviews.Interview import Interview; i = Interview.example(); d = i.to_dict(); i2 = Interview.from_dict(d); i == i2
197
- True
198
- """
199
- return hash(self) == hash(other)
200
-
201
- # region: Conducting the interview
202
- async def async_conduct_interview(
203
- self,
204
- model_buckets: Optional[ModelBuckets] = None,
205
- stop_on_exception: bool = False,
206
- sidecar_model: Optional["LanguageModel"] = None,
207
- raise_validation_errors: bool = True,
208
- ) -> tuple["Answers", List[dict[str, Any]]]:
209
- """
210
- Conduct an Interview asynchronously.
211
- It returns a tuple with the answers and a list of valid results.
212
-
213
- :param model_buckets: a dictionary of token buckets for the model.
214
- :param debug: run without calls to LLM.
215
- :param stop_on_exception: if True, stops the interview if an exception is raised.
216
- :param sidecar_model: a sidecar model used to answer questions.
217
-
218
- Example usage:
219
-
220
- >>> i = Interview.example()
221
- >>> result, _ = asyncio.run(i.async_conduct_interview())
222
- >>> result['q0']
223
- 'yes'
224
-
225
- >>> i = Interview.example(throw_exception = True)
226
- >>> result, _ = asyncio.run(i.async_conduct_interview())
227
- >>> i.exceptions
228
- {'q0': ...
229
- >>> i = Interview.example()
230
- >>> result, _ = asyncio.run(i.async_conduct_interview(stop_on_exception = True))
231
- Traceback (most recent call last):
232
- ...
233
- asyncio.exceptions.CancelledError
234
- """
235
- self.sidecar_model = sidecar_model
236
- self.stop_on_exception = stop_on_exception
237
-
238
- # if no model bucket is passed, create an 'infinity' bucket with no rate limits
239
- if model_buckets is None or hasattr(self.agent, "answer_question_directly"):
240
- model_buckets = ModelBuckets.infinity_bucket()
241
-
242
- # was "self.tasks" - is that necessary?
243
- self.tasks = self.task_manager.build_question_tasks(
244
- answer_func=AnswerQuestionFunctionConstructor(self)(),
245
- token_estimator=RequestTokenEstimator(self),
246
- model_buckets=model_buckets,
247
- )
248
-
249
- ## This is the key part---it creates a task for each question,
250
- ## with dependencies on the questions that must be answered before this one can be answered.
251
-
252
- ## 'Invigilators' are used to administer the survey.
253
- self.invigilators = [
254
- FetchInvigilator(interview=self, current_answers=self.answers)(question)
255
- for question in self.survey.questions
256
- ]
257
- await asyncio.gather(*self.tasks, return_exceptions=not stop_on_exception)
258
- self.answers.replace_missing_answers_with_none(self.survey)
259
- valid_results = list(
260
- self._extract_valid_results(self.tasks, self.invigilators, self.exceptions)
261
- )
262
- return self.answers, valid_results
263
-
264
- # endregion
265
-
266
- # region: Extracting results and recording errors
267
- @staticmethod
268
- def _extract_valid_results(
269
- tasks, invigilators: List["InvigilatorABC"], exceptions
270
- ) -> Generator["Answers", None, None]:
271
- """Extract the valid results from the list of results.
272
-
273
- It iterates through the tasks and invigilators, and yields the results of the tasks that are done.
274
- If a task is not done, it raises a ValueError.
275
- If an exception is raised in the task, it records the exception in the Interview instance except if the task was cancelled, which is expected behavior.
276
-
277
- >>> i = Interview.example()
278
- >>> result, _ = asyncio.run(i.async_conduct_interview())
279
- """
280
- assert len(tasks) == len(invigilators)
281
-
282
- for task, invigilator in zip(tasks, invigilators):
283
- if not task.done():
284
- raise ValueError(f"Task {task.get_name()} is not done.")
285
-
286
- try:
287
- result = task.result()
288
- except asyncio.CancelledError as e: # task was cancelled
289
- result = invigilator.get_failed_task_result(
290
- failure_reason="Task was cancelled."
291
- )
292
- except Exception as e: # any other kind of exception in the task
293
- result = invigilator.get_failed_task_result(
294
- failure_reason=f"Task failed with exception: {str(e)}."
295
- )
296
- exception_entry = InterviewExceptionEntry(
297
- exception=e,
298
- invigilator=invigilator,
299
- )
300
- exceptions.add(task.get_name(), exception_entry)
301
-
302
- yield result
303
-
304
- # endregion
305
-
306
- # region: Magic methods
307
- def __repr__(self) -> str:
308
- """Return a string representation of the Interview instance."""
309
- return f"Interview(agent = {repr(self.agent)}, survey = {repr(self.survey)}, scenario = {repr(self.scenario)}, model = {repr(self.model)})"
310
-
311
- def duplicate(self, iteration: int, cache: "Cache") -> Interview:
312
- """Duplicate the interview, but with a new iteration number and cache.
313
-
314
- >>> i = Interview.example()
315
- >>> i2 = i.duplicate(1, None)
316
- >>> i.iteration + 1 == i2.iteration
317
- True
318
-
319
- """
320
- return Interview(
321
- agent=self.agent,
322
- survey=self.survey,
323
- scenario=self.scenario,
324
- model=self.model,
325
- iteration=iteration,
326
- cache=cache,
327
- skip_retry=self.skip_retry,
328
- indices=self.indices,
329
- )
330
-
331
- @classmethod
332
- def example(self, throw_exception: bool = False) -> Interview:
333
- """Return an example Interview instance."""
334
- from edsl.agents import Agent
335
- from edsl.surveys import Survey
336
- from edsl.scenarios import Scenario
337
- from edsl.language_models import LanguageModel
338
-
339
- def f(self, question, scenario):
340
- return "yes"
341
-
342
- agent = Agent.example()
343
- agent.add_direct_question_answering_method(f)
344
- survey = Survey.example()
345
- scenario = Scenario.example()
346
- model = LanguageModel.example()
347
- if throw_exception:
348
- model = LanguageModel.example(test_model=True, throw_exception=True)
349
- agent = Agent.example()
350
- return Interview(agent=agent, survey=survey, scenario=scenario, model=model)
351
- return Interview(agent=agent, survey=survey, scenario=scenario, model=model)
352
-
353
-
354
- if __name__ == "__main__":
355
- import doctest
356
-
357
- # add ellipsis
358
- doctest.testmod(optionflags=doctest.ELLIPSIS)
1
+ """This module contains the Interview class, which is responsible for conducting an interview asynchronously."""
2
+
3
+ from __future__ import annotations
4
+ import asyncio
5
+ from typing import Any, Type, List, Generator, Optional, Union
6
+ import copy
7
+
8
+ from tenacity import (
9
+ retry,
10
+ stop_after_attempt,
11
+ wait_exponential,
12
+ retry_if_exception_type,
13
+ RetryError,
14
+ )
15
+
16
+ from edsl import CONFIG
17
+ from edsl.surveys.base import EndOfSurvey
18
+ from edsl.exceptions import QuestionAnswerValidationError
19
+ from edsl.exceptions import QuestionAnswerValidationError
20
+ from edsl.data_transfer_models import AgentResponseDict, EDSLResultObjectInput
21
+
22
+ from edsl.jobs.buckets.ModelBuckets import ModelBuckets
23
+ from edsl.jobs.Answers import Answers
24
+ from edsl.jobs.tasks.QuestionTaskCreator import QuestionTaskCreator
25
+ from edsl.jobs.tasks.TaskCreators import TaskCreators
26
+ from edsl.jobs.interviews.InterviewStatusLog import InterviewStatusLog
27
+ from edsl.jobs.interviews.InterviewExceptionCollection import (
28
+ InterviewExceptionCollection,
29
+ )
30
+
31
+ # from edsl.jobs.interviews.InterviewStatusMixin import InterviewStatusMixin
32
+
33
+ from edsl.surveys.base import EndOfSurvey
34
+ from edsl.jobs.buckets.ModelBuckets import ModelBuckets
35
+ from edsl.jobs.interviews.InterviewExceptionEntry import InterviewExceptionEntry
36
+ from edsl.jobs.tasks.task_status_enum import TaskStatus
37
+ from edsl.jobs.tasks.QuestionTaskCreator import QuestionTaskCreator
38
+
39
+
40
+ from edsl import Agent, Survey, Scenario, Cache
41
+ from edsl.language_models import LanguageModel
42
+ from edsl.questions import QuestionBase
43
+ from edsl.agents.InvigilatorBase import InvigilatorBase
44
+
45
+ from edsl.exceptions.language_models import LanguageModelNoResponseError
46
+
47
+ from edsl.jobs.interviews.InterviewStatusLog import InterviewStatusLog
48
+ from edsl.jobs.tokens.InterviewTokenUsage import InterviewTokenUsage
49
+ from edsl.jobs.interviews.InterviewStatusDictionary import InterviewStatusDictionary
50
+
51
+
52
+ from edsl import CONFIG
53
+
54
+ EDSL_BACKOFF_START_SEC = float(CONFIG.get("EDSL_BACKOFF_START_SEC"))
55
+ EDSL_BACKOFF_MAX_SEC = float(CONFIG.get("EDSL_BACKOFF_MAX_SEC"))
56
+ EDSL_MAX_ATTEMPTS = int(CONFIG.get("EDSL_MAX_ATTEMPTS"))
57
+
58
+
59
+ class Interview:
60
+ """
61
+ An 'interview' is one agent answering one survey, with one language model, for a given scenario.
62
+
63
+ The main method is `async_conduct_interview`, which conducts the interview asynchronously.
64
+ Most of the class is dedicated to creating the tasks for each question in the survey, and then running them.
65
+ """
66
+
67
+ def __init__(
68
+ self,
69
+ agent: Agent,
70
+ survey: Survey,
71
+ scenario: Scenario,
72
+ model: Type["LanguageModel"],
73
+ debug: Optional[bool] = False,
74
+ iteration: int = 0,
75
+ cache: Optional["Cache"] = None,
76
+ sidecar_model: Optional["LanguageModel"] = None,
77
+ skip_retry: bool = False,
78
+ raise_validation_errors: bool = True,
79
+ ):
80
+ """Initialize the Interview instance.
81
+
82
+ :param agent: the agent being interviewed.
83
+ :param survey: the survey being administered to the agent.
84
+ :param scenario: the scenario that populates the survey questions.
85
+ :param model: the language model used to answer the questions.
86
+ :param debug: if True, run without calls to the language model.
87
+ :param iteration: the iteration number of the interview.
88
+ :param cache: the cache used to store the answers.
89
+ :param sidecar_model: a sidecar model used to answer questions.
90
+
91
+ >>> i = Interview.example()
92
+ >>> i.task_creators
93
+ {}
94
+
95
+ >>> i.exceptions
96
+ {}
97
+
98
+ >>> _ = asyncio.run(i.async_conduct_interview())
99
+ >>> i.task_status_logs['q0']
100
+ [{'log_time': ..., 'value': <TaskStatus.NOT_STARTED: 1>}, {'log_time': ..., 'value': <TaskStatus.WAITING_FOR_DEPENDENCIES: 2>}, {'log_time': ..., 'value': <TaskStatus.API_CALL_IN_PROGRESS: 7>}, {'log_time': ..., 'value': <TaskStatus.SUCCESS: 8>}]
101
+
102
+ >>> i.to_index
103
+ {'q0': 0, 'q1': 1, 'q2': 2}
104
+
105
+ """
106
+ self.agent = agent
107
+ self.survey = copy.deepcopy(survey)
108
+ self.scenario = scenario
109
+ self.model = model
110
+ self.debug = debug
111
+ self.iteration = iteration
112
+ self.cache = cache
113
+ self.answers: dict[
114
+ str, str
115
+ ] = Answers() # will get filled in as interview progresses
116
+ self.sidecar_model = sidecar_model
117
+
118
+ # Trackers
119
+ self.task_creators = TaskCreators() # tracks the task creators
120
+ self.exceptions = InterviewExceptionCollection()
121
+
122
+ self._task_status_log_dict = InterviewStatusLog()
123
+ self.skip_retry = skip_retry
124
+ self.raise_validation_errors = raise_validation_errors
125
+
126
+ # dictionary mapping question names to their index in the survey.
127
+ self.to_index = {
128
+ question_name: index
129
+ for index, question_name in enumerate(self.survey.question_names)
130
+ }
131
+
132
+ self.failed_questions = []
133
+
134
+ @property
135
+ def has_exceptions(self) -> bool:
136
+ """Return True if there are exceptions."""
137
+ return len(self.exceptions) > 0
138
+
139
+ @property
140
+ def task_status_logs(self) -> InterviewStatusLog:
141
+ """Return the task status logs for the interview.
142
+
143
+ The keys are the question names; the values are the lists of status log changes for each task.
144
+ """
145
+ for task_creator in self.task_creators.values():
146
+ self._task_status_log_dict[
147
+ task_creator.question.question_name
148
+ ] = task_creator.status_log
149
+ return self._task_status_log_dict
150
+
151
+ @property
152
+ def token_usage(self) -> InterviewTokenUsage:
153
+ """Determine how many tokens were used for the interview."""
154
+ return self.task_creators.token_usage
155
+
156
+ @property
157
+ def interview_status(self) -> InterviewStatusDictionary:
158
+ """Return a dictionary mapping task status codes to counts."""
159
+ return self.task_creators.interview_status
160
+
161
+ # region: Serialization
162
+ def to_dict(self, include_exceptions=True, add_edsl_version=True) -> dict[str, Any]:
163
+ """Return a dictionary representation of the Interview instance.
164
+ This is just for hashing purposes.
165
+
166
+ >>> i = Interview.example()
167
+ >>> hash(i)
168
+ 1217840301076717434
169
+ """
170
+ d = {
171
+ "agent": self.agent.to_dict(add_edsl_version=add_edsl_version),
172
+ "survey": self.survey.to_dict(add_edsl_version=add_edsl_version),
173
+ "scenario": self.scenario.to_dict(add_edsl_version=add_edsl_version),
174
+ "model": self.model.to_dict(add_edsl_version=add_edsl_version),
175
+ "iteration": self.iteration,
176
+ "exceptions": {},
177
+ }
178
+ if include_exceptions:
179
+ d["exceptions"] = self.exceptions.to_dict()
180
+ return d
181
+
182
+ @classmethod
183
+ def from_dict(cls, d: dict[str, Any]) -> "Interview":
184
+ """Return an Interview instance from a dictionary."""
185
+ agent = Agent.from_dict(d["agent"])
186
+ survey = Survey.from_dict(d["survey"])
187
+ scenario = Scenario.from_dict(d["scenario"])
188
+ model = LanguageModel.from_dict(d["model"])
189
+ iteration = d["iteration"]
190
+ interview = cls(
191
+ agent=agent,
192
+ survey=survey,
193
+ scenario=scenario,
194
+ model=model,
195
+ iteration=iteration,
196
+ )
197
+ if "exceptions" in d:
198
+ exceptions = InterviewExceptionCollection.from_dict(d["exceptions"])
199
+ interview.exceptions = exceptions
200
+ return interview
201
+
202
+ def __hash__(self) -> int:
203
+ from edsl.utilities.utilities import dict_hash
204
+
205
+ return dict_hash(self.to_dict(include_exceptions=False, add_edsl_version=False))
206
+
207
+ def __eq__(self, other: "Interview") -> bool:
208
+ """
209
+ >>> from edsl.jobs.interviews.Interview import Interview; i = Interview.example(); d = i.to_dict(); i2 = Interview.from_dict(d); i == i2
210
+ True
211
+ """
212
+ return hash(self) == hash(other)
213
+
214
+ # endregion
215
+
216
+ # region: Creating tasks
217
+ @property
218
+ def dag(self) -> "DAG":
219
+ """Return the directed acyclic graph for the survey.
220
+
221
+ The DAG, or directed acyclic graph, is a dictionary that maps question names to their dependencies.
222
+ It is used to determine the order in which questions should be answered.
223
+ This reflects both agent 'memory' considerations and 'skip' logic.
224
+ The 'textify' parameter is set to True, so that the question names are returned as strings rather than integer indices.
225
+
226
+ >>> i = Interview.example()
227
+ >>> i.dag == {'q2': {'q0'}, 'q1': {'q0'}}
228
+ True
229
+ """
230
+ return self.survey.dag(textify=True)
231
+
232
+ def _build_question_tasks(
233
+ self,
234
+ model_buckets: ModelBuckets,
235
+ ) -> list[asyncio.Task]:
236
+ """Create a task for each question, with dependencies on the questions that must be answered before this one can be answered.
237
+
238
+ :param debug: whether to use debug mode, in which case `InvigilatorDebug` is used.
239
+ :param model_buckets: the model buckets used to track and control usage rates.
240
+ """
241
+ tasks = []
242
+ for question in self.survey.questions:
243
+ tasks_that_must_be_completed_before = list(
244
+ self._get_tasks_that_must_be_completed_before(
245
+ tasks=tasks, question=question
246
+ )
247
+ )
248
+ question_task = self._create_question_task(
249
+ question=question,
250
+ tasks_that_must_be_completed_before=tasks_that_must_be_completed_before,
251
+ model_buckets=model_buckets,
252
+ iteration=self.iteration,
253
+ )
254
+ tasks.append(question_task)
255
+ return tuple(tasks)
256
+
257
+ def _get_tasks_that_must_be_completed_before(
258
+ self, *, tasks: list[asyncio.Task], question: "QuestionBase"
259
+ ) -> Generator[asyncio.Task, None, None]:
260
+ """Return the tasks that must be completed before the given question can be answered.
261
+
262
+ :param tasks: a list of tasks that have been created so far.
263
+ :param question: the question for which we are determining dependencies.
264
+
265
+ If a question has no dependencies, this will be an empty list, [].
266
+ """
267
+ parents_of_focal_question = self.dag.get(question.question_name, [])
268
+ for parent_question_name in parents_of_focal_question:
269
+ yield tasks[self.to_index[parent_question_name]]
270
+
271
+ def _create_question_task(
272
+ self,
273
+ *,
274
+ question: QuestionBase,
275
+ tasks_that_must_be_completed_before: list[asyncio.Task],
276
+ model_buckets: ModelBuckets,
277
+ iteration: int = 0,
278
+ ) -> asyncio.Task:
279
+ """Create a task that depends on the passed-in dependencies that are awaited before the task is run.
280
+
281
+ :param question: the question to be answered. This is the question we are creating a task for.
282
+ :param tasks_that_must_be_completed_before: the tasks that must be completed before the focal task is run.
283
+ :param model_buckets: the model buckets used to track and control usage rates.
284
+ :param debug: whether to use debug mode, in which case `InvigilatorDebug` is used.
285
+ :param iteration: the iteration number for the interview.
286
+
287
+ The task is created by a `QuestionTaskCreator`, which is responsible for creating the task and managing its dependencies.
288
+ It is passed a reference to the function that will be called to answer the question.
289
+ It is passed a list "tasks_that_must_be_completed_before" that are awaited before the task is run.
290
+ These are added as a dependency to the focal task.
291
+ """
292
+ task_creator = QuestionTaskCreator(
293
+ question=question,
294
+ answer_question_func=self._answer_question_and_record_task,
295
+ token_estimator=self._get_estimated_request_tokens,
296
+ model_buckets=model_buckets,
297
+ iteration=iteration,
298
+ )
299
+ for task in tasks_that_must_be_completed_before:
300
+ task_creator.add_dependency(task)
301
+
302
+ self.task_creators.update(
303
+ {question.question_name: task_creator}
304
+ ) # track this task creator
305
+ return task_creator.generate_task()
306
+
307
+ def _get_estimated_request_tokens(self, question) -> float:
308
+ """Estimate the number of tokens that will be required to run the focal task."""
309
+ from edsl.scenarios.FileStore import FileStore
310
+
311
+ invigilator = self._get_invigilator(question=question)
312
+ # TODO: There should be a way to get a more accurate estimate.
313
+ combined_text = ""
314
+ file_tokens = 0
315
+ for prompt in invigilator.get_prompts().values():
316
+ if hasattr(prompt, "text"):
317
+ combined_text += prompt.text
318
+ elif isinstance(prompt, str):
319
+ combined_text += prompt
320
+ elif isinstance(prompt, list):
321
+ for file in prompt:
322
+ if isinstance(file, FileStore):
323
+ file_tokens += file.size * 0.25
324
+ else:
325
+ raise ValueError(f"Prompt is of type {type(prompt)}")
326
+ return len(combined_text) / 4.0 + file_tokens
327
+
328
+ async def _answer_question_and_record_task(
329
+ self,
330
+ *,
331
+ question: "QuestionBase",
332
+ task=None,
333
+ ) -> "AgentResponseDict":
334
+ """Answer a question and records the task."""
335
+
336
+ had_language_model_no_response_error = False
337
+
338
+ @retry(
339
+ stop=stop_after_attempt(EDSL_MAX_ATTEMPTS),
340
+ wait=wait_exponential(
341
+ multiplier=EDSL_BACKOFF_START_SEC, max=EDSL_BACKOFF_MAX_SEC
342
+ ),
343
+ retry=retry_if_exception_type(LanguageModelNoResponseError),
344
+ reraise=True,
345
+ )
346
+ async def attempt_answer():
347
+ nonlocal had_language_model_no_response_error
348
+
349
+ invigilator = self._get_invigilator(question)
350
+
351
+ if self._skip_this_question(question):
352
+ return invigilator.get_failed_task_result(
353
+ failure_reason="Question skipped."
354
+ )
355
+
356
+ try:
357
+ response: EDSLResultObjectInput = (
358
+ await invigilator.async_answer_question()
359
+ )
360
+ if response.validated:
361
+ self.answers.add_answer(response=response, question=question)
362
+ self._cancel_skipped_questions(question)
363
+ else:
364
+ # When a question is not validated, it is not added to the answers.
365
+ # this should also cancel and dependent children questions.
366
+ # Is that happening now?
367
+ if (
368
+ hasattr(response, "exception_occurred")
369
+ and response.exception_occurred
370
+ ):
371
+ raise response.exception_occurred
372
+
373
+ except QuestionAnswerValidationError as e:
374
+ self._handle_exception(e, invigilator, task)
375
+ return invigilator.get_failed_task_result(
376
+ failure_reason="Question answer validation failed."
377
+ )
378
+
379
+ except asyncio.TimeoutError as e:
380
+ self._handle_exception(e, invigilator, task)
381
+ had_language_model_no_response_error = True
382
+ raise LanguageModelNoResponseError(
383
+ f"Language model timed out for question '{question.question_name}.'"
384
+ )
385
+
386
+ except Exception as e:
387
+ self._handle_exception(e, invigilator, task)
388
+
389
+ if "response" not in locals():
390
+ had_language_model_no_response_error = True
391
+ raise LanguageModelNoResponseError(
392
+ f"Language model did not return a response for question '{question.question_name}.'"
393
+ )
394
+
395
+ # if it gets here, it means the no response error was fixed
396
+ if (
397
+ question.question_name in self.exceptions
398
+ and had_language_model_no_response_error
399
+ ):
400
+ self.exceptions.record_fixed_question(question.question_name)
401
+
402
+ return response
403
+
404
+ try:
405
+ return await attempt_answer()
406
+ except RetryError as retry_error:
407
+ # All retries have failed for LanguageModelNoResponseError
408
+ original_error = retry_error.last_attempt.exception()
409
+ self._handle_exception(
410
+ original_error, self._get_invigilator(question), task
411
+ )
412
+ raise original_error # Re-raise the original error after handling
413
+
414
+ def _get_invigilator(self, question: QuestionBase) -> InvigilatorBase:
415
+ """Return an invigilator for the given question.
416
+
417
+ :param question: the question to be answered
418
+ :param debug: whether to use debug mode, in which case `InvigilatorDebug` is used.
419
+ """
420
+ invigilator = self.agent.create_invigilator(
421
+ question=question,
422
+ scenario=self.scenario,
423
+ model=self.model,
424
+ debug=False,
425
+ survey=self.survey,
426
+ memory_plan=self.survey.memory_plan,
427
+ current_answers=self.answers,
428
+ iteration=self.iteration,
429
+ cache=self.cache,
430
+ sidecar_model=self.sidecar_model,
431
+ raise_validation_errors=self.raise_validation_errors,
432
+ )
433
+ """Return an invigilator for the given question."""
434
+ return invigilator
435
+
436
+ def _skip_this_question(self, current_question: "QuestionBase") -> bool:
437
+ """Determine if the current question should be skipped.
438
+
439
+ :param current_question: the question to be answered.
440
+ """
441
+ current_question_index = self.to_index[current_question.question_name]
442
+
443
+ answers = self.answers | self.scenario | self.agent["traits"]
444
+ skip = self.survey.rule_collection.skip_question_before_running(
445
+ current_question_index, answers
446
+ )
447
+ return skip
448
+
449
+ def _handle_exception(
450
+ self, e: Exception, invigilator: "InvigilatorBase", task=None
451
+ ):
452
+ import copy
453
+
454
+ # breakpoint()
455
+
456
+ answers = copy.copy(self.answers)
457
+ exception_entry = InterviewExceptionEntry(
458
+ exception=e,
459
+ invigilator=invigilator,
460
+ answers=answers,
461
+ )
462
+ if task:
463
+ task.task_status = TaskStatus.FAILED
464
+ self.exceptions.add(invigilator.question.question_name, exception_entry)
465
+
466
+ if self.raise_validation_errors:
467
+ if isinstance(e, QuestionAnswerValidationError):
468
+ raise e
469
+
470
+ if hasattr(self, "stop_on_exception"):
471
+ stop_on_exception = self.stop_on_exception
472
+ else:
473
+ stop_on_exception = False
474
+
475
+ if stop_on_exception:
476
+ raise e
477
+
478
+ def _cancel_skipped_questions(self, current_question: QuestionBase) -> None:
479
+ """Cancel the tasks for questions that are skipped.
480
+
481
+ :param current_question: the question that was just answered.
482
+
483
+ It first determines the next question, given the current question and the current answers.
484
+ If the next question is the end of the survey, it cancels all remaining tasks.
485
+ If the next question is after the current question, it cancels all tasks between the current question and the next question.
486
+ """
487
+ current_question_index: int = self.to_index[current_question.question_name]
488
+
489
+ next_question: Union[
490
+ int, EndOfSurvey
491
+ ] = self.survey.rule_collection.next_question(
492
+ q_now=current_question_index,
493
+ answers=self.answers | self.scenario | self.agent["traits"],
494
+ )
495
+
496
+ next_question_index = next_question.next_q
497
+
498
+ def cancel_between(start, end):
499
+ """Cancel the tasks between the start and end indices."""
500
+ for i in range(start, end):
501
+ self.tasks[i].cancel()
502
+
503
+ if next_question_index == EndOfSurvey:
504
+ cancel_between(current_question_index + 1, len(self.survey.questions))
505
+ return
506
+
507
+ if next_question_index > (current_question_index + 1):
508
+ cancel_between(current_question_index + 1, next_question_index)
509
+
510
+ # endregion
511
+
512
+ # region: Conducting the interview
513
+ async def async_conduct_interview(
514
+ self,
515
+ model_buckets: Optional[ModelBuckets] = None,
516
+ stop_on_exception: bool = False,
517
+ sidecar_model: Optional["LanguageModel"] = None,
518
+ raise_validation_errors: bool = True,
519
+ ) -> tuple["Answers", List[dict[str, Any]]]:
520
+ """
521
+ Conduct an Interview asynchronously.
522
+ It returns a tuple with the answers and a list of valid results.
523
+
524
+ :param model_buckets: a dictionary of token buckets for the model.
525
+ :param debug: run without calls to LLM.
526
+ :param stop_on_exception: if True, stops the interview if an exception is raised.
527
+ :param sidecar_model: a sidecar model used to answer questions.
528
+
529
+ Example usage:
530
+
531
+ >>> i = Interview.example()
532
+ >>> result, _ = asyncio.run(i.async_conduct_interview())
533
+ >>> result['q0']
534
+ 'yes'
535
+
536
+ >>> i = Interview.example(throw_exception = True)
537
+ >>> result, _ = asyncio.run(i.async_conduct_interview())
538
+ >>> i.exceptions
539
+ {'q0': ...
540
+ >>> i = Interview.example()
541
+ >>> result, _ = asyncio.run(i.async_conduct_interview(stop_on_exception = True))
542
+ Traceback (most recent call last):
543
+ ...
544
+ asyncio.exceptions.CancelledError
545
+ """
546
+ self.sidecar_model = sidecar_model
547
+ self.stop_on_exception = stop_on_exception
548
+
549
+ # if no model bucket is passed, create an 'infinity' bucket with no rate limits
550
+ if model_buckets is None or hasattr(self.agent, "answer_question_directly"):
551
+ model_buckets = ModelBuckets.infinity_bucket()
552
+
553
+ ## This is the key part---it creates a task for each question,
554
+ ## with dependencies on the questions that must be answered before this one can be answered.
555
+ self.tasks = self._build_question_tasks(model_buckets=model_buckets)
556
+
557
+ ## 'Invigilators' are used to administer the survey
558
+ self.invigilators = [
559
+ self._get_invigilator(question) for question in self.survey.questions
560
+ ]
561
+ await asyncio.gather(
562
+ *self.tasks, return_exceptions=not stop_on_exception
563
+ ) # not stop_on_exception)
564
+ self.answers.replace_missing_answers_with_none(self.survey)
565
+ valid_results = list(self._extract_valid_results())
566
+ return self.answers, valid_results
567
+
568
+ # endregion
569
+
570
+ # region: Extracting results and recording errors
571
+ def _extract_valid_results(self) -> Generator["Answers", None, None]:
572
+ """Extract the valid results from the list of results.
573
+
574
+ It iterates through the tasks and invigilators, and yields the results of the tasks that are done.
575
+ If a task is not done, it raises a ValueError.
576
+ If an exception is raised in the task, it records the exception in the Interview instance except if the task was cancelled, which is expected behavior.
577
+
578
+ >>> i = Interview.example()
579
+ >>> result, _ = asyncio.run(i.async_conduct_interview())
580
+ >>> results = list(i._extract_valid_results())
581
+ >>> len(results) == len(i.survey)
582
+ True
583
+ """
584
+ assert len(self.tasks) == len(self.invigilators)
585
+
586
+ for task, invigilator in zip(self.tasks, self.invigilators):
587
+ if not task.done():
588
+ raise ValueError(f"Task {task.get_name()} is not done.")
589
+
590
+ try:
591
+ result = task.result()
592
+ except asyncio.CancelledError as e: # task was cancelled
593
+ result = invigilator.get_failed_task_result(
594
+ failure_reason="Task was cancelled."
595
+ )
596
+ except Exception as e: # any other kind of exception in the task
597
+ result = invigilator.get_failed_task_result(
598
+ failure_reason=f"Task failed with exception: {str(e)}."
599
+ )
600
+ exception_entry = InterviewExceptionEntry(
601
+ exception=e,
602
+ invigilator=invigilator,
603
+ )
604
+ self.exceptions.add(task.get_name(), exception_entry)
605
+
606
+ yield result
607
+
608
+ # endregion
609
+
610
+ # region: Magic methods
611
+ def __repr__(self) -> str:
612
+ """Return a string representation of the Interview instance."""
613
+ return f"Interview(agent = {repr(self.agent)}, survey = {repr(self.survey)}, scenario = {repr(self.scenario)}, model = {repr(self.model)})"
614
+
615
+ def duplicate(self, iteration: int, cache: "Cache") -> Interview:
616
+ """Duplicate the interview, but with a new iteration number and cache.
617
+
618
+ >>> i = Interview.example()
619
+ >>> i2 = i.duplicate(1, None)
620
+ >>> i.iteration + 1 == i2.iteration
621
+ True
622
+
623
+ """
624
+ return Interview(
625
+ agent=self.agent,
626
+ survey=self.survey,
627
+ scenario=self.scenario,
628
+ model=self.model,
629
+ iteration=iteration,
630
+ cache=cache,
631
+ skip_retry=self.skip_retry,
632
+ )
633
+
634
+ @classmethod
635
+ def example(self, throw_exception: bool = False) -> Interview:
636
+ """Return an example Interview instance."""
637
+ from edsl.agents import Agent
638
+ from edsl.surveys import Survey
639
+ from edsl.scenarios import Scenario
640
+ from edsl.language_models import LanguageModel
641
+
642
+ def f(self, question, scenario):
643
+ return "yes"
644
+
645
+ agent = Agent.example()
646
+ agent.add_direct_question_answering_method(f)
647
+ survey = Survey.example()
648
+ scenario = Scenario.example()
649
+ model = LanguageModel.example()
650
+ if throw_exception:
651
+ model = LanguageModel.example(test_model=True, throw_exception=True)
652
+ agent = Agent.example()
653
+ return Interview(agent=agent, survey=survey, scenario=scenario, model=model)
654
+ return Interview(agent=agent, survey=survey, scenario=scenario, model=model)
655
+
656
+
657
+ if __name__ == "__main__":
658
+ import doctest
659
+
660
+ # add ellipsis
661
+ doctest.testmod(optionflags=doctest.ELLIPSIS)