c63a5cfe-b235-4fbe-8bbb-82a9e02a482a-python 0.1.0a3__py3-none-any.whl → 0.1.0a4__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 (234) hide show
  1. {c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a3.dist-info → c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a4.dist-info}/METADATA +91 -59
  2. c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a4.dist-info/RECORD +217 -0
  3. {c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a3.dist-info → c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a4.dist-info}/licenses/LICENSE +1 -1
  4. {digitalocean_genai_sdk → gradientai}/__init__.py +10 -9
  5. {digitalocean_genai_sdk → gradientai}/_base_client.py +39 -3
  6. {digitalocean_genai_sdk → gradientai}/_client.py +69 -148
  7. {digitalocean_genai_sdk → gradientai}/_exceptions.py +2 -2
  8. {digitalocean_genai_sdk → gradientai}/_resource.py +5 -5
  9. {digitalocean_genai_sdk → gradientai}/_response.py +6 -6
  10. {digitalocean_genai_sdk → gradientai}/_streaming.py +3 -3
  11. {digitalocean_genai_sdk → gradientai}/_types.py +1 -1
  12. {digitalocean_genai_sdk → gradientai}/_utils/_logs.py +3 -3
  13. gradientai/_utils/_resources_proxy.py +24 -0
  14. digitalocean_genai_sdk/types/providers/__init__.py → gradientai/_version.py +2 -1
  15. {digitalocean_genai_sdk → gradientai}/resources/__init__.py +13 -41
  16. {digitalocean_genai_sdk → gradientai}/resources/agents/agents.py +40 -16
  17. {digitalocean_genai_sdk → gradientai}/resources/agents/api_keys.py +34 -14
  18. {digitalocean_genai_sdk → gradientai}/resources/agents/child_agents.py +28 -12
  19. {digitalocean_genai_sdk → gradientai}/resources/agents/functions.py +22 -10
  20. {digitalocean_genai_sdk → gradientai}/resources/agents/knowledge_bases.py +22 -10
  21. {digitalocean_genai_sdk → gradientai}/resources/agents/versions.py +16 -8
  22. gradientai/resources/chat/__init__.py +33 -0
  23. gradientai/resources/chat/chat.py +102 -0
  24. digitalocean_genai_sdk/resources/chat.py → gradientai/resources/chat/completions.py +61 -57
  25. {digitalocean_genai_sdk → gradientai}/resources/indexing_jobs.py +34 -14
  26. gradientai/resources/inference/__init__.py +47 -0
  27. digitalocean_genai_sdk/resources/api_keys/api_keys_.py → gradientai/resources/inference/api_keys.py +40 -20
  28. gradientai/resources/inference/inference.py +134 -0
  29. {digitalocean_genai_sdk/resources → gradientai/resources/inference}/models.py +19 -15
  30. {digitalocean_genai_sdk → gradientai}/resources/knowledge_bases/data_sources.py +25 -12
  31. {digitalocean_genai_sdk → gradientai}/resources/knowledge_bases/knowledge_bases.py +34 -14
  32. digitalocean_genai_sdk/resources/api_keys/api_keys.py → gradientai/resources/models.py +51 -72
  33. {digitalocean_genai_sdk → gradientai}/resources/providers/anthropic/anthropic.py +4 -4
  34. {digitalocean_genai_sdk → gradientai}/resources/providers/anthropic/keys.py +40 -16
  35. {digitalocean_genai_sdk → gradientai}/resources/providers/openai/keys.py +40 -16
  36. {digitalocean_genai_sdk → gradientai}/resources/providers/openai/openai.py +4 -4
  37. {digitalocean_genai_sdk → gradientai}/resources/providers/providers.py +4 -4
  38. gradientai/resources/regions/__init__.py +61 -0
  39. gradientai/resources/regions/evaluation_datasets.py +292 -0
  40. gradientai/resources/regions/evaluation_runs/__init__.py +33 -0
  41. gradientai/resources/regions/evaluation_runs/evaluation_runs.py +316 -0
  42. gradientai/resources/regions/evaluation_runs/results.py +264 -0
  43. gradientai/resources/regions/evaluation_test_cases.py +618 -0
  44. gradientai/resources/regions/regions.py +352 -0
  45. {digitalocean_genai_sdk → gradientai}/types/__init__.py +7 -11
  46. {digitalocean_genai_sdk → gradientai}/types/agent_list_response.py +3 -3
  47. {digitalocean_genai_sdk → gradientai}/types/api_agent.py +8 -3
  48. digitalocean_genai_sdk/types/api_model.py → gradientai/types/api_agent_model.py +2 -2
  49. gradientai/types/api_evaluation_metric.py +24 -0
  50. digitalocean_genai_sdk/types/api_key_list_response.py → gradientai/types/api_model.py +3 -13
  51. {digitalocean_genai_sdk → gradientai}/types/api_openai_api_key_info.py +2 -2
  52. gradientai/types/api_workspace.py +36 -0
  53. gradientai/types/chat/__init__.py +7 -0
  54. {digitalocean_genai_sdk/types → gradientai/types/chat}/chat_completion_token_logprob.py +1 -1
  55. digitalocean_genai_sdk/types/chat_create_completion_params.py → gradientai/types/chat/completion_create_params.py +6 -29
  56. digitalocean_genai_sdk/types/chat_create_completion_response.py → gradientai/types/chat/completion_create_response.py +3 -3
  57. {digitalocean_genai_sdk/types/api_keys → gradientai/types/inference}/__init__.py +2 -0
  58. {digitalocean_genai_sdk/types → gradientai/types/inference}/model.py +1 -1
  59. {digitalocean_genai_sdk/types → gradientai/types/inference}/model_list_response.py +1 -1
  60. {digitalocean_genai_sdk → gradientai}/types/knowledge_base_create_params.py +3 -0
  61. {digitalocean_genai_sdk → gradientai}/types/knowledge_bases/__init__.py +1 -0
  62. {digitalocean_genai_sdk → gradientai}/types/knowledge_bases/api_knowledge_base_data_source.py +11 -1
  63. gradientai/types/knowledge_bases/aws_data_source_param.py +19 -0
  64. {digitalocean_genai_sdk → gradientai}/types/knowledge_bases/data_source_create_params.py +3 -14
  65. digitalocean_genai_sdk/types/api_key_list_params.py → gradientai/types/model_list_params.py +2 -2
  66. gradientai/types/model_list_response.py +18 -0
  67. gradientai/types/region_list_evaluation_metrics_response.py +12 -0
  68. gradientai/types/regions/__init__.py +32 -0
  69. gradientai/types/regions/api_evaluation_test_case.py +46 -0
  70. gradientai/types/regions/api_star_metric.py +19 -0
  71. gradientai/types/regions/api_star_metric_param.py +19 -0
  72. gradientai/types/regions/evaluation_dataset_create_file_upload_presigned_urls_params.py +20 -0
  73. gradientai/types/regions/evaluation_dataset_create_file_upload_presigned_urls_response.py +30 -0
  74. gradientai/types/regions/evaluation_dataset_create_params.py +17 -0
  75. gradientai/types/regions/evaluation_dataset_create_response.py +12 -0
  76. gradientai/types/regions/evaluation_run_create_params.py +17 -0
  77. gradientai/types/regions/evaluation_run_create_response.py +11 -0
  78. gradientai/types/regions/evaluation_run_retrieve_response.py +12 -0
  79. gradientai/types/regions/evaluation_runs/__init__.py +9 -0
  80. gradientai/types/regions/evaluation_runs/api_evaluation_metric_result.py +17 -0
  81. gradientai/types/regions/evaluation_runs/api_evaluation_run.py +56 -0
  82. gradientai/types/regions/evaluation_runs/api_prompt.py +42 -0
  83. gradientai/types/regions/evaluation_runs/result_retrieve_prompt_response.py +12 -0
  84. gradientai/types/regions/evaluation_runs/result_retrieve_response.py +16 -0
  85. gradientai/types/regions/evaluation_test_case_create_params.py +29 -0
  86. gradientai/types/regions/evaluation_test_case_create_response.py +12 -0
  87. gradientai/types/regions/evaluation_test_case_list_evaluation_runs_params.py +12 -0
  88. gradientai/types/regions/evaluation_test_case_list_evaluation_runs_response.py +13 -0
  89. gradientai/types/regions/evaluation_test_case_list_response.py +12 -0
  90. gradientai/types/regions/evaluation_test_case_retrieve_response.py +12 -0
  91. gradientai/types/regions/evaluation_test_case_update_params.py +32 -0
  92. gradientai/types/regions/evaluation_test_case_update_response.py +14 -0
  93. c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a3.dist-info/RECORD +0 -190
  94. digitalocean_genai_sdk/_utils/_resources_proxy.py +0 -24
  95. digitalocean_genai_sdk/_version.py +0 -4
  96. digitalocean_genai_sdk/resources/api_keys/__init__.py +0 -19
  97. digitalocean_genai_sdk/resources/auth/__init__.py +0 -33
  98. digitalocean_genai_sdk/resources/auth/agents/__init__.py +0 -33
  99. digitalocean_genai_sdk/resources/auth/agents/agents.py +0 -102
  100. digitalocean_genai_sdk/resources/auth/agents/token.py +0 -173
  101. digitalocean_genai_sdk/resources/auth/auth.py +0 -102
  102. digitalocean_genai_sdk/resources/embeddings.py +0 -201
  103. digitalocean_genai_sdk/resources/regions.py +0 -191
  104. digitalocean_genai_sdk/types/auth/agents/__init__.py +0 -6
  105. digitalocean_genai_sdk/types/auth/agents/token_create_params.py +0 -13
  106. digitalocean_genai_sdk/types/auth/agents/token_create_response.py +0 -13
  107. digitalocean_genai_sdk/types/chat_completion_request_message_content_part_text_param.py +0 -15
  108. digitalocean_genai_sdk/types/embedding_create_params.py +0 -28
  109. digitalocean_genai_sdk/types/embedding_create_response.py +0 -41
  110. {c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a3.dist-info → c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a4.dist-info}/WHEEL +0 -0
  111. {digitalocean_genai_sdk → gradientai}/_compat.py +0 -0
  112. {digitalocean_genai_sdk → gradientai}/_constants.py +0 -0
  113. {digitalocean_genai_sdk → gradientai}/_files.py +0 -0
  114. {digitalocean_genai_sdk → gradientai}/_models.py +0 -0
  115. {digitalocean_genai_sdk → gradientai}/_qs.py +0 -0
  116. {digitalocean_genai_sdk → gradientai}/_utils/__init__.py +0 -0
  117. {digitalocean_genai_sdk → gradientai}/_utils/_proxy.py +0 -0
  118. {digitalocean_genai_sdk → gradientai}/_utils/_reflection.py +0 -0
  119. {digitalocean_genai_sdk → gradientai}/_utils/_streams.py +0 -0
  120. {digitalocean_genai_sdk → gradientai}/_utils/_sync.py +0 -0
  121. {digitalocean_genai_sdk → gradientai}/_utils/_transform.py +0 -0
  122. {digitalocean_genai_sdk → gradientai}/_utils/_typing.py +0 -0
  123. {digitalocean_genai_sdk → gradientai}/_utils/_utils.py +0 -0
  124. {digitalocean_genai_sdk → gradientai}/lib/.keep +0 -0
  125. {digitalocean_genai_sdk → gradientai}/py.typed +0 -0
  126. {digitalocean_genai_sdk → gradientai}/resources/agents/__init__.py +0 -0
  127. {digitalocean_genai_sdk → gradientai}/resources/knowledge_bases/__init__.py +0 -0
  128. {digitalocean_genai_sdk → gradientai}/resources/providers/__init__.py +0 -0
  129. {digitalocean_genai_sdk → gradientai}/resources/providers/anthropic/__init__.py +0 -0
  130. {digitalocean_genai_sdk → gradientai}/resources/providers/openai/__init__.py +0 -0
  131. {digitalocean_genai_sdk → gradientai}/types/agent_create_params.py +0 -0
  132. {digitalocean_genai_sdk → gradientai}/types/agent_create_response.py +0 -0
  133. {digitalocean_genai_sdk → gradientai}/types/agent_delete_response.py +0 -0
  134. {digitalocean_genai_sdk → gradientai}/types/agent_list_params.py +0 -0
  135. {digitalocean_genai_sdk → gradientai}/types/agent_retrieve_response.py +0 -0
  136. {digitalocean_genai_sdk → gradientai}/types/agent_update_params.py +0 -0
  137. {digitalocean_genai_sdk → gradientai}/types/agent_update_response.py +0 -0
  138. {digitalocean_genai_sdk → gradientai}/types/agent_update_status_params.py +0 -0
  139. {digitalocean_genai_sdk → gradientai}/types/agent_update_status_response.py +0 -0
  140. {digitalocean_genai_sdk → gradientai}/types/agents/__init__.py +0 -0
  141. {digitalocean_genai_sdk → gradientai}/types/agents/api_key_create_params.py +0 -0
  142. {digitalocean_genai_sdk → gradientai}/types/agents/api_key_create_response.py +0 -0
  143. {digitalocean_genai_sdk → gradientai}/types/agents/api_key_delete_response.py +0 -0
  144. {digitalocean_genai_sdk → gradientai}/types/agents/api_key_list_params.py +0 -0
  145. {digitalocean_genai_sdk → gradientai}/types/agents/api_key_list_response.py +0 -0
  146. {digitalocean_genai_sdk → gradientai}/types/agents/api_key_regenerate_response.py +0 -0
  147. {digitalocean_genai_sdk → gradientai}/types/agents/api_key_update_params.py +0 -0
  148. {digitalocean_genai_sdk → gradientai}/types/agents/api_key_update_response.py +0 -0
  149. {digitalocean_genai_sdk → gradientai}/types/agents/api_link_knowledge_base_output.py +0 -0
  150. {digitalocean_genai_sdk → gradientai}/types/agents/api_links.py +0 -0
  151. {digitalocean_genai_sdk → gradientai}/types/agents/api_meta.py +0 -0
  152. {digitalocean_genai_sdk → gradientai}/types/agents/child_agent_add_params.py +0 -0
  153. {digitalocean_genai_sdk → gradientai}/types/agents/child_agent_add_response.py +0 -0
  154. {digitalocean_genai_sdk → gradientai}/types/agents/child_agent_delete_response.py +0 -0
  155. {digitalocean_genai_sdk → gradientai}/types/agents/child_agent_update_params.py +0 -0
  156. {digitalocean_genai_sdk → gradientai}/types/agents/child_agent_update_response.py +0 -0
  157. {digitalocean_genai_sdk → gradientai}/types/agents/child_agent_view_response.py +0 -0
  158. {digitalocean_genai_sdk → gradientai}/types/agents/function_create_params.py +0 -0
  159. {digitalocean_genai_sdk → gradientai}/types/agents/function_create_response.py +0 -0
  160. {digitalocean_genai_sdk → gradientai}/types/agents/function_delete_response.py +0 -0
  161. {digitalocean_genai_sdk → gradientai}/types/agents/function_update_params.py +0 -0
  162. {digitalocean_genai_sdk → gradientai}/types/agents/function_update_response.py +0 -0
  163. {digitalocean_genai_sdk → gradientai}/types/agents/knowledge_base_detach_response.py +0 -0
  164. {digitalocean_genai_sdk → gradientai}/types/agents/version_list_params.py +0 -0
  165. {digitalocean_genai_sdk → gradientai}/types/agents/version_list_response.py +0 -0
  166. {digitalocean_genai_sdk → gradientai}/types/agents/version_update_params.py +0 -0
  167. {digitalocean_genai_sdk → gradientai}/types/agents/version_update_response.py +0 -0
  168. {digitalocean_genai_sdk → gradientai}/types/api_agent_api_key_info.py +0 -0
  169. {digitalocean_genai_sdk → gradientai}/types/api_agreement.py +0 -0
  170. {digitalocean_genai_sdk → gradientai}/types/api_anthropic_api_key_info.py +0 -0
  171. {digitalocean_genai_sdk → gradientai}/types/api_deployment_visibility.py +0 -0
  172. {digitalocean_genai_sdk → gradientai}/types/api_indexing_job.py +0 -0
  173. {digitalocean_genai_sdk → gradientai}/types/api_knowledge_base.py +0 -0
  174. {digitalocean_genai_sdk → gradientai}/types/api_model_version.py +0 -0
  175. {digitalocean_genai_sdk → gradientai}/types/api_retrieval_method.py +0 -0
  176. {digitalocean_genai_sdk → gradientai}/types/indexing_job_create_params.py +0 -0
  177. {digitalocean_genai_sdk → gradientai}/types/indexing_job_create_response.py +0 -0
  178. {digitalocean_genai_sdk → gradientai}/types/indexing_job_list_params.py +0 -0
  179. {digitalocean_genai_sdk → gradientai}/types/indexing_job_list_response.py +0 -0
  180. {digitalocean_genai_sdk → gradientai}/types/indexing_job_retrieve_data_sources_response.py +0 -0
  181. {digitalocean_genai_sdk → gradientai}/types/indexing_job_retrieve_response.py +0 -0
  182. {digitalocean_genai_sdk → gradientai}/types/indexing_job_update_cancel_params.py +0 -0
  183. {digitalocean_genai_sdk → gradientai}/types/indexing_job_update_cancel_response.py +0 -0
  184. {digitalocean_genai_sdk/types/api_keys → gradientai/types/inference}/api_key_create_params.py +0 -0
  185. {digitalocean_genai_sdk/types/api_keys → gradientai/types/inference}/api_key_create_response.py +0 -0
  186. {digitalocean_genai_sdk/types/api_keys → gradientai/types/inference}/api_key_delete_response.py +0 -0
  187. {digitalocean_genai_sdk/types/api_keys → gradientai/types/inference}/api_key_list_params.py +0 -0
  188. {digitalocean_genai_sdk/types/api_keys → gradientai/types/inference}/api_key_list_response.py +0 -0
  189. {digitalocean_genai_sdk/types/api_keys → gradientai/types/inference}/api_key_update_params.py +0 -0
  190. {digitalocean_genai_sdk/types/api_keys → gradientai/types/inference}/api_key_update_regenerate_response.py +0 -0
  191. {digitalocean_genai_sdk/types/api_keys → gradientai/types/inference}/api_key_update_response.py +0 -0
  192. {digitalocean_genai_sdk/types/api_keys → gradientai/types/inference}/api_model_api_key_info.py +0 -0
  193. {digitalocean_genai_sdk → gradientai}/types/knowledge_base_create_response.py +0 -0
  194. {digitalocean_genai_sdk → gradientai}/types/knowledge_base_delete_response.py +0 -0
  195. {digitalocean_genai_sdk → gradientai}/types/knowledge_base_list_params.py +0 -0
  196. {digitalocean_genai_sdk → gradientai}/types/knowledge_base_list_response.py +0 -0
  197. {digitalocean_genai_sdk → gradientai}/types/knowledge_base_retrieve_response.py +0 -0
  198. {digitalocean_genai_sdk → gradientai}/types/knowledge_base_update_params.py +0 -0
  199. {digitalocean_genai_sdk → gradientai}/types/knowledge_base_update_response.py +0 -0
  200. {digitalocean_genai_sdk → gradientai}/types/knowledge_bases/api_file_upload_data_source.py +0 -0
  201. {digitalocean_genai_sdk → gradientai}/types/knowledge_bases/api_file_upload_data_source_param.py +0 -0
  202. {digitalocean_genai_sdk → gradientai}/types/knowledge_bases/api_spaces_data_source.py +0 -0
  203. {digitalocean_genai_sdk → gradientai}/types/knowledge_bases/api_spaces_data_source_param.py +0 -0
  204. {digitalocean_genai_sdk → gradientai}/types/knowledge_bases/api_web_crawler_data_source.py +0 -0
  205. {digitalocean_genai_sdk → gradientai}/types/knowledge_bases/api_web_crawler_data_source_param.py +0 -0
  206. {digitalocean_genai_sdk → gradientai}/types/knowledge_bases/data_source_create_response.py +0 -0
  207. {digitalocean_genai_sdk → gradientai}/types/knowledge_bases/data_source_delete_response.py +0 -0
  208. {digitalocean_genai_sdk → gradientai}/types/knowledge_bases/data_source_list_params.py +0 -0
  209. {digitalocean_genai_sdk → gradientai}/types/knowledge_bases/data_source_list_response.py +0 -0
  210. {digitalocean_genai_sdk/types/auth → gradientai/types/providers}/__init__.py +0 -0
  211. {digitalocean_genai_sdk → gradientai}/types/providers/anthropic/__init__.py +0 -0
  212. {digitalocean_genai_sdk → gradientai}/types/providers/anthropic/key_create_params.py +0 -0
  213. {digitalocean_genai_sdk → gradientai}/types/providers/anthropic/key_create_response.py +0 -0
  214. {digitalocean_genai_sdk → gradientai}/types/providers/anthropic/key_delete_response.py +0 -0
  215. {digitalocean_genai_sdk → gradientai}/types/providers/anthropic/key_list_agents_params.py +0 -0
  216. {digitalocean_genai_sdk → gradientai}/types/providers/anthropic/key_list_agents_response.py +0 -0
  217. {digitalocean_genai_sdk → gradientai}/types/providers/anthropic/key_list_params.py +0 -0
  218. {digitalocean_genai_sdk → gradientai}/types/providers/anthropic/key_list_response.py +0 -0
  219. {digitalocean_genai_sdk → gradientai}/types/providers/anthropic/key_retrieve_response.py +0 -0
  220. {digitalocean_genai_sdk → gradientai}/types/providers/anthropic/key_update_params.py +0 -0
  221. {digitalocean_genai_sdk → gradientai}/types/providers/anthropic/key_update_response.py +0 -0
  222. {digitalocean_genai_sdk → gradientai}/types/providers/openai/__init__.py +0 -0
  223. {digitalocean_genai_sdk → gradientai}/types/providers/openai/key_create_params.py +0 -0
  224. {digitalocean_genai_sdk → gradientai}/types/providers/openai/key_create_response.py +0 -0
  225. {digitalocean_genai_sdk → gradientai}/types/providers/openai/key_delete_response.py +0 -0
  226. {digitalocean_genai_sdk → gradientai}/types/providers/openai/key_list_params.py +0 -0
  227. {digitalocean_genai_sdk → gradientai}/types/providers/openai/key_list_response.py +0 -0
  228. {digitalocean_genai_sdk → gradientai}/types/providers/openai/key_retrieve_agents_params.py +0 -0
  229. {digitalocean_genai_sdk → gradientai}/types/providers/openai/key_retrieve_agents_response.py +0 -0
  230. {digitalocean_genai_sdk → gradientai}/types/providers/openai/key_retrieve_response.py +0 -0
  231. {digitalocean_genai_sdk → gradientai}/types/providers/openai/key_update_params.py +0 -0
  232. {digitalocean_genai_sdk → gradientai}/types/providers/openai/key_update_response.py +0 -0
  233. {digitalocean_genai_sdk → gradientai}/types/region_list_params.py +0 -0
  234. {digitalocean_genai_sdk → gradientai}/types/region_list_response.py +0 -0
@@ -5,22 +5,18 @@ from __future__ import annotations
5
5
  from typing import Dict, List, Union, Iterable, Optional
6
6
  from typing_extensions import Literal, Required, TypeAlias, TypedDict
7
7
 
8
- from .chat_completion_request_message_content_part_text_param import ChatCompletionRequestMessageContentPartTextParam
9
-
10
8
  __all__ = [
11
- "ChatCreateCompletionParams",
9
+ "CompletionCreateParams",
12
10
  "Message",
13
11
  "MessageChatCompletionRequestSystemMessage",
14
12
  "MessageChatCompletionRequestDeveloperMessage",
15
13
  "MessageChatCompletionRequestUserMessage",
16
14
  "MessageChatCompletionRequestAssistantMessage",
17
- "MessageChatCompletionRequestAssistantMessageContentArrayOfContentPart",
18
- "MessageChatCompletionRequestAssistantMessageContentArrayOfContentPartChatCompletionRequestMessageContentPartRefusal",
19
15
  "StreamOptions",
20
16
  ]
21
17
 
22
18
 
23
- class ChatCreateCompletionParams(TypedDict, total=False):
19
+ class CompletionCreateParams(TypedDict, total=False):
24
20
  messages: Required[Iterable[Message]]
25
21
  """A list of messages comprising the conversation so far."""
26
22
 
@@ -137,7 +133,7 @@ class ChatCreateCompletionParams(TypedDict, total=False):
137
133
 
138
134
 
139
135
  class MessageChatCompletionRequestSystemMessage(TypedDict, total=False):
140
- content: Required[Union[str, Iterable[ChatCompletionRequestMessageContentPartTextParam]]]
136
+ content: Required[Union[str, List[str]]]
141
137
  """The contents of the system message."""
142
138
 
143
139
  role: Required[Literal["system"]]
@@ -145,7 +141,7 @@ class MessageChatCompletionRequestSystemMessage(TypedDict, total=False):
145
141
 
146
142
 
147
143
  class MessageChatCompletionRequestDeveloperMessage(TypedDict, total=False):
148
- content: Required[Union[str, Iterable[ChatCompletionRequestMessageContentPartTextParam]]]
144
+ content: Required[Union[str, List[str]]]
149
145
  """The contents of the developer message."""
150
146
 
151
147
  role: Required[Literal["developer"]]
@@ -153,39 +149,20 @@ class MessageChatCompletionRequestDeveloperMessage(TypedDict, total=False):
153
149
 
154
150
 
155
151
  class MessageChatCompletionRequestUserMessage(TypedDict, total=False):
156
- content: Required[Union[str, Iterable[ChatCompletionRequestMessageContentPartTextParam]]]
152
+ content: Required[Union[str, List[str]]]
157
153
  """The contents of the user message."""
158
154
 
159
155
  role: Required[Literal["user"]]
160
156
  """The role of the messages author, in this case `user`."""
161
157
 
162
158
 
163
- class MessageChatCompletionRequestAssistantMessageContentArrayOfContentPartChatCompletionRequestMessageContentPartRefusal(
164
- TypedDict, total=False
165
- ):
166
- refusal: Required[str]
167
- """The refusal message generated by the model."""
168
-
169
- type: Required[Literal["refusal"]]
170
- """The type of the content part."""
171
-
172
-
173
- MessageChatCompletionRequestAssistantMessageContentArrayOfContentPart: TypeAlias = Union[
174
- ChatCompletionRequestMessageContentPartTextParam,
175
- MessageChatCompletionRequestAssistantMessageContentArrayOfContentPartChatCompletionRequestMessageContentPartRefusal,
176
- ]
177
-
178
-
179
159
  class MessageChatCompletionRequestAssistantMessage(TypedDict, total=False):
180
160
  role: Required[Literal["assistant"]]
181
161
  """The role of the messages author, in this case `assistant`."""
182
162
 
183
- content: Union[str, Iterable[MessageChatCompletionRequestAssistantMessageContentArrayOfContentPart], None]
163
+ content: Union[str, List[str], None]
184
164
  """The contents of the assistant message."""
185
165
 
186
- refusal: Optional[str]
187
- """The refusal message by the assistant."""
188
-
189
166
 
190
167
  Message: TypeAlias = Union[
191
168
  MessageChatCompletionRequestSystemMessage,
@@ -3,10 +3,10 @@
3
3
  from typing import List, Optional
4
4
  from typing_extensions import Literal
5
5
 
6
- from .._models import BaseModel
6
+ from ..._models import BaseModel
7
7
  from .chat_completion_token_logprob import ChatCompletionTokenLogprob
8
8
 
9
- __all__ = ["ChatCreateCompletionResponse", "Choice", "ChoiceLogprobs", "ChoiceMessage", "Usage"]
9
+ __all__ = ["CompletionCreateResponse", "Choice", "ChoiceLogprobs", "ChoiceMessage", "Usage"]
10
10
 
11
11
 
12
12
  class ChoiceLogprobs(BaseModel):
@@ -58,7 +58,7 @@ class Usage(BaseModel):
58
58
  """Total number of tokens used in the request (prompt + completion)."""
59
59
 
60
60
 
61
- class ChatCreateCompletionResponse(BaseModel):
61
+ class CompletionCreateResponse(BaseModel):
62
62
  id: str
63
63
  """A unique identifier for the chat completion."""
64
64
 
@@ -2,7 +2,9 @@
2
2
 
3
3
  from __future__ import annotations
4
4
 
5
+ from .model import Model as Model
5
6
  from .api_key_list_params import APIKeyListParams as APIKeyListParams
7
+ from .model_list_response import ModelListResponse as ModelListResponse
6
8
  from .api_key_create_params import APIKeyCreateParams as APIKeyCreateParams
7
9
  from .api_key_list_response import APIKeyListResponse as APIKeyListResponse
8
10
  from .api_key_update_params import APIKeyUpdateParams as APIKeyUpdateParams
@@ -2,7 +2,7 @@
2
2
 
3
3
  from typing_extensions import Literal
4
4
 
5
- from .._models import BaseModel
5
+ from ..._models import BaseModel
6
6
 
7
7
  __all__ = ["Model"]
8
8
 
@@ -4,7 +4,7 @@ from typing import List
4
4
  from typing_extensions import Literal
5
5
 
6
6
  from .model import Model
7
- from .._models import BaseModel
7
+ from ..._models import BaseModel
8
8
 
9
9
  __all__ = ["ModelListResponse"]
10
10
 
@@ -5,6 +5,7 @@ from __future__ import annotations
5
5
  from typing import List, Iterable
6
6
  from typing_extensions import TypedDict
7
7
 
8
+ from .knowledge_bases.aws_data_source_param import AwsDataSourceParam
8
9
  from .knowledge_bases.api_spaces_data_source_param import APISpacesDataSourceParam
9
10
  from .knowledge_bases.api_file_upload_data_source_param import APIFileUploadDataSourceParam
10
11
  from .knowledge_bases.api_web_crawler_data_source_param import APIWebCrawlerDataSourceParam
@@ -50,6 +51,8 @@ class KnowledgeBaseCreateParams(TypedDict, total=False):
50
51
 
51
52
 
52
53
  class Datasource(TypedDict, total=False):
54
+ aws_data_source: AwsDataSourceParam
55
+
53
56
  bucket_name: str
54
57
 
55
58
  bucket_region: str
@@ -2,6 +2,7 @@
2
2
 
3
3
  from __future__ import annotations
4
4
 
5
+ from .aws_data_source_param import AwsDataSourceParam as AwsDataSourceParam
5
6
  from .api_spaces_data_source import APISpacesDataSource as APISpacesDataSource
6
7
  from .data_source_list_params import DataSourceListParams as DataSourceListParams
7
8
  from .data_source_create_params import DataSourceCreateParams as DataSourceCreateParams
@@ -9,10 +9,20 @@ from .api_spaces_data_source import APISpacesDataSource
9
9
  from .api_file_upload_data_source import APIFileUploadDataSource
10
10
  from .api_web_crawler_data_source import APIWebCrawlerDataSource
11
11
 
12
- __all__ = ["APIKnowledgeBaseDataSource"]
12
+ __all__ = ["APIKnowledgeBaseDataSource", "AwsDataSource"]
13
+
14
+
15
+ class AwsDataSource(BaseModel):
16
+ bucket_name: Optional[str] = None
17
+
18
+ item_path: Optional[str] = None
19
+
20
+ region: Optional[str] = None
13
21
 
14
22
 
15
23
  class APIKnowledgeBaseDataSource(BaseModel):
24
+ aws_data_source: Optional[AwsDataSource] = None
25
+
16
26
  bucket_name: Optional[str] = None
17
27
 
18
28
  created_at: Optional[datetime] = None
@@ -0,0 +1,19 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from __future__ import annotations
4
+
5
+ from typing_extensions import TypedDict
6
+
7
+ __all__ = ["AwsDataSourceParam"]
8
+
9
+
10
+ class AwsDataSourceParam(TypedDict, total=False):
11
+ bucket_name: str
12
+
13
+ item_path: str
14
+
15
+ key_id: str
16
+
17
+ region: str
18
+
19
+ secret_key: str
@@ -5,29 +5,18 @@ from __future__ import annotations
5
5
  from typing_extensions import Annotated, TypedDict
6
6
 
7
7
  from ..._utils import PropertyInfo
8
+ from .aws_data_source_param import AwsDataSourceParam
8
9
  from .api_spaces_data_source_param import APISpacesDataSourceParam
9
10
  from .api_web_crawler_data_source_param import APIWebCrawlerDataSourceParam
10
11
 
11
- __all__ = ["DataSourceCreateParams", "AwsDataSource"]
12
+ __all__ = ["DataSourceCreateParams"]
12
13
 
13
14
 
14
15
  class DataSourceCreateParams(TypedDict, total=False):
15
- aws_data_source: AwsDataSource
16
+ aws_data_source: AwsDataSourceParam
16
17
 
17
18
  body_knowledge_base_uuid: Annotated[str, PropertyInfo(alias="knowledge_base_uuid")]
18
19
 
19
20
  spaces_data_source: APISpacesDataSourceParam
20
21
 
21
22
  web_crawler_data_source: APIWebCrawlerDataSourceParam
22
-
23
-
24
- class AwsDataSource(TypedDict, total=False):
25
- bucket_name: str
26
-
27
- item_path: str
28
-
29
- key_id: str
30
-
31
- region: str
32
-
33
- secret_key: str
@@ -5,10 +5,10 @@ from __future__ import annotations
5
5
  from typing import List
6
6
  from typing_extensions import Literal, TypedDict
7
7
 
8
- __all__ = ["APIKeyListParams"]
8
+ __all__ = ["ModelListParams"]
9
9
 
10
10
 
11
- class APIKeyListParams(TypedDict, total=False):
11
+ class ModelListParams(TypedDict, total=False):
12
12
  page: int
13
13
  """page number."""
14
14
 
@@ -0,0 +1,18 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import List, Optional
4
+
5
+ from .._models import BaseModel
6
+ from .api_model import APIModel
7
+ from .agents.api_meta import APIMeta
8
+ from .agents.api_links import APILinks
9
+
10
+ __all__ = ["ModelListResponse"]
11
+
12
+
13
+ class ModelListResponse(BaseModel):
14
+ links: Optional[APILinks] = None
15
+
16
+ meta: Optional[APIMeta] = None
17
+
18
+ models: Optional[List[APIModel]] = None
@@ -0,0 +1,12 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import List, Optional
4
+
5
+ from .._models import BaseModel
6
+ from .api_evaluation_metric import APIEvaluationMetric
7
+
8
+ __all__ = ["RegionListEvaluationMetricsResponse"]
9
+
10
+
11
+ class RegionListEvaluationMetricsResponse(BaseModel):
12
+ metrics: Optional[List[APIEvaluationMetric]] = None
@@ -0,0 +1,32 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from __future__ import annotations
4
+
5
+ from .api_star_metric import APIStarMetric as APIStarMetric
6
+ from .api_star_metric_param import APIStarMetricParam as APIStarMetricParam
7
+ from .api_evaluation_test_case import APIEvaluationTestCase as APIEvaluationTestCase
8
+ from .evaluation_run_create_params import EvaluationRunCreateParams as EvaluationRunCreateParams
9
+ from .evaluation_run_create_response import EvaluationRunCreateResponse as EvaluationRunCreateResponse
10
+ from .evaluation_dataset_create_params import EvaluationDatasetCreateParams as EvaluationDatasetCreateParams
11
+ from .evaluation_run_retrieve_response import EvaluationRunRetrieveResponse as EvaluationRunRetrieveResponse
12
+ from .evaluation_dataset_create_response import EvaluationDatasetCreateResponse as EvaluationDatasetCreateResponse
13
+ from .evaluation_test_case_create_params import EvaluationTestCaseCreateParams as EvaluationTestCaseCreateParams
14
+ from .evaluation_test_case_list_response import EvaluationTestCaseListResponse as EvaluationTestCaseListResponse
15
+ from .evaluation_test_case_update_params import EvaluationTestCaseUpdateParams as EvaluationTestCaseUpdateParams
16
+ from .evaluation_test_case_create_response import EvaluationTestCaseCreateResponse as EvaluationTestCaseCreateResponse
17
+ from .evaluation_test_case_update_response import EvaluationTestCaseUpdateResponse as EvaluationTestCaseUpdateResponse
18
+ from .evaluation_test_case_retrieve_response import (
19
+ EvaluationTestCaseRetrieveResponse as EvaluationTestCaseRetrieveResponse,
20
+ )
21
+ from .evaluation_test_case_list_evaluation_runs_params import (
22
+ EvaluationTestCaseListEvaluationRunsParams as EvaluationTestCaseListEvaluationRunsParams,
23
+ )
24
+ from .evaluation_test_case_list_evaluation_runs_response import (
25
+ EvaluationTestCaseListEvaluationRunsResponse as EvaluationTestCaseListEvaluationRunsResponse,
26
+ )
27
+ from .evaluation_dataset_create_file_upload_presigned_urls_params import (
28
+ EvaluationDatasetCreateFileUploadPresignedURLsParams as EvaluationDatasetCreateFileUploadPresignedURLsParams,
29
+ )
30
+ from .evaluation_dataset_create_file_upload_presigned_urls_response import (
31
+ EvaluationDatasetCreateFileUploadPresignedURLsResponse as EvaluationDatasetCreateFileUploadPresignedURLsResponse,
32
+ )
@@ -0,0 +1,46 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import List, Optional
4
+ from datetime import datetime
5
+
6
+ from ..._models import BaseModel
7
+ from .api_star_metric import APIStarMetric
8
+ from ..api_evaluation_metric import APIEvaluationMetric
9
+
10
+ __all__ = ["APIEvaluationTestCase"]
11
+
12
+
13
+ class APIEvaluationTestCase(BaseModel):
14
+ archived_at: Optional[datetime] = None
15
+
16
+ created_at: Optional[datetime] = None
17
+
18
+ created_by_user_email: Optional[str] = None
19
+
20
+ created_by_user_id: Optional[str] = None
21
+
22
+ dataset_name: Optional[str] = None
23
+
24
+ dataset_uuid: Optional[str] = None
25
+
26
+ description: Optional[str] = None
27
+
28
+ latest_version_number_of_runs: Optional[int] = None
29
+
30
+ metrics: Optional[List[APIEvaluationMetric]] = None
31
+
32
+ name: Optional[str] = None
33
+
34
+ star_metric: Optional[APIStarMetric] = None
35
+
36
+ test_case_uuid: Optional[str] = None
37
+
38
+ total_runs: Optional[int] = None
39
+
40
+ updated_at: Optional[datetime] = None
41
+
42
+ updated_by_user_email: Optional[str] = None
43
+
44
+ updated_by_user_id: Optional[str] = None
45
+
46
+ version: Optional[int] = None
@@ -0,0 +1,19 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import Optional
4
+
5
+ from ..._models import BaseModel
6
+
7
+ __all__ = ["APIStarMetric"]
8
+
9
+
10
+ class APIStarMetric(BaseModel):
11
+ metric_uuid: Optional[str] = None
12
+
13
+ name: Optional[str] = None
14
+
15
+ success_threshold_pct: Optional[int] = None
16
+ """
17
+ The success threshold for the star metric. This is a percentage value between 0
18
+ and 100.
19
+ """
@@ -0,0 +1,19 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from __future__ import annotations
4
+
5
+ from typing_extensions import TypedDict
6
+
7
+ __all__ = ["APIStarMetricParam"]
8
+
9
+
10
+ class APIStarMetricParam(TypedDict, total=False):
11
+ metric_uuid: str
12
+
13
+ name: str
14
+
15
+ success_threshold_pct: int
16
+ """
17
+ The success threshold for the star metric. This is a percentage value between 0
18
+ and 100.
19
+ """
@@ -0,0 +1,20 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from __future__ import annotations
4
+
5
+ from typing import Iterable
6
+ from typing_extensions import TypedDict
7
+
8
+ __all__ = ["EvaluationDatasetCreateFileUploadPresignedURLsParams", "File"]
9
+
10
+
11
+ class EvaluationDatasetCreateFileUploadPresignedURLsParams(TypedDict, total=False):
12
+ files: Iterable[File]
13
+ """A list of files to generate presigned URLs for."""
14
+
15
+
16
+ class File(TypedDict, total=False):
17
+ file_name: str
18
+
19
+ file_size: str
20
+ """The size of the file in bytes."""
@@ -0,0 +1,30 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import List, Optional
4
+ from datetime import datetime
5
+
6
+ from ..._models import BaseModel
7
+
8
+ __all__ = ["EvaluationDatasetCreateFileUploadPresignedURLsResponse", "Upload"]
9
+
10
+
11
+ class Upload(BaseModel):
12
+ expires_at: Optional[datetime] = None
13
+ """The time the url expires at."""
14
+
15
+ object_key: Optional[str] = None
16
+ """The unique object key to store the file as."""
17
+
18
+ original_file_name: Optional[str] = None
19
+ """The original file name."""
20
+
21
+ presigned_url: Optional[str] = None
22
+ """The actual presigned URL the client can use to upload the file directly."""
23
+
24
+
25
+ class EvaluationDatasetCreateFileUploadPresignedURLsResponse(BaseModel):
26
+ request_id: Optional[str] = None
27
+ """The ID generated for the request for Presigned URLs."""
28
+
29
+ uploads: Optional[List[Upload]] = None
30
+ """A list of generated presigned URLs and object keys, one per file."""
@@ -0,0 +1,17 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from __future__ import annotations
4
+
5
+ from typing_extensions import TypedDict
6
+
7
+ from ..knowledge_bases.api_file_upload_data_source_param import APIFileUploadDataSourceParam
8
+
9
+ __all__ = ["EvaluationDatasetCreateParams"]
10
+
11
+
12
+ class EvaluationDatasetCreateParams(TypedDict, total=False):
13
+ file_upload_dataset: APIFileUploadDataSourceParam
14
+ """File to upload as data source for knowledge base."""
15
+
16
+ name: str
17
+ """The name of the agent evaluation dataset."""
@@ -0,0 +1,12 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import Optional
4
+
5
+ from ..._models import BaseModel
6
+
7
+ __all__ = ["EvaluationDatasetCreateResponse"]
8
+
9
+
10
+ class EvaluationDatasetCreateResponse(BaseModel):
11
+ evaluation_dataset_uuid: Optional[str] = None
12
+ """Evaluation dataset uuid."""
@@ -0,0 +1,17 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from __future__ import annotations
4
+
5
+ from typing_extensions import TypedDict
6
+
7
+ __all__ = ["EvaluationRunCreateParams"]
8
+
9
+
10
+ class EvaluationRunCreateParams(TypedDict, total=False):
11
+ agent_uuid: str
12
+ """Agent UUID to run the test case against."""
13
+
14
+ run_name: str
15
+ """The name of the run."""
16
+
17
+ test_case_uuid: str
@@ -0,0 +1,11 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import Optional
4
+
5
+ from ..._models import BaseModel
6
+
7
+ __all__ = ["EvaluationRunCreateResponse"]
8
+
9
+
10
+ class EvaluationRunCreateResponse(BaseModel):
11
+ evaluation_run_uuid: Optional[str] = None
@@ -0,0 +1,12 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import Optional
4
+
5
+ from ..._models import BaseModel
6
+ from .evaluation_runs.api_evaluation_run import APIEvaluationRun
7
+
8
+ __all__ = ["EvaluationRunRetrieveResponse"]
9
+
10
+
11
+ class EvaluationRunRetrieveResponse(BaseModel):
12
+ evaluation_run: Optional[APIEvaluationRun] = None
@@ -0,0 +1,9 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from __future__ import annotations
4
+
5
+ from .api_prompt import APIPrompt as APIPrompt
6
+ from .api_evaluation_run import APIEvaluationRun as APIEvaluationRun
7
+ from .result_retrieve_response import ResultRetrieveResponse as ResultRetrieveResponse
8
+ from .api_evaluation_metric_result import APIEvaluationMetricResult as APIEvaluationMetricResult
9
+ from .result_retrieve_prompt_response import ResultRetrievePromptResponse as ResultRetrievePromptResponse
@@ -0,0 +1,17 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import Optional
4
+
5
+ from ...._models import BaseModel
6
+
7
+ __all__ = ["APIEvaluationMetricResult"]
8
+
9
+
10
+ class APIEvaluationMetricResult(BaseModel):
11
+ metric_name: Optional[str] = None
12
+
13
+ number_value: Optional[float] = None
14
+ """The value of the metric as a number."""
15
+
16
+ string_value: Optional[str] = None
17
+ """The value of the metric as a string."""
@@ -0,0 +1,56 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import List, Optional
4
+ from datetime import datetime
5
+ from typing_extensions import Literal
6
+
7
+ from ...._models import BaseModel
8
+ from .api_evaluation_metric_result import APIEvaluationMetricResult
9
+
10
+ __all__ = ["APIEvaluationRun"]
11
+
12
+
13
+ class APIEvaluationRun(BaseModel):
14
+ agent_uuid: Optional[str] = None
15
+ """Agent UUID."""
16
+
17
+ agent_version_hash: Optional[str] = None
18
+
19
+ evaluation_run_uuid: Optional[str] = None
20
+ """Evaluation run UUID."""
21
+
22
+ finished_at: Optional[datetime] = None
23
+ """Run end time."""
24
+
25
+ pass_status: Optional[bool] = None
26
+ """The pass status of the evaluation run based on the star metric."""
27
+
28
+ run_level_metric_results: Optional[List[APIEvaluationMetricResult]] = None
29
+
30
+ run_name: Optional[str] = None
31
+ """Run name."""
32
+
33
+ star_metric_result: Optional[APIEvaluationMetricResult] = None
34
+
35
+ started_at: Optional[datetime] = None
36
+ """Run start time."""
37
+
38
+ status: Optional[
39
+ Literal[
40
+ "EVALUATION_RUN_STATUS_UNSPECIFIED",
41
+ "EVALUATION_RUN_QUEUED",
42
+ "EVALUATION_RUN_RUNNING_DATASET",
43
+ "EVALUATION_RUN_EVALUATING_RESULTS",
44
+ "EVALUATION_RUN_CANCELLING",
45
+ "EVALUATION_RUN_CANCELLED",
46
+ "EVALUATION_RUN_SUCCESSFUL",
47
+ "EVALUATION_RUN_PARTIALLY_SUCCESSFUL",
48
+ "EVALUATION_RUN_FAILED",
49
+ ]
50
+ ] = None
51
+
52
+ test_case_uuid: Optional[str] = None
53
+ """Test-case UUID."""
54
+
55
+ test_case_version: Optional[int] = None
56
+ """Test-case-version."""
@@ -0,0 +1,42 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from typing import List, Optional
4
+
5
+ from ...._models import BaseModel
6
+ from .api_evaluation_metric_result import APIEvaluationMetricResult
7
+
8
+ __all__ = ["APIPrompt", "PromptChunk"]
9
+
10
+
11
+ class PromptChunk(BaseModel):
12
+ chunk_usage_pct: Optional[float] = None
13
+ """The usage percentage of the chunk."""
14
+
15
+ chunk_used: Optional[bool] = None
16
+ """Indicates if the chunk was used in the prompt."""
17
+
18
+ index_uuid: Optional[str] = None
19
+ """The index uuid (Knowledge Base) of the chunk."""
20
+
21
+ source_name: Optional[str] = None
22
+ """The source name for the chunk, e.g., the file name or document title."""
23
+
24
+ text: Optional[str] = None
25
+ """Text content of the chunk."""
26
+
27
+
28
+ class APIPrompt(BaseModel):
29
+ ground_truth: Optional[str] = None
30
+ """The ground truth for the prompt."""
31
+
32
+ input: Optional[str] = None
33
+
34
+ output: Optional[str] = None
35
+
36
+ prompt_chunks: Optional[List[PromptChunk]] = None
37
+ """The list of prompt chunks."""
38
+
39
+ prompt_id: Optional[int] = None
40
+
41
+ prompt_level_metric_results: Optional[List[APIEvaluationMetricResult]] = None
42
+ """The metric results for the prompt."""