opik 1.6.4__py3-none-any.whl → 1.9.71__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 (1021) hide show
  1. opik/__init__.py +33 -2
  2. opik/anonymizer/__init__.py +5 -0
  3. opik/anonymizer/anonymizer.py +12 -0
  4. opik/anonymizer/factory.py +80 -0
  5. opik/anonymizer/recursive_anonymizer.py +64 -0
  6. opik/anonymizer/rules.py +56 -0
  7. opik/anonymizer/rules_anonymizer.py +35 -0
  8. opik/api_objects/attachment/__init__.py +5 -0
  9. opik/api_objects/attachment/attachment.py +20 -0
  10. opik/api_objects/attachment/attachment_context.py +36 -0
  11. opik/api_objects/attachment/attachments_extractor.py +153 -0
  12. opik/api_objects/attachment/client.py +220 -0
  13. opik/api_objects/attachment/converters.py +51 -0
  14. opik/api_objects/attachment/decoder.py +18 -0
  15. opik/api_objects/attachment/decoder_base64.py +83 -0
  16. opik/api_objects/attachment/decoder_helpers.py +137 -0
  17. opik/api_objects/conversation/__init__.py +0 -0
  18. opik/api_objects/conversation/conversation_factory.py +43 -0
  19. opik/api_objects/conversation/conversation_thread.py +49 -0
  20. opik/api_objects/data_helpers.py +79 -0
  21. opik/api_objects/dataset/dataset.py +107 -45
  22. opik/api_objects/dataset/rest_operations.py +12 -3
  23. opik/api_objects/experiment/experiment.py +81 -45
  24. opik/api_objects/experiment/experiment_item.py +2 -1
  25. opik/api_objects/experiment/experiments_client.py +64 -0
  26. opik/api_objects/experiment/helpers.py +35 -11
  27. opik/api_objects/experiment/rest_operations.py +88 -19
  28. opik/api_objects/helpers.py +104 -7
  29. opik/api_objects/local_recording.py +81 -0
  30. opik/api_objects/opik_client.py +872 -174
  31. opik/api_objects/opik_query_language.py +136 -18
  32. opik/api_objects/optimization/__init__.py +3 -0
  33. opik/api_objects/optimization/optimization.py +39 -0
  34. opik/api_objects/prompt/__init__.py +13 -1
  35. opik/api_objects/prompt/base_prompt.py +69 -0
  36. opik/api_objects/prompt/base_prompt_template.py +29 -0
  37. opik/api_objects/prompt/chat/__init__.py +1 -0
  38. opik/api_objects/prompt/chat/chat_prompt.py +210 -0
  39. opik/api_objects/prompt/chat/chat_prompt_template.py +350 -0
  40. opik/api_objects/prompt/chat/content_renderer_registry.py +203 -0
  41. opik/api_objects/prompt/client.py +193 -41
  42. opik/api_objects/prompt/text/__init__.py +1 -0
  43. opik/api_objects/prompt/text/prompt.py +174 -0
  44. opik/api_objects/prompt/text/prompt_template.py +55 -0
  45. opik/api_objects/prompt/types.py +29 -0
  46. opik/api_objects/rest_stream_parser.py +98 -0
  47. opik/api_objects/search_helpers.py +89 -0
  48. opik/api_objects/span/span_client.py +165 -45
  49. opik/api_objects/span/span_data.py +136 -25
  50. opik/api_objects/threads/__init__.py +0 -0
  51. opik/api_objects/threads/threads_client.py +185 -0
  52. opik/api_objects/trace/trace_client.py +72 -36
  53. opik/api_objects/trace/trace_data.py +112 -26
  54. opik/api_objects/validation_helpers.py +3 -3
  55. opik/cli/__init__.py +5 -0
  56. opik/cli/__main__.py +6 -0
  57. opik/cli/configure.py +66 -0
  58. opik/cli/exports/__init__.py +131 -0
  59. opik/cli/exports/dataset.py +278 -0
  60. opik/cli/exports/experiment.py +784 -0
  61. opik/cli/exports/project.py +685 -0
  62. opik/cli/exports/prompt.py +578 -0
  63. opik/cli/exports/utils.py +406 -0
  64. opik/cli/harbor.py +39 -0
  65. opik/cli/healthcheck.py +21 -0
  66. opik/cli/imports/__init__.py +439 -0
  67. opik/cli/imports/dataset.py +143 -0
  68. opik/cli/imports/experiment.py +1192 -0
  69. opik/cli/imports/project.py +262 -0
  70. opik/cli/imports/prompt.py +177 -0
  71. opik/cli/imports/utils.py +280 -0
  72. opik/cli/main.py +49 -0
  73. opik/cli/proxy.py +93 -0
  74. opik/cli/usage_report/__init__.py +16 -0
  75. opik/cli/usage_report/charts.py +783 -0
  76. opik/cli/usage_report/cli.py +274 -0
  77. opik/cli/usage_report/constants.py +9 -0
  78. opik/cli/usage_report/extraction.py +749 -0
  79. opik/cli/usage_report/pdf.py +244 -0
  80. opik/cli/usage_report/statistics.py +78 -0
  81. opik/cli/usage_report/utils.py +235 -0
  82. opik/config.py +62 -4
  83. opik/configurator/configure.py +45 -6
  84. opik/configurator/opik_rest_helpers.py +4 -1
  85. opik/context_storage.py +164 -65
  86. opik/datetime_helpers.py +12 -0
  87. opik/decorator/arguments_helpers.py +9 -1
  88. opik/decorator/base_track_decorator.py +298 -146
  89. opik/decorator/context_manager/__init__.py +0 -0
  90. opik/decorator/context_manager/span_context_manager.py +123 -0
  91. opik/decorator/context_manager/trace_context_manager.py +84 -0
  92. opik/decorator/generator_wrappers.py +3 -2
  93. opik/decorator/inspect_helpers.py +11 -0
  94. opik/decorator/opik_args/__init__.py +13 -0
  95. opik/decorator/opik_args/api_classes.py +71 -0
  96. opik/decorator/opik_args/helpers.py +120 -0
  97. opik/decorator/span_creation_handler.py +49 -21
  98. opik/decorator/tracker.py +9 -1
  99. opik/dict_utils.py +3 -3
  100. opik/environment.py +13 -1
  101. opik/error_tracking/api.py +1 -1
  102. opik/error_tracking/before_send.py +6 -5
  103. opik/error_tracking/environment_details.py +29 -7
  104. opik/error_tracking/error_filtering/filter_by_response_status_code.py +42 -0
  105. opik/error_tracking/error_filtering/filter_chain_builder.py +14 -3
  106. opik/evaluation/__init__.py +14 -2
  107. opik/evaluation/engine/engine.py +280 -82
  108. opik/evaluation/engine/evaluation_tasks_executor.py +15 -10
  109. opik/evaluation/engine/helpers.py +34 -9
  110. opik/evaluation/engine/metrics_evaluator.py +237 -0
  111. opik/evaluation/engine/types.py +5 -4
  112. opik/evaluation/evaluation_result.py +169 -2
  113. opik/evaluation/evaluator.py +659 -58
  114. opik/evaluation/metrics/__init__.py +121 -6
  115. opik/evaluation/metrics/aggregated_metric.py +92 -0
  116. opik/evaluation/metrics/arguments_helpers.py +15 -21
  117. opik/evaluation/metrics/arguments_validator.py +38 -0
  118. opik/evaluation/metrics/base_metric.py +20 -10
  119. opik/evaluation/metrics/conversation/__init__.py +48 -0
  120. opik/evaluation/metrics/conversation/conversation_thread_metric.py +79 -0
  121. opik/evaluation/metrics/conversation/conversation_turns_factory.py +39 -0
  122. opik/evaluation/metrics/conversation/g_eval_wrappers.py +19 -0
  123. opik/evaluation/metrics/conversation/helpers.py +84 -0
  124. opik/evaluation/metrics/conversation/heuristics/__init__.py +14 -0
  125. opik/evaluation/metrics/conversation/heuristics/degeneration/__init__.py +3 -0
  126. opik/evaluation/metrics/conversation/heuristics/degeneration/metric.py +189 -0
  127. opik/evaluation/metrics/conversation/heuristics/degeneration/phrases.py +12 -0
  128. opik/evaluation/metrics/conversation/heuristics/knowledge_retention/__init__.py +3 -0
  129. opik/evaluation/metrics/conversation/heuristics/knowledge_retention/metric.py +172 -0
  130. opik/evaluation/metrics/conversation/llm_judges/__init__.py +32 -0
  131. opik/evaluation/metrics/conversation/llm_judges/conversational_coherence/__init__.py +0 -0
  132. opik/evaluation/metrics/conversation/llm_judges/conversational_coherence/metric.py +274 -0
  133. opik/evaluation/metrics/conversation/llm_judges/conversational_coherence/schema.py +16 -0
  134. opik/evaluation/metrics/conversation/llm_judges/conversational_coherence/templates.py +95 -0
  135. opik/evaluation/metrics/conversation/llm_judges/g_eval_wrappers.py +442 -0
  136. opik/evaluation/metrics/conversation/llm_judges/session_completeness/__init__.py +0 -0
  137. opik/evaluation/metrics/conversation/llm_judges/session_completeness/metric.py +295 -0
  138. opik/evaluation/metrics/conversation/llm_judges/session_completeness/schema.py +22 -0
  139. opik/evaluation/metrics/conversation/llm_judges/session_completeness/templates.py +139 -0
  140. opik/evaluation/metrics/conversation/llm_judges/user_frustration/__init__.py +0 -0
  141. opik/evaluation/metrics/conversation/llm_judges/user_frustration/metric.py +277 -0
  142. opik/evaluation/metrics/conversation/llm_judges/user_frustration/schema.py +16 -0
  143. opik/evaluation/metrics/conversation/llm_judges/user_frustration/templates.py +135 -0
  144. opik/evaluation/metrics/conversation/types.py +34 -0
  145. opik/evaluation/metrics/conversation_types.py +9 -0
  146. opik/evaluation/metrics/heuristics/bertscore.py +107 -0
  147. opik/evaluation/metrics/heuristics/bleu.py +43 -16
  148. opik/evaluation/metrics/heuristics/chrf.py +127 -0
  149. opik/evaluation/metrics/heuristics/contains.py +50 -11
  150. opik/evaluation/metrics/heuristics/distribution_metrics.py +331 -0
  151. opik/evaluation/metrics/heuristics/equals.py +4 -1
  152. opik/evaluation/metrics/heuristics/gleu.py +113 -0
  153. opik/evaluation/metrics/heuristics/is_json.py +9 -3
  154. opik/evaluation/metrics/heuristics/language_adherence.py +123 -0
  155. opik/evaluation/metrics/heuristics/levenshtein_ratio.py +6 -5
  156. opik/evaluation/metrics/heuristics/meteor.py +119 -0
  157. opik/evaluation/metrics/heuristics/prompt_injection.py +150 -0
  158. opik/evaluation/metrics/heuristics/readability.py +129 -0
  159. opik/evaluation/metrics/heuristics/regex_match.py +4 -1
  160. opik/evaluation/metrics/heuristics/rouge.py +148 -0
  161. opik/evaluation/metrics/heuristics/sentiment.py +98 -0
  162. opik/evaluation/metrics/heuristics/spearman.py +88 -0
  163. opik/evaluation/metrics/heuristics/tone.py +155 -0
  164. opik/evaluation/metrics/heuristics/vader_sentiment.py +77 -0
  165. opik/evaluation/metrics/llm_judges/answer_relevance/metric.py +27 -30
  166. opik/evaluation/metrics/llm_judges/answer_relevance/parser.py +27 -0
  167. opik/evaluation/metrics/llm_judges/answer_relevance/templates.py +10 -10
  168. opik/evaluation/metrics/llm_judges/context_precision/metric.py +28 -31
  169. opik/evaluation/metrics/llm_judges/context_precision/parser.py +27 -0
  170. opik/evaluation/metrics/llm_judges/context_precision/template.py +7 -7
  171. opik/evaluation/metrics/llm_judges/context_recall/metric.py +27 -31
  172. opik/evaluation/metrics/llm_judges/context_recall/parser.py +27 -0
  173. opik/evaluation/metrics/llm_judges/context_recall/template.py +7 -7
  174. opik/evaluation/metrics/llm_judges/factuality/metric.py +7 -26
  175. opik/evaluation/metrics/llm_judges/factuality/parser.py +35 -0
  176. opik/evaluation/metrics/llm_judges/factuality/template.py +1 -1
  177. opik/evaluation/metrics/llm_judges/g_eval/__init__.py +5 -0
  178. opik/evaluation/metrics/llm_judges/g_eval/metric.py +244 -113
  179. opik/evaluation/metrics/llm_judges/g_eval/parser.py +161 -0
  180. opik/evaluation/metrics/llm_judges/g_eval/presets.py +209 -0
  181. opik/evaluation/metrics/llm_judges/g_eval_presets/__init__.py +36 -0
  182. opik/evaluation/metrics/llm_judges/g_eval_presets/agent_assessment.py +77 -0
  183. opik/evaluation/metrics/llm_judges/g_eval_presets/bias_classifier.py +181 -0
  184. opik/evaluation/metrics/llm_judges/g_eval_presets/compliance_risk.py +41 -0
  185. opik/evaluation/metrics/llm_judges/g_eval_presets/prompt_uncertainty.py +41 -0
  186. opik/evaluation/metrics/llm_judges/g_eval_presets/qa_suite.py +146 -0
  187. opik/evaluation/metrics/llm_judges/hallucination/metric.py +23 -27
  188. opik/evaluation/metrics/llm_judges/hallucination/parser.py +29 -0
  189. opik/evaluation/metrics/llm_judges/hallucination/template.py +2 -4
  190. opik/evaluation/metrics/llm_judges/llm_juries/__init__.py +3 -0
  191. opik/evaluation/metrics/llm_judges/llm_juries/metric.py +76 -0
  192. opik/evaluation/metrics/llm_judges/moderation/metric.py +23 -28
  193. opik/evaluation/metrics/llm_judges/moderation/parser.py +27 -0
  194. opik/evaluation/metrics/llm_judges/moderation/template.py +2 -2
  195. opik/evaluation/metrics/llm_judges/parsing_helpers.py +26 -0
  196. opik/evaluation/metrics/llm_judges/structure_output_compliance/__init__.py +0 -0
  197. opik/evaluation/metrics/llm_judges/structure_output_compliance/metric.py +144 -0
  198. opik/evaluation/metrics/llm_judges/structure_output_compliance/parser.py +79 -0
  199. opik/evaluation/metrics/llm_judges/structure_output_compliance/schema.py +15 -0
  200. opik/evaluation/metrics/llm_judges/structure_output_compliance/template.py +50 -0
  201. opik/evaluation/metrics/llm_judges/syc_eval/__init__.py +0 -0
  202. opik/evaluation/metrics/llm_judges/syc_eval/metric.py +252 -0
  203. opik/evaluation/metrics/llm_judges/syc_eval/parser.py +82 -0
  204. opik/evaluation/metrics/llm_judges/syc_eval/template.py +155 -0
  205. opik/evaluation/metrics/llm_judges/trajectory_accuracy/__init__.py +3 -0
  206. opik/evaluation/metrics/llm_judges/trajectory_accuracy/metric.py +171 -0
  207. opik/evaluation/metrics/llm_judges/trajectory_accuracy/parser.py +38 -0
  208. opik/evaluation/metrics/llm_judges/trajectory_accuracy/templates.py +65 -0
  209. opik/evaluation/metrics/llm_judges/usefulness/metric.py +23 -32
  210. opik/evaluation/metrics/llm_judges/usefulness/parser.py +28 -0
  211. opik/evaluation/metrics/ragas_metric.py +112 -0
  212. opik/evaluation/models/__init__.py +10 -0
  213. opik/evaluation/models/base_model.py +140 -18
  214. opik/evaluation/models/langchain/__init__.py +3 -0
  215. opik/evaluation/models/langchain/langchain_chat_model.py +166 -0
  216. opik/evaluation/models/langchain/message_converters.py +106 -0
  217. opik/evaluation/models/langchain/opik_monitoring.py +23 -0
  218. opik/evaluation/models/litellm/litellm_chat_model.py +186 -40
  219. opik/evaluation/models/litellm/opik_monitor.py +24 -21
  220. opik/evaluation/models/litellm/util.py +125 -0
  221. opik/evaluation/models/litellm/warning_filters.py +16 -4
  222. opik/evaluation/models/model_capabilities.py +187 -0
  223. opik/evaluation/models/models_factory.py +25 -3
  224. opik/evaluation/preprocessing.py +92 -0
  225. opik/evaluation/report.py +70 -12
  226. opik/evaluation/rest_operations.py +49 -45
  227. opik/evaluation/samplers/__init__.py +4 -0
  228. opik/evaluation/samplers/base_dataset_sampler.py +40 -0
  229. opik/evaluation/samplers/random_dataset_sampler.py +48 -0
  230. opik/evaluation/score_statistics.py +66 -0
  231. opik/evaluation/scorers/__init__.py +4 -0
  232. opik/evaluation/scorers/scorer_function.py +55 -0
  233. opik/evaluation/scorers/scorer_wrapper_metric.py +130 -0
  234. opik/evaluation/test_case.py +3 -2
  235. opik/evaluation/test_result.py +1 -0
  236. opik/evaluation/threads/__init__.py +0 -0
  237. opik/evaluation/threads/context_helper.py +32 -0
  238. opik/evaluation/threads/evaluation_engine.py +181 -0
  239. opik/evaluation/threads/evaluation_result.py +18 -0
  240. opik/evaluation/threads/evaluator.py +120 -0
  241. opik/evaluation/threads/helpers.py +51 -0
  242. opik/evaluation/types.py +9 -1
  243. opik/exceptions.py +116 -3
  244. opik/file_upload/__init__.py +0 -0
  245. opik/file_upload/base_upload_manager.py +39 -0
  246. opik/file_upload/file_upload_monitor.py +14 -0
  247. opik/file_upload/file_uploader.py +141 -0
  248. opik/file_upload/mime_type.py +9 -0
  249. opik/file_upload/s3_multipart_upload/__init__.py +0 -0
  250. opik/file_upload/s3_multipart_upload/file_parts_strategy.py +89 -0
  251. opik/file_upload/s3_multipart_upload/s3_file_uploader.py +86 -0
  252. opik/file_upload/s3_multipart_upload/s3_upload_error.py +29 -0
  253. opik/file_upload/thread_pool.py +17 -0
  254. opik/file_upload/upload_client.py +114 -0
  255. opik/file_upload/upload_manager.py +255 -0
  256. opik/file_upload/upload_options.py +37 -0
  257. opik/format_helpers.py +17 -0
  258. opik/guardrails/__init__.py +4 -0
  259. opik/guardrails/guardrail.py +157 -0
  260. opik/guardrails/guards/__init__.py +5 -0
  261. opik/guardrails/guards/guard.py +17 -0
  262. opik/guardrails/guards/pii.py +47 -0
  263. opik/guardrails/guards/topic.py +76 -0
  264. opik/guardrails/rest_api_client.py +34 -0
  265. opik/guardrails/schemas.py +24 -0
  266. opik/guardrails/tracing.py +61 -0
  267. opik/healthcheck/__init__.py +2 -1
  268. opik/healthcheck/checks.py +2 -2
  269. opik/healthcheck/rich_representation.py +1 -1
  270. opik/hooks/__init__.py +23 -0
  271. opik/hooks/anonymizer_hook.py +36 -0
  272. opik/hooks/httpx_client_hook.py +112 -0
  273. opik/httpx_client.py +75 -4
  274. opik/id_helpers.py +18 -0
  275. opik/integrations/adk/__init__.py +14 -0
  276. opik/integrations/adk/callback_context_info_extractors.py +32 -0
  277. opik/integrations/adk/graph/__init__.py +0 -0
  278. opik/integrations/adk/graph/mermaid_graph_builder.py +128 -0
  279. opik/integrations/adk/graph/nodes.py +101 -0
  280. opik/integrations/adk/graph/subgraph_edges_builders.py +41 -0
  281. opik/integrations/adk/helpers.py +48 -0
  282. opik/integrations/adk/legacy_opik_tracer.py +381 -0
  283. opik/integrations/adk/opik_tracer.py +370 -0
  284. opik/integrations/adk/patchers/__init__.py +4 -0
  285. opik/integrations/adk/patchers/adk_otel_tracer/__init__.py +0 -0
  286. opik/integrations/adk/patchers/adk_otel_tracer/llm_span_helpers.py +30 -0
  287. opik/integrations/adk/patchers/adk_otel_tracer/opik_adk_otel_tracer.py +201 -0
  288. opik/integrations/adk/patchers/litellm_wrappers.py +91 -0
  289. opik/integrations/adk/patchers/llm_response_wrapper.py +105 -0
  290. opik/integrations/adk/patchers/patchers.py +64 -0
  291. opik/integrations/adk/recursive_callback_injector.py +126 -0
  292. opik/integrations/aisuite/aisuite_decorator.py +8 -3
  293. opik/integrations/aisuite/opik_tracker.py +1 -0
  294. opik/integrations/anthropic/messages_create_decorator.py +8 -3
  295. opik/integrations/anthropic/opik_tracker.py +0 -1
  296. opik/integrations/bedrock/converse/__init__.py +0 -0
  297. opik/integrations/bedrock/converse/chunks_aggregator.py +188 -0
  298. opik/integrations/bedrock/{converse_decorator.py → converse/converse_decorator.py} +18 -8
  299. opik/integrations/bedrock/invoke_agent_decorator.py +12 -7
  300. opik/integrations/bedrock/invoke_model/__init__.py +0 -0
  301. opik/integrations/bedrock/invoke_model/chunks_aggregator/__init__.py +78 -0
  302. opik/integrations/bedrock/invoke_model/chunks_aggregator/api.py +45 -0
  303. opik/integrations/bedrock/invoke_model/chunks_aggregator/base.py +23 -0
  304. opik/integrations/bedrock/invoke_model/chunks_aggregator/claude.py +121 -0
  305. opik/integrations/bedrock/invoke_model/chunks_aggregator/format_detector.py +107 -0
  306. opik/integrations/bedrock/invoke_model/chunks_aggregator/llama.py +108 -0
  307. opik/integrations/bedrock/invoke_model/chunks_aggregator/mistral.py +118 -0
  308. opik/integrations/bedrock/invoke_model/chunks_aggregator/nova.py +99 -0
  309. opik/integrations/bedrock/invoke_model/invoke_model_decorator.py +178 -0
  310. opik/integrations/bedrock/invoke_model/response_types.py +34 -0
  311. opik/integrations/bedrock/invoke_model/stream_wrappers.py +122 -0
  312. opik/integrations/bedrock/invoke_model/usage_converters.py +87 -0
  313. opik/integrations/bedrock/invoke_model/usage_extraction.py +108 -0
  314. opik/integrations/bedrock/opik_tracker.py +43 -4
  315. opik/integrations/bedrock/types.py +19 -0
  316. opik/integrations/crewai/crewai_decorator.py +34 -56
  317. opik/integrations/crewai/opik_tracker.py +31 -10
  318. opik/integrations/crewai/patchers/__init__.py +5 -0
  319. opik/integrations/crewai/patchers/flow.py +118 -0
  320. opik/integrations/crewai/patchers/litellm_completion.py +30 -0
  321. opik/integrations/crewai/patchers/llm_client.py +207 -0
  322. opik/integrations/dspy/callback.py +246 -84
  323. opik/integrations/dspy/graph.py +88 -0
  324. opik/integrations/dspy/parsers.py +168 -0
  325. opik/integrations/genai/encoder_extension.py +2 -6
  326. opik/integrations/genai/generate_content_decorator.py +20 -13
  327. opik/integrations/guardrails/guardrails_decorator.py +4 -0
  328. opik/integrations/harbor/__init__.py +17 -0
  329. opik/integrations/harbor/experiment_service.py +269 -0
  330. opik/integrations/harbor/opik_tracker.py +528 -0
  331. opik/integrations/haystack/constants.py +35 -0
  332. opik/integrations/haystack/converters.py +1 -2
  333. opik/integrations/haystack/opik_connector.py +28 -6
  334. opik/integrations/haystack/opik_span_bridge.py +284 -0
  335. opik/integrations/haystack/opik_tracer.py +124 -222
  336. opik/integrations/langchain/__init__.py +3 -1
  337. opik/integrations/langchain/helpers.py +96 -0
  338. opik/integrations/langchain/langgraph_async_context_bridge.py +131 -0
  339. opik/integrations/langchain/langgraph_tracer_injector.py +88 -0
  340. opik/integrations/langchain/opik_encoder_extension.py +2 -2
  341. opik/integrations/langchain/opik_tracer.py +641 -206
  342. opik/integrations/langchain/provider_usage_extractors/__init__.py +5 -0
  343. opik/integrations/langchain/provider_usage_extractors/anthropic_usage_extractor.py +101 -0
  344. opik/integrations/langchain/provider_usage_extractors/anthropic_vertexai_usage_extractor.py +67 -0
  345. opik/integrations/langchain/provider_usage_extractors/bedrock_usage_extractor.py +94 -0
  346. opik/integrations/langchain/provider_usage_extractors/google_generative_ai_usage_extractor.py +109 -0
  347. opik/integrations/langchain/provider_usage_extractors/groq_usage_extractor.py +92 -0
  348. opik/integrations/langchain/provider_usage_extractors/langchain_run_helpers/__init__.py +15 -0
  349. opik/integrations/langchain/provider_usage_extractors/langchain_run_helpers/helpers.py +134 -0
  350. opik/integrations/langchain/provider_usage_extractors/langchain_run_helpers/langchain_usage.py +163 -0
  351. opik/integrations/langchain/provider_usage_extractors/openai_usage_extractor.py +124 -0
  352. opik/integrations/langchain/provider_usage_extractors/provider_usage_extractor_protocol.py +29 -0
  353. opik/integrations/langchain/provider_usage_extractors/usage_extractor.py +48 -0
  354. opik/integrations/langchain/provider_usage_extractors/vertexai_usage_extractor.py +109 -0
  355. opik/integrations/litellm/__init__.py +5 -0
  356. opik/integrations/litellm/completion_chunks_aggregator.py +115 -0
  357. opik/integrations/litellm/litellm_completion_decorator.py +242 -0
  358. opik/integrations/litellm/opik_tracker.py +43 -0
  359. opik/integrations/litellm/stream_patchers.py +151 -0
  360. opik/integrations/llama_index/callback.py +179 -78
  361. opik/integrations/llama_index/event_parsing_utils.py +29 -9
  362. opik/integrations/openai/agents/opik_tracing_processor.py +204 -32
  363. opik/integrations/openai/agents/span_data_parsers.py +15 -6
  364. opik/integrations/openai/chat_completion_chunks_aggregator.py +1 -1
  365. opik/integrations/openai/{openai_decorator.py → openai_chat_completions_decorator.py} +45 -35
  366. opik/integrations/openai/openai_responses_decorator.py +158 -0
  367. opik/integrations/openai/opik_tracker.py +94 -13
  368. opik/integrations/openai/response_events_aggregator.py +36 -0
  369. opik/integrations/openai/stream_patchers.py +125 -15
  370. opik/integrations/sagemaker/auth.py +5 -1
  371. opik/jsonable_encoder.py +29 -1
  372. opik/llm_usage/base_original_provider_usage.py +15 -8
  373. opik/llm_usage/bedrock_usage.py +8 -2
  374. opik/llm_usage/google_usage.py +6 -1
  375. opik/llm_usage/llm_usage_info.py +6 -0
  376. opik/llm_usage/{openai_usage.py → openai_chat_completions_usage.py} +2 -12
  377. opik/llm_usage/{openai_agent_usage.py → openai_responses_usage.py} +7 -15
  378. opik/llm_usage/opik_usage.py +36 -10
  379. opik/llm_usage/opik_usage_factory.py +35 -19
  380. opik/logging_messages.py +19 -7
  381. opik/message_processing/arguments_utils.py +22 -0
  382. opik/message_processing/batching/base_batcher.py +45 -17
  383. opik/message_processing/batching/batch_manager.py +22 -10
  384. opik/message_processing/batching/batch_manager_constuctors.py +36 -11
  385. opik/message_processing/batching/batchers.py +167 -44
  386. opik/message_processing/batching/flushing_thread.py +0 -3
  387. opik/message_processing/batching/sequence_splitter.py +50 -5
  388. opik/message_processing/emulation/__init__.py +0 -0
  389. opik/message_processing/emulation/emulator_message_processor.py +578 -0
  390. opik/message_processing/emulation/local_emulator_message_processor.py +140 -0
  391. opik/message_processing/emulation/models.py +162 -0
  392. opik/message_processing/encoder_helpers.py +79 -0
  393. opik/message_processing/message_queue.py +79 -0
  394. opik/message_processing/messages.py +154 -12
  395. opik/message_processing/preprocessing/__init__.py +0 -0
  396. opik/message_processing/preprocessing/attachments_preprocessor.py +70 -0
  397. opik/message_processing/preprocessing/batching_preprocessor.py +53 -0
  398. opik/message_processing/preprocessing/constants.py +1 -0
  399. opik/message_processing/preprocessing/file_upload_preprocessor.py +38 -0
  400. opik/message_processing/preprocessing/preprocessor.py +36 -0
  401. opik/message_processing/processors/__init__.py +0 -0
  402. opik/message_processing/processors/attachments_extraction_processor.py +146 -0
  403. opik/message_processing/processors/message_processors.py +92 -0
  404. opik/message_processing/processors/message_processors_chain.py +96 -0
  405. opik/message_processing/processors/online_message_processor.py +324 -0
  406. opik/message_processing/queue_consumer.py +61 -13
  407. opik/message_processing/streamer.py +102 -31
  408. opik/message_processing/streamer_constructors.py +67 -12
  409. opik/opik_context.py +103 -11
  410. opik/plugins/pytest/decorator.py +2 -2
  411. opik/plugins/pytest/experiment_runner.py +3 -2
  412. opik/plugins/pytest/hooks.py +6 -4
  413. opik/rate_limit/__init__.py +0 -0
  414. opik/rate_limit/rate_limit.py +25 -0
  415. opik/rest_api/__init__.py +643 -11
  416. opik/rest_api/alerts/__init__.py +7 -0
  417. opik/rest_api/alerts/client.py +667 -0
  418. opik/rest_api/alerts/raw_client.py +1015 -0
  419. opik/rest_api/alerts/types/__init__.py +7 -0
  420. opik/rest_api/alerts/types/get_webhook_examples_request_alert_type.py +5 -0
  421. opik/rest_api/annotation_queues/__init__.py +4 -0
  422. opik/rest_api/annotation_queues/client.py +668 -0
  423. opik/rest_api/annotation_queues/raw_client.py +1019 -0
  424. opik/rest_api/attachments/__init__.py +17 -0
  425. opik/rest_api/attachments/client.py +752 -0
  426. opik/rest_api/attachments/raw_client.py +1125 -0
  427. opik/rest_api/attachments/types/__init__.py +15 -0
  428. opik/rest_api/attachments/types/attachment_list_request_entity_type.py +5 -0
  429. opik/rest_api/attachments/types/download_attachment_request_entity_type.py +5 -0
  430. opik/rest_api/attachments/types/start_multipart_upload_request_entity_type.py +5 -0
  431. opik/rest_api/attachments/types/upload_attachment_request_entity_type.py +5 -0
  432. opik/rest_api/automation_rule_evaluators/__init__.py +2 -0
  433. opik/rest_api/automation_rule_evaluators/client.py +182 -1162
  434. opik/rest_api/automation_rule_evaluators/raw_client.py +598 -0
  435. opik/rest_api/chat_completions/__init__.py +2 -0
  436. opik/rest_api/chat_completions/client.py +115 -149
  437. opik/rest_api/chat_completions/raw_client.py +339 -0
  438. opik/rest_api/check/__init__.py +2 -0
  439. opik/rest_api/check/client.py +88 -106
  440. opik/rest_api/check/raw_client.py +258 -0
  441. opik/rest_api/client.py +112 -212
  442. opik/rest_api/core/__init__.py +5 -0
  443. opik/rest_api/core/api_error.py +12 -6
  444. opik/rest_api/core/client_wrapper.py +4 -14
  445. opik/rest_api/core/datetime_utils.py +1 -3
  446. opik/rest_api/core/file.py +2 -5
  447. opik/rest_api/core/http_client.py +42 -120
  448. opik/rest_api/core/http_response.py +55 -0
  449. opik/rest_api/core/jsonable_encoder.py +1 -4
  450. opik/rest_api/core/pydantic_utilities.py +79 -147
  451. opik/rest_api/core/query_encoder.py +1 -3
  452. opik/rest_api/core/serialization.py +10 -10
  453. opik/rest_api/dashboards/__init__.py +4 -0
  454. opik/rest_api/dashboards/client.py +462 -0
  455. opik/rest_api/dashboards/raw_client.py +648 -0
  456. opik/rest_api/datasets/__init__.py +5 -0
  457. opik/rest_api/datasets/client.py +1638 -1091
  458. opik/rest_api/datasets/raw_client.py +3389 -0
  459. opik/rest_api/datasets/types/__init__.py +8 -0
  460. opik/rest_api/datasets/types/dataset_update_visibility.py +5 -0
  461. opik/rest_api/datasets/types/dataset_write_visibility.py +5 -0
  462. opik/rest_api/errors/__init__.py +2 -0
  463. opik/rest_api/errors/bad_request_error.py +4 -3
  464. opik/rest_api/errors/conflict_error.py +4 -3
  465. opik/rest_api/errors/forbidden_error.py +4 -2
  466. opik/rest_api/errors/not_found_error.py +4 -3
  467. opik/rest_api/errors/not_implemented_error.py +4 -3
  468. opik/rest_api/errors/unauthorized_error.py +4 -3
  469. opik/rest_api/errors/unprocessable_entity_error.py +4 -3
  470. opik/rest_api/experiments/__init__.py +5 -0
  471. opik/rest_api/experiments/client.py +676 -752
  472. opik/rest_api/experiments/raw_client.py +1872 -0
  473. opik/rest_api/experiments/types/__init__.py +10 -0
  474. opik/rest_api/experiments/types/experiment_update_status.py +5 -0
  475. opik/rest_api/experiments/types/experiment_update_type.py +5 -0
  476. opik/rest_api/experiments/types/experiment_write_status.py +5 -0
  477. opik/rest_api/experiments/types/experiment_write_type.py +5 -0
  478. opik/rest_api/feedback_definitions/__init__.py +2 -0
  479. opik/rest_api/feedback_definitions/client.py +96 -370
  480. opik/rest_api/feedback_definitions/raw_client.py +541 -0
  481. opik/rest_api/feedback_definitions/types/__init__.py +2 -0
  482. opik/rest_api/feedback_definitions/types/find_feedback_definitions_request_type.py +1 -3
  483. opik/rest_api/guardrails/__init__.py +4 -0
  484. opik/rest_api/guardrails/client.py +104 -0
  485. opik/rest_api/guardrails/raw_client.py +102 -0
  486. opik/rest_api/llm_provider_key/__init__.py +2 -0
  487. opik/rest_api/llm_provider_key/client.py +166 -440
  488. opik/rest_api/llm_provider_key/raw_client.py +643 -0
  489. opik/rest_api/llm_provider_key/types/__init__.py +2 -0
  490. opik/rest_api/llm_provider_key/types/provider_api_key_write_provider.py +1 -1
  491. opik/rest_api/manual_evaluation/__init__.py +4 -0
  492. opik/rest_api/manual_evaluation/client.py +347 -0
  493. opik/rest_api/manual_evaluation/raw_client.py +543 -0
  494. opik/rest_api/open_telemetry_ingestion/__init__.py +2 -0
  495. opik/rest_api/open_telemetry_ingestion/client.py +38 -63
  496. opik/rest_api/open_telemetry_ingestion/raw_client.py +88 -0
  497. opik/rest_api/optimizations/__init__.py +7 -0
  498. opik/rest_api/optimizations/client.py +704 -0
  499. opik/rest_api/optimizations/raw_client.py +920 -0
  500. opik/rest_api/optimizations/types/__init__.py +7 -0
  501. opik/rest_api/optimizations/types/optimization_update_status.py +7 -0
  502. opik/rest_api/projects/__init__.py +10 -1
  503. opik/rest_api/projects/client.py +180 -855
  504. opik/rest_api/projects/raw_client.py +1216 -0
  505. opik/rest_api/projects/types/__init__.py +11 -4
  506. opik/rest_api/projects/types/project_metric_request_public_interval.py +1 -3
  507. opik/rest_api/projects/types/project_metric_request_public_metric_type.py +11 -1
  508. opik/rest_api/projects/types/project_update_visibility.py +5 -0
  509. opik/rest_api/projects/types/project_write_visibility.py +5 -0
  510. opik/rest_api/prompts/__init__.py +4 -2
  511. opik/rest_api/prompts/client.py +381 -970
  512. opik/rest_api/prompts/raw_client.py +1634 -0
  513. opik/rest_api/prompts/types/__init__.py +5 -1
  514. opik/rest_api/prompts/types/create_prompt_version_detail_template_structure.py +5 -0
  515. opik/rest_api/prompts/types/prompt_write_template_structure.py +5 -0
  516. opik/rest_api/raw_client.py +156 -0
  517. opik/rest_api/redirect/__init__.py +4 -0
  518. opik/rest_api/redirect/client.py +375 -0
  519. opik/rest_api/redirect/raw_client.py +566 -0
  520. opik/rest_api/service_toggles/__init__.py +4 -0
  521. opik/rest_api/service_toggles/client.py +91 -0
  522. opik/rest_api/service_toggles/raw_client.py +93 -0
  523. opik/rest_api/spans/__init__.py +2 -0
  524. opik/rest_api/spans/client.py +659 -1354
  525. opik/rest_api/spans/raw_client.py +2383 -0
  526. opik/rest_api/spans/types/__init__.py +2 -0
  527. opik/rest_api/spans/types/find_feedback_score_names_1_request_type.py +1 -3
  528. opik/rest_api/spans/types/get_span_stats_request_type.py +1 -3
  529. opik/rest_api/spans/types/get_spans_by_project_request_type.py +1 -3
  530. opik/rest_api/spans/types/span_search_stream_request_public_type.py +1 -3
  531. opik/rest_api/system_usage/__init__.py +2 -0
  532. opik/rest_api/system_usage/client.py +157 -216
  533. opik/rest_api/system_usage/raw_client.py +455 -0
  534. opik/rest_api/traces/__init__.py +2 -0
  535. opik/rest_api/traces/client.py +2102 -1625
  536. opik/rest_api/traces/raw_client.py +4144 -0
  537. opik/rest_api/types/__init__.py +629 -24
  538. opik/rest_api/types/aggregation_data.py +27 -0
  539. opik/rest_api/types/alert.py +33 -0
  540. opik/rest_api/types/alert_alert_type.py +5 -0
  541. opik/rest_api/types/alert_page_public.py +24 -0
  542. opik/rest_api/types/alert_public.py +33 -0
  543. opik/rest_api/types/alert_public_alert_type.py +5 -0
  544. opik/rest_api/types/alert_trigger.py +27 -0
  545. opik/rest_api/types/alert_trigger_config.py +28 -0
  546. opik/rest_api/types/alert_trigger_config_public.py +28 -0
  547. opik/rest_api/types/alert_trigger_config_public_type.py +10 -0
  548. opik/rest_api/types/alert_trigger_config_type.py +10 -0
  549. opik/rest_api/types/alert_trigger_config_write.py +22 -0
  550. opik/rest_api/types/alert_trigger_config_write_type.py +10 -0
  551. opik/rest_api/types/alert_trigger_event_type.py +19 -0
  552. opik/rest_api/types/alert_trigger_public.py +27 -0
  553. opik/rest_api/types/alert_trigger_public_event_type.py +19 -0
  554. opik/rest_api/types/alert_trigger_write.py +23 -0
  555. opik/rest_api/types/alert_trigger_write_event_type.py +19 -0
  556. opik/rest_api/types/alert_write.py +28 -0
  557. opik/rest_api/types/alert_write_alert_type.py +5 -0
  558. opik/rest_api/types/annotation_queue.py +42 -0
  559. opik/rest_api/types/annotation_queue_batch.py +27 -0
  560. opik/rest_api/types/{json_schema_element.py → annotation_queue_item_ids.py} +5 -7
  561. opik/rest_api/types/annotation_queue_page_public.py +28 -0
  562. opik/rest_api/types/annotation_queue_public.py +38 -0
  563. opik/rest_api/types/annotation_queue_public_scope.py +5 -0
  564. opik/rest_api/types/{workspace_metadata.py → annotation_queue_reviewer.py} +6 -7
  565. opik/rest_api/types/annotation_queue_reviewer_public.py +20 -0
  566. opik/rest_api/types/annotation_queue_scope.py +5 -0
  567. opik/rest_api/types/annotation_queue_write.py +31 -0
  568. opik/rest_api/types/annotation_queue_write_scope.py +5 -0
  569. opik/rest_api/types/assistant_message.py +7 -8
  570. opik/rest_api/types/assistant_message_role.py +1 -3
  571. opik/rest_api/types/attachment.py +22 -0
  572. opik/rest_api/types/attachment_page.py +28 -0
  573. opik/rest_api/types/audio_url.py +19 -0
  574. opik/rest_api/types/audio_url_public.py +19 -0
  575. opik/rest_api/types/audio_url_write.py +19 -0
  576. opik/rest_api/types/automation_rule_evaluator.py +160 -0
  577. opik/rest_api/types/automation_rule_evaluator_llm_as_judge.py +6 -6
  578. opik/rest_api/types/automation_rule_evaluator_llm_as_judge_public.py +6 -6
  579. opik/rest_api/types/automation_rule_evaluator_llm_as_judge_write.py +6 -6
  580. opik/rest_api/types/automation_rule_evaluator_object_object_public.py +155 -0
  581. opik/rest_api/types/automation_rule_evaluator_page_public.py +6 -6
  582. opik/rest_api/types/automation_rule_evaluator_public.py +155 -0
  583. opik/rest_api/types/automation_rule_evaluator_span_llm_as_judge.py +22 -0
  584. opik/rest_api/types/automation_rule_evaluator_span_llm_as_judge_public.py +22 -0
  585. opik/rest_api/types/automation_rule_evaluator_span_llm_as_judge_write.py +22 -0
  586. opik/rest_api/types/automation_rule_evaluator_span_user_defined_metric_python.py +22 -0
  587. opik/rest_api/types/automation_rule_evaluator_span_user_defined_metric_python_public.py +22 -0
  588. opik/rest_api/types/automation_rule_evaluator_span_user_defined_metric_python_write.py +22 -0
  589. opik/rest_api/types/automation_rule_evaluator_trace_thread_llm_as_judge.py +22 -0
  590. opik/rest_api/types/automation_rule_evaluator_trace_thread_llm_as_judge_public.py +22 -0
  591. opik/rest_api/types/automation_rule_evaluator_trace_thread_llm_as_judge_write.py +22 -0
  592. opik/rest_api/types/automation_rule_evaluator_trace_thread_user_defined_metric_python.py +22 -0
  593. opik/rest_api/types/automation_rule_evaluator_trace_thread_user_defined_metric_python_public.py +22 -0
  594. opik/rest_api/types/automation_rule_evaluator_trace_thread_user_defined_metric_python_write.py +22 -0
  595. opik/rest_api/types/automation_rule_evaluator_update.py +143 -0
  596. opik/rest_api/types/automation_rule_evaluator_update_llm_as_judge.py +6 -6
  597. opik/rest_api/types/automation_rule_evaluator_update_span_llm_as_judge.py +22 -0
  598. opik/rest_api/types/automation_rule_evaluator_update_span_user_defined_metric_python.py +22 -0
  599. opik/rest_api/types/automation_rule_evaluator_update_trace_thread_llm_as_judge.py +22 -0
  600. opik/rest_api/types/automation_rule_evaluator_update_trace_thread_user_defined_metric_python.py +22 -0
  601. opik/rest_api/types/automation_rule_evaluator_update_user_defined_metric_python.py +6 -6
  602. opik/rest_api/types/automation_rule_evaluator_user_defined_metric_python.py +6 -6
  603. opik/rest_api/types/automation_rule_evaluator_user_defined_metric_python_public.py +6 -6
  604. opik/rest_api/types/automation_rule_evaluator_user_defined_metric_python_write.py +6 -6
  605. opik/rest_api/types/automation_rule_evaluator_write.py +143 -0
  606. opik/rest_api/types/avg_value_stat_public.py +3 -5
  607. opik/rest_api/types/batch_delete.py +3 -5
  608. opik/rest_api/types/batch_delete_by_project.py +20 -0
  609. opik/rest_api/types/bi_information.py +3 -5
  610. opik/rest_api/types/bi_information_response.py +4 -6
  611. opik/rest_api/types/boolean_feedback_definition.py +25 -0
  612. opik/rest_api/types/boolean_feedback_definition_create.py +20 -0
  613. opik/rest_api/types/boolean_feedback_definition_public.py +25 -0
  614. opik/rest_api/types/boolean_feedback_definition_update.py +20 -0
  615. opik/rest_api/types/boolean_feedback_detail.py +29 -0
  616. opik/rest_api/types/boolean_feedback_detail_create.py +29 -0
  617. opik/rest_api/types/boolean_feedback_detail_public.py +29 -0
  618. opik/rest_api/types/boolean_feedback_detail_update.py +29 -0
  619. opik/rest_api/types/categorical_feedback_definition.py +5 -7
  620. opik/rest_api/types/categorical_feedback_definition_create.py +4 -6
  621. opik/rest_api/types/categorical_feedback_definition_public.py +5 -7
  622. opik/rest_api/types/categorical_feedback_definition_update.py +4 -6
  623. opik/rest_api/types/categorical_feedback_detail.py +3 -5
  624. opik/rest_api/types/categorical_feedback_detail_create.py +3 -5
  625. opik/rest_api/types/categorical_feedback_detail_public.py +3 -5
  626. opik/rest_api/types/categorical_feedback_detail_update.py +3 -5
  627. opik/rest_api/types/chat_completion_choice.py +4 -6
  628. opik/rest_api/types/chat_completion_response.py +5 -6
  629. opik/rest_api/types/check.py +22 -0
  630. opik/rest_api/types/{json_node_compare.py → check_name.py} +1 -1
  631. opik/rest_api/types/check_public.py +22 -0
  632. opik/rest_api/types/check_public_name.py +5 -0
  633. opik/rest_api/types/check_public_result.py +5 -0
  634. opik/rest_api/types/check_result.py +5 -0
  635. opik/rest_api/types/chunked_output_json_node.py +4 -6
  636. opik/rest_api/types/chunked_output_json_node_public.py +4 -6
  637. opik/rest_api/types/chunked_output_json_node_public_type.py +6 -10
  638. opik/rest_api/types/chunked_output_json_node_type.py +6 -10
  639. opik/rest_api/types/column.py +8 -10
  640. opik/rest_api/types/column_compare.py +8 -10
  641. opik/rest_api/types/column_public.py +8 -10
  642. opik/rest_api/types/column_types_item.py +1 -3
  643. opik/rest_api/types/comment.py +4 -6
  644. opik/rest_api/types/comment_compare.py +4 -6
  645. opik/rest_api/types/comment_public.py +4 -6
  646. opik/rest_api/types/complete_multipart_upload_request.py +33 -0
  647. opik/rest_api/types/complete_multipart_upload_request_entity_type.py +5 -0
  648. opik/rest_api/types/completion_tokens_details.py +3 -5
  649. opik/rest_api/types/count_value_stat_public.py +3 -5
  650. opik/rest_api/types/dashboard_page_public.py +24 -0
  651. opik/rest_api/types/dashboard_public.py +30 -0
  652. opik/rest_api/types/data_point_double.py +21 -0
  653. opik/rest_api/types/data_point_number_public.py +3 -5
  654. opik/rest_api/types/dataset.py +14 -6
  655. opik/rest_api/types/dataset_expansion.py +42 -0
  656. opik/rest_api/types/dataset_expansion_response.py +39 -0
  657. opik/rest_api/types/dataset_item.py +9 -8
  658. opik/rest_api/types/dataset_item_batch.py +3 -5
  659. opik/rest_api/types/dataset_item_changes_public.py +5 -0
  660. opik/rest_api/types/dataset_item_compare.py +9 -8
  661. opik/rest_api/types/dataset_item_compare_source.py +1 -3
  662. opik/rest_api/types/dataset_item_filter.py +27 -0
  663. opik/rest_api/types/dataset_item_filter_operator.py +21 -0
  664. opik/rest_api/types/dataset_item_page_compare.py +10 -7
  665. opik/rest_api/types/dataset_item_page_public.py +10 -7
  666. opik/rest_api/types/dataset_item_public.py +9 -8
  667. opik/rest_api/types/dataset_item_public_source.py +1 -3
  668. opik/rest_api/types/dataset_item_source.py +1 -3
  669. opik/rest_api/types/dataset_item_update.py +39 -0
  670. opik/rest_api/types/dataset_item_write.py +5 -6
  671. opik/rest_api/types/dataset_item_write_source.py +1 -3
  672. opik/rest_api/types/dataset_page_public.py +9 -6
  673. opik/rest_api/types/dataset_public.py +14 -6
  674. opik/rest_api/types/dataset_public_status.py +5 -0
  675. opik/rest_api/types/dataset_public_visibility.py +5 -0
  676. opik/rest_api/types/dataset_status.py +5 -0
  677. opik/rest_api/types/dataset_version_diff.py +22 -0
  678. opik/rest_api/types/dataset_version_diff_stats.py +24 -0
  679. opik/rest_api/types/dataset_version_page_public.py +23 -0
  680. opik/rest_api/types/dataset_version_public.py +59 -0
  681. opik/rest_api/types/dataset_version_summary.py +46 -0
  682. opik/rest_api/types/dataset_version_summary_public.py +46 -0
  683. opik/rest_api/types/dataset_visibility.py +5 -0
  684. opik/rest_api/types/delete_attachments_request.py +23 -0
  685. opik/rest_api/types/delete_attachments_request_entity_type.py +5 -0
  686. opik/rest_api/types/delete_feedback_score.py +4 -5
  687. opik/rest_api/types/delete_ids_holder.py +19 -0
  688. opik/rest_api/types/delta.py +7 -9
  689. opik/rest_api/types/error_count_with_deviation.py +21 -0
  690. opik/rest_api/types/error_count_with_deviation_detailed.py +21 -0
  691. opik/rest_api/types/error_info.py +3 -5
  692. opik/rest_api/types/error_info_experiment_item_bulk_write_view.py +21 -0
  693. opik/rest_api/types/error_info_public.py +3 -5
  694. opik/rest_api/types/error_info_write.py +3 -5
  695. opik/rest_api/types/error_message.py +3 -5
  696. opik/rest_api/types/error_message_detail.py +3 -5
  697. opik/rest_api/types/error_message_detailed.py +3 -5
  698. opik/rest_api/types/error_message_public.py +3 -5
  699. opik/rest_api/types/experiment.py +21 -10
  700. opik/rest_api/types/experiment_group_aggregations_response.py +20 -0
  701. opik/rest_api/types/experiment_group_response.py +22 -0
  702. opik/rest_api/types/experiment_item.py +14 -11
  703. opik/rest_api/types/experiment_item_bulk_record.py +27 -0
  704. opik/rest_api/types/experiment_item_bulk_record_experiment_item_bulk_write_view.py +27 -0
  705. opik/rest_api/types/experiment_item_bulk_upload.py +27 -0
  706. opik/rest_api/types/experiment_item_compare.py +14 -11
  707. opik/rest_api/types/experiment_item_compare_trace_visibility_mode.py +5 -0
  708. opik/rest_api/types/experiment_item_public.py +6 -6
  709. opik/rest_api/types/experiment_item_public_trace_visibility_mode.py +5 -0
  710. opik/rest_api/types/experiment_item_trace_visibility_mode.py +5 -0
  711. opik/rest_api/types/experiment_page_public.py +9 -6
  712. opik/rest_api/types/experiment_public.py +21 -10
  713. opik/rest_api/types/experiment_public_status.py +5 -0
  714. opik/rest_api/types/experiment_public_type.py +5 -0
  715. opik/rest_api/types/experiment_score.py +20 -0
  716. opik/rest_api/types/experiment_score_public.py +20 -0
  717. opik/rest_api/types/experiment_score_write.py +20 -0
  718. opik/rest_api/types/experiment_status.py +5 -0
  719. opik/rest_api/types/experiment_type.py +5 -0
  720. opik/rest_api/types/export_trace_service_request.py +5 -0
  721. opik/rest_api/types/feedback.py +40 -27
  722. opik/rest_api/types/feedback_create.py +27 -13
  723. opik/rest_api/types/feedback_definition_page_public.py +4 -6
  724. opik/rest_api/types/feedback_object_public.py +40 -27
  725. opik/rest_api/types/feedback_public.py +40 -27
  726. opik/rest_api/types/feedback_score.py +7 -7
  727. opik/rest_api/types/feedback_score_average.py +3 -5
  728. opik/rest_api/types/feedback_score_average_detailed.py +3 -5
  729. opik/rest_api/types/feedback_score_average_public.py +3 -5
  730. opik/rest_api/types/feedback_score_batch.py +4 -6
  731. opik/rest_api/types/feedback_score_batch_item.py +6 -6
  732. opik/rest_api/types/feedback_score_batch_item_source.py +1 -3
  733. opik/rest_api/types/feedback_score_batch_item_thread.py +32 -0
  734. opik/rest_api/types/feedback_score_batch_item_thread_source.py +5 -0
  735. opik/rest_api/types/feedback_score_compare.py +7 -7
  736. opik/rest_api/types/feedback_score_compare_source.py +1 -3
  737. opik/rest_api/types/feedback_score_experiment_item_bulk_write_view.py +31 -0
  738. opik/rest_api/types/feedback_score_experiment_item_bulk_write_view_source.py +5 -0
  739. opik/rest_api/types/feedback_score_names.py +4 -6
  740. opik/rest_api/types/feedback_score_public.py +11 -7
  741. opik/rest_api/types/feedback_score_public_source.py +1 -3
  742. opik/rest_api/types/feedback_score_source.py +1 -3
  743. opik/rest_api/types/feedback_update.py +27 -13
  744. opik/rest_api/types/function.py +4 -7
  745. opik/rest_api/types/function_call.py +3 -5
  746. opik/rest_api/types/group_content.py +19 -0
  747. opik/rest_api/types/group_content_with_aggregations.py +21 -0
  748. opik/rest_api/types/group_detail.py +19 -0
  749. opik/rest_api/types/group_details.py +20 -0
  750. opik/rest_api/types/guardrail.py +34 -0
  751. opik/rest_api/types/guardrail_batch.py +20 -0
  752. opik/rest_api/types/guardrail_name.py +5 -0
  753. opik/rest_api/types/guardrail_result.py +5 -0
  754. opik/rest_api/types/guardrail_write.py +33 -0
  755. opik/rest_api/types/guardrail_write_name.py +5 -0
  756. opik/rest_api/types/guardrail_write_result.py +5 -0
  757. opik/rest_api/types/guardrails_validation.py +21 -0
  758. opik/rest_api/types/guardrails_validation_public.py +21 -0
  759. opik/rest_api/types/ids_holder.py +19 -0
  760. opik/rest_api/types/image_url.py +20 -0
  761. opik/rest_api/types/image_url_public.py +20 -0
  762. opik/rest_api/types/image_url_write.py +20 -0
  763. opik/rest_api/types/json_list_string.py +7 -0
  764. opik/rest_api/types/json_list_string_compare.py +7 -0
  765. opik/rest_api/types/json_list_string_experiment_item_bulk_write_view.py +7 -0
  766. opik/rest_api/types/json_list_string_public.py +7 -0
  767. opik/rest_api/types/json_list_string_write.py +7 -0
  768. opik/rest_api/types/json_schema.py +5 -8
  769. opik/rest_api/types/llm_as_judge_code.py +8 -12
  770. opik/rest_api/types/llm_as_judge_code_public.py +8 -12
  771. opik/rest_api/types/llm_as_judge_code_write.py +8 -12
  772. opik/rest_api/types/llm_as_judge_message.py +9 -7
  773. opik/rest_api/types/llm_as_judge_message_content.py +26 -0
  774. opik/rest_api/types/llm_as_judge_message_content_public.py +26 -0
  775. opik/rest_api/types/llm_as_judge_message_content_write.py +26 -0
  776. opik/rest_api/types/llm_as_judge_message_public.py +9 -7
  777. opik/rest_api/types/llm_as_judge_message_public_role.py +1 -1
  778. opik/rest_api/types/llm_as_judge_message_role.py +1 -1
  779. opik/rest_api/types/llm_as_judge_message_write.py +9 -7
  780. opik/rest_api/types/llm_as_judge_message_write_role.py +1 -1
  781. opik/rest_api/types/llm_as_judge_model_parameters.py +6 -5
  782. opik/rest_api/types/llm_as_judge_model_parameters_public.py +6 -5
  783. opik/rest_api/types/llm_as_judge_model_parameters_write.py +6 -5
  784. opik/rest_api/types/llm_as_judge_output_schema.py +4 -6
  785. opik/rest_api/types/llm_as_judge_output_schema_public.py +4 -6
  786. opik/rest_api/types/llm_as_judge_output_schema_public_type.py +1 -3
  787. opik/rest_api/types/llm_as_judge_output_schema_type.py +1 -3
  788. opik/rest_api/types/llm_as_judge_output_schema_write.py +4 -6
  789. opik/rest_api/types/llm_as_judge_output_schema_write_type.py +1 -3
  790. opik/rest_api/types/log_item.py +5 -7
  791. opik/rest_api/types/log_item_level.py +1 -3
  792. opik/rest_api/types/log_page.py +4 -6
  793. opik/rest_api/types/manual_evaluation_request.py +38 -0
  794. opik/rest_api/types/manual_evaluation_request_entity_type.py +5 -0
  795. opik/rest_api/types/manual_evaluation_response.py +27 -0
  796. opik/rest_api/types/multipart_upload_part.py +20 -0
  797. opik/rest_api/types/numerical_feedback_definition.py +5 -7
  798. opik/rest_api/types/numerical_feedback_definition_create.py +4 -6
  799. opik/rest_api/types/numerical_feedback_definition_public.py +5 -7
  800. opik/rest_api/types/numerical_feedback_definition_update.py +4 -6
  801. opik/rest_api/types/numerical_feedback_detail.py +3 -5
  802. opik/rest_api/types/numerical_feedback_detail_create.py +3 -5
  803. opik/rest_api/types/numerical_feedback_detail_public.py +3 -5
  804. opik/rest_api/types/numerical_feedback_detail_update.py +3 -5
  805. opik/rest_api/types/optimization.py +37 -0
  806. opik/rest_api/types/optimization_page_public.py +28 -0
  807. opik/rest_api/types/optimization_public.py +37 -0
  808. opik/rest_api/types/optimization_public_status.py +7 -0
  809. opik/rest_api/types/optimization_status.py +7 -0
  810. opik/rest_api/types/optimization_studio_config.py +27 -0
  811. opik/rest_api/types/optimization_studio_config_public.py +27 -0
  812. opik/rest_api/types/optimization_studio_config_write.py +27 -0
  813. opik/rest_api/types/optimization_studio_log.py +22 -0
  814. opik/rest_api/types/optimization_write.py +30 -0
  815. opik/rest_api/types/optimization_write_status.py +7 -0
  816. opik/rest_api/types/page_columns.py +4 -6
  817. opik/rest_api/types/percentage_value_stat_public.py +4 -6
  818. opik/rest_api/types/percentage_values.py +8 -16
  819. opik/rest_api/types/percentage_values_detailed.py +8 -16
  820. opik/rest_api/types/percentage_values_public.py +8 -16
  821. opik/rest_api/types/project.py +12 -7
  822. opik/rest_api/types/project_detailed.py +12 -7
  823. opik/rest_api/types/project_detailed_visibility.py +5 -0
  824. opik/rest_api/types/project_metric_response_public.py +5 -9
  825. opik/rest_api/types/project_metric_response_public_interval.py +1 -3
  826. opik/rest_api/types/project_metric_response_public_metric_type.py +11 -1
  827. opik/rest_api/types/project_page_public.py +8 -10
  828. opik/rest_api/types/project_public.py +6 -6
  829. opik/rest_api/types/project_public_visibility.py +5 -0
  830. opik/rest_api/types/project_reference.py +31 -0
  831. opik/rest_api/types/project_reference_public.py +31 -0
  832. opik/rest_api/types/project_stat_item_object_public.py +8 -17
  833. opik/rest_api/types/project_stats_public.py +4 -6
  834. opik/rest_api/types/project_stats_summary.py +4 -6
  835. opik/rest_api/types/project_stats_summary_item.py +9 -6
  836. opik/rest_api/types/project_visibility.py +5 -0
  837. opik/rest_api/types/prompt.py +12 -7
  838. opik/rest_api/types/prompt_detail.py +12 -7
  839. opik/rest_api/types/prompt_detail_template_structure.py +5 -0
  840. opik/rest_api/types/prompt_page_public.py +9 -6
  841. opik/rest_api/types/prompt_public.py +11 -6
  842. opik/rest_api/types/prompt_public_template_structure.py +5 -0
  843. opik/rest_api/types/prompt_template_structure.py +5 -0
  844. opik/rest_api/types/prompt_tokens_details.py +19 -0
  845. opik/rest_api/types/prompt_version.py +7 -6
  846. opik/rest_api/types/prompt_version_detail.py +7 -6
  847. opik/rest_api/types/prompt_version_detail_template_structure.py +5 -0
  848. opik/rest_api/types/prompt_version_link.py +4 -5
  849. opik/rest_api/types/prompt_version_link_public.py +4 -5
  850. opik/rest_api/types/prompt_version_link_write.py +3 -5
  851. opik/rest_api/types/prompt_version_page_public.py +9 -6
  852. opik/rest_api/types/prompt_version_public.py +7 -6
  853. opik/rest_api/types/prompt_version_public_template_structure.py +5 -0
  854. opik/rest_api/types/prompt_version_template_structure.py +5 -0
  855. opik/rest_api/types/prompt_version_update.py +33 -0
  856. opik/rest_api/types/provider_api_key.py +18 -8
  857. opik/rest_api/types/provider_api_key_page_public.py +27 -0
  858. opik/rest_api/types/provider_api_key_provider.py +1 -1
  859. opik/rest_api/types/provider_api_key_public.py +18 -8
  860. opik/rest_api/types/provider_api_key_public_provider.py +1 -1
  861. opik/rest_api/types/response_format.py +5 -7
  862. opik/rest_api/types/response_format_type.py +1 -3
  863. opik/rest_api/types/result.py +21 -0
  864. opik/rest_api/types/results_number_public.py +4 -6
  865. opik/rest_api/types/score_name.py +4 -5
  866. opik/rest_api/types/service_toggles_config.py +44 -0
  867. opik/rest_api/types/span.py +13 -15
  868. opik/rest_api/types/span_batch.py +4 -6
  869. opik/rest_api/types/span_enrichment_options.py +31 -0
  870. opik/rest_api/types/span_experiment_item_bulk_write_view.py +39 -0
  871. opik/rest_api/types/span_experiment_item_bulk_write_view_type.py +5 -0
  872. opik/rest_api/types/span_filter.py +23 -0
  873. opik/rest_api/types/span_filter_operator.py +21 -0
  874. opik/rest_api/types/span_filter_public.py +4 -6
  875. opik/rest_api/types/span_filter_public_operator.py +2 -0
  876. opik/rest_api/types/span_filter_write.py +23 -0
  877. opik/rest_api/types/span_filter_write_operator.py +21 -0
  878. opik/rest_api/types/span_llm_as_judge_code.py +27 -0
  879. opik/rest_api/types/span_llm_as_judge_code_public.py +27 -0
  880. opik/rest_api/types/span_llm_as_judge_code_write.py +27 -0
  881. opik/rest_api/types/span_page_public.py +9 -6
  882. opik/rest_api/types/span_public.py +19 -16
  883. opik/rest_api/types/span_public_type.py +1 -1
  884. opik/rest_api/types/span_type.py +1 -1
  885. opik/rest_api/types/span_update.py +46 -0
  886. opik/rest_api/types/span_update_type.py +5 -0
  887. opik/rest_api/types/span_user_defined_metric_python_code.py +20 -0
  888. opik/rest_api/types/span_user_defined_metric_python_code_public.py +20 -0
  889. opik/rest_api/types/span_user_defined_metric_python_code_write.py +20 -0
  890. opik/rest_api/types/span_write.py +13 -14
  891. opik/rest_api/types/span_write_type.py +1 -1
  892. opik/rest_api/types/spans_count_response.py +20 -0
  893. opik/rest_api/types/start_multipart_upload_response.py +20 -0
  894. opik/rest_api/types/stream_options.py +3 -5
  895. opik/rest_api/types/studio_evaluation.py +20 -0
  896. opik/rest_api/types/studio_evaluation_public.py +20 -0
  897. opik/rest_api/types/studio_evaluation_write.py +20 -0
  898. opik/rest_api/types/studio_llm_model.py +21 -0
  899. opik/rest_api/types/studio_llm_model_public.py +21 -0
  900. opik/rest_api/types/studio_llm_model_write.py +21 -0
  901. opik/rest_api/types/studio_message.py +20 -0
  902. opik/rest_api/types/studio_message_public.py +20 -0
  903. opik/rest_api/types/studio_message_write.py +20 -0
  904. opik/rest_api/types/studio_metric.py +21 -0
  905. opik/rest_api/types/studio_metric_public.py +21 -0
  906. opik/rest_api/types/studio_metric_write.py +21 -0
  907. opik/rest_api/types/studio_optimizer.py +21 -0
  908. opik/rest_api/types/studio_optimizer_public.py +21 -0
  909. opik/rest_api/types/studio_optimizer_write.py +21 -0
  910. opik/rest_api/types/studio_prompt.py +20 -0
  911. opik/rest_api/types/studio_prompt_public.py +20 -0
  912. opik/rest_api/types/studio_prompt_write.py +20 -0
  913. opik/rest_api/types/tool.py +4 -6
  914. opik/rest_api/types/tool_call.py +4 -6
  915. opik/rest_api/types/trace.py +26 -12
  916. opik/rest_api/types/trace_batch.py +4 -6
  917. opik/rest_api/types/trace_count_response.py +4 -6
  918. opik/rest_api/types/trace_enrichment_options.py +32 -0
  919. opik/rest_api/types/trace_experiment_item_bulk_write_view.py +41 -0
  920. opik/rest_api/types/trace_filter.py +23 -0
  921. opik/rest_api/types/trace_filter_operator.py +21 -0
  922. opik/rest_api/types/trace_filter_public.py +23 -0
  923. opik/rest_api/types/trace_filter_public_operator.py +21 -0
  924. opik/rest_api/types/trace_filter_write.py +23 -0
  925. opik/rest_api/types/trace_filter_write_operator.py +21 -0
  926. opik/rest_api/types/trace_page_public.py +8 -10
  927. opik/rest_api/types/trace_public.py +27 -13
  928. opik/rest_api/types/trace_public_visibility_mode.py +5 -0
  929. opik/rest_api/types/trace_thread.py +18 -9
  930. opik/rest_api/types/trace_thread_filter.py +23 -0
  931. opik/rest_api/types/trace_thread_filter_operator.py +21 -0
  932. opik/rest_api/types/trace_thread_filter_public.py +23 -0
  933. opik/rest_api/types/trace_thread_filter_public_operator.py +21 -0
  934. opik/rest_api/types/trace_thread_filter_write.py +23 -0
  935. opik/rest_api/types/trace_thread_filter_write_operator.py +21 -0
  936. opik/rest_api/types/trace_thread_identifier.py +22 -0
  937. opik/rest_api/types/trace_thread_llm_as_judge_code.py +26 -0
  938. opik/rest_api/types/trace_thread_llm_as_judge_code_public.py +26 -0
  939. opik/rest_api/types/trace_thread_llm_as_judge_code_write.py +26 -0
  940. opik/rest_api/types/trace_thread_page.py +9 -6
  941. opik/rest_api/types/trace_thread_status.py +5 -0
  942. opik/rest_api/types/trace_thread_update.py +19 -0
  943. opik/rest_api/types/trace_thread_user_defined_metric_python_code.py +19 -0
  944. opik/rest_api/types/trace_thread_user_defined_metric_python_code_public.py +19 -0
  945. opik/rest_api/types/trace_thread_user_defined_metric_python_code_write.py +19 -0
  946. opik/rest_api/types/trace_update.py +39 -0
  947. opik/rest_api/types/trace_visibility_mode.py +5 -0
  948. opik/rest_api/types/trace_write.py +10 -11
  949. opik/rest_api/types/usage.py +6 -6
  950. opik/rest_api/types/user_defined_metric_python_code.py +3 -5
  951. opik/rest_api/types/user_defined_metric_python_code_public.py +3 -5
  952. opik/rest_api/types/user_defined_metric_python_code_write.py +3 -5
  953. opik/rest_api/types/value_entry.py +27 -0
  954. opik/rest_api/types/value_entry_compare.py +27 -0
  955. opik/rest_api/types/value_entry_compare_source.py +5 -0
  956. opik/rest_api/types/value_entry_experiment_item_bulk_write_view.py +27 -0
  957. opik/rest_api/types/value_entry_experiment_item_bulk_write_view_source.py +5 -0
  958. opik/rest_api/types/value_entry_public.py +27 -0
  959. opik/rest_api/types/value_entry_public_source.py +5 -0
  960. opik/rest_api/types/value_entry_source.py +5 -0
  961. opik/rest_api/types/video_url.py +19 -0
  962. opik/rest_api/types/video_url_public.py +19 -0
  963. opik/rest_api/types/video_url_write.py +19 -0
  964. opik/rest_api/types/webhook.py +28 -0
  965. opik/rest_api/types/webhook_examples.py +19 -0
  966. opik/rest_api/types/webhook_public.py +28 -0
  967. opik/rest_api/types/webhook_test_result.py +23 -0
  968. opik/rest_api/types/webhook_test_result_status.py +5 -0
  969. opik/rest_api/types/webhook_write.py +23 -0
  970. opik/rest_api/types/welcome_wizard_tracking.py +22 -0
  971. opik/rest_api/types/workspace_configuration.py +27 -0
  972. opik/rest_api/types/workspace_metric_request.py +24 -0
  973. opik/rest_api/types/workspace_metric_response.py +20 -0
  974. opik/rest_api/types/workspace_metrics_summary_request.py +23 -0
  975. opik/rest_api/types/workspace_metrics_summary_response.py +20 -0
  976. opik/rest_api/types/workspace_name_holder.py +19 -0
  977. opik/rest_api/types/workspace_spans_count.py +20 -0
  978. opik/rest_api/types/workspace_trace_count.py +3 -5
  979. opik/rest_api/welcome_wizard/__init__.py +4 -0
  980. opik/rest_api/welcome_wizard/client.py +195 -0
  981. opik/rest_api/welcome_wizard/raw_client.py +208 -0
  982. opik/rest_api/workspaces/__init__.py +2 -0
  983. opik/rest_api/workspaces/client.py +550 -77
  984. opik/rest_api/workspaces/raw_client.py +923 -0
  985. opik/rest_client_configurator/api.py +1 -0
  986. opik/rest_client_configurator/retry_decorator.py +1 -0
  987. opik/s3_httpx_client.py +67 -0
  988. opik/simulation/__init__.py +6 -0
  989. opik/simulation/simulated_user.py +99 -0
  990. opik/simulation/simulator.py +108 -0
  991. opik/synchronization.py +11 -24
  992. opik/tracing_runtime_config.py +48 -0
  993. opik/types.py +48 -2
  994. opik/url_helpers.py +13 -3
  995. opik/validation/chat_prompt_messages.py +241 -0
  996. opik/validation/feedback_score.py +4 -5
  997. opik/validation/parameter.py +122 -0
  998. opik/validation/parameters_validator.py +175 -0
  999. opik/validation/validator.py +30 -2
  1000. opik/validation/validator_helpers.py +147 -0
  1001. opik-1.9.71.dist-info/METADATA +370 -0
  1002. opik-1.9.71.dist-info/RECORD +1110 -0
  1003. {opik-1.6.4.dist-info → opik-1.9.71.dist-info}/WHEEL +1 -1
  1004. opik-1.9.71.dist-info/licenses/LICENSE +203 -0
  1005. opik/api_objects/prompt/prompt.py +0 -107
  1006. opik/api_objects/prompt/prompt_template.py +0 -35
  1007. opik/cli.py +0 -193
  1008. opik/evaluation/metrics/models.py +0 -8
  1009. opik/hooks.py +0 -13
  1010. opik/integrations/bedrock/chunks_aggregator.py +0 -55
  1011. opik/integrations/bedrock/helpers.py +0 -8
  1012. opik/integrations/langchain/google_run_helpers.py +0 -75
  1013. opik/integrations/langchain/openai_run_helpers.py +0 -122
  1014. opik/message_processing/message_processors.py +0 -203
  1015. opik/rest_api/types/delta_role.py +0 -7
  1016. opik/rest_api/types/json_object_schema.py +0 -34
  1017. opik-1.6.4.dist-info/METADATA +0 -270
  1018. opik-1.6.4.dist-info/RECORD +0 -507
  1019. /opik/integrations/bedrock/{stream_wrappers.py → converse/stream_wrappers.py} +0 -0
  1020. {opik-1.6.4.dist-info → opik-1.9.71.dist-info}/entry_points.txt +0 -0
  1021. {opik-1.6.4.dist-info → opik-1.9.71.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,1634 @@
1
+ # This file was auto-generated by Fern from our API Definition.
2
+
3
+ import typing
4
+ from json.decoder import JSONDecodeError
5
+
6
+ from ..core.api_error import ApiError
7
+ from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
8
+ from ..core.http_response import AsyncHttpResponse, HttpResponse
9
+ from ..core.jsonable_encoder import jsonable_encoder
10
+ from ..core.pydantic_utilities import parse_obj_as
11
+ from ..core.request_options import RequestOptions
12
+ from ..core.serialization import convert_and_respect_annotation_metadata
13
+ from ..errors.bad_request_error import BadRequestError
14
+ from ..errors.conflict_error import ConflictError
15
+ from ..errors.not_found_error import NotFoundError
16
+ from ..errors.unprocessable_entity_error import UnprocessableEntityError
17
+ from ..types.json_node_write import JsonNodeWrite
18
+ from ..types.prompt_detail import PromptDetail
19
+ from ..types.prompt_page_public import PromptPagePublic
20
+ from ..types.prompt_version_detail import PromptVersionDetail
21
+ from ..types.prompt_version_page_public import PromptVersionPagePublic
22
+ from ..types.prompt_version_update import PromptVersionUpdate
23
+ from .types.create_prompt_version_detail_template_structure import CreatePromptVersionDetailTemplateStructure
24
+ from .types.prompt_write_template_structure import PromptWriteTemplateStructure
25
+ from .types.prompt_write_type import PromptWriteType
26
+
27
+ # this is used as the default value for optional parameters
28
+ OMIT = typing.cast(typing.Any, ...)
29
+
30
+
31
+ class RawPromptsClient:
32
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
33
+ self._client_wrapper = client_wrapper
34
+
35
+ def get_prompts(
36
+ self,
37
+ *,
38
+ page: typing.Optional[int] = None,
39
+ size: typing.Optional[int] = None,
40
+ name: typing.Optional[str] = None,
41
+ sorting: typing.Optional[str] = None,
42
+ filters: typing.Optional[str] = None,
43
+ request_options: typing.Optional[RequestOptions] = None,
44
+ ) -> HttpResponse[PromptPagePublic]:
45
+ """
46
+ Get prompts
47
+
48
+ Parameters
49
+ ----------
50
+ page : typing.Optional[int]
51
+
52
+ size : typing.Optional[int]
53
+
54
+ name : typing.Optional[str]
55
+
56
+ sorting : typing.Optional[str]
57
+
58
+ filters : typing.Optional[str]
59
+
60
+ request_options : typing.Optional[RequestOptions]
61
+ Request-specific configuration.
62
+
63
+ Returns
64
+ -------
65
+ HttpResponse[PromptPagePublic]
66
+ OK
67
+ """
68
+ _response = self._client_wrapper.httpx_client.request(
69
+ "v1/private/prompts",
70
+ method="GET",
71
+ params={
72
+ "page": page,
73
+ "size": size,
74
+ "name": name,
75
+ "sorting": sorting,
76
+ "filters": filters,
77
+ },
78
+ request_options=request_options,
79
+ )
80
+ try:
81
+ if 200 <= _response.status_code < 300:
82
+ _data = typing.cast(
83
+ PromptPagePublic,
84
+ parse_obj_as(
85
+ type_=PromptPagePublic, # type: ignore
86
+ object_=_response.json(),
87
+ ),
88
+ )
89
+ return HttpResponse(response=_response, data=_data)
90
+ _response_json = _response.json()
91
+ except JSONDecodeError:
92
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
93
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
94
+
95
+ def create_prompt(
96
+ self,
97
+ *,
98
+ name: str,
99
+ id: typing.Optional[str] = OMIT,
100
+ description: typing.Optional[str] = OMIT,
101
+ template: typing.Optional[str] = OMIT,
102
+ metadata: typing.Optional[JsonNodeWrite] = OMIT,
103
+ change_description: typing.Optional[str] = OMIT,
104
+ type: typing.Optional[PromptWriteType] = OMIT,
105
+ template_structure: typing.Optional[PromptWriteTemplateStructure] = OMIT,
106
+ tags: typing.Optional[typing.Sequence[str]] = OMIT,
107
+ request_options: typing.Optional[RequestOptions] = None,
108
+ ) -> HttpResponse[None]:
109
+ """
110
+ Create prompt
111
+
112
+ Parameters
113
+ ----------
114
+ name : str
115
+
116
+ id : typing.Optional[str]
117
+
118
+ description : typing.Optional[str]
119
+
120
+ template : typing.Optional[str]
121
+
122
+ metadata : typing.Optional[JsonNodeWrite]
123
+
124
+ change_description : typing.Optional[str]
125
+
126
+ type : typing.Optional[PromptWriteType]
127
+
128
+ template_structure : typing.Optional[PromptWriteTemplateStructure]
129
+ Template structure type: 'text' or 'chat'. Immutable after creation.
130
+
131
+ tags : typing.Optional[typing.Sequence[str]]
132
+
133
+ request_options : typing.Optional[RequestOptions]
134
+ Request-specific configuration.
135
+
136
+ Returns
137
+ -------
138
+ HttpResponse[None]
139
+ """
140
+ _response = self._client_wrapper.httpx_client.request(
141
+ "v1/private/prompts",
142
+ method="POST",
143
+ json={
144
+ "id": id,
145
+ "name": name,
146
+ "description": description,
147
+ "template": template,
148
+ "metadata": metadata,
149
+ "change_description": change_description,
150
+ "type": type,
151
+ "template_structure": template_structure,
152
+ "tags": tags,
153
+ },
154
+ headers={
155
+ "content-type": "application/json",
156
+ },
157
+ request_options=request_options,
158
+ omit=OMIT,
159
+ )
160
+ try:
161
+ if 200 <= _response.status_code < 300:
162
+ return HttpResponse(response=_response, data=None)
163
+ if _response.status_code == 400:
164
+ raise BadRequestError(
165
+ headers=dict(_response.headers),
166
+ body=typing.cast(
167
+ typing.Optional[typing.Any],
168
+ parse_obj_as(
169
+ type_=typing.Optional[typing.Any], # type: ignore
170
+ object_=_response.json(),
171
+ ),
172
+ ),
173
+ )
174
+ if _response.status_code == 409:
175
+ raise ConflictError(
176
+ headers=dict(_response.headers),
177
+ body=typing.cast(
178
+ typing.Optional[typing.Any],
179
+ parse_obj_as(
180
+ type_=typing.Optional[typing.Any], # type: ignore
181
+ object_=_response.json(),
182
+ ),
183
+ ),
184
+ )
185
+ if _response.status_code == 422:
186
+ raise UnprocessableEntityError(
187
+ headers=dict(_response.headers),
188
+ body=typing.cast(
189
+ typing.Optional[typing.Any],
190
+ parse_obj_as(
191
+ type_=typing.Optional[typing.Any], # type: ignore
192
+ object_=_response.json(),
193
+ ),
194
+ ),
195
+ )
196
+ _response_json = _response.json()
197
+ except JSONDecodeError:
198
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
199
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
200
+
201
+ def create_prompt_version(
202
+ self,
203
+ *,
204
+ name: str,
205
+ version: PromptVersionDetail,
206
+ template_structure: typing.Optional[CreatePromptVersionDetailTemplateStructure] = OMIT,
207
+ request_options: typing.Optional[RequestOptions] = None,
208
+ ) -> HttpResponse[PromptVersionDetail]:
209
+ """
210
+ Create prompt version
211
+
212
+ Parameters
213
+ ----------
214
+ name : str
215
+
216
+ version : PromptVersionDetail
217
+
218
+ template_structure : typing.Optional[CreatePromptVersionDetailTemplateStructure]
219
+ Template structure for the prompt: 'text' or 'chat'. Note: This field is only used when creating a new prompt. If a prompt with the given name already exists, this field is ignored and the existing prompt's template structure is used. Template structure is immutable after prompt creation.
220
+
221
+ request_options : typing.Optional[RequestOptions]
222
+ Request-specific configuration.
223
+
224
+ Returns
225
+ -------
226
+ HttpResponse[PromptVersionDetail]
227
+ OK
228
+ """
229
+ _response = self._client_wrapper.httpx_client.request(
230
+ "v1/private/prompts/versions",
231
+ method="POST",
232
+ json={
233
+ "name": name,
234
+ "version": convert_and_respect_annotation_metadata(
235
+ object_=version, annotation=PromptVersionDetail, direction="write"
236
+ ),
237
+ "template_structure": template_structure,
238
+ },
239
+ headers={
240
+ "content-type": "application/json",
241
+ },
242
+ request_options=request_options,
243
+ omit=OMIT,
244
+ )
245
+ try:
246
+ if 200 <= _response.status_code < 300:
247
+ _data = typing.cast(
248
+ PromptVersionDetail,
249
+ parse_obj_as(
250
+ type_=PromptVersionDetail, # type: ignore
251
+ object_=_response.json(),
252
+ ),
253
+ )
254
+ return HttpResponse(response=_response, data=_data)
255
+ if _response.status_code == 400:
256
+ raise BadRequestError(
257
+ headers=dict(_response.headers),
258
+ body=typing.cast(
259
+ typing.Optional[typing.Any],
260
+ parse_obj_as(
261
+ type_=typing.Optional[typing.Any], # type: ignore
262
+ object_=_response.json(),
263
+ ),
264
+ ),
265
+ )
266
+ if _response.status_code == 409:
267
+ raise ConflictError(
268
+ headers=dict(_response.headers),
269
+ body=typing.cast(
270
+ typing.Optional[typing.Any],
271
+ parse_obj_as(
272
+ type_=typing.Optional[typing.Any], # type: ignore
273
+ object_=_response.json(),
274
+ ),
275
+ ),
276
+ )
277
+ if _response.status_code == 422:
278
+ raise UnprocessableEntityError(
279
+ headers=dict(_response.headers),
280
+ body=typing.cast(
281
+ typing.Optional[typing.Any],
282
+ parse_obj_as(
283
+ type_=typing.Optional[typing.Any], # type: ignore
284
+ object_=_response.json(),
285
+ ),
286
+ ),
287
+ )
288
+ _response_json = _response.json()
289
+ except JSONDecodeError:
290
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
291
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
292
+
293
+ def update_prompt_versions(
294
+ self,
295
+ *,
296
+ ids: typing.Sequence[str],
297
+ update: PromptVersionUpdate,
298
+ merge_tags: typing.Optional[bool] = OMIT,
299
+ request_options: typing.Optional[RequestOptions] = None,
300
+ ) -> HttpResponse[None]:
301
+ """
302
+ Update one or more prompt versions.
303
+
304
+ Note: Prompt versions are immutable by design.
305
+ Only organizational properties, such as tags etc., can be updated.
306
+ Core properties like template and metadata cannot be modified after creation.
307
+
308
+ PATCH semantics:
309
+ - non-empty values update the field
310
+ - null values preserve existing field values (no change)
311
+ - empty values explicitly clear the field
312
+
313
+ Parameters
314
+ ----------
315
+ ids : typing.Sequence[str]
316
+ IDs of prompt versions to update
317
+
318
+ update : PromptVersionUpdate
319
+
320
+ merge_tags : typing.Optional[bool]
321
+ Tag merge behavior:
322
+ - true: Add new tags to existing tags (union)
323
+ - false: Replace all existing tags with new tags (default behaviour if not provided)
324
+
325
+ request_options : typing.Optional[RequestOptions]
326
+ Request-specific configuration.
327
+
328
+ Returns
329
+ -------
330
+ HttpResponse[None]
331
+ """
332
+ _response = self._client_wrapper.httpx_client.request(
333
+ "v1/private/prompts/versions",
334
+ method="PATCH",
335
+ json={
336
+ "ids": ids,
337
+ "update": convert_and_respect_annotation_metadata(
338
+ object_=update, annotation=PromptVersionUpdate, direction="write"
339
+ ),
340
+ "merge_tags": merge_tags,
341
+ },
342
+ headers={
343
+ "content-type": "application/json",
344
+ },
345
+ request_options=request_options,
346
+ omit=OMIT,
347
+ )
348
+ try:
349
+ if 200 <= _response.status_code < 300:
350
+ return HttpResponse(response=_response, data=None)
351
+ if _response.status_code == 400:
352
+ raise BadRequestError(
353
+ headers=dict(_response.headers),
354
+ body=typing.cast(
355
+ typing.Optional[typing.Any],
356
+ parse_obj_as(
357
+ type_=typing.Optional[typing.Any], # type: ignore
358
+ object_=_response.json(),
359
+ ),
360
+ ),
361
+ )
362
+ _response_json = _response.json()
363
+ except JSONDecodeError:
364
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
365
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
366
+
367
+ def get_prompt_by_id(
368
+ self, id: str, *, request_options: typing.Optional[RequestOptions] = None
369
+ ) -> HttpResponse[PromptDetail]:
370
+ """
371
+ Get prompt by id
372
+
373
+ Parameters
374
+ ----------
375
+ id : str
376
+
377
+ request_options : typing.Optional[RequestOptions]
378
+ Request-specific configuration.
379
+
380
+ Returns
381
+ -------
382
+ HttpResponse[PromptDetail]
383
+ Prompt resource
384
+ """
385
+ _response = self._client_wrapper.httpx_client.request(
386
+ f"v1/private/prompts/{jsonable_encoder(id)}",
387
+ method="GET",
388
+ request_options=request_options,
389
+ )
390
+ try:
391
+ if 200 <= _response.status_code < 300:
392
+ _data = typing.cast(
393
+ PromptDetail,
394
+ parse_obj_as(
395
+ type_=PromptDetail, # type: ignore
396
+ object_=_response.json(),
397
+ ),
398
+ )
399
+ return HttpResponse(response=_response, data=_data)
400
+ if _response.status_code == 404:
401
+ raise NotFoundError(
402
+ headers=dict(_response.headers),
403
+ body=typing.cast(
404
+ typing.Optional[typing.Any],
405
+ parse_obj_as(
406
+ type_=typing.Optional[typing.Any], # type: ignore
407
+ object_=_response.json(),
408
+ ),
409
+ ),
410
+ )
411
+ _response_json = _response.json()
412
+ except JSONDecodeError:
413
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
414
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
415
+
416
+ def update_prompt(
417
+ self,
418
+ id: str,
419
+ *,
420
+ name: str,
421
+ description: typing.Optional[str] = OMIT,
422
+ tags: typing.Optional[typing.Sequence[str]] = OMIT,
423
+ request_options: typing.Optional[RequestOptions] = None,
424
+ ) -> HttpResponse[None]:
425
+ """
426
+ Update prompt
427
+
428
+ Parameters
429
+ ----------
430
+ id : str
431
+
432
+ name : str
433
+
434
+ description : typing.Optional[str]
435
+
436
+ tags : typing.Optional[typing.Sequence[str]]
437
+
438
+ request_options : typing.Optional[RequestOptions]
439
+ Request-specific configuration.
440
+
441
+ Returns
442
+ -------
443
+ HttpResponse[None]
444
+ """
445
+ _response = self._client_wrapper.httpx_client.request(
446
+ f"v1/private/prompts/{jsonable_encoder(id)}",
447
+ method="PUT",
448
+ json={
449
+ "name": name,
450
+ "description": description,
451
+ "tags": tags,
452
+ },
453
+ headers={
454
+ "content-type": "application/json",
455
+ },
456
+ request_options=request_options,
457
+ omit=OMIT,
458
+ )
459
+ try:
460
+ if 200 <= _response.status_code < 300:
461
+ return HttpResponse(response=_response, data=None)
462
+ if _response.status_code == 400:
463
+ raise BadRequestError(
464
+ headers=dict(_response.headers),
465
+ body=typing.cast(
466
+ typing.Optional[typing.Any],
467
+ parse_obj_as(
468
+ type_=typing.Optional[typing.Any], # type: ignore
469
+ object_=_response.json(),
470
+ ),
471
+ ),
472
+ )
473
+ if _response.status_code == 404:
474
+ raise NotFoundError(
475
+ headers=dict(_response.headers),
476
+ body=typing.cast(
477
+ typing.Optional[typing.Any],
478
+ parse_obj_as(
479
+ type_=typing.Optional[typing.Any], # type: ignore
480
+ object_=_response.json(),
481
+ ),
482
+ ),
483
+ )
484
+ if _response.status_code == 409:
485
+ raise ConflictError(
486
+ headers=dict(_response.headers),
487
+ body=typing.cast(
488
+ typing.Optional[typing.Any],
489
+ parse_obj_as(
490
+ type_=typing.Optional[typing.Any], # type: ignore
491
+ object_=_response.json(),
492
+ ),
493
+ ),
494
+ )
495
+ if _response.status_code == 422:
496
+ raise UnprocessableEntityError(
497
+ headers=dict(_response.headers),
498
+ body=typing.cast(
499
+ typing.Optional[typing.Any],
500
+ parse_obj_as(
501
+ type_=typing.Optional[typing.Any], # type: ignore
502
+ object_=_response.json(),
503
+ ),
504
+ ),
505
+ )
506
+ _response_json = _response.json()
507
+ except JSONDecodeError:
508
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
509
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
510
+
511
+ def delete_prompt(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[None]:
512
+ """
513
+ Delete prompt
514
+
515
+ Parameters
516
+ ----------
517
+ id : str
518
+
519
+ request_options : typing.Optional[RequestOptions]
520
+ Request-specific configuration.
521
+
522
+ Returns
523
+ -------
524
+ HttpResponse[None]
525
+ """
526
+ _response = self._client_wrapper.httpx_client.request(
527
+ f"v1/private/prompts/{jsonable_encoder(id)}",
528
+ method="DELETE",
529
+ request_options=request_options,
530
+ )
531
+ try:
532
+ if 200 <= _response.status_code < 300:
533
+ return HttpResponse(response=_response, data=None)
534
+ _response_json = _response.json()
535
+ except JSONDecodeError:
536
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
537
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
538
+
539
+ def delete_prompts_batch(
540
+ self, *, ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None
541
+ ) -> HttpResponse[None]:
542
+ """
543
+ Delete prompts batch
544
+
545
+ Parameters
546
+ ----------
547
+ ids : typing.Sequence[str]
548
+
549
+ request_options : typing.Optional[RequestOptions]
550
+ Request-specific configuration.
551
+
552
+ Returns
553
+ -------
554
+ HttpResponse[None]
555
+ """
556
+ _response = self._client_wrapper.httpx_client.request(
557
+ "v1/private/prompts/delete",
558
+ method="POST",
559
+ json={
560
+ "ids": ids,
561
+ },
562
+ headers={
563
+ "content-type": "application/json",
564
+ },
565
+ request_options=request_options,
566
+ omit=OMIT,
567
+ )
568
+ try:
569
+ if 200 <= _response.status_code < 300:
570
+ return HttpResponse(response=_response, data=None)
571
+ _response_json = _response.json()
572
+ except JSONDecodeError:
573
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
574
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
575
+
576
+ def get_prompt_version_by_id(
577
+ self, version_id: str, *, request_options: typing.Optional[RequestOptions] = None
578
+ ) -> HttpResponse[PromptVersionDetail]:
579
+ """
580
+ Get prompt version by id
581
+
582
+ Parameters
583
+ ----------
584
+ version_id : str
585
+
586
+ request_options : typing.Optional[RequestOptions]
587
+ Request-specific configuration.
588
+
589
+ Returns
590
+ -------
591
+ HttpResponse[PromptVersionDetail]
592
+ Prompt version resource
593
+ """
594
+ _response = self._client_wrapper.httpx_client.request(
595
+ f"v1/private/prompts/versions/{jsonable_encoder(version_id)}",
596
+ method="GET",
597
+ request_options=request_options,
598
+ )
599
+ try:
600
+ if 200 <= _response.status_code < 300:
601
+ _data = typing.cast(
602
+ PromptVersionDetail,
603
+ parse_obj_as(
604
+ type_=PromptVersionDetail, # type: ignore
605
+ object_=_response.json(),
606
+ ),
607
+ )
608
+ return HttpResponse(response=_response, data=_data)
609
+ if _response.status_code == 404:
610
+ raise NotFoundError(
611
+ headers=dict(_response.headers),
612
+ body=typing.cast(
613
+ typing.Optional[typing.Any],
614
+ parse_obj_as(
615
+ type_=typing.Optional[typing.Any], # type: ignore
616
+ object_=_response.json(),
617
+ ),
618
+ ),
619
+ )
620
+ _response_json = _response.json()
621
+ except JSONDecodeError:
622
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
623
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
624
+
625
+ def get_prompt_versions(
626
+ self,
627
+ id: str,
628
+ *,
629
+ page: typing.Optional[int] = None,
630
+ size: typing.Optional[int] = None,
631
+ search: typing.Optional[str] = None,
632
+ sorting: typing.Optional[str] = None,
633
+ filters: typing.Optional[str] = None,
634
+ request_options: typing.Optional[RequestOptions] = None,
635
+ ) -> HttpResponse[PromptVersionPagePublic]:
636
+ """
637
+ Get prompt versions
638
+
639
+ Parameters
640
+ ----------
641
+ id : str
642
+
643
+ page : typing.Optional[int]
644
+
645
+ size : typing.Optional[int]
646
+
647
+ search : typing.Optional[str]
648
+ Search text to find in template or change description fields
649
+
650
+ sorting : typing.Optional[str]
651
+
652
+ filters : typing.Optional[str]
653
+
654
+ request_options : typing.Optional[RequestOptions]
655
+ Request-specific configuration.
656
+
657
+ Returns
658
+ -------
659
+ HttpResponse[PromptVersionPagePublic]
660
+ OK
661
+ """
662
+ _response = self._client_wrapper.httpx_client.request(
663
+ f"v1/private/prompts/{jsonable_encoder(id)}/versions",
664
+ method="GET",
665
+ params={
666
+ "page": page,
667
+ "size": size,
668
+ "search": search,
669
+ "sorting": sorting,
670
+ "filters": filters,
671
+ },
672
+ request_options=request_options,
673
+ )
674
+ try:
675
+ if 200 <= _response.status_code < 300:
676
+ _data = typing.cast(
677
+ PromptVersionPagePublic,
678
+ parse_obj_as(
679
+ type_=PromptVersionPagePublic, # type: ignore
680
+ object_=_response.json(),
681
+ ),
682
+ )
683
+ return HttpResponse(response=_response, data=_data)
684
+ _response_json = _response.json()
685
+ except JSONDecodeError:
686
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
687
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
688
+
689
+ def restore_prompt_version(
690
+ self, prompt_id: str, version_id: str, *, request_options: typing.Optional[RequestOptions] = None
691
+ ) -> HttpResponse[PromptVersionDetail]:
692
+ """
693
+ Restore a prompt version by creating a new version with the content from the specified version
694
+
695
+ Parameters
696
+ ----------
697
+ prompt_id : str
698
+
699
+ version_id : str
700
+
701
+ request_options : typing.Optional[RequestOptions]
702
+ Request-specific configuration.
703
+
704
+ Returns
705
+ -------
706
+ HttpResponse[PromptVersionDetail]
707
+ OK
708
+ """
709
+ _response = self._client_wrapper.httpx_client.request(
710
+ f"v1/private/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}/restore",
711
+ method="POST",
712
+ request_options=request_options,
713
+ )
714
+ try:
715
+ if 200 <= _response.status_code < 300:
716
+ _data = typing.cast(
717
+ PromptVersionDetail,
718
+ parse_obj_as(
719
+ type_=PromptVersionDetail, # type: ignore
720
+ object_=_response.json(),
721
+ ),
722
+ )
723
+ return HttpResponse(response=_response, data=_data)
724
+ if _response.status_code == 400:
725
+ raise BadRequestError(
726
+ headers=dict(_response.headers),
727
+ body=typing.cast(
728
+ typing.Optional[typing.Any],
729
+ parse_obj_as(
730
+ type_=typing.Optional[typing.Any], # type: ignore
731
+ object_=_response.json(),
732
+ ),
733
+ ),
734
+ )
735
+ if _response.status_code == 404:
736
+ raise NotFoundError(
737
+ headers=dict(_response.headers),
738
+ body=typing.cast(
739
+ typing.Optional[typing.Any],
740
+ parse_obj_as(
741
+ type_=typing.Optional[typing.Any], # type: ignore
742
+ object_=_response.json(),
743
+ ),
744
+ ),
745
+ )
746
+ _response_json = _response.json()
747
+ except JSONDecodeError:
748
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
749
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
750
+
751
+ def retrieve_prompt_version(
752
+ self, *, name: str, commit: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
753
+ ) -> HttpResponse[PromptVersionDetail]:
754
+ """
755
+ Retrieve prompt version
756
+
757
+ Parameters
758
+ ----------
759
+ name : str
760
+
761
+ commit : typing.Optional[str]
762
+
763
+ request_options : typing.Optional[RequestOptions]
764
+ Request-specific configuration.
765
+
766
+ Returns
767
+ -------
768
+ HttpResponse[PromptVersionDetail]
769
+ OK
770
+ """
771
+ _response = self._client_wrapper.httpx_client.request(
772
+ "v1/private/prompts/versions/retrieve",
773
+ method="POST",
774
+ json={
775
+ "name": name,
776
+ "commit": commit,
777
+ },
778
+ headers={
779
+ "content-type": "application/json",
780
+ },
781
+ request_options=request_options,
782
+ omit=OMIT,
783
+ )
784
+ try:
785
+ if 200 <= _response.status_code < 300:
786
+ _data = typing.cast(
787
+ PromptVersionDetail,
788
+ parse_obj_as(
789
+ type_=PromptVersionDetail, # type: ignore
790
+ object_=_response.json(),
791
+ ),
792
+ )
793
+ return HttpResponse(response=_response, data=_data)
794
+ if _response.status_code == 400:
795
+ raise BadRequestError(
796
+ headers=dict(_response.headers),
797
+ body=typing.cast(
798
+ typing.Optional[typing.Any],
799
+ parse_obj_as(
800
+ type_=typing.Optional[typing.Any], # type: ignore
801
+ object_=_response.json(),
802
+ ),
803
+ ),
804
+ )
805
+ if _response.status_code == 404:
806
+ raise NotFoundError(
807
+ headers=dict(_response.headers),
808
+ body=typing.cast(
809
+ typing.Optional[typing.Any],
810
+ parse_obj_as(
811
+ type_=typing.Optional[typing.Any], # type: ignore
812
+ object_=_response.json(),
813
+ ),
814
+ ),
815
+ )
816
+ if _response.status_code == 422:
817
+ raise UnprocessableEntityError(
818
+ headers=dict(_response.headers),
819
+ body=typing.cast(
820
+ typing.Optional[typing.Any],
821
+ parse_obj_as(
822
+ type_=typing.Optional[typing.Any], # type: ignore
823
+ object_=_response.json(),
824
+ ),
825
+ ),
826
+ )
827
+ _response_json = _response.json()
828
+ except JSONDecodeError:
829
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
830
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
831
+
832
+
833
+ class AsyncRawPromptsClient:
834
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
835
+ self._client_wrapper = client_wrapper
836
+
837
+ async def get_prompts(
838
+ self,
839
+ *,
840
+ page: typing.Optional[int] = None,
841
+ size: typing.Optional[int] = None,
842
+ name: typing.Optional[str] = None,
843
+ sorting: typing.Optional[str] = None,
844
+ filters: typing.Optional[str] = None,
845
+ request_options: typing.Optional[RequestOptions] = None,
846
+ ) -> AsyncHttpResponse[PromptPagePublic]:
847
+ """
848
+ Get prompts
849
+
850
+ Parameters
851
+ ----------
852
+ page : typing.Optional[int]
853
+
854
+ size : typing.Optional[int]
855
+
856
+ name : typing.Optional[str]
857
+
858
+ sorting : typing.Optional[str]
859
+
860
+ filters : typing.Optional[str]
861
+
862
+ request_options : typing.Optional[RequestOptions]
863
+ Request-specific configuration.
864
+
865
+ Returns
866
+ -------
867
+ AsyncHttpResponse[PromptPagePublic]
868
+ OK
869
+ """
870
+ _response = await self._client_wrapper.httpx_client.request(
871
+ "v1/private/prompts",
872
+ method="GET",
873
+ params={
874
+ "page": page,
875
+ "size": size,
876
+ "name": name,
877
+ "sorting": sorting,
878
+ "filters": filters,
879
+ },
880
+ request_options=request_options,
881
+ )
882
+ try:
883
+ if 200 <= _response.status_code < 300:
884
+ _data = typing.cast(
885
+ PromptPagePublic,
886
+ parse_obj_as(
887
+ type_=PromptPagePublic, # type: ignore
888
+ object_=_response.json(),
889
+ ),
890
+ )
891
+ return AsyncHttpResponse(response=_response, data=_data)
892
+ _response_json = _response.json()
893
+ except JSONDecodeError:
894
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
895
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
896
+
897
+ async def create_prompt(
898
+ self,
899
+ *,
900
+ name: str,
901
+ id: typing.Optional[str] = OMIT,
902
+ description: typing.Optional[str] = OMIT,
903
+ template: typing.Optional[str] = OMIT,
904
+ metadata: typing.Optional[JsonNodeWrite] = OMIT,
905
+ change_description: typing.Optional[str] = OMIT,
906
+ type: typing.Optional[PromptWriteType] = OMIT,
907
+ template_structure: typing.Optional[PromptWriteTemplateStructure] = OMIT,
908
+ tags: typing.Optional[typing.Sequence[str]] = OMIT,
909
+ request_options: typing.Optional[RequestOptions] = None,
910
+ ) -> AsyncHttpResponse[None]:
911
+ """
912
+ Create prompt
913
+
914
+ Parameters
915
+ ----------
916
+ name : str
917
+
918
+ id : typing.Optional[str]
919
+
920
+ description : typing.Optional[str]
921
+
922
+ template : typing.Optional[str]
923
+
924
+ metadata : typing.Optional[JsonNodeWrite]
925
+
926
+ change_description : typing.Optional[str]
927
+
928
+ type : typing.Optional[PromptWriteType]
929
+
930
+ template_structure : typing.Optional[PromptWriteTemplateStructure]
931
+ Template structure type: 'text' or 'chat'. Immutable after creation.
932
+
933
+ tags : typing.Optional[typing.Sequence[str]]
934
+
935
+ request_options : typing.Optional[RequestOptions]
936
+ Request-specific configuration.
937
+
938
+ Returns
939
+ -------
940
+ AsyncHttpResponse[None]
941
+ """
942
+ _response = await self._client_wrapper.httpx_client.request(
943
+ "v1/private/prompts",
944
+ method="POST",
945
+ json={
946
+ "id": id,
947
+ "name": name,
948
+ "description": description,
949
+ "template": template,
950
+ "metadata": metadata,
951
+ "change_description": change_description,
952
+ "type": type,
953
+ "template_structure": template_structure,
954
+ "tags": tags,
955
+ },
956
+ headers={
957
+ "content-type": "application/json",
958
+ },
959
+ request_options=request_options,
960
+ omit=OMIT,
961
+ )
962
+ try:
963
+ if 200 <= _response.status_code < 300:
964
+ return AsyncHttpResponse(response=_response, data=None)
965
+ if _response.status_code == 400:
966
+ raise BadRequestError(
967
+ headers=dict(_response.headers),
968
+ body=typing.cast(
969
+ typing.Optional[typing.Any],
970
+ parse_obj_as(
971
+ type_=typing.Optional[typing.Any], # type: ignore
972
+ object_=_response.json(),
973
+ ),
974
+ ),
975
+ )
976
+ if _response.status_code == 409:
977
+ raise ConflictError(
978
+ headers=dict(_response.headers),
979
+ body=typing.cast(
980
+ typing.Optional[typing.Any],
981
+ parse_obj_as(
982
+ type_=typing.Optional[typing.Any], # type: ignore
983
+ object_=_response.json(),
984
+ ),
985
+ ),
986
+ )
987
+ if _response.status_code == 422:
988
+ raise UnprocessableEntityError(
989
+ headers=dict(_response.headers),
990
+ body=typing.cast(
991
+ typing.Optional[typing.Any],
992
+ parse_obj_as(
993
+ type_=typing.Optional[typing.Any], # type: ignore
994
+ object_=_response.json(),
995
+ ),
996
+ ),
997
+ )
998
+ _response_json = _response.json()
999
+ except JSONDecodeError:
1000
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
1001
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
1002
+
1003
+ async def create_prompt_version(
1004
+ self,
1005
+ *,
1006
+ name: str,
1007
+ version: PromptVersionDetail,
1008
+ template_structure: typing.Optional[CreatePromptVersionDetailTemplateStructure] = OMIT,
1009
+ request_options: typing.Optional[RequestOptions] = None,
1010
+ ) -> AsyncHttpResponse[PromptVersionDetail]:
1011
+ """
1012
+ Create prompt version
1013
+
1014
+ Parameters
1015
+ ----------
1016
+ name : str
1017
+
1018
+ version : PromptVersionDetail
1019
+
1020
+ template_structure : typing.Optional[CreatePromptVersionDetailTemplateStructure]
1021
+ Template structure for the prompt: 'text' or 'chat'. Note: This field is only used when creating a new prompt. If a prompt with the given name already exists, this field is ignored and the existing prompt's template structure is used. Template structure is immutable after prompt creation.
1022
+
1023
+ request_options : typing.Optional[RequestOptions]
1024
+ Request-specific configuration.
1025
+
1026
+ Returns
1027
+ -------
1028
+ AsyncHttpResponse[PromptVersionDetail]
1029
+ OK
1030
+ """
1031
+ _response = await self._client_wrapper.httpx_client.request(
1032
+ "v1/private/prompts/versions",
1033
+ method="POST",
1034
+ json={
1035
+ "name": name,
1036
+ "version": convert_and_respect_annotation_metadata(
1037
+ object_=version, annotation=PromptVersionDetail, direction="write"
1038
+ ),
1039
+ "template_structure": template_structure,
1040
+ },
1041
+ headers={
1042
+ "content-type": "application/json",
1043
+ },
1044
+ request_options=request_options,
1045
+ omit=OMIT,
1046
+ )
1047
+ try:
1048
+ if 200 <= _response.status_code < 300:
1049
+ _data = typing.cast(
1050
+ PromptVersionDetail,
1051
+ parse_obj_as(
1052
+ type_=PromptVersionDetail, # type: ignore
1053
+ object_=_response.json(),
1054
+ ),
1055
+ )
1056
+ return AsyncHttpResponse(response=_response, data=_data)
1057
+ if _response.status_code == 400:
1058
+ raise BadRequestError(
1059
+ headers=dict(_response.headers),
1060
+ body=typing.cast(
1061
+ typing.Optional[typing.Any],
1062
+ parse_obj_as(
1063
+ type_=typing.Optional[typing.Any], # type: ignore
1064
+ object_=_response.json(),
1065
+ ),
1066
+ ),
1067
+ )
1068
+ if _response.status_code == 409:
1069
+ raise ConflictError(
1070
+ headers=dict(_response.headers),
1071
+ body=typing.cast(
1072
+ typing.Optional[typing.Any],
1073
+ parse_obj_as(
1074
+ type_=typing.Optional[typing.Any], # type: ignore
1075
+ object_=_response.json(),
1076
+ ),
1077
+ ),
1078
+ )
1079
+ if _response.status_code == 422:
1080
+ raise UnprocessableEntityError(
1081
+ headers=dict(_response.headers),
1082
+ body=typing.cast(
1083
+ typing.Optional[typing.Any],
1084
+ parse_obj_as(
1085
+ type_=typing.Optional[typing.Any], # type: ignore
1086
+ object_=_response.json(),
1087
+ ),
1088
+ ),
1089
+ )
1090
+ _response_json = _response.json()
1091
+ except JSONDecodeError:
1092
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
1093
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
1094
+
1095
+ async def update_prompt_versions(
1096
+ self,
1097
+ *,
1098
+ ids: typing.Sequence[str],
1099
+ update: PromptVersionUpdate,
1100
+ merge_tags: typing.Optional[bool] = OMIT,
1101
+ request_options: typing.Optional[RequestOptions] = None,
1102
+ ) -> AsyncHttpResponse[None]:
1103
+ """
1104
+ Update one or more prompt versions.
1105
+
1106
+ Note: Prompt versions are immutable by design.
1107
+ Only organizational properties, such as tags etc., can be updated.
1108
+ Core properties like template and metadata cannot be modified after creation.
1109
+
1110
+ PATCH semantics:
1111
+ - non-empty values update the field
1112
+ - null values preserve existing field values (no change)
1113
+ - empty values explicitly clear the field
1114
+
1115
+ Parameters
1116
+ ----------
1117
+ ids : typing.Sequence[str]
1118
+ IDs of prompt versions to update
1119
+
1120
+ update : PromptVersionUpdate
1121
+
1122
+ merge_tags : typing.Optional[bool]
1123
+ Tag merge behavior:
1124
+ - true: Add new tags to existing tags (union)
1125
+ - false: Replace all existing tags with new tags (default behaviour if not provided)
1126
+
1127
+ request_options : typing.Optional[RequestOptions]
1128
+ Request-specific configuration.
1129
+
1130
+ Returns
1131
+ -------
1132
+ AsyncHttpResponse[None]
1133
+ """
1134
+ _response = await self._client_wrapper.httpx_client.request(
1135
+ "v1/private/prompts/versions",
1136
+ method="PATCH",
1137
+ json={
1138
+ "ids": ids,
1139
+ "update": convert_and_respect_annotation_metadata(
1140
+ object_=update, annotation=PromptVersionUpdate, direction="write"
1141
+ ),
1142
+ "merge_tags": merge_tags,
1143
+ },
1144
+ headers={
1145
+ "content-type": "application/json",
1146
+ },
1147
+ request_options=request_options,
1148
+ omit=OMIT,
1149
+ )
1150
+ try:
1151
+ if 200 <= _response.status_code < 300:
1152
+ return AsyncHttpResponse(response=_response, data=None)
1153
+ if _response.status_code == 400:
1154
+ raise BadRequestError(
1155
+ headers=dict(_response.headers),
1156
+ body=typing.cast(
1157
+ typing.Optional[typing.Any],
1158
+ parse_obj_as(
1159
+ type_=typing.Optional[typing.Any], # type: ignore
1160
+ object_=_response.json(),
1161
+ ),
1162
+ ),
1163
+ )
1164
+ _response_json = _response.json()
1165
+ except JSONDecodeError:
1166
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
1167
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
1168
+
1169
+ async def get_prompt_by_id(
1170
+ self, id: str, *, request_options: typing.Optional[RequestOptions] = None
1171
+ ) -> AsyncHttpResponse[PromptDetail]:
1172
+ """
1173
+ Get prompt by id
1174
+
1175
+ Parameters
1176
+ ----------
1177
+ id : str
1178
+
1179
+ request_options : typing.Optional[RequestOptions]
1180
+ Request-specific configuration.
1181
+
1182
+ Returns
1183
+ -------
1184
+ AsyncHttpResponse[PromptDetail]
1185
+ Prompt resource
1186
+ """
1187
+ _response = await self._client_wrapper.httpx_client.request(
1188
+ f"v1/private/prompts/{jsonable_encoder(id)}",
1189
+ method="GET",
1190
+ request_options=request_options,
1191
+ )
1192
+ try:
1193
+ if 200 <= _response.status_code < 300:
1194
+ _data = typing.cast(
1195
+ PromptDetail,
1196
+ parse_obj_as(
1197
+ type_=PromptDetail, # type: ignore
1198
+ object_=_response.json(),
1199
+ ),
1200
+ )
1201
+ return AsyncHttpResponse(response=_response, data=_data)
1202
+ if _response.status_code == 404:
1203
+ raise NotFoundError(
1204
+ headers=dict(_response.headers),
1205
+ body=typing.cast(
1206
+ typing.Optional[typing.Any],
1207
+ parse_obj_as(
1208
+ type_=typing.Optional[typing.Any], # type: ignore
1209
+ object_=_response.json(),
1210
+ ),
1211
+ ),
1212
+ )
1213
+ _response_json = _response.json()
1214
+ except JSONDecodeError:
1215
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
1216
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
1217
+
1218
+ async def update_prompt(
1219
+ self,
1220
+ id: str,
1221
+ *,
1222
+ name: str,
1223
+ description: typing.Optional[str] = OMIT,
1224
+ tags: typing.Optional[typing.Sequence[str]] = OMIT,
1225
+ request_options: typing.Optional[RequestOptions] = None,
1226
+ ) -> AsyncHttpResponse[None]:
1227
+ """
1228
+ Update prompt
1229
+
1230
+ Parameters
1231
+ ----------
1232
+ id : str
1233
+
1234
+ name : str
1235
+
1236
+ description : typing.Optional[str]
1237
+
1238
+ tags : typing.Optional[typing.Sequence[str]]
1239
+
1240
+ request_options : typing.Optional[RequestOptions]
1241
+ Request-specific configuration.
1242
+
1243
+ Returns
1244
+ -------
1245
+ AsyncHttpResponse[None]
1246
+ """
1247
+ _response = await self._client_wrapper.httpx_client.request(
1248
+ f"v1/private/prompts/{jsonable_encoder(id)}",
1249
+ method="PUT",
1250
+ json={
1251
+ "name": name,
1252
+ "description": description,
1253
+ "tags": tags,
1254
+ },
1255
+ headers={
1256
+ "content-type": "application/json",
1257
+ },
1258
+ request_options=request_options,
1259
+ omit=OMIT,
1260
+ )
1261
+ try:
1262
+ if 200 <= _response.status_code < 300:
1263
+ return AsyncHttpResponse(response=_response, data=None)
1264
+ if _response.status_code == 400:
1265
+ raise BadRequestError(
1266
+ headers=dict(_response.headers),
1267
+ body=typing.cast(
1268
+ typing.Optional[typing.Any],
1269
+ parse_obj_as(
1270
+ type_=typing.Optional[typing.Any], # type: ignore
1271
+ object_=_response.json(),
1272
+ ),
1273
+ ),
1274
+ )
1275
+ if _response.status_code == 404:
1276
+ raise NotFoundError(
1277
+ headers=dict(_response.headers),
1278
+ body=typing.cast(
1279
+ typing.Optional[typing.Any],
1280
+ parse_obj_as(
1281
+ type_=typing.Optional[typing.Any], # type: ignore
1282
+ object_=_response.json(),
1283
+ ),
1284
+ ),
1285
+ )
1286
+ if _response.status_code == 409:
1287
+ raise ConflictError(
1288
+ headers=dict(_response.headers),
1289
+ body=typing.cast(
1290
+ typing.Optional[typing.Any],
1291
+ parse_obj_as(
1292
+ type_=typing.Optional[typing.Any], # type: ignore
1293
+ object_=_response.json(),
1294
+ ),
1295
+ ),
1296
+ )
1297
+ if _response.status_code == 422:
1298
+ raise UnprocessableEntityError(
1299
+ headers=dict(_response.headers),
1300
+ body=typing.cast(
1301
+ typing.Optional[typing.Any],
1302
+ parse_obj_as(
1303
+ type_=typing.Optional[typing.Any], # type: ignore
1304
+ object_=_response.json(),
1305
+ ),
1306
+ ),
1307
+ )
1308
+ _response_json = _response.json()
1309
+ except JSONDecodeError:
1310
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
1311
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
1312
+
1313
+ async def delete_prompt(
1314
+ self, id: str, *, request_options: typing.Optional[RequestOptions] = None
1315
+ ) -> AsyncHttpResponse[None]:
1316
+ """
1317
+ Delete prompt
1318
+
1319
+ Parameters
1320
+ ----------
1321
+ id : str
1322
+
1323
+ request_options : typing.Optional[RequestOptions]
1324
+ Request-specific configuration.
1325
+
1326
+ Returns
1327
+ -------
1328
+ AsyncHttpResponse[None]
1329
+ """
1330
+ _response = await self._client_wrapper.httpx_client.request(
1331
+ f"v1/private/prompts/{jsonable_encoder(id)}",
1332
+ method="DELETE",
1333
+ request_options=request_options,
1334
+ )
1335
+ try:
1336
+ if 200 <= _response.status_code < 300:
1337
+ return AsyncHttpResponse(response=_response, data=None)
1338
+ _response_json = _response.json()
1339
+ except JSONDecodeError:
1340
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
1341
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
1342
+
1343
+ async def delete_prompts_batch(
1344
+ self, *, ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None
1345
+ ) -> AsyncHttpResponse[None]:
1346
+ """
1347
+ Delete prompts batch
1348
+
1349
+ Parameters
1350
+ ----------
1351
+ ids : typing.Sequence[str]
1352
+
1353
+ request_options : typing.Optional[RequestOptions]
1354
+ Request-specific configuration.
1355
+
1356
+ Returns
1357
+ -------
1358
+ AsyncHttpResponse[None]
1359
+ """
1360
+ _response = await self._client_wrapper.httpx_client.request(
1361
+ "v1/private/prompts/delete",
1362
+ method="POST",
1363
+ json={
1364
+ "ids": ids,
1365
+ },
1366
+ headers={
1367
+ "content-type": "application/json",
1368
+ },
1369
+ request_options=request_options,
1370
+ omit=OMIT,
1371
+ )
1372
+ try:
1373
+ if 200 <= _response.status_code < 300:
1374
+ return AsyncHttpResponse(response=_response, data=None)
1375
+ _response_json = _response.json()
1376
+ except JSONDecodeError:
1377
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
1378
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
1379
+
1380
+ async def get_prompt_version_by_id(
1381
+ self, version_id: str, *, request_options: typing.Optional[RequestOptions] = None
1382
+ ) -> AsyncHttpResponse[PromptVersionDetail]:
1383
+ """
1384
+ Get prompt version by id
1385
+
1386
+ Parameters
1387
+ ----------
1388
+ version_id : str
1389
+
1390
+ request_options : typing.Optional[RequestOptions]
1391
+ Request-specific configuration.
1392
+
1393
+ Returns
1394
+ -------
1395
+ AsyncHttpResponse[PromptVersionDetail]
1396
+ Prompt version resource
1397
+ """
1398
+ _response = await self._client_wrapper.httpx_client.request(
1399
+ f"v1/private/prompts/versions/{jsonable_encoder(version_id)}",
1400
+ method="GET",
1401
+ request_options=request_options,
1402
+ )
1403
+ try:
1404
+ if 200 <= _response.status_code < 300:
1405
+ _data = typing.cast(
1406
+ PromptVersionDetail,
1407
+ parse_obj_as(
1408
+ type_=PromptVersionDetail, # type: ignore
1409
+ object_=_response.json(),
1410
+ ),
1411
+ )
1412
+ return AsyncHttpResponse(response=_response, data=_data)
1413
+ if _response.status_code == 404:
1414
+ raise NotFoundError(
1415
+ headers=dict(_response.headers),
1416
+ body=typing.cast(
1417
+ typing.Optional[typing.Any],
1418
+ parse_obj_as(
1419
+ type_=typing.Optional[typing.Any], # type: ignore
1420
+ object_=_response.json(),
1421
+ ),
1422
+ ),
1423
+ )
1424
+ _response_json = _response.json()
1425
+ except JSONDecodeError:
1426
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
1427
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
1428
+
1429
+ async def get_prompt_versions(
1430
+ self,
1431
+ id: str,
1432
+ *,
1433
+ page: typing.Optional[int] = None,
1434
+ size: typing.Optional[int] = None,
1435
+ search: typing.Optional[str] = None,
1436
+ sorting: typing.Optional[str] = None,
1437
+ filters: typing.Optional[str] = None,
1438
+ request_options: typing.Optional[RequestOptions] = None,
1439
+ ) -> AsyncHttpResponse[PromptVersionPagePublic]:
1440
+ """
1441
+ Get prompt versions
1442
+
1443
+ Parameters
1444
+ ----------
1445
+ id : str
1446
+
1447
+ page : typing.Optional[int]
1448
+
1449
+ size : typing.Optional[int]
1450
+
1451
+ search : typing.Optional[str]
1452
+ Search text to find in template or change description fields
1453
+
1454
+ sorting : typing.Optional[str]
1455
+
1456
+ filters : typing.Optional[str]
1457
+
1458
+ request_options : typing.Optional[RequestOptions]
1459
+ Request-specific configuration.
1460
+
1461
+ Returns
1462
+ -------
1463
+ AsyncHttpResponse[PromptVersionPagePublic]
1464
+ OK
1465
+ """
1466
+ _response = await self._client_wrapper.httpx_client.request(
1467
+ f"v1/private/prompts/{jsonable_encoder(id)}/versions",
1468
+ method="GET",
1469
+ params={
1470
+ "page": page,
1471
+ "size": size,
1472
+ "search": search,
1473
+ "sorting": sorting,
1474
+ "filters": filters,
1475
+ },
1476
+ request_options=request_options,
1477
+ )
1478
+ try:
1479
+ if 200 <= _response.status_code < 300:
1480
+ _data = typing.cast(
1481
+ PromptVersionPagePublic,
1482
+ parse_obj_as(
1483
+ type_=PromptVersionPagePublic, # type: ignore
1484
+ object_=_response.json(),
1485
+ ),
1486
+ )
1487
+ return AsyncHttpResponse(response=_response, data=_data)
1488
+ _response_json = _response.json()
1489
+ except JSONDecodeError:
1490
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
1491
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
1492
+
1493
+ async def restore_prompt_version(
1494
+ self, prompt_id: str, version_id: str, *, request_options: typing.Optional[RequestOptions] = None
1495
+ ) -> AsyncHttpResponse[PromptVersionDetail]:
1496
+ """
1497
+ Restore a prompt version by creating a new version with the content from the specified version
1498
+
1499
+ Parameters
1500
+ ----------
1501
+ prompt_id : str
1502
+
1503
+ version_id : str
1504
+
1505
+ request_options : typing.Optional[RequestOptions]
1506
+ Request-specific configuration.
1507
+
1508
+ Returns
1509
+ -------
1510
+ AsyncHttpResponse[PromptVersionDetail]
1511
+ OK
1512
+ """
1513
+ _response = await self._client_wrapper.httpx_client.request(
1514
+ f"v1/private/prompts/{jsonable_encoder(prompt_id)}/versions/{jsonable_encoder(version_id)}/restore",
1515
+ method="POST",
1516
+ request_options=request_options,
1517
+ )
1518
+ try:
1519
+ if 200 <= _response.status_code < 300:
1520
+ _data = typing.cast(
1521
+ PromptVersionDetail,
1522
+ parse_obj_as(
1523
+ type_=PromptVersionDetail, # type: ignore
1524
+ object_=_response.json(),
1525
+ ),
1526
+ )
1527
+ return AsyncHttpResponse(response=_response, data=_data)
1528
+ if _response.status_code == 400:
1529
+ raise BadRequestError(
1530
+ headers=dict(_response.headers),
1531
+ body=typing.cast(
1532
+ typing.Optional[typing.Any],
1533
+ parse_obj_as(
1534
+ type_=typing.Optional[typing.Any], # type: ignore
1535
+ object_=_response.json(),
1536
+ ),
1537
+ ),
1538
+ )
1539
+ if _response.status_code == 404:
1540
+ raise NotFoundError(
1541
+ headers=dict(_response.headers),
1542
+ body=typing.cast(
1543
+ typing.Optional[typing.Any],
1544
+ parse_obj_as(
1545
+ type_=typing.Optional[typing.Any], # type: ignore
1546
+ object_=_response.json(),
1547
+ ),
1548
+ ),
1549
+ )
1550
+ _response_json = _response.json()
1551
+ except JSONDecodeError:
1552
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
1553
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
1554
+
1555
+ async def retrieve_prompt_version(
1556
+ self, *, name: str, commit: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
1557
+ ) -> AsyncHttpResponse[PromptVersionDetail]:
1558
+ """
1559
+ Retrieve prompt version
1560
+
1561
+ Parameters
1562
+ ----------
1563
+ name : str
1564
+
1565
+ commit : typing.Optional[str]
1566
+
1567
+ request_options : typing.Optional[RequestOptions]
1568
+ Request-specific configuration.
1569
+
1570
+ Returns
1571
+ -------
1572
+ AsyncHttpResponse[PromptVersionDetail]
1573
+ OK
1574
+ """
1575
+ _response = await self._client_wrapper.httpx_client.request(
1576
+ "v1/private/prompts/versions/retrieve",
1577
+ method="POST",
1578
+ json={
1579
+ "name": name,
1580
+ "commit": commit,
1581
+ },
1582
+ headers={
1583
+ "content-type": "application/json",
1584
+ },
1585
+ request_options=request_options,
1586
+ omit=OMIT,
1587
+ )
1588
+ try:
1589
+ if 200 <= _response.status_code < 300:
1590
+ _data = typing.cast(
1591
+ PromptVersionDetail,
1592
+ parse_obj_as(
1593
+ type_=PromptVersionDetail, # type: ignore
1594
+ object_=_response.json(),
1595
+ ),
1596
+ )
1597
+ return AsyncHttpResponse(response=_response, data=_data)
1598
+ if _response.status_code == 400:
1599
+ raise BadRequestError(
1600
+ headers=dict(_response.headers),
1601
+ body=typing.cast(
1602
+ typing.Optional[typing.Any],
1603
+ parse_obj_as(
1604
+ type_=typing.Optional[typing.Any], # type: ignore
1605
+ object_=_response.json(),
1606
+ ),
1607
+ ),
1608
+ )
1609
+ if _response.status_code == 404:
1610
+ raise NotFoundError(
1611
+ headers=dict(_response.headers),
1612
+ body=typing.cast(
1613
+ typing.Optional[typing.Any],
1614
+ parse_obj_as(
1615
+ type_=typing.Optional[typing.Any], # type: ignore
1616
+ object_=_response.json(),
1617
+ ),
1618
+ ),
1619
+ )
1620
+ if _response.status_code == 422:
1621
+ raise UnprocessableEntityError(
1622
+ headers=dict(_response.headers),
1623
+ body=typing.cast(
1624
+ typing.Optional[typing.Any],
1625
+ parse_obj_as(
1626
+ type_=typing.Optional[typing.Any], # type: ignore
1627
+ object_=_response.json(),
1628
+ ),
1629
+ ),
1630
+ )
1631
+ _response_json = _response.json()
1632
+ except JSONDecodeError:
1633
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
1634
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)