edsl 0.1.37.dev3__py3-none-any.whl → 0.1.37.dev5__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 (261) hide show
  1. edsl/Base.py +303 -303
  2. edsl/BaseDiff.py +260 -260
  3. edsl/TemplateLoader.py +24 -24
  4. edsl/__init__.py +48 -48
  5. edsl/__version__.py +1 -1
  6. edsl/agents/Agent.py +855 -804
  7. edsl/agents/AgentList.py +350 -345
  8. edsl/agents/Invigilator.py +222 -222
  9. edsl/agents/InvigilatorBase.py +284 -305
  10. edsl/agents/PromptConstructor.py +353 -312
  11. edsl/agents/__init__.py +3 -3
  12. edsl/agents/descriptors.py +99 -86
  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 +289 -289
  26. edsl/config.py +149 -149
  27. edsl/conjure/AgentConstructionMixin.py +160 -152
  28. edsl/conjure/Conjure.py +62 -62
  29. edsl/conjure/InputData.py +659 -659
  30. edsl/conjure/InputDataCSV.py +48 -48
  31. edsl/conjure/InputDataMixinQuestionStats.py +182 -182
  32. edsl/conjure/InputDataPyRead.py +91 -91
  33. edsl/conjure/InputDataSPSS.py +8 -8
  34. edsl/conjure/InputDataStata.py +8 -8
  35. edsl/conjure/QuestionOptionMixin.py +76 -76
  36. edsl/conjure/QuestionTypeMixin.py +23 -23
  37. edsl/conjure/RawQuestion.py +65 -65
  38. edsl/conjure/SurveyResponses.py +7 -7
  39. edsl/conjure/__init__.py +9 -9
  40. edsl/conjure/naming_utilities.py +263 -263
  41. edsl/conjure/utilities.py +201 -201
  42. edsl/conversation/Conversation.py +290 -238
  43. edsl/conversation/car_buying.py +58 -58
  44. edsl/conversation/chips.py +95 -0
  45. edsl/conversation/mug_negotiation.py +81 -81
  46. edsl/conversation/next_speaker_utilities.py +93 -93
  47. edsl/coop/PriceFetcher.py +54 -54
  48. edsl/coop/__init__.py +2 -2
  49. edsl/coop/coop.py +958 -824
  50. edsl/coop/utils.py +131 -131
  51. edsl/data/Cache.py +527 -527
  52. edsl/data/CacheEntry.py +228 -228
  53. edsl/data/CacheHandler.py +149 -149
  54. edsl/data/RemoteCacheSync.py +97 -97
  55. edsl/data/SQLiteDict.py +292 -292
  56. edsl/data/__init__.py +4 -4
  57. edsl/data/orm.py +10 -10
  58. edsl/data_transfer_models.py +73 -73
  59. edsl/enums.py +173 -173
  60. edsl/exceptions/BaseException.py +21 -0
  61. edsl/exceptions/__init__.py +54 -50
  62. edsl/exceptions/agents.py +38 -40
  63. edsl/exceptions/configuration.py +16 -16
  64. edsl/exceptions/coop.py +10 -10
  65. edsl/exceptions/data.py +14 -14
  66. edsl/exceptions/general.py +34 -34
  67. edsl/exceptions/jobs.py +33 -33
  68. edsl/exceptions/language_models.py +63 -63
  69. edsl/exceptions/prompts.py +15 -15
  70. edsl/exceptions/questions.py +91 -91
  71. edsl/exceptions/results.py +29 -26
  72. edsl/exceptions/scenarios.py +22 -0
  73. edsl/exceptions/surveys.py +37 -34
  74. edsl/inference_services/AnthropicService.py +87 -87
  75. edsl/inference_services/AwsBedrock.py +120 -115
  76. edsl/inference_services/AzureAI.py +217 -217
  77. edsl/inference_services/DeepInfraService.py +18 -18
  78. edsl/inference_services/GoogleService.py +156 -156
  79. edsl/inference_services/GroqService.py +20 -20
  80. edsl/inference_services/InferenceServiceABC.py +147 -147
  81. edsl/inference_services/InferenceServicesCollection.py +97 -74
  82. edsl/inference_services/MistralAIService.py +123 -123
  83. edsl/inference_services/OllamaService.py +18 -18
  84. edsl/inference_services/OpenAIService.py +224 -224
  85. edsl/inference_services/TestService.py +89 -89
  86. edsl/inference_services/TogetherAIService.py +170 -170
  87. edsl/inference_services/models_available_cache.py +118 -118
  88. edsl/inference_services/rate_limits_cache.py +25 -25
  89. edsl/inference_services/registry.py +39 -39
  90. edsl/inference_services/write_available.py +10 -10
  91. edsl/jobs/Answers.py +56 -56
  92. edsl/jobs/Jobs.py +1347 -1121
  93. edsl/jobs/__init__.py +1 -1
  94. edsl/jobs/buckets/BucketCollection.py +63 -63
  95. edsl/jobs/buckets/ModelBuckets.py +65 -65
  96. edsl/jobs/buckets/TokenBucket.py +248 -248
  97. edsl/jobs/interviews/Interview.py +661 -661
  98. edsl/jobs/interviews/InterviewExceptionCollection.py +99 -99
  99. edsl/jobs/interviews/InterviewExceptionEntry.py +186 -182
  100. edsl/jobs/interviews/InterviewStatistic.py +63 -63
  101. edsl/jobs/interviews/InterviewStatisticsCollection.py +25 -25
  102. edsl/jobs/interviews/InterviewStatusDictionary.py +78 -78
  103. edsl/jobs/interviews/InterviewStatusLog.py +92 -92
  104. edsl/jobs/interviews/ReportErrors.py +66 -66
  105. edsl/jobs/interviews/interview_status_enum.py +9 -9
  106. edsl/jobs/runners/JobsRunnerAsyncio.py +338 -338
  107. edsl/jobs/runners/JobsRunnerStatus.py +332 -332
  108. edsl/jobs/tasks/QuestionTaskCreator.py +242 -242
  109. edsl/jobs/tasks/TaskCreators.py +64 -64
  110. edsl/jobs/tasks/TaskHistory.py +442 -441
  111. edsl/jobs/tasks/TaskStatusLog.py +23 -23
  112. edsl/jobs/tasks/task_status_enum.py +163 -163
  113. edsl/jobs/tokens/InterviewTokenUsage.py +27 -27
  114. edsl/jobs/tokens/TokenUsage.py +34 -34
  115. edsl/language_models/KeyLookup.py +30 -0
  116. edsl/language_models/LanguageModel.py +706 -718
  117. edsl/language_models/ModelList.py +102 -102
  118. edsl/language_models/RegisterLanguageModelsMeta.py +184 -184
  119. edsl/language_models/__init__.py +3 -2
  120. edsl/language_models/fake_openai_call.py +15 -15
  121. edsl/language_models/fake_openai_service.py +61 -61
  122. edsl/language_models/registry.py +137 -137
  123. edsl/language_models/repair.py +156 -156
  124. edsl/language_models/unused/ReplicateBase.py +83 -83
  125. edsl/language_models/utilities.py +64 -64
  126. edsl/notebooks/Notebook.py +259 -259
  127. edsl/notebooks/__init__.py +1 -1
  128. edsl/prompts/Prompt.py +357 -353
  129. edsl/prompts/__init__.py +2 -2
  130. edsl/questions/AnswerValidatorMixin.py +289 -289
  131. edsl/questions/QuestionBase.py +656 -616
  132. edsl/questions/QuestionBaseGenMixin.py +161 -161
  133. edsl/questions/QuestionBasePromptsMixin.py +234 -266
  134. edsl/questions/QuestionBudget.py +227 -227
  135. edsl/questions/QuestionCheckBox.py +359 -359
  136. edsl/questions/QuestionExtract.py +183 -183
  137. edsl/questions/QuestionFreeText.py +114 -114
  138. edsl/questions/QuestionFunctional.py +159 -159
  139. edsl/questions/QuestionList.py +231 -231
  140. edsl/questions/QuestionMultipleChoice.py +286 -286
  141. edsl/questions/QuestionNumerical.py +153 -153
  142. edsl/questions/QuestionRank.py +324 -324
  143. edsl/questions/Quick.py +41 -41
  144. edsl/questions/RegisterQuestionsMeta.py +71 -71
  145. edsl/questions/ResponseValidatorABC.py +174 -174
  146. edsl/questions/SimpleAskMixin.py +73 -73
  147. edsl/questions/__init__.py +26 -26
  148. edsl/questions/compose_questions.py +98 -98
  149. edsl/questions/decorators.py +21 -21
  150. edsl/questions/derived/QuestionLikertFive.py +76 -76
  151. edsl/questions/derived/QuestionLinearScale.py +87 -87
  152. edsl/questions/derived/QuestionTopK.py +91 -91
  153. edsl/questions/derived/QuestionYesNo.py +82 -82
  154. edsl/questions/descriptors.py +413 -418
  155. edsl/questions/prompt_templates/question_budget.jinja +13 -13
  156. edsl/questions/prompt_templates/question_checkbox.jinja +32 -32
  157. edsl/questions/prompt_templates/question_extract.jinja +11 -11
  158. edsl/questions/prompt_templates/question_free_text.jinja +3 -3
  159. edsl/questions/prompt_templates/question_linear_scale.jinja +11 -11
  160. edsl/questions/prompt_templates/question_list.jinja +17 -17
  161. edsl/questions/prompt_templates/question_multiple_choice.jinja +33 -33
  162. edsl/questions/prompt_templates/question_numerical.jinja +36 -36
  163. edsl/questions/question_registry.py +147 -147
  164. edsl/questions/settings.py +12 -12
  165. edsl/questions/templates/budget/answering_instructions.jinja +7 -7
  166. edsl/questions/templates/budget/question_presentation.jinja +7 -7
  167. edsl/questions/templates/checkbox/answering_instructions.jinja +10 -10
  168. edsl/questions/templates/checkbox/question_presentation.jinja +22 -22
  169. edsl/questions/templates/extract/answering_instructions.jinja +7 -7
  170. edsl/questions/templates/likert_five/answering_instructions.jinja +10 -10
  171. edsl/questions/templates/likert_five/question_presentation.jinja +11 -11
  172. edsl/questions/templates/linear_scale/answering_instructions.jinja +5 -5
  173. edsl/questions/templates/linear_scale/question_presentation.jinja +5 -5
  174. edsl/questions/templates/list/answering_instructions.jinja +3 -3
  175. edsl/questions/templates/list/question_presentation.jinja +5 -5
  176. edsl/questions/templates/multiple_choice/answering_instructions.jinja +9 -9
  177. edsl/questions/templates/multiple_choice/question_presentation.jinja +11 -11
  178. edsl/questions/templates/numerical/answering_instructions.jinja +6 -6
  179. edsl/questions/templates/numerical/question_presentation.jinja +6 -6
  180. edsl/questions/templates/rank/answering_instructions.jinja +11 -11
  181. edsl/questions/templates/rank/question_presentation.jinja +15 -15
  182. edsl/questions/templates/top_k/answering_instructions.jinja +8 -8
  183. edsl/questions/templates/top_k/question_presentation.jinja +22 -22
  184. edsl/questions/templates/yes_no/answering_instructions.jinja +6 -6
  185. edsl/questions/templates/yes_no/question_presentation.jinja +11 -11
  186. edsl/results/Dataset.py +293 -293
  187. edsl/results/DatasetExportMixin.py +717 -693
  188. edsl/results/DatasetTree.py +145 -145
  189. edsl/results/Result.py +450 -435
  190. edsl/results/Results.py +1071 -1160
  191. edsl/results/ResultsDBMixin.py +238 -238
  192. edsl/results/ResultsExportMixin.py +43 -43
  193. edsl/results/ResultsFetchMixin.py +33 -33
  194. edsl/results/ResultsGGMixin.py +121 -121
  195. edsl/results/ResultsToolsMixin.py +98 -98
  196. edsl/results/Selector.py +135 -118
  197. edsl/results/__init__.py +2 -2
  198. edsl/results/tree_explore.py +115 -115
  199. edsl/scenarios/FileStore.py +458 -458
  200. edsl/scenarios/Scenario.py +546 -510
  201. edsl/scenarios/ScenarioHtmlMixin.py +64 -59
  202. edsl/scenarios/ScenarioList.py +1112 -1101
  203. edsl/scenarios/ScenarioListExportMixin.py +52 -52
  204. edsl/scenarios/ScenarioListPdfMixin.py +261 -261
  205. edsl/scenarios/__init__.py +4 -4
  206. edsl/shared.py +1 -1
  207. edsl/study/ObjectEntry.py +173 -173
  208. edsl/study/ProofOfWork.py +113 -113
  209. edsl/study/SnapShot.py +80 -80
  210. edsl/study/Study.py +528 -528
  211. edsl/study/__init__.py +4 -4
  212. edsl/surveys/DAG.py +148 -148
  213. edsl/surveys/Memory.py +31 -31
  214. edsl/surveys/MemoryPlan.py +244 -244
  215. edsl/surveys/Rule.py +330 -324
  216. edsl/surveys/RuleCollection.py +387 -387
  217. edsl/surveys/Survey.py +1795 -1772
  218. edsl/surveys/SurveyCSS.py +261 -261
  219. edsl/surveys/SurveyExportMixin.py +259 -259
  220. edsl/surveys/SurveyFlowVisualizationMixin.py +121 -121
  221. edsl/surveys/SurveyQualtricsImport.py +284 -284
  222. edsl/surveys/__init__.py +3 -3
  223. edsl/surveys/base.py +53 -53
  224. edsl/surveys/descriptors.py +56 -56
  225. edsl/surveys/instructions/ChangeInstruction.py +47 -47
  226. edsl/surveys/instructions/Instruction.py +51 -51
  227. edsl/surveys/instructions/InstructionCollection.py +77 -77
  228. edsl/templates/error_reporting/base.html +23 -23
  229. edsl/templates/error_reporting/exceptions_by_model.html +34 -34
  230. edsl/templates/error_reporting/exceptions_by_question_name.html +16 -16
  231. edsl/templates/error_reporting/exceptions_by_type.html +16 -16
  232. edsl/templates/error_reporting/interview_details.html +115 -115
  233. edsl/templates/error_reporting/interviews.html +9 -9
  234. edsl/templates/error_reporting/overview.html +4 -4
  235. edsl/templates/error_reporting/performance_plot.html +1 -1
  236. edsl/templates/error_reporting/report.css +73 -73
  237. edsl/templates/error_reporting/report.html +117 -117
  238. edsl/templates/error_reporting/report.js +25 -25
  239. edsl/tools/__init__.py +1 -1
  240. edsl/tools/clusters.py +192 -192
  241. edsl/tools/embeddings.py +27 -27
  242. edsl/tools/embeddings_plotting.py +118 -118
  243. edsl/tools/plotting.py +112 -112
  244. edsl/tools/summarize.py +18 -18
  245. edsl/utilities/SystemInfo.py +28 -28
  246. edsl/utilities/__init__.py +22 -22
  247. edsl/utilities/ast_utilities.py +25 -25
  248. edsl/utilities/data/Registry.py +6 -6
  249. edsl/utilities/data/__init__.py +1 -1
  250. edsl/utilities/data/scooter_results.json +1 -1
  251. edsl/utilities/decorators.py +77 -77
  252. edsl/utilities/gcp_bucket/cloud_storage.py +96 -96
  253. edsl/utilities/interface.py +627 -627
  254. edsl/utilities/repair_functions.py +28 -28
  255. edsl/utilities/restricted_python.py +70 -70
  256. edsl/utilities/utilities.py +409 -391
  257. {edsl-0.1.37.dev3.dist-info → edsl-0.1.37.dev5.dist-info}/LICENSE +21 -21
  258. {edsl-0.1.37.dev3.dist-info → edsl-0.1.37.dev5.dist-info}/METADATA +1 -1
  259. edsl-0.1.37.dev5.dist-info/RECORD +283 -0
  260. edsl-0.1.37.dev3.dist-info/RECORD +0 -279
  261. {edsl-0.1.37.dev3.dist-info → edsl-0.1.37.dev5.dist-info}/WHEEL +0 -0
@@ -1,217 +1,217 @@
1
- import os
2
- from typing import Any, Optional, List
3
- import re
4
- from openai import AsyncAzureOpenAI
5
- from edsl.inference_services.InferenceServiceABC import InferenceServiceABC
6
- from edsl.language_models.LanguageModel import LanguageModel
7
-
8
- from azure.ai.inference.aio import ChatCompletionsClient
9
- from azure.core.credentials import AzureKeyCredential
10
- from azure.ai.inference.models import SystemMessage, UserMessage
11
- import asyncio
12
- import json
13
- from edsl.utilities.utilities import fix_partial_correct_response
14
-
15
-
16
- def json_handle_none(value: Any) -> Any:
17
- """
18
- Handle None values during JSON serialization.
19
- - Return "null" if the value is None. Otherwise, don't return anything.
20
- """
21
- if value is None:
22
- return "null"
23
-
24
-
25
- class AzureAIService(InferenceServiceABC):
26
- """Azure AI service class."""
27
-
28
- # key_sequence = ["content", 0, "text"] # ["content"][0]["text"]
29
- key_sequence = ["choices", 0, "message", "content"]
30
- usage_sequence = ["usage"]
31
- input_token_name = "prompt_tokens"
32
- output_token_name = "completion_tokens"
33
-
34
- _inference_service_ = "azure"
35
- _env_key_name_ = (
36
- "AZURE_ENDPOINT_URL_AND_KEY" # Environment variable for Azure API key
37
- )
38
- _model_id_to_endpoint_and_key = {}
39
- model_exclude_list = [
40
- "Cohere-command-r-plus-xncmg",
41
- "Mistral-Nemo-klfsi",
42
- "Mistral-large-2407-ojfld",
43
- ]
44
-
45
- @classmethod
46
- def available(cls):
47
- out = []
48
- azure_endpoints = os.getenv("AZURE_ENDPOINT_URL_AND_KEY", None)
49
- if not azure_endpoints:
50
- raise EnvironmentError(f"AZURE_ENDPOINT_URL_AND_KEY is not defined")
51
- azure_endpoints = azure_endpoints.split(",")
52
- for data in azure_endpoints:
53
- try:
54
- # data has this format for non openai models https://model_id.azure_endpoint:azure_key
55
- _, endpoint, azure_endpoint_key = data.split(":")
56
- if "openai" not in endpoint:
57
- model_id = endpoint.split(".")[0].replace("/", "")
58
- out.append(model_id)
59
- cls._model_id_to_endpoint_and_key[model_id] = {
60
- "endpoint": f"https:{endpoint}",
61
- "azure_endpoint_key": azure_endpoint_key,
62
- }
63
- else:
64
- # data has this format for openai models ,https://azure_project_id.openai.azure.com/openai/deployments/gpt-4o-mini/chat/completions?api-version=2023-03-15-preview:azure_key
65
- if "/deployments/" in endpoint:
66
- start_idx = endpoint.index("/deployments/") + len(
67
- "/deployments/"
68
- )
69
- end_idx = (
70
- endpoint.index("/", start_idx)
71
- if "/" in endpoint[start_idx:]
72
- else len(endpoint)
73
- )
74
- model_id = endpoint[start_idx:end_idx]
75
- api_version_value = None
76
- if "api-version=" in endpoint:
77
- start_idx = endpoint.index("api-version=") + len(
78
- "api-version="
79
- )
80
- end_idx = (
81
- endpoint.index("&", start_idx)
82
- if "&" in endpoint[start_idx:]
83
- else len(endpoint)
84
- )
85
- api_version_value = endpoint[start_idx:end_idx]
86
-
87
- cls._model_id_to_endpoint_and_key[f"azure:{model_id}"] = {
88
- "endpoint": f"https:{endpoint}",
89
- "azure_endpoint_key": azure_endpoint_key,
90
- "api_version": api_version_value,
91
- }
92
- out.append(f"azure:{model_id}")
93
-
94
- except Exception as e:
95
- raise e
96
- return [m for m in out if m not in cls.model_exclude_list]
97
-
98
- @classmethod
99
- def create_model(
100
- cls, model_name: str = "azureai", model_class_name=None
101
- ) -> LanguageModel:
102
- if model_class_name is None:
103
- model_class_name = cls.to_class_name(model_name)
104
-
105
- class LLM(LanguageModel):
106
- """
107
- Child class of LanguageModel for interacting with Azure OpenAI models.
108
- """
109
-
110
- key_sequence = cls.key_sequence
111
- usage_sequence = cls.usage_sequence
112
- input_token_name = cls.input_token_name
113
- output_token_name = cls.output_token_name
114
- _inference_service_ = cls._inference_service_
115
- _model_ = model_name
116
- _parameters_ = {
117
- "temperature": 0.5,
118
- "max_tokens": 512,
119
- "top_p": 0.9,
120
- }
121
- _rpm = cls.get_rpm(cls)
122
- _tpm = cls.get_tpm(cls)
123
-
124
- async def async_execute_model_call(
125
- self,
126
- user_prompt: str,
127
- system_prompt: str = "",
128
- files_list: Optional[List["FileStore"]] = None,
129
- ) -> dict[str, Any]:
130
- """Calls the Azure OpenAI API and returns the API response."""
131
-
132
- try:
133
- api_key = cls._model_id_to_endpoint_and_key[model_name][
134
- "azure_endpoint_key"
135
- ]
136
- except:
137
- api_key = None
138
-
139
- if not api_key:
140
- raise EnvironmentError(
141
- f"AZURE_ENDPOINT_URL_AND_KEY doesn't have the endpoint:key pair for your model: {model_name}"
142
- )
143
-
144
- try:
145
- endpoint = cls._model_id_to_endpoint_and_key[model_name]["endpoint"]
146
- except:
147
- endpoint = None
148
-
149
- if not endpoint:
150
- raise EnvironmentError(
151
- f"AZURE_ENDPOINT_URL_AND_KEY doesn't have the endpoint:key pair for your model: {model_name}"
152
- )
153
-
154
- if "openai" not in endpoint:
155
- client = ChatCompletionsClient(
156
- endpoint=endpoint,
157
- credential=AzureKeyCredential(api_key),
158
- temperature=self.temperature,
159
- top_p=self.top_p,
160
- max_tokens=self.max_tokens,
161
- )
162
- try:
163
- response = await client.complete(
164
- messages=[
165
- SystemMessage(content=system_prompt),
166
- UserMessage(content=user_prompt),
167
- ],
168
- # model_extras={"safe_mode": True},
169
- )
170
- await client.close()
171
- return response.as_dict()
172
- except Exception as e:
173
- await client.close()
174
- return {"error": str(e)}
175
- else:
176
- api_version = cls._model_id_to_endpoint_and_key[model_name][
177
- "api_version"
178
- ]
179
- client = AsyncAzureOpenAI(
180
- azure_endpoint=endpoint,
181
- api_version=api_version,
182
- api_key=api_key,
183
- )
184
- response = await client.chat.completions.create(
185
- model=model_name,
186
- messages=[
187
- {
188
- "role": "user",
189
- "content": user_prompt, # Your question can go here
190
- },
191
- ],
192
- )
193
- return response.model_dump()
194
-
195
- # @staticmethod
196
- # def parse_response(raw_response: dict[str, Any]) -> str:
197
- # """Parses the API response and returns the response text."""
198
- # if (
199
- # raw_response
200
- # and "choices" in raw_response
201
- # and raw_response["choices"]
202
- # ):
203
- # response = raw_response["choices"][0]["message"]["content"]
204
- # pattern = r"^```json(?:\\n|\n)(.+?)(?:\\n|\n)```$"
205
- # match = re.match(pattern, response, re.DOTALL)
206
- # if match:
207
- # return match.group(1)
208
- # else:
209
- # out = fix_partial_correct_response(response)
210
- # if "error" not in out:
211
- # response = out["extracted_json"]
212
- # return response
213
- # return "Error parsing response"
214
-
215
- LLM.__name__ = model_class_name
216
-
217
- return LLM
1
+ import os
2
+ from typing import Any, Optional, List
3
+ import re
4
+ from openai import AsyncAzureOpenAI
5
+ from edsl.inference_services.InferenceServiceABC import InferenceServiceABC
6
+ from edsl.language_models.LanguageModel import LanguageModel
7
+
8
+ from azure.ai.inference.aio import ChatCompletionsClient
9
+ from azure.core.credentials import AzureKeyCredential
10
+ from azure.ai.inference.models import SystemMessage, UserMessage
11
+ import asyncio
12
+ import json
13
+ from edsl.utilities.utilities import fix_partial_correct_response
14
+
15
+
16
+ def json_handle_none(value: Any) -> Any:
17
+ """
18
+ Handle None values during JSON serialization.
19
+ - Return "null" if the value is None. Otherwise, don't return anything.
20
+ """
21
+ if value is None:
22
+ return "null"
23
+
24
+
25
+ class AzureAIService(InferenceServiceABC):
26
+ """Azure AI service class."""
27
+
28
+ # key_sequence = ["content", 0, "text"] # ["content"][0]["text"]
29
+ key_sequence = ["choices", 0, "message", "content"]
30
+ usage_sequence = ["usage"]
31
+ input_token_name = "prompt_tokens"
32
+ output_token_name = "completion_tokens"
33
+
34
+ _inference_service_ = "azure"
35
+ _env_key_name_ = (
36
+ "AZURE_ENDPOINT_URL_AND_KEY" # Environment variable for Azure API key
37
+ )
38
+ _model_id_to_endpoint_and_key = {}
39
+ model_exclude_list = [
40
+ "Cohere-command-r-plus-xncmg",
41
+ "Mistral-Nemo-klfsi",
42
+ "Mistral-large-2407-ojfld",
43
+ ]
44
+
45
+ @classmethod
46
+ def available(cls):
47
+ out = []
48
+ azure_endpoints = os.getenv("AZURE_ENDPOINT_URL_AND_KEY", None)
49
+ if not azure_endpoints:
50
+ raise EnvironmentError(f"AZURE_ENDPOINT_URL_AND_KEY is not defined")
51
+ azure_endpoints = azure_endpoints.split(",")
52
+ for data in azure_endpoints:
53
+ try:
54
+ # data has this format for non openai models https://model_id.azure_endpoint:azure_key
55
+ _, endpoint, azure_endpoint_key = data.split(":")
56
+ if "openai" not in endpoint:
57
+ model_id = endpoint.split(".")[0].replace("/", "")
58
+ out.append(model_id)
59
+ cls._model_id_to_endpoint_and_key[model_id] = {
60
+ "endpoint": f"https:{endpoint}",
61
+ "azure_endpoint_key": azure_endpoint_key,
62
+ }
63
+ else:
64
+ # data has this format for openai models ,https://azure_project_id.openai.azure.com/openai/deployments/gpt-4o-mini/chat/completions?api-version=2023-03-15-preview:azure_key
65
+ if "/deployments/" in endpoint:
66
+ start_idx = endpoint.index("/deployments/") + len(
67
+ "/deployments/"
68
+ )
69
+ end_idx = (
70
+ endpoint.index("/", start_idx)
71
+ if "/" in endpoint[start_idx:]
72
+ else len(endpoint)
73
+ )
74
+ model_id = endpoint[start_idx:end_idx]
75
+ api_version_value = None
76
+ if "api-version=" in endpoint:
77
+ start_idx = endpoint.index("api-version=") + len(
78
+ "api-version="
79
+ )
80
+ end_idx = (
81
+ endpoint.index("&", start_idx)
82
+ if "&" in endpoint[start_idx:]
83
+ else len(endpoint)
84
+ )
85
+ api_version_value = endpoint[start_idx:end_idx]
86
+
87
+ cls._model_id_to_endpoint_and_key[f"azure:{model_id}"] = {
88
+ "endpoint": f"https:{endpoint}",
89
+ "azure_endpoint_key": azure_endpoint_key,
90
+ "api_version": api_version_value,
91
+ }
92
+ out.append(f"azure:{model_id}")
93
+
94
+ except Exception as e:
95
+ raise e
96
+ return [m for m in out if m not in cls.model_exclude_list]
97
+
98
+ @classmethod
99
+ def create_model(
100
+ cls, model_name: str = "azureai", model_class_name=None
101
+ ) -> LanguageModel:
102
+ if model_class_name is None:
103
+ model_class_name = cls.to_class_name(model_name)
104
+
105
+ class LLM(LanguageModel):
106
+ """
107
+ Child class of LanguageModel for interacting with Azure OpenAI models.
108
+ """
109
+
110
+ key_sequence = cls.key_sequence
111
+ usage_sequence = cls.usage_sequence
112
+ input_token_name = cls.input_token_name
113
+ output_token_name = cls.output_token_name
114
+ _inference_service_ = cls._inference_service_
115
+ _model_ = model_name
116
+ _parameters_ = {
117
+ "temperature": 0.5,
118
+ "max_tokens": 512,
119
+ "top_p": 0.9,
120
+ }
121
+ _rpm = cls.get_rpm(cls)
122
+ _tpm = cls.get_tpm(cls)
123
+
124
+ async def async_execute_model_call(
125
+ self,
126
+ user_prompt: str,
127
+ system_prompt: str = "",
128
+ files_list: Optional[List["FileStore"]] = None,
129
+ ) -> dict[str, Any]:
130
+ """Calls the Azure OpenAI API and returns the API response."""
131
+
132
+ try:
133
+ api_key = cls._model_id_to_endpoint_and_key[model_name][
134
+ "azure_endpoint_key"
135
+ ]
136
+ except:
137
+ api_key = None
138
+
139
+ if not api_key:
140
+ raise EnvironmentError(
141
+ f"AZURE_ENDPOINT_URL_AND_KEY doesn't have the endpoint:key pair for your model: {model_name}"
142
+ )
143
+
144
+ try:
145
+ endpoint = cls._model_id_to_endpoint_and_key[model_name]["endpoint"]
146
+ except:
147
+ endpoint = None
148
+
149
+ if not endpoint:
150
+ raise EnvironmentError(
151
+ f"AZURE_ENDPOINT_URL_AND_KEY doesn't have the endpoint:key pair for your model: {model_name}"
152
+ )
153
+
154
+ if "openai" not in endpoint:
155
+ client = ChatCompletionsClient(
156
+ endpoint=endpoint,
157
+ credential=AzureKeyCredential(api_key),
158
+ temperature=self.temperature,
159
+ top_p=self.top_p,
160
+ max_tokens=self.max_tokens,
161
+ )
162
+ try:
163
+ response = await client.complete(
164
+ messages=[
165
+ SystemMessage(content=system_prompt),
166
+ UserMessage(content=user_prompt),
167
+ ],
168
+ # model_extras={"safe_mode": True},
169
+ )
170
+ await client.close()
171
+ return response.as_dict()
172
+ except Exception as e:
173
+ await client.close()
174
+ return {"error": str(e)}
175
+ else:
176
+ api_version = cls._model_id_to_endpoint_and_key[model_name][
177
+ "api_version"
178
+ ]
179
+ client = AsyncAzureOpenAI(
180
+ azure_endpoint=endpoint,
181
+ api_version=api_version,
182
+ api_key=api_key,
183
+ )
184
+ response = await client.chat.completions.create(
185
+ model=model_name,
186
+ messages=[
187
+ {
188
+ "role": "user",
189
+ "content": user_prompt, # Your question can go here
190
+ },
191
+ ],
192
+ )
193
+ return response.model_dump()
194
+
195
+ # @staticmethod
196
+ # def parse_response(raw_response: dict[str, Any]) -> str:
197
+ # """Parses the API response and returns the response text."""
198
+ # if (
199
+ # raw_response
200
+ # and "choices" in raw_response
201
+ # and raw_response["choices"]
202
+ # ):
203
+ # response = raw_response["choices"][0]["message"]["content"]
204
+ # pattern = r"^```json(?:\\n|\n)(.+?)(?:\\n|\n)```$"
205
+ # match = re.match(pattern, response, re.DOTALL)
206
+ # if match:
207
+ # return match.group(1)
208
+ # else:
209
+ # out = fix_partial_correct_response(response)
210
+ # if "error" not in out:
211
+ # response = out["extracted_json"]
212
+ # return response
213
+ # return "Error parsing response"
214
+
215
+ LLM.__name__ = model_class_name
216
+
217
+ return LLM
@@ -1,18 +1,18 @@
1
- import aiohttp
2
- import json
3
- import requests
4
- from typing import Any, List
5
-
6
- # from edsl.inference_services.InferenceServiceABC import InferenceServiceABC
7
- from edsl.language_models import LanguageModel
8
-
9
- from edsl.inference_services.OpenAIService import OpenAIService
10
-
11
-
12
- class DeepInfraService(OpenAIService):
13
- """DeepInfra service class."""
14
-
15
- _inference_service_ = "deep_infra"
16
- _env_key_name_ = "DEEP_INFRA_API_KEY"
17
- _base_url_ = "https://api.deepinfra.com/v1/openai"
18
- _models_list_cache: List[str] = []
1
+ import aiohttp
2
+ import json
3
+ import requests
4
+ from typing import Any, List
5
+
6
+ # from edsl.inference_services.InferenceServiceABC import InferenceServiceABC
7
+ from edsl.language_models import LanguageModel
8
+
9
+ from edsl.inference_services.OpenAIService import OpenAIService
10
+
11
+
12
+ class DeepInfraService(OpenAIService):
13
+ """DeepInfra service class."""
14
+
15
+ _inference_service_ = "deep_infra"
16
+ _env_key_name_ = "DEEP_INFRA_API_KEY"
17
+ _base_url_ = "https://api.deepinfra.com/v1/openai"
18
+ _models_list_cache: List[str] = []