orca-sdk 0.1.1__py3-none-any.whl → 0.1.2__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 (185) hide show
  1. orca_sdk/__init__.py +10 -4
  2. orca_sdk/_shared/__init__.py +10 -0
  3. orca_sdk/_shared/metrics.py +393 -0
  4. orca_sdk/_shared/metrics_test.py +273 -0
  5. orca_sdk/_utils/analysis_ui.py +12 -10
  6. orca_sdk/_utils/analysis_ui_style.css +0 -3
  7. orca_sdk/_utils/auth.py +27 -29
  8. orca_sdk/_utils/data_parsing.py +28 -2
  9. orca_sdk/_utils/data_parsing_test.py +15 -15
  10. orca_sdk/_utils/pagination.py +126 -0
  11. orca_sdk/_utils/pagination_test.py +132 -0
  12. orca_sdk/_utils/prediction_result_ui.py +67 -21
  13. orca_sdk/_utils/tqdm_file_reader.py +12 -0
  14. orca_sdk/_utils/value_parser.py +45 -0
  15. orca_sdk/_utils/value_parser_test.py +39 -0
  16. orca_sdk/classification_model.py +439 -129
  17. orca_sdk/classification_model_test.py +334 -104
  18. orca_sdk/client.py +3747 -0
  19. orca_sdk/conftest.py +164 -19
  20. orca_sdk/credentials.py +120 -18
  21. orca_sdk/credentials_test.py +20 -0
  22. orca_sdk/datasource.py +259 -68
  23. orca_sdk/datasource_test.py +242 -0
  24. orca_sdk/embedding_model.py +425 -82
  25. orca_sdk/embedding_model_test.py +39 -13
  26. orca_sdk/job.py +337 -0
  27. orca_sdk/job_test.py +108 -0
  28. orca_sdk/memoryset.py +1341 -305
  29. orca_sdk/memoryset_test.py +350 -111
  30. orca_sdk/regression_model.py +684 -0
  31. orca_sdk/regression_model_test.py +369 -0
  32. orca_sdk/telemetry.py +449 -143
  33. orca_sdk/telemetry_test.py +43 -24
  34. {orca_sdk-0.1.1.dist-info → orca_sdk-0.1.2.dist-info}/METADATA +34 -16
  35. orca_sdk-0.1.2.dist-info/RECORD +40 -0
  36. {orca_sdk-0.1.1.dist-info → orca_sdk-0.1.2.dist-info}/WHEEL +1 -1
  37. orca_sdk/_generated_api_client/__init__.py +0 -3
  38. orca_sdk/_generated_api_client/api/__init__.py +0 -193
  39. orca_sdk/_generated_api_client/api/auth/__init__.py +0 -0
  40. orca_sdk/_generated_api_client/api/auth/check_authentication_auth_get.py +0 -128
  41. orca_sdk/_generated_api_client/api/auth/create_api_key_auth_api_key_post.py +0 -170
  42. orca_sdk/_generated_api_client/api/auth/delete_api_key_auth_api_key_name_or_id_delete.py +0 -156
  43. orca_sdk/_generated_api_client/api/auth/delete_org_auth_org_delete.py +0 -130
  44. orca_sdk/_generated_api_client/api/auth/list_api_keys_auth_api_key_get.py +0 -127
  45. orca_sdk/_generated_api_client/api/classification_model/__init__.py +0 -0
  46. orca_sdk/_generated_api_client/api/classification_model/create_evaluation_classification_model_model_name_or_id_evaluation_post.py +0 -183
  47. orca_sdk/_generated_api_client/api/classification_model/create_model_classification_model_post.py +0 -170
  48. orca_sdk/_generated_api_client/api/classification_model/delete_evaluation_classification_model_model_name_or_id_evaluation_task_id_delete.py +0 -168
  49. orca_sdk/_generated_api_client/api/classification_model/delete_model_classification_model_name_or_id_delete.py +0 -154
  50. orca_sdk/_generated_api_client/api/classification_model/get_evaluation_classification_model_model_name_or_id_evaluation_task_id_get.py +0 -170
  51. orca_sdk/_generated_api_client/api/classification_model/get_model_classification_model_name_or_id_get.py +0 -156
  52. orca_sdk/_generated_api_client/api/classification_model/list_evaluations_classification_model_model_name_or_id_evaluation_get.py +0 -161
  53. orca_sdk/_generated_api_client/api/classification_model/list_models_classification_model_get.py +0 -127
  54. orca_sdk/_generated_api_client/api/classification_model/predict_gpu_classification_model_name_or_id_prediction_post.py +0 -190
  55. orca_sdk/_generated_api_client/api/datasource/__init__.py +0 -0
  56. orca_sdk/_generated_api_client/api/datasource/create_datasource_datasource_post.py +0 -167
  57. orca_sdk/_generated_api_client/api/datasource/delete_datasource_datasource_name_or_id_delete.py +0 -156
  58. orca_sdk/_generated_api_client/api/datasource/get_datasource_datasource_name_or_id_get.py +0 -156
  59. orca_sdk/_generated_api_client/api/datasource/list_datasources_datasource_get.py +0 -127
  60. orca_sdk/_generated_api_client/api/default/__init__.py +0 -0
  61. orca_sdk/_generated_api_client/api/default/healthcheck_get.py +0 -118
  62. orca_sdk/_generated_api_client/api/default/healthcheck_gpu_get.py +0 -118
  63. orca_sdk/_generated_api_client/api/finetuned_embedding_model/__init__.py +0 -0
  64. orca_sdk/_generated_api_client/api/finetuned_embedding_model/create_finetuned_embedding_model_finetuned_embedding_model_post.py +0 -168
  65. orca_sdk/_generated_api_client/api/finetuned_embedding_model/delete_finetuned_embedding_model_finetuned_embedding_model_name_or_id_delete.py +0 -156
  66. orca_sdk/_generated_api_client/api/finetuned_embedding_model/embed_with_finetuned_model_gpu_finetuned_embedding_model_name_or_id_embedding_post.py +0 -189
  67. orca_sdk/_generated_api_client/api/finetuned_embedding_model/get_finetuned_embedding_model_finetuned_embedding_model_name_or_id_get.py +0 -156
  68. orca_sdk/_generated_api_client/api/finetuned_embedding_model/list_finetuned_embedding_models_finetuned_embedding_model_get.py +0 -127
  69. orca_sdk/_generated_api_client/api/memoryset/__init__.py +0 -0
  70. orca_sdk/_generated_api_client/api/memoryset/clone_memoryset_memoryset_name_or_id_clone_post.py +0 -181
  71. orca_sdk/_generated_api_client/api/memoryset/create_analysis_memoryset_name_or_id_analysis_post.py +0 -183
  72. orca_sdk/_generated_api_client/api/memoryset/create_memoryset_memoryset_post.py +0 -168
  73. orca_sdk/_generated_api_client/api/memoryset/delete_memories_memoryset_name_or_id_memories_delete_post.py +0 -181
  74. orca_sdk/_generated_api_client/api/memoryset/delete_memory_memoryset_name_or_id_memory_memory_id_delete.py +0 -167
  75. orca_sdk/_generated_api_client/api/memoryset/delete_memoryset_memoryset_name_or_id_delete.py +0 -156
  76. orca_sdk/_generated_api_client/api/memoryset/get_analysis_memoryset_name_or_id_analysis_analysis_task_id_get.py +0 -169
  77. orca_sdk/_generated_api_client/api/memoryset/get_memories_memoryset_name_or_id_memories_get_post.py +0 -188
  78. orca_sdk/_generated_api_client/api/memoryset/get_memory_memoryset_name_or_id_memory_memory_id_get.py +0 -169
  79. orca_sdk/_generated_api_client/api/memoryset/get_memoryset_memoryset_name_or_id_get.py +0 -156
  80. orca_sdk/_generated_api_client/api/memoryset/insert_memories_gpu_memoryset_name_or_id_memory_post.py +0 -184
  81. orca_sdk/_generated_api_client/api/memoryset/list_analyses_memoryset_name_or_id_analysis_get.py +0 -260
  82. orca_sdk/_generated_api_client/api/memoryset/list_memorysets_memoryset_get.py +0 -127
  83. orca_sdk/_generated_api_client/api/memoryset/memoryset_lookup_gpu_memoryset_name_or_id_lookup_post.py +0 -193
  84. orca_sdk/_generated_api_client/api/memoryset/query_memoryset_memoryset_name_or_id_memories_post.py +0 -188
  85. orca_sdk/_generated_api_client/api/memoryset/update_memories_gpu_memoryset_name_or_id_memories_patch.py +0 -191
  86. orca_sdk/_generated_api_client/api/memoryset/update_memory_gpu_memoryset_name_or_id_memory_patch.py +0 -187
  87. orca_sdk/_generated_api_client/api/pretrained_embedding_model/__init__.py +0 -0
  88. orca_sdk/_generated_api_client/api/pretrained_embedding_model/embed_with_pretrained_model_gpu_pretrained_embedding_model_model_name_embedding_post.py +0 -188
  89. orca_sdk/_generated_api_client/api/pretrained_embedding_model/get_pretrained_embedding_model_pretrained_embedding_model_model_name_get.py +0 -157
  90. orca_sdk/_generated_api_client/api/pretrained_embedding_model/list_pretrained_embedding_models_pretrained_embedding_model_get.py +0 -127
  91. orca_sdk/_generated_api_client/api/task/__init__.py +0 -0
  92. orca_sdk/_generated_api_client/api/task/abort_task_task_task_id_abort_delete.py +0 -154
  93. orca_sdk/_generated_api_client/api/task/get_task_status_task_task_id_status_get.py +0 -156
  94. orca_sdk/_generated_api_client/api/task/list_tasks_task_get.py +0 -243
  95. orca_sdk/_generated_api_client/api/telemetry/__init__.py +0 -0
  96. orca_sdk/_generated_api_client/api/telemetry/drop_feedback_category_with_data_telemetry_feedback_category_name_or_id_delete.py +0 -162
  97. orca_sdk/_generated_api_client/api/telemetry/get_feedback_category_telemetry_feedback_category_name_or_id_get.py +0 -156
  98. orca_sdk/_generated_api_client/api/telemetry/get_prediction_telemetry_prediction_prediction_id_get.py +0 -157
  99. orca_sdk/_generated_api_client/api/telemetry/list_feedback_categories_telemetry_feedback_category_get.py +0 -127
  100. orca_sdk/_generated_api_client/api/telemetry/list_predictions_telemetry_prediction_post.py +0 -175
  101. orca_sdk/_generated_api_client/api/telemetry/record_prediction_feedback_telemetry_prediction_feedback_put.py +0 -171
  102. orca_sdk/_generated_api_client/api/telemetry/update_prediction_telemetry_prediction_prediction_id_patch.py +0 -181
  103. orca_sdk/_generated_api_client/client.py +0 -216
  104. orca_sdk/_generated_api_client/errors.py +0 -38
  105. orca_sdk/_generated_api_client/models/__init__.py +0 -159
  106. orca_sdk/_generated_api_client/models/analyze_neighbor_labels_result.py +0 -84
  107. orca_sdk/_generated_api_client/models/api_key_metadata.py +0 -118
  108. orca_sdk/_generated_api_client/models/base_model.py +0 -55
  109. orca_sdk/_generated_api_client/models/body_create_datasource_datasource_post.py +0 -176
  110. orca_sdk/_generated_api_client/models/classification_evaluation_result.py +0 -114
  111. orca_sdk/_generated_api_client/models/clone_labeled_memoryset_request.py +0 -150
  112. orca_sdk/_generated_api_client/models/column_info.py +0 -114
  113. orca_sdk/_generated_api_client/models/column_type.py +0 -14
  114. orca_sdk/_generated_api_client/models/conflict_error_response.py +0 -80
  115. orca_sdk/_generated_api_client/models/create_api_key_request.py +0 -99
  116. orca_sdk/_generated_api_client/models/create_api_key_response.py +0 -126
  117. orca_sdk/_generated_api_client/models/create_labeled_memoryset_request.py +0 -259
  118. orca_sdk/_generated_api_client/models/create_rac_model_request.py +0 -209
  119. orca_sdk/_generated_api_client/models/datasource_metadata.py +0 -142
  120. orca_sdk/_generated_api_client/models/delete_memories_request.py +0 -70
  121. orca_sdk/_generated_api_client/models/embed_request.py +0 -127
  122. orca_sdk/_generated_api_client/models/embedding_finetuning_method.py +0 -9
  123. orca_sdk/_generated_api_client/models/evaluation_request.py +0 -180
  124. orca_sdk/_generated_api_client/models/evaluation_response.py +0 -140
  125. orca_sdk/_generated_api_client/models/feedback_type.py +0 -9
  126. orca_sdk/_generated_api_client/models/field_validation_error.py +0 -103
  127. orca_sdk/_generated_api_client/models/filter_item.py +0 -231
  128. orca_sdk/_generated_api_client/models/filter_item_field_type_0_item.py +0 -15
  129. orca_sdk/_generated_api_client/models/filter_item_field_type_2_item_type_1.py +0 -16
  130. orca_sdk/_generated_api_client/models/filter_item_op.py +0 -16
  131. orca_sdk/_generated_api_client/models/find_duplicates_analysis_result.py +0 -70
  132. orca_sdk/_generated_api_client/models/finetune_embedding_model_request.py +0 -259
  133. orca_sdk/_generated_api_client/models/finetune_embedding_model_request_training_args.py +0 -66
  134. orca_sdk/_generated_api_client/models/finetuned_embedding_model_metadata.py +0 -166
  135. orca_sdk/_generated_api_client/models/get_memories_request.py +0 -70
  136. orca_sdk/_generated_api_client/models/internal_server_error_response.py +0 -80
  137. orca_sdk/_generated_api_client/models/label_class_metrics.py +0 -108
  138. orca_sdk/_generated_api_client/models/label_prediction_memory_lookup.py +0 -274
  139. orca_sdk/_generated_api_client/models/label_prediction_memory_lookup_metadata.py +0 -68
  140. orca_sdk/_generated_api_client/models/label_prediction_result.py +0 -101
  141. orca_sdk/_generated_api_client/models/label_prediction_with_memories_and_feedback.py +0 -232
  142. orca_sdk/_generated_api_client/models/labeled_memory.py +0 -197
  143. orca_sdk/_generated_api_client/models/labeled_memory_insert.py +0 -108
  144. orca_sdk/_generated_api_client/models/labeled_memory_insert_metadata.py +0 -68
  145. orca_sdk/_generated_api_client/models/labeled_memory_lookup.py +0 -258
  146. orca_sdk/_generated_api_client/models/labeled_memory_lookup_metadata.py +0 -68
  147. orca_sdk/_generated_api_client/models/labeled_memory_metadata.py +0 -68
  148. orca_sdk/_generated_api_client/models/labeled_memory_metrics.py +0 -277
  149. orca_sdk/_generated_api_client/models/labeled_memory_update.py +0 -171
  150. orca_sdk/_generated_api_client/models/labeled_memory_update_metadata_type_0.py +0 -68
  151. orca_sdk/_generated_api_client/models/labeled_memoryset_metadata.py +0 -195
  152. orca_sdk/_generated_api_client/models/list_analyses_memoryset_name_or_id_analysis_get_type_type_0.py +0 -9
  153. orca_sdk/_generated_api_client/models/list_memories_request.py +0 -104
  154. orca_sdk/_generated_api_client/models/list_predictions_request.py +0 -234
  155. orca_sdk/_generated_api_client/models/list_predictions_request_sort_item_item_type_0.py +0 -9
  156. orca_sdk/_generated_api_client/models/list_predictions_request_sort_item_item_type_1.py +0 -9
  157. orca_sdk/_generated_api_client/models/lookup_request.py +0 -81
  158. orca_sdk/_generated_api_client/models/memoryset_analysis_request.py +0 -83
  159. orca_sdk/_generated_api_client/models/memoryset_analysis_request_type.py +0 -9
  160. orca_sdk/_generated_api_client/models/memoryset_analysis_response.py +0 -180
  161. orca_sdk/_generated_api_client/models/memoryset_analysis_response_config.py +0 -66
  162. orca_sdk/_generated_api_client/models/memoryset_analysis_response_type.py +0 -9
  163. orca_sdk/_generated_api_client/models/not_found_error_response.py +0 -100
  164. orca_sdk/_generated_api_client/models/not_found_error_response_resource_type_0.py +0 -20
  165. orca_sdk/_generated_api_client/models/prediction_feedback.py +0 -157
  166. orca_sdk/_generated_api_client/models/prediction_feedback_category.py +0 -115
  167. orca_sdk/_generated_api_client/models/prediction_feedback_request.py +0 -122
  168. orca_sdk/_generated_api_client/models/prediction_feedback_result.py +0 -102
  169. orca_sdk/_generated_api_client/models/prediction_request.py +0 -169
  170. orca_sdk/_generated_api_client/models/pretrained_embedding_model_metadata.py +0 -97
  171. orca_sdk/_generated_api_client/models/pretrained_embedding_model_name.py +0 -11
  172. orca_sdk/_generated_api_client/models/rac_head_type.py +0 -11
  173. orca_sdk/_generated_api_client/models/rac_model_metadata.py +0 -191
  174. orca_sdk/_generated_api_client/models/service_unavailable_error_response.py +0 -80
  175. orca_sdk/_generated_api_client/models/task.py +0 -198
  176. orca_sdk/_generated_api_client/models/task_status.py +0 -14
  177. orca_sdk/_generated_api_client/models/task_status_info.py +0 -133
  178. orca_sdk/_generated_api_client/models/unauthenticated_error_response.py +0 -72
  179. orca_sdk/_generated_api_client/models/unauthorized_error_response.py +0 -80
  180. orca_sdk/_generated_api_client/models/unprocessable_input_error_response.py +0 -94
  181. orca_sdk/_generated_api_client/models/update_prediction_request.py +0 -93
  182. orca_sdk/_generated_api_client/py.typed +0 -1
  183. orca_sdk/_generated_api_client/types.py +0 -56
  184. orca_sdk/_utils/task.py +0 -73
  185. orca_sdk-0.1.1.dist-info/RECORD +0 -175
orca_sdk/client.py ADDED
@@ -0,0 +1,3747 @@
1
+ # Do not edit this file manually! It is generated by scripts/codegen.py
2
+
3
+ from __future__ import annotations
4
+
5
+ import json
6
+ import logging
7
+ import os
8
+ import uuid
9
+ from string import Formatter
10
+ from typing import Any, Literal, Mapping, NotRequired, TypedDict, cast, overload
11
+
12
+ from httpx import (
13
+ URL,
14
+ USE_CLIENT_DEFAULT,
15
+ Client,
16
+ Headers,
17
+ HTTPTransport,
18
+ Request,
19
+ Response,
20
+ Timeout,
21
+ )
22
+ from httpx._client import UseClientDefault # type: ignore
23
+ from httpx._types import AuthTypes # type: ignore
24
+ from httpx._types import CookieTypes # type: ignore
25
+ from httpx._types import FileTypes # type: ignore
26
+ from httpx._types import HeaderTypes # type: ignore
27
+ from httpx._types import RequestContent # type: ignore
28
+ from httpx._types import RequestExtensions # type: ignore
29
+ from httpx._types import TimeoutTypes # type: ignore
30
+ from httpx_retries import Retry, RetryTransport
31
+
32
+
33
+ class ActionRecommendation(TypedDict):
34
+ action: Literal["remove_duplicates", "detect_mislabels", "add_memories", "finetuning"]
35
+ """
36
+ The recommended action to take
37
+ """
38
+ rationale: str
39
+ """
40
+ Explanation for why this action was recommended
41
+ """
42
+
43
+
44
+ class AddMemorySuggestion(TypedDict):
45
+ value: str
46
+ label_name: str
47
+
48
+
49
+ class AliveResponse(TypedDict):
50
+ ok: bool
51
+
52
+
53
+ class ApiKeyMetadata(TypedDict):
54
+ id: str
55
+ org_id: str
56
+ name: str
57
+ created_by: str | None
58
+ created_at: str
59
+ updated_at: str
60
+ scope: list[Literal["ADMINISTER", "PREDICT"]]
61
+
62
+
63
+ class BaseLabelPredictionResult(TypedDict):
64
+ prediction_id: str | None
65
+ confidence: float
66
+ anomaly_score: float | None
67
+ label: int | None
68
+ label_name: str | None
69
+ logits: list[float]
70
+
71
+
72
+ class BaseModel(TypedDict):
73
+ pass
74
+
75
+
76
+ class BaseScorePredictionResult(TypedDict):
77
+ prediction_id: str | None
78
+ confidence: float
79
+ anomaly_score: float | None
80
+ score: float | None
81
+
82
+
83
+ class CascadeEditSuggestionsRequest(TypedDict):
84
+ old_label: int | None
85
+ new_label: int
86
+ max_neighbors: NotRequired[int]
87
+ max_validation_neighbors: NotRequired[int]
88
+ similarity_threshold: NotRequired[float | None]
89
+ only_if_has_old_label: NotRequired[bool]
90
+ exclude_if_new_label: NotRequired[bool]
91
+ suggestion_cooldown_time: NotRequired[float]
92
+ label_confirmation_cooldown_time: NotRequired[float]
93
+
94
+
95
+ class ClassPattern(TypedDict):
96
+ label: int
97
+ name: str
98
+ description: str
99
+
100
+
101
+ class ClassPatternsDescription(TypedDict):
102
+ overview: str
103
+ classes: list[ClassPattern]
104
+ summary: str
105
+
106
+
107
+ class ClassRepresentatives(TypedDict):
108
+ label: int
109
+ label_name: str | None
110
+ representative_memory_ids: list[str]
111
+
112
+
113
+ class ClassificationEvaluationRequest(TypedDict):
114
+ datasource_name_or_id: str
115
+ memoryset_override_name_or_id: NotRequired[str | None]
116
+ datasource_label_column: str
117
+ datasource_value_column: str
118
+ record_telemetry: NotRequired[bool]
119
+ telemetry_tags: NotRequired[list[str] | None]
120
+
121
+
122
+ class CleanupResponse(TypedDict):
123
+ deleted_milvus_collections: list[str]
124
+ deleted_milvus_collections_count: int
125
+ deleted_blob_paths: list[str]
126
+ deleted_blob_paths_count: int
127
+
128
+
129
+ class ClusterMetrics(TypedDict):
130
+ cluster: int
131
+ memory_count: int
132
+
133
+
134
+ ColumnType = Literal["STRING", "FLOAT", "INT", "BOOL", "ENUM", "IMAGE", "OTHER"]
135
+
136
+
137
+ class ConstraintViolationErrorResponse(TypedDict):
138
+ status_code: NotRequired[int]
139
+ constraint: str
140
+
141
+
142
+ class CountPredictionsRequest(TypedDict):
143
+ model_id: NotRequired[str | None]
144
+ tag: NotRequired[str | None]
145
+ prediction_ids: NotRequired[list[str] | None]
146
+ start_timestamp: NotRequired[str | None]
147
+ end_timestamp: NotRequired[str | None]
148
+
149
+
150
+ class CreateApiKeyRequest(TypedDict):
151
+ id: NotRequired[str]
152
+ name: NotRequired[str]
153
+ created_by: NotRequired[str | None]
154
+ scope: list[Literal["ADMINISTER", "PREDICT"]]
155
+
156
+
157
+ class CreateApiKeyResponse(TypedDict):
158
+ id: str
159
+ org_id: str
160
+ name: str
161
+ created_by: str | None
162
+ created_at: str
163
+ updated_at: str
164
+ scope: list[Literal["ADMINISTER", "PREDICT"]]
165
+ api_key: str
166
+
167
+
168
+ class CreateDatasourceFromContentRequest(TypedDict):
169
+ name: str
170
+ description: NotRequired[str | None]
171
+ content: Any
172
+
173
+
174
+ class CreateOrgPlanRequest(TypedDict):
175
+ tier: Literal["FREE", "PRO", "ENTERPRISE", "CANCELLED"]
176
+
177
+
178
+ class DeleteMemoriesRequest(TypedDict):
179
+ memory_ids: list[str]
180
+
181
+
182
+ class DeleteMemorysetsRequest(TypedDict):
183
+ memoryset_ids: list[str]
184
+
185
+
186
+ class EmbedRequest(TypedDict):
187
+ values: list[str] | list[bytes] | list[str | bytes]
188
+ max_seq_length: NotRequired[int | None]
189
+ prompt: NotRequired[str | None]
190
+
191
+
192
+ class EmbeddingEvaluationRequest(TypedDict):
193
+ datasource_name_or_id: str
194
+ eval_datasource_name_or_id: NotRequired[str | None]
195
+ subsample: NotRequired[int | None]
196
+ datasource_value_column: NotRequired[str]
197
+ datasource_label_column: NotRequired[str | None]
198
+ datasource_score_column: NotRequired[str | None]
199
+ neighbor_count: NotRequired[int]
200
+ batch_size: NotRequired[int]
201
+ weigh_memories: NotRequired[bool]
202
+
203
+
204
+ EmbeddingFinetuningMethod = Literal["classification", "batch_triplet_loss"]
205
+
206
+
207
+ class FeedbackMetrics(TypedDict):
208
+ avg: float | None
209
+ count: int
210
+
211
+
212
+ FeedbackType = Literal["CONTINUOUS", "BINARY"]
213
+
214
+
215
+ class FilterItem(TypedDict):
216
+ field: list
217
+ op: Literal["==", "!=", ">", ">=", "<", "<=", "in", "not in", "like"]
218
+ value: str | int | float | bool | list[str] | list[int] | list[float] | list[bool] | None
219
+
220
+
221
+ class GetMemoriesRequest(TypedDict):
222
+ memory_ids: list[str]
223
+
224
+
225
+ class HealthyResponse(TypedDict):
226
+ ok: bool
227
+ checks: dict[str, bool]
228
+ durations: dict[str, int]
229
+ draining: bool
230
+ config: dict[str, str | float | int | bool | None]
231
+
232
+
233
+ class InternalServerErrorResponse(TypedDict):
234
+ status_code: NotRequired[int]
235
+ message: str
236
+ request_id: str
237
+
238
+
239
+ class LabelClassMetrics(TypedDict):
240
+ label: int | None
241
+ label_name: NotRequired[str | None]
242
+ average_lookup_score: float
243
+ memory_count: int
244
+
245
+
246
+ class LabeledExample(TypedDict):
247
+ text: str
248
+ label_name: str
249
+
250
+
251
+ class LabeledMemoryInsert(TypedDict):
252
+ memory_id: NotRequired[str | None]
253
+ value: str | bytes
254
+ metadata: NotRequired[dict[str, str | int | float | bool | None]]
255
+ source_id: NotRequired[str | None]
256
+ label: int | None
257
+
258
+
259
+ class ListMemoriesRequest(TypedDict):
260
+ offset: NotRequired[int]
261
+ limit: NotRequired[int]
262
+ filters: NotRequired[list[FilterItem]]
263
+
264
+
265
+ class LookupRequest(TypedDict):
266
+ query: list[str]
267
+ count: NotRequired[int]
268
+ prompt: NotRequired[str | None]
269
+
270
+
271
+ class LookupScoreMetrics(TypedDict):
272
+ median: float
273
+ std: float
274
+ quantiles: list[float]
275
+ quantile_values: list[float]
276
+
277
+
278
+ class MemoryMetrics(TypedDict):
279
+ is_duplicate: NotRequired[bool]
280
+ duplicate_memory_ids: NotRequired[list[str]]
281
+ has_potential_duplicates: NotRequired[bool]
282
+ potential_duplicate_memory_ids: NotRequired[list[str] | None]
283
+ cluster: NotRequired[int]
284
+ embedding_2d: NotRequired[list]
285
+ anomaly_score: NotRequired[float]
286
+ neighbor_label_logits: NotRequired[list[float]]
287
+ neighbor_predicted_label: NotRequired[int | None]
288
+ neighbor_predicted_label_ambiguity: NotRequired[float]
289
+ neighbor_predicted_label_confidence: NotRequired[float]
290
+ current_label_neighbor_confidence: NotRequired[float]
291
+ normalized_neighbor_label_entropy: NotRequired[float]
292
+ neighbor_predicted_label_matches_current_label: NotRequired[bool | None]
293
+ spread: NotRequired[float]
294
+ uniformity: NotRequired[float]
295
+ concept_id: NotRequired[int | None]
296
+ subconcept_id: NotRequired[int | None]
297
+
298
+
299
+ MemoryType = Literal["LABELED", "SCORED"]
300
+
301
+
302
+ class MemorysetClassPatternsAnalysisConfig(TypedDict):
303
+ representatives_per_class: NotRequired[int]
304
+ enable_patterns_description: NotRequired[bool]
305
+
306
+
307
+ class MemorysetClassPatternsMetrics(TypedDict):
308
+ class_representatives: list[ClassRepresentatives]
309
+ patterns_description: NotRequired[ClassPatternsDescription | None]
310
+ mean_spread: float
311
+ variance_spread: float
312
+ mean_uniformity: float
313
+ variance_uniformity: float
314
+ updated_at: str
315
+
316
+
317
+ class MemorysetClusterAnalysisConfig(TypedDict):
318
+ min_cluster_size: NotRequired[int | None]
319
+ max_cluster_size: NotRequired[int | None]
320
+ clustering_method: NotRequired[Literal["density", "graph"]]
321
+ min_cluster_distance: NotRequired[float]
322
+ partitioning_method: NotRequired[Literal["ng", "rb", "cpm"]]
323
+ resolution: NotRequired[float | None]
324
+ num_iterations: NotRequired[int]
325
+ random_state: NotRequired[int | None]
326
+
327
+
328
+ class MemorysetClusterMetrics(TypedDict):
329
+ cluster_metrics: list[ClusterMetrics]
330
+ num_outliers: int
331
+ num_clusters: int
332
+ updated_at: str
333
+
334
+
335
+ class MemorysetConceptAnalysisConfig(TypedDict):
336
+ high_level_description: NotRequired[str | None]
337
+ max_sample_rows: NotRequired[int]
338
+ max_trial_count: NotRequired[int]
339
+ min_desired_clusters_per_label: NotRequired[int]
340
+ max_desired_clusters_per_label: NotRequired[int]
341
+ accuracy_importance: NotRequired[float]
342
+ noise_penalty: NotRequired[float]
343
+ naming_examples_count: NotRequired[int]
344
+ naming_counterexample_count: NotRequired[int]
345
+ seed: NotRequired[int]
346
+
347
+
348
+ class MemorysetDuplicateAnalysisConfig(TypedDict):
349
+ potential_duplicate_threshold: NotRequired[float]
350
+
351
+
352
+ class MemorysetDuplicateMetrics(TypedDict):
353
+ num_duplicates: int
354
+ num_potential_duplicates: int
355
+ updated_at: str
356
+
357
+
358
+ class MemorysetLabelAnalysisConfig(TypedDict):
359
+ normalize_logits: NotRequired[bool]
360
+
361
+
362
+ class MemorysetLabelMetrics(TypedDict):
363
+ label_metrics: list[LabelClassMetrics]
364
+ neighbor_prediction_accuracy: float
365
+ mean_neighbor_label_confidence: float
366
+ mean_neighbor_label_entropy: float
367
+ mean_neighbor_predicted_label_ambiguity: float
368
+ num_no_labeled_neighbors: int
369
+ num_potential_mislabels: int
370
+ updated_at: str
371
+
372
+
373
+ class MemorysetNeighborAnalysisConfig(TypedDict):
374
+ neighbor_counts: NotRequired[list[int]]
375
+ quantiles: NotRequired[list[float]]
376
+
377
+
378
+ class MemorysetNeighborMetrics(TypedDict):
379
+ lookup_score_metrics: dict[str, LookupScoreMetrics]
380
+ updated_at: str
381
+
382
+
383
+ class MemorysetProjectionAnalysisConfig(TypedDict):
384
+ min_dist: NotRequired[float]
385
+ spread: NotRequired[float]
386
+
387
+
388
+ class MemorysetProjectionMetrics(TypedDict):
389
+ updated_at: str
390
+
391
+
392
+ class MemorysetUpdate(TypedDict):
393
+ label_names: NotRequired[list[str]]
394
+ description: NotRequired[str | None]
395
+ name: NotRequired[str]
396
+ notes: NotRequired[str | None]
397
+ hidden: NotRequired[bool]
398
+
399
+
400
+ class NotFoundErrorResponse(TypedDict):
401
+ status_code: NotRequired[int]
402
+ resource: (
403
+ Literal[
404
+ "org",
405
+ "api_key",
406
+ "datasource",
407
+ "memoryset",
408
+ "classification_model",
409
+ "regression_model",
410
+ "prediction",
411
+ "memory",
412
+ "evaluation",
413
+ "analysis",
414
+ "task",
415
+ "pretrained_embedding_model",
416
+ "finetuned_embedding_model",
417
+ "feedback_category",
418
+ "embedding_evaluation",
419
+ "org_plan",
420
+ ]
421
+ | None
422
+ )
423
+
424
+
425
+ class OrgPlan(TypedDict):
426
+ org_id: str
427
+ created_at: str
428
+ updated_at: str
429
+ tier: Literal["FREE", "PRO", "ENTERPRISE", "CANCELLED"]
430
+
431
+
432
+ class PRCurve(TypedDict):
433
+ thresholds: list[float]
434
+ precisions: list[float]
435
+ recalls: list[float]
436
+
437
+
438
+ class PredictionFeedback(TypedDict):
439
+ prediction_id: str
440
+ category_name: str
441
+ value: float | bool
442
+ comment: str | None
443
+ id: str
444
+ org_id: str
445
+ category_id: str
446
+ category_type: FeedbackType
447
+ created_at: str
448
+ updated_at: str
449
+
450
+
451
+ class PredictionFeedbackCategory(TypedDict):
452
+ id: str
453
+ org_id: str
454
+ name: str
455
+ type: FeedbackType
456
+ created_at: str
457
+ updated_at: str
458
+
459
+
460
+ class PredictionFeedbackRequest(TypedDict):
461
+ prediction_id: str
462
+ category_name: str
463
+ value: NotRequired[float | bool | None]
464
+ """
465
+ The feedback value. For updates, UNSET means keep existing value. None means delete the feedback.
466
+ """
467
+ comment: NotRequired[str | None]
468
+ """
469
+ Optional comment. For updates, UNSET means keep existing comment. None means remove the comment.
470
+ """
471
+
472
+
473
+ class PredictionFeedbackResult(TypedDict):
474
+ prediction_ids: list[str]
475
+ deleted_feedback_ids: list[str]
476
+ updated_feedback_ids: list[str]
477
+ inserted_feedback_ids: list[str]
478
+ new_category_ids: list[str]
479
+
480
+
481
+ PredictionSort = list[list]
482
+
483
+
484
+ class PredictiveModelUpdate(TypedDict):
485
+ description: NotRequired[str | None]
486
+ notes: NotRequired[str | None]
487
+ locked: NotRequired[bool]
488
+
489
+
490
+ PretrainedEmbeddingModelName = Literal[
491
+ "CLIP_BASE",
492
+ "GTE_BASE",
493
+ "CDE_SMALL",
494
+ "DISTILBERT",
495
+ "GTE_SMALL",
496
+ "MXBAI_LARGE",
497
+ "E5_LARGE",
498
+ "QWEN2_1_5B",
499
+ "BGE_BASE",
500
+ "GIST_LARGE",
501
+ ]
502
+
503
+
504
+ RACHeadType = Literal["KNN", "MMOE", "FF", "BMMOE"]
505
+
506
+
507
+ RARHeadType = Literal["MMOE", "KNN"]
508
+
509
+
510
+ class ROCCurve(TypedDict):
511
+ thresholds: list[float]
512
+ false_positive_rates: list[float]
513
+ true_positive_rates: list[float]
514
+
515
+
516
+ class ReadyResponse(TypedDict):
517
+ ok: bool
518
+ draining: bool
519
+
520
+
521
+ class RegressionEvaluationRequest(TypedDict):
522
+ datasource_name_or_id: str
523
+ memoryset_override_name_or_id: NotRequired[str | None]
524
+ datasource_score_column: str
525
+ datasource_value_column: str
526
+ record_telemetry: NotRequired[bool]
527
+ telemetry_tags: NotRequired[list[str] | None]
528
+
529
+
530
+ class RegressionMetrics(TypedDict):
531
+ coverage: float
532
+ mse: float
533
+ rmse: float
534
+ mae: float
535
+ r2: float
536
+ explained_variance: float
537
+ loss: float
538
+ anomaly_score_mean: NotRequired[float | None]
539
+ anomaly_score_median: NotRequired[float | None]
540
+ anomaly_score_variance: NotRequired[float | None]
541
+
542
+
543
+ class RegressionModelMetadata(TypedDict):
544
+ id: str
545
+ org_id: str
546
+ name: str
547
+ description: str | None
548
+ notes: str | None
549
+ version: int
550
+ memoryset_id: str
551
+ memory_lookup_count: int
552
+ storage_path: str
553
+ memoryset_collection_name: str
554
+ created_at: str
555
+ updated_at: str
556
+ locked: bool
557
+ head_type: RARHeadType
558
+
559
+
560
+ class RegressionPredictionRequest(TypedDict):
561
+ input_values: list[str] | list[bytes] | list[str | bytes]
562
+ expected_scores: NotRequired[list[float] | None]
563
+ tags: NotRequired[list[str]]
564
+ memoryset_override_name_or_id: NotRequired[str | None]
565
+ save_telemetry: NotRequired[bool]
566
+ save_telemetry_synchronously: NotRequired[bool]
567
+ prompt: NotRequired[str | None]
568
+ use_lookup_cache: NotRequired[bool]
569
+ consistency_level: NotRequired[Literal["Bounded", "Session", "Strong", "Eventual"] | None]
570
+
571
+
572
+ class ScorePredictionMemoryLookup(TypedDict):
573
+ value: str | bytes
574
+ embedding: list[float]
575
+ source_id: str | None
576
+ metadata: dict[str, str | int | float | bool | None]
577
+ memory_id: str
578
+ memory_version: int
579
+ created_at: str
580
+ updated_at: str
581
+ edited_at: str
582
+ metrics: MemoryMetrics
583
+ lookup_score: float
584
+ score: float | None
585
+ prediction_id: str
586
+ attention_weight: float
587
+
588
+
589
+ class ScorePredictionWithMemoriesAndFeedback(TypedDict):
590
+ prediction_id: str
591
+ confidence: float
592
+ anomaly_score: float | None
593
+ score: float | None
594
+ timestamp: str
595
+ input_value: str | bytes
596
+ input_embedding: list[float]
597
+ expected_score: float | None
598
+ memories: list[ScorePredictionMemoryLookup]
599
+ org_id: str
600
+ memoryset_id: str
601
+ model_id: str
602
+ updated_at: str
603
+ tags: list[str]
604
+ explanation: str | None
605
+ memory_id: str | None
606
+ feedbacks: list[PredictionFeedback]
607
+
608
+
609
+ class ScoredMemory(TypedDict):
610
+ value: str | bytes
611
+ embedding: list[float]
612
+ source_id: str | None
613
+ metadata: dict[str, str | int | float | bool | None]
614
+ memory_id: str
615
+ memory_version: int
616
+ created_at: str
617
+ updated_at: str
618
+ edited_at: str
619
+ metrics: MemoryMetrics
620
+ score: float | None
621
+
622
+
623
+ class ScoredMemoryInsert(TypedDict):
624
+ memory_id: NotRequired[str | None]
625
+ value: str | bytes
626
+ metadata: NotRequired[dict[str, str | int | float | bool | None]]
627
+ source_id: NotRequired[str | None]
628
+ score: float | None
629
+
630
+
631
+ class ScoredMemoryLookup(TypedDict):
632
+ value: str | bytes
633
+ embedding: list[float]
634
+ source_id: str | None
635
+ metadata: dict[str, str | int | float | bool | None]
636
+ memory_id: str
637
+ memory_version: int
638
+ created_at: str
639
+ updated_at: str
640
+ edited_at: str
641
+ metrics: MemoryMetrics
642
+ lookup_score: float
643
+ score: float | None
644
+
645
+
646
+ class ScoredMemoryUpdate(TypedDict):
647
+ memory_id: str
648
+ value: NotRequired[str | bytes]
649
+ metadata: NotRequired[dict[str, str | int | float | bool | None] | None]
650
+ source_id: NotRequired[str | None]
651
+ metrics: NotRequired[MemoryMetrics | None]
652
+ score: NotRequired[float | None]
653
+
654
+
655
+ class ScoredMemoryWithFeedbackMetrics(TypedDict):
656
+ value: str | bytes
657
+ embedding: list[float]
658
+ source_id: str | None
659
+ metadata: dict[str, str | int | float | bool | None]
660
+ memory_id: str
661
+ memory_version: int
662
+ created_at: str
663
+ updated_at: str
664
+ edited_at: str
665
+ metrics: MemoryMetrics
666
+ score: float | None
667
+ feedback_metrics: dict[str, FeedbackMetrics]
668
+ lookup_count: int
669
+
670
+
671
+ class ServiceUnavailableErrorResponse(TypedDict):
672
+ status_code: NotRequired[int]
673
+ service: str
674
+
675
+
676
+ class SubConceptMetrics(TypedDict):
677
+ id: int
678
+ name: str
679
+ description: str | None
680
+ primary_label: int | None
681
+ memory_count: int
682
+
683
+
684
+ TaskStatus = Literal["INITIALIZED", "DISPATCHED", "WAITING", "PROCESSING", "COMPLETED", "FAILED", "ABORTING", "ABORTED"]
685
+
686
+
687
+ class TaskStatusInfo(TypedDict):
688
+ status: TaskStatus
689
+ steps_total: int | None
690
+ steps_completed: int | None
691
+ exception: str | None
692
+ updated_at: str
693
+ created_at: str
694
+
695
+
696
+ TelemetryField = list
697
+
698
+
699
+ class TelemetryFilterItem(TypedDict):
700
+ field: TelemetryField
701
+ op: Literal["==", "!=", ">", ">=", "<", "<=", "in", "not in"]
702
+ value: float | list[float] | int | list[int]
703
+
704
+
705
+ class TelemetrySortOptions(TypedDict):
706
+ field: TelemetryField
707
+ direction: Literal["asc", "desc"]
708
+
709
+
710
+ class UnauthenticatedErrorResponse(TypedDict):
711
+ status_code: NotRequired[int]
712
+
713
+
714
+ class UnauthorizedErrorResponse(TypedDict):
715
+ status_code: NotRequired[int]
716
+ reason: str
717
+
718
+
719
+ class UpdateOrgPlanRequest(TypedDict):
720
+ tier: Literal["FREE", "PRO", "ENTERPRISE", "CANCELLED"]
721
+
722
+
723
+ class UpdatePredictionRequest(TypedDict):
724
+ expected_label: NotRequired[int | None]
725
+ expected_score: NotRequired[float | None]
726
+ tags: NotRequired[list[str]]
727
+ memory_id: NotRequired[str | None]
728
+
729
+
730
+ class ValidationError(TypedDict):
731
+ loc: list[str | int]
732
+ msg: str
733
+ type: str
734
+
735
+
736
+ class DeleteAuthApiKeyByNameOrIdParams(TypedDict):
737
+ name_or_id: str
738
+
739
+
740
+ class GetMemorysetParams(TypedDict):
741
+ type: NotRequired[MemoryType | None]
742
+ show_hidden: NotRequired[bool | None]
743
+
744
+
745
+ class PostMemorysetByNameOrIdCloneParams(TypedDict):
746
+ name_or_id: str
747
+
748
+
749
+ class PatchMemorysetByNameOrIdParams(TypedDict):
750
+ name_or_id: str
751
+
752
+
753
+ class GetMemorysetByNameOrIdParams(TypedDict):
754
+ name_or_id: str
755
+
756
+
757
+ class DeleteMemorysetByNameOrIdParams(TypedDict):
758
+ name_or_id: str
759
+
760
+
761
+ class GetMemorysetByNameOrIdMemoryByMemoryIdParams(TypedDict):
762
+ name_or_id: str
763
+ memory_id: str
764
+ """
765
+ ID of the memory
766
+ """
767
+
768
+
769
+ class DeleteMemorysetByNameOrIdMemoryByMemoryIdParams(TypedDict):
770
+ name_or_id: str
771
+ memory_id: str
772
+ """
773
+ ID of the memory
774
+ """
775
+
776
+
777
+ class GetMemorysetByNameOrIdPotentialDuplicateGroupsParams(TypedDict):
778
+ name_or_id: str
779
+
780
+
781
+ class PostMemorysetByNameOrIdMemoriesGetParams(TypedDict):
782
+ name_or_id: str
783
+
784
+
785
+ class PostMemorysetByNameOrIdMemoriesParams(TypedDict):
786
+ name_or_id: str
787
+
788
+
789
+ class PostMemorysetByNameOrIdMemoriesDeleteParams(TypedDict):
790
+ name_or_id: str
791
+
792
+
793
+ class PostMemorysetByNameOrIdAnalysisParams(TypedDict):
794
+ name_or_id: str
795
+
796
+
797
+ class GetMemorysetByNameOrIdAnalysisParams(TypedDict):
798
+ name_or_id: str
799
+ status: NotRequired[TaskStatus | None]
800
+ limit: NotRequired[int | None]
801
+ offset: NotRequired[int | None]
802
+
803
+
804
+ class GetMemorysetByNameOrIdAnalysisByAnalysisTaskIdParams(TypedDict):
805
+ name_or_id: str
806
+ analysis_task_id: str
807
+
808
+
809
+ class PostMemorysetByNameOrIdMemoryByMemoryIdCascadingEditsParams(TypedDict):
810
+ name_or_id: str
811
+ memory_id: str
812
+
813
+
814
+ class GetFinetunedEmbeddingModelByNameOrIdParams(TypedDict):
815
+ name_or_id: str
816
+
817
+
818
+ class DeleteFinetunedEmbeddingModelByNameOrIdParams(TypedDict):
819
+ name_or_id: str
820
+
821
+
822
+ class PostFinetunedEmbeddingModelByNameOrIdEvaluationParams(TypedDict):
823
+ name_or_id: str
824
+
825
+
826
+ class GetFinetunedEmbeddingModelByNameOrIdEvaluationByTaskIdParams(TypedDict):
827
+ name_or_id: str
828
+ task_id: str
829
+
830
+
831
+ class GetFinetunedEmbeddingModelByNameOrIdEvaluationsParams(TypedDict):
832
+ name_or_id: str
833
+
834
+
835
+ class GetPretrainedEmbeddingModelByModelNameParams(TypedDict):
836
+ model_name: PretrainedEmbeddingModelName
837
+
838
+
839
+ class PostPretrainedEmbeddingModelByModelNameEvaluationParams(TypedDict):
840
+ model_name: PretrainedEmbeddingModelName
841
+
842
+
843
+ class GetPretrainedEmbeddingModelByModelNameEvaluationByTaskIdParams(TypedDict):
844
+ model_name: PretrainedEmbeddingModelName
845
+ task_id: str
846
+
847
+
848
+ class GetPretrainedEmbeddingModelByModelNameEvaluationsParams(TypedDict):
849
+ model_name: PretrainedEmbeddingModelName
850
+
851
+
852
+ class PostDatasourceUploadRequest(TypedDict):
853
+ name: str
854
+ """
855
+ Name for the datasource
856
+ """
857
+ description: NotRequired[str | None]
858
+ """
859
+ Optional description for the datasource
860
+ """
861
+
862
+
863
+ class GetDatasourceByNameOrIdParams(TypedDict):
864
+ name_or_id: str
865
+
866
+
867
+ class DeleteDatasourceByNameOrIdParams(TypedDict):
868
+ name_or_id: str
869
+
870
+
871
+ class PostDatasourceByNameOrIdEmbeddingEvaluationParams(TypedDict):
872
+ name_or_id: str
873
+
874
+
875
+ class GetDatasourceByNameOrIdEmbeddingEvaluationParams(TypedDict):
876
+ name_or_id: str
877
+ status: NotRequired[TaskStatus | None]
878
+ limit: NotRequired[int | None]
879
+ offset: NotRequired[int | None]
880
+
881
+
882
+ class GetDatasourceByNameOrIdEmbeddingEvaluationByTaskIdParams(TypedDict):
883
+ name_or_id: str
884
+ task_id: str
885
+
886
+
887
+ class GetDatasourceByNameOrIdDownloadParams(TypedDict):
888
+ name_or_id: str
889
+ file_type: NotRequired[Literal["hf_dataset", "json", "csv"]]
890
+ """
891
+ File type to download:
892
+ * `hf_dataset`: Zipped HuggingFace dataset (default)
893
+ * `json`: Row-oriented JSON array
894
+ * `csv`: CSV file
895
+ """
896
+
897
+
898
+ class PatchClassificationModelByNameOrIdParams(TypedDict):
899
+ name_or_id: str
900
+
901
+
902
+ class GetClassificationModelByNameOrIdParams(TypedDict):
903
+ name_or_id: str
904
+
905
+
906
+ class DeleteClassificationModelByNameOrIdParams(TypedDict):
907
+ name_or_id: str
908
+
909
+
910
+ class PostClassificationModelByModelNameOrIdEvaluationParams(TypedDict):
911
+ model_name_or_id: str
912
+
913
+
914
+ class GetClassificationModelByModelNameOrIdEvaluationParams(TypedDict):
915
+ model_name_or_id: str
916
+
917
+
918
+ class GetClassificationModelByModelNameOrIdEvaluationByTaskIdParams(TypedDict):
919
+ model_name_or_id: str
920
+ task_id: str
921
+
922
+
923
+ class DeleteClassificationModelByModelNameOrIdEvaluationByTaskIdParams(TypedDict):
924
+ model_name_or_id: str
925
+ task_id: str
926
+
927
+
928
+ class PatchRegressionModelByNameOrIdParams(TypedDict):
929
+ name_or_id: str
930
+
931
+
932
+ class GetRegressionModelByNameOrIdParams(TypedDict):
933
+ name_or_id: str
934
+
935
+
936
+ class DeleteRegressionModelByNameOrIdParams(TypedDict):
937
+ name_or_id: str
938
+
939
+
940
+ class PostRegressionModelByModelNameOrIdEvaluationParams(TypedDict):
941
+ model_name_or_id: str
942
+
943
+
944
+ class GetRegressionModelByModelNameOrIdEvaluationParams(TypedDict):
945
+ model_name_or_id: str
946
+
947
+
948
+ class GetRegressionModelByModelNameOrIdEvaluationByTaskIdParams(TypedDict):
949
+ model_name_or_id: str
950
+ task_id: str
951
+
952
+
953
+ class DeleteRegressionModelByModelNameOrIdEvaluationByTaskIdParams(TypedDict):
954
+ model_name_or_id: str
955
+ task_id: str
956
+
957
+
958
+ class GetTaskByTaskIdParams(TypedDict):
959
+ task_id: str
960
+
961
+
962
+ class GetTaskByTaskIdStatusParams(TypedDict):
963
+ task_id: str
964
+
965
+
966
+ class GetTaskParams(TypedDict):
967
+ status: NotRequired[TaskStatus | list[TaskStatus] | None]
968
+ type: NotRequired[str | list[str] | None]
969
+ limit: NotRequired[int | None]
970
+ offset: NotRequired[int]
971
+ start_timestamp: NotRequired[str | None]
972
+ end_timestamp: NotRequired[str | None]
973
+
974
+
975
+ class DeleteTaskByTaskIdAbortParams(TypedDict):
976
+ task_id: str
977
+
978
+
979
+ class GetTelemetryPredictionByPredictionIdParams(TypedDict):
980
+ prediction_id: str
981
+
982
+
983
+ class PatchTelemetryPredictionByPredictionIdParams(TypedDict):
984
+ prediction_id: str
985
+
986
+
987
+ class GetTelemetryPredictionByPredictionIdExplanationParams(TypedDict):
988
+ prediction_id: str
989
+ refresh: NotRequired[bool]
990
+
991
+
992
+ class GetTelemetryPredictionByPredictionIdActionParams(TypedDict):
993
+ prediction_id: str
994
+
995
+
996
+ class GetTelemetryPredictionByPredictionIdMemorySuggestionsParams(TypedDict):
997
+ prediction_id: str
998
+ """
999
+ ID of the prediction to generate suggestions for
1000
+ """
1001
+ num_memories: NotRequired[int]
1002
+ """
1003
+ Number of memory suggestions to generate
1004
+ """
1005
+ refresh: NotRequired[bool]
1006
+ """
1007
+ Force the explanation agent to re-run even if a cached explanation exists
1008
+ """
1009
+
1010
+
1011
+ class GetTelemetryFeedbackCategoryByNameOrIdParams(TypedDict):
1012
+ name_or_id: str
1013
+
1014
+
1015
+ class DeleteTelemetryFeedbackCategoryByNameOrIdParams(TypedDict):
1016
+ name_or_id: str
1017
+
1018
+
1019
+ PutTelemetryPredictionFeedbackRequest = list[PredictionFeedbackRequest]
1020
+
1021
+
1022
+ class GetAgentsBootstrapClassificationModelByTaskIdParams(TypedDict):
1023
+ task_id: str
1024
+
1025
+
1026
+ class PostGpuMemorysetByNameOrIdLookupParams(TypedDict):
1027
+ name_or_id: str
1028
+
1029
+
1030
+ class PatchGpuMemorysetByNameOrIdMemoryParams(TypedDict):
1031
+ name_or_id: str
1032
+
1033
+
1034
+ class PostGpuMemorysetByNameOrIdMemoryParams(TypedDict):
1035
+ name_or_id: str
1036
+
1037
+
1038
+ PostGpuMemorysetByNameOrIdMemoryRequest = list[LabeledMemoryInsert] | list[ScoredMemoryInsert]
1039
+
1040
+
1041
+ class PatchGpuMemorysetByNameOrIdMemoriesParams(TypedDict):
1042
+ name_or_id: str
1043
+
1044
+
1045
+ class PostGpuClassificationModelByNameOrIdPredictionParams(TypedDict):
1046
+ name_or_id: str
1047
+
1048
+
1049
+ class PostGpuRegressionModelByNameOrIdPredictionParams(TypedDict):
1050
+ name_or_id: str
1051
+
1052
+
1053
+ class PostGpuFinetunedEmbeddingModelByNameOrIdEmbeddingParams(TypedDict):
1054
+ name_or_id: str
1055
+
1056
+
1057
+ class PostGpuPretrainedEmbeddingModelByModelNameEmbeddingParams(TypedDict):
1058
+ model_name: PretrainedEmbeddingModelName
1059
+
1060
+
1061
+ class FieldValidationError(TypedDict):
1062
+ loc: list[str | int]
1063
+ msg: str
1064
+ type: NotRequired[str]
1065
+
1066
+
1067
+ class AddMemoryRecommendations(TypedDict):
1068
+ memories: list[AddMemorySuggestion]
1069
+
1070
+
1071
+ class BootstrapClassificationModelRequest(TypedDict):
1072
+ model_description: str
1073
+ label_names: list[str]
1074
+ initial_examples: NotRequired[list[LabeledExample]]
1075
+ num_examples_per_label: NotRequired[int]
1076
+
1077
+
1078
+ class BootstrapClassificationModelResult(TypedDict):
1079
+ model_description: str
1080
+ label_names: list[str]
1081
+ model_name: str
1082
+ generated_examples: NotRequired[list[LabeledExample]]
1083
+
1084
+
1085
+ class ClassificationMetrics(TypedDict):
1086
+ coverage: float
1087
+ f1_score: float
1088
+ accuracy: float
1089
+ loss: float | None
1090
+ anomaly_score_mean: NotRequired[float | None]
1091
+ anomaly_score_median: NotRequired[float | None]
1092
+ anomaly_score_variance: NotRequired[float | None]
1093
+ roc_auc: NotRequired[float | None]
1094
+ pr_auc: NotRequired[float | None]
1095
+ pr_curve: NotRequired[PRCurve | None]
1096
+ roc_curve: NotRequired[ROCCurve | None]
1097
+
1098
+
1099
+ class ClassificationModelMetadata(TypedDict):
1100
+ id: str
1101
+ org_id: str
1102
+ name: str
1103
+ description: str | None
1104
+ notes: str | None
1105
+ version: int
1106
+ memoryset_id: str
1107
+ memory_lookup_count: int
1108
+ storage_path: str
1109
+ memoryset_collection_name: str
1110
+ created_at: str
1111
+ updated_at: str
1112
+ locked: bool
1113
+ num_classes: int
1114
+ head_type: RACHeadType
1115
+ weigh_memories: bool | None
1116
+ min_memory_weight: float | None
1117
+
1118
+
1119
+ class ClassificationPredictionRequest(TypedDict):
1120
+ input_values: list[str] | list[bytes] | list[str | bytes]
1121
+ expected_labels: NotRequired[list[int] | None]
1122
+ filters: NotRequired[list[FilterItem]]
1123
+ tags: NotRequired[list[str]]
1124
+ memoryset_override_name_or_id: NotRequired[str | None]
1125
+ save_telemetry: NotRequired[bool]
1126
+ save_telemetry_synchronously: NotRequired[bool]
1127
+ prompt: NotRequired[str | None]
1128
+ use_lookup_cache: NotRequired[bool]
1129
+ consistency_level: NotRequired[Literal["Bounded", "Session", "Strong", "Eventual"] | None]
1130
+
1131
+
1132
+ class CloneMemorysetRequest(TypedDict):
1133
+ name: str
1134
+ description: NotRequired[str | None]
1135
+ notes: NotRequired[str | None]
1136
+ pretrained_embedding_model_name: NotRequired[PretrainedEmbeddingModelName | None]
1137
+ finetuned_embedding_model_name_or_id: NotRequired[str | None]
1138
+ max_seq_length_override: NotRequired[int | None]
1139
+ prompt: NotRequired[str]
1140
+
1141
+
1142
+ class ColumnInfo(TypedDict):
1143
+ name: str
1144
+ type: ColumnType
1145
+ enum_options: NotRequired[list[str] | None]
1146
+ int_values: NotRequired[list[int] | None]
1147
+ contains_nones: NotRequired[bool]
1148
+
1149
+
1150
+ class ConceptMetrics(TypedDict):
1151
+ id: int
1152
+ name: str
1153
+ description: str | None
1154
+ primary_label: int | None
1155
+ memory_count: int
1156
+ subconcepts: list[SubConceptMetrics]
1157
+
1158
+
1159
+ class CreateClassificationModelRequest(TypedDict):
1160
+ name: str
1161
+ description: NotRequired[str | None]
1162
+ notes: NotRequired[str | None]
1163
+ memoryset_name: NotRequired[str | None]
1164
+ memoryset_name_or_id: str
1165
+ memory_lookup_count: NotRequired[int | None]
1166
+ head_type: NotRequired[RACHeadType]
1167
+ weigh_memories: NotRequired[bool | None]
1168
+ min_memory_weight: NotRequired[float | None]
1169
+ num_classes: NotRequired[int | None]
1170
+
1171
+
1172
+ class CreateMemorysetRequest(TypedDict):
1173
+ name: str
1174
+ description: NotRequired[str | None]
1175
+ notes: NotRequired[str | None]
1176
+ datasource_name_or_id: str
1177
+ datasource_label_column: NotRequired[str | None]
1178
+ datasource_score_column: NotRequired[str | None]
1179
+ datasource_value_column: str
1180
+ datasource_source_id_column: NotRequired[str | None]
1181
+ remove_duplicates: NotRequired[bool]
1182
+ pretrained_embedding_model_name: NotRequired[PretrainedEmbeddingModelName | None]
1183
+ finetuned_embedding_model_name_or_id: NotRequired[str | None]
1184
+ max_seq_length_override: NotRequired[int | None]
1185
+ label_names: NotRequired[list[str] | None]
1186
+ index_type: NotRequired[Literal["FLAT", "IVF_FLAT", "IVF_SQ8", "IVF_PQ", "HNSW", "DISKANN"]]
1187
+ index_params: NotRequired[dict[str, int | float | str]]
1188
+ prompt: NotRequired[str]
1189
+ hidden: NotRequired[bool]
1190
+
1191
+
1192
+ class CreateRegressionModelRequest(TypedDict):
1193
+ name: str
1194
+ description: NotRequired[str | None]
1195
+ notes: NotRequired[str | None]
1196
+ memoryset_name_or_id: str
1197
+ memory_lookup_count: NotRequired[int | None]
1198
+ head_type: NotRequired[RARHeadType]
1199
+
1200
+
1201
+ class DatasourceEmbeddingEvaluationsRequest(TypedDict):
1202
+ value_column: str
1203
+ label_column: str
1204
+ source_id_column: str | None
1205
+ neighbor_count: NotRequired[int]
1206
+ label_names: NotRequired[list[str] | None]
1207
+ embedding_models: NotRequired[list[PretrainedEmbeddingModelName | str] | None]
1208
+
1209
+
1210
+ class DatasourceEmbeddingEvaluationsTaskPayload(TypedDict):
1211
+ value_column: str
1212
+ label_column: str
1213
+ source_id_column: str | None
1214
+ neighbor_count: NotRequired[int]
1215
+ label_names: NotRequired[list[str] | None]
1216
+ embedding_models: NotRequired[list[PretrainedEmbeddingModelName | str] | None]
1217
+ datasource_id: str
1218
+
1219
+
1220
+ class DatasourceMetadata(TypedDict):
1221
+ id: str
1222
+ org_id: str
1223
+ name: str
1224
+ description: str | None
1225
+ storage_path: str
1226
+ length: int
1227
+ columns: list[ColumnInfo]
1228
+ created_at: str
1229
+ updated_at: str
1230
+
1231
+
1232
+ class EmbeddingEvaluationResponse(TypedDict):
1233
+ task_id: str
1234
+ org_id: str
1235
+ status: TaskStatus
1236
+ result: ClassificationMetrics | RegressionMetrics | None
1237
+ created_at: str
1238
+ updated_at: str
1239
+
1240
+
1241
+ class EmbeddingEvaluationResponseUnionClassificationMetricsRegressionMetrics(TypedDict):
1242
+ task_id: str
1243
+ org_id: str
1244
+ status: TaskStatus
1245
+ result: ClassificationMetrics | RegressionMetrics | None
1246
+ created_at: str
1247
+ updated_at: str
1248
+
1249
+
1250
+ class EmbeddingModelResult(TypedDict):
1251
+ embedding_model_name: str
1252
+ embedding_model_path: str
1253
+ analysis_result: MemorysetLabelMetrics
1254
+ memoryset_name: NotRequired[str | None]
1255
+ is_finetuned: NotRequired[bool]
1256
+
1257
+
1258
+ class EvaluationResponse(TypedDict):
1259
+ task_id: str
1260
+ org_id: str
1261
+ status: TaskStatus
1262
+ result: ClassificationMetrics | RegressionMetrics | None
1263
+ created_at: str
1264
+ updated_at: str
1265
+
1266
+
1267
+ class EvaluationResponseClassificationMetrics(TypedDict):
1268
+ task_id: str
1269
+ org_id: str
1270
+ status: TaskStatus
1271
+ result: ClassificationMetrics | None
1272
+ created_at: str
1273
+ updated_at: str
1274
+
1275
+
1276
+ class EvaluationResponseRegressionMetrics(TypedDict):
1277
+ task_id: str
1278
+ org_id: str
1279
+ status: TaskStatus
1280
+ result: RegressionMetrics | None
1281
+ created_at: str
1282
+ updated_at: str
1283
+
1284
+
1285
+ class FinetuneEmbeddingModelRequest(TypedDict):
1286
+ name: str
1287
+ base_model: PretrainedEmbeddingModelName
1288
+ train_memoryset_name_or_id: NotRequired[str | None]
1289
+ train_datasource_name_or_id: NotRequired[str | None]
1290
+ eval_datasource_name_or_id: NotRequired[str | None]
1291
+ label_column: NotRequired[str]
1292
+ value_column: NotRequired[str]
1293
+ training_method: NotRequired[EmbeddingFinetuningMethod]
1294
+ training_args: NotRequired[dict[str, str | int | float | bool]]
1295
+
1296
+
1297
+ class FinetunedEmbeddingModelMetadata(TypedDict):
1298
+ embedding_dim: int
1299
+ max_seq_length: int
1300
+ uses_context: bool
1301
+ id: str
1302
+ org_id: str
1303
+ name: str
1304
+ storage_path: str
1305
+ created_at: str
1306
+ updated_at: str
1307
+ base_model: PretrainedEmbeddingModelName
1308
+ finetuning_task_id: str
1309
+ finetuning_status: TaskStatus
1310
+
1311
+
1312
+ class HTTPValidationError(TypedDict):
1313
+ detail: NotRequired[list[ValidationError]]
1314
+
1315
+
1316
+ class InvalidInputErrorResponse(TypedDict):
1317
+ status_code: NotRequired[int]
1318
+ validation_issues: list[FieldValidationError]
1319
+
1320
+
1321
+ class LabelPredictionMemoryLookup(TypedDict):
1322
+ value: str | bytes
1323
+ embedding: list[float]
1324
+ source_id: str | None
1325
+ metadata: dict[str, str | int | float | bool | None]
1326
+ memory_id: str
1327
+ memory_version: int
1328
+ created_at: str
1329
+ updated_at: str
1330
+ edited_at: str
1331
+ metrics: MemoryMetrics
1332
+ label: int | None
1333
+ label_name: str | None
1334
+ lookup_score: float
1335
+ prediction_id: str
1336
+ attention_weight: float
1337
+
1338
+
1339
+ class LabelPredictionWithMemoriesAndFeedback(TypedDict):
1340
+ prediction_id: str
1341
+ confidence: float
1342
+ anomaly_score: float | None
1343
+ label: int | None
1344
+ label_name: str | None
1345
+ logits: list[float]
1346
+ timestamp: str
1347
+ input_value: str | bytes
1348
+ input_embedding: list[float]
1349
+ expected_label: int | None
1350
+ expected_label_name: str | None
1351
+ memories: list[LabelPredictionMemoryLookup]
1352
+ org_id: str
1353
+ memoryset_id: str
1354
+ model_id: str
1355
+ updated_at: str
1356
+ tags: list[str]
1357
+ explanation: str | None
1358
+ memory_id: str | None
1359
+ feedbacks: list[PredictionFeedback]
1360
+
1361
+
1362
+ class LabeledMemory(TypedDict):
1363
+ value: str | bytes
1364
+ embedding: list[float]
1365
+ source_id: str | None
1366
+ metadata: dict[str, str | int | float | bool | None]
1367
+ memory_id: str
1368
+ memory_version: int
1369
+ created_at: str
1370
+ updated_at: str
1371
+ edited_at: str
1372
+ metrics: MemoryMetrics
1373
+ label: int | None
1374
+ label_name: str | None
1375
+
1376
+
1377
+ class LabeledMemoryLookup(TypedDict):
1378
+ value: str | bytes
1379
+ embedding: list[float]
1380
+ source_id: str | None
1381
+ metadata: dict[str, str | int | float | bool | None]
1382
+ memory_id: str
1383
+ memory_version: int
1384
+ created_at: str
1385
+ updated_at: str
1386
+ edited_at: str
1387
+ metrics: MemoryMetrics
1388
+ label: int | None
1389
+ label_name: str | None
1390
+ lookup_score: float
1391
+
1392
+
1393
+ class LabeledMemoryUpdate(TypedDict):
1394
+ memory_id: str
1395
+ value: NotRequired[str | bytes]
1396
+ metadata: NotRequired[dict[str, str | int | float | bool | None] | None]
1397
+ source_id: NotRequired[str | None]
1398
+ metrics: NotRequired[MemoryMetrics | None]
1399
+ label: NotRequired[int | None]
1400
+
1401
+
1402
+ class LabeledMemoryWithFeedbackMetrics(TypedDict):
1403
+ value: str | bytes
1404
+ embedding: list[float]
1405
+ source_id: str | None
1406
+ metadata: dict[str, str | int | float | bool | None]
1407
+ memory_id: str
1408
+ memory_version: int
1409
+ created_at: str
1410
+ updated_at: str
1411
+ edited_at: str
1412
+ metrics: MemoryMetrics
1413
+ label: int | None
1414
+ label_name: str | None
1415
+ feedback_metrics: dict[str, FeedbackMetrics]
1416
+ lookup_count: int
1417
+
1418
+
1419
+ class ListPredictionsRequest(TypedDict):
1420
+ model_id: NotRequired[str | None]
1421
+ tag: NotRequired[str | None]
1422
+ prediction_ids: NotRequired[list[str] | None]
1423
+ start_timestamp: NotRequired[str | None]
1424
+ end_timestamp: NotRequired[str | None]
1425
+ limit: NotRequired[int | None]
1426
+ offset: NotRequired[int | None]
1427
+ sort: NotRequired[PredictionSort]
1428
+ expected_label_match: NotRequired[bool | None]
1429
+
1430
+
1431
+ class MemorysetAnalysisConfigs(TypedDict):
1432
+ neighbor: NotRequired[MemorysetNeighborAnalysisConfig | None]
1433
+ label: NotRequired[MemorysetLabelAnalysisConfig | None]
1434
+ duplicate: NotRequired[MemorysetDuplicateAnalysisConfig | None]
1435
+ projection: NotRequired[MemorysetProjectionAnalysisConfig | None]
1436
+ cluster: NotRequired[MemorysetClusterAnalysisConfig | None]
1437
+ class_patterns: NotRequired[MemorysetClassPatternsAnalysisConfig | None]
1438
+ concepts: NotRequired[MemorysetConceptAnalysisConfig | None]
1439
+
1440
+
1441
+ class MemorysetAnalysisRequest(TypedDict):
1442
+ lookup_count: NotRequired[int]
1443
+ batch_size: NotRequired[int]
1444
+ clear_metrics: NotRequired[bool]
1445
+ configs: MemorysetAnalysisConfigs
1446
+
1447
+
1448
+ class MemorysetConceptMetrics(TypedDict):
1449
+ concepts: list[ConceptMetrics]
1450
+ num_outliers: int
1451
+ updated_at: str
1452
+
1453
+
1454
+ class MemorysetMetrics(TypedDict):
1455
+ neighbor: NotRequired[MemorysetNeighborMetrics | None]
1456
+ label: NotRequired[MemorysetLabelMetrics | None]
1457
+ duplicate: NotRequired[MemorysetDuplicateMetrics | None]
1458
+ projection: NotRequired[MemorysetProjectionMetrics | None]
1459
+ cluster: NotRequired[MemorysetClusterMetrics | None]
1460
+ class_patterns: NotRequired[MemorysetClassPatternsMetrics | None]
1461
+ concepts: NotRequired[MemorysetConceptMetrics | None]
1462
+
1463
+
1464
+ class PaginatedUnionLabeledMemoryWithFeedbackMetricsScoredMemoryWithFeedbackMetrics(TypedDict):
1465
+ items: list[LabeledMemoryWithFeedbackMetrics | ScoredMemoryWithFeedbackMetrics]
1466
+ total: int
1467
+ offset: int
1468
+ limit: int
1469
+
1470
+
1471
+ class PretrainedEmbeddingModelMetadata(TypedDict):
1472
+ embedding_dim: int
1473
+ max_seq_length: int
1474
+ uses_context: bool
1475
+ name: PretrainedEmbeddingModelName
1476
+ experimental: NotRequired[bool]
1477
+ supports_instructions: bool
1478
+ num_params: int
1479
+
1480
+
1481
+ class Task(TypedDict):
1482
+ status: TaskStatus
1483
+ steps_total: int | None
1484
+ steps_completed: int | None
1485
+ exception: str | None
1486
+ updated_at: str
1487
+ created_at: str
1488
+ id: str
1489
+ org_id: str
1490
+ type: str
1491
+ payload: BaseModel
1492
+ result: BaseModel | None
1493
+ depends_on: NotRequired[list[str]]
1494
+
1495
+
1496
+ class TelemetryMemoriesRequest(TypedDict):
1497
+ memoryset_id: str
1498
+ offset: NotRequired[int]
1499
+ limit: NotRequired[int]
1500
+ filters: NotRequired[list[FilterItem | TelemetryFilterItem]]
1501
+ sort: NotRequired[list[TelemetrySortOptions] | None]
1502
+
1503
+
1504
+ PatchGpuMemorysetByNameOrIdMemoryRequest = LabeledMemoryUpdate | ScoredMemoryUpdate
1505
+
1506
+
1507
+ PatchGpuMemorysetByNameOrIdMemoriesRequest = list[LabeledMemoryUpdate] | list[ScoredMemoryUpdate]
1508
+
1509
+
1510
+ class CascadingEditSuggestion(TypedDict):
1511
+ neighbor: LabeledMemoryLookup
1512
+ suggested_label: int
1513
+ lookup_score: float
1514
+
1515
+
1516
+ class EmbeddingEvaluationResult(TypedDict):
1517
+ evaluation_results: list[EmbeddingModelResult]
1518
+
1519
+
1520
+ class MemorysetAnalysisResponse(TypedDict):
1521
+ task_id: str
1522
+ org_id: str
1523
+ memoryset_id: str
1524
+ status: TaskStatus
1525
+ lookup_count: int
1526
+ batch_size: int
1527
+ clear_metrics: bool
1528
+ configs: MemorysetAnalysisConfigs
1529
+ results: MemorysetMetrics | None
1530
+ created_at: str
1531
+ updated_at: str
1532
+
1533
+
1534
+ class MemorysetMetadata(TypedDict):
1535
+ id: str
1536
+ org_id: str
1537
+ collection_name: str
1538
+ name: str
1539
+ description: str | None
1540
+ notes: str | None
1541
+ length: int
1542
+ pretrained_embedding_model_name: PretrainedEmbeddingModelName | None
1543
+ finetuned_embedding_model_id: str | None
1544
+ created_at: str
1545
+ updated_at: str
1546
+ memories_updated_at: str
1547
+ insertion_task_id: str
1548
+ insertion_status: TaskStatus
1549
+ metrics: MemorysetMetrics
1550
+ memory_type: MemoryType
1551
+ label_names: list[str] | None
1552
+ index_type: Literal["FLAT", "IVF_FLAT", "IVF_SQ8", "IVF_PQ", "HNSW", "DISKANN"]
1553
+ index_params: dict[str, Any]
1554
+ database_uri: str | None
1555
+ document_prompt_override: str | None
1556
+ query_prompt_override: str | None
1557
+ hidden: bool
1558
+
1559
+
1560
+ class PaginatedTask(TypedDict):
1561
+ items: list[Task]
1562
+ total: int
1563
+ offset: int
1564
+ limit: int
1565
+
1566
+
1567
+ class BootstrapClassificationModelMeta(TypedDict):
1568
+ datasource_meta: DatasourceMetadata
1569
+ memoryset_meta: MemorysetMetadata
1570
+ model_meta: ClassificationModelMetadata
1571
+ agent_output: BootstrapClassificationModelResult
1572
+
1573
+
1574
+ class BootstrapClassificationModelResponse(TypedDict):
1575
+ task_id: str
1576
+ org_id: str
1577
+ status: TaskStatus
1578
+ result: BootstrapClassificationModelMeta | None
1579
+ input: BootstrapClassificationModelRequest | None
1580
+
1581
+
1582
+ class DatasourceEmbeddingEvaluationsResponse(TypedDict):
1583
+ task_id: str
1584
+ org_id: str
1585
+ datasource_id: str
1586
+ status: TaskStatus
1587
+ result: EmbeddingEvaluationResult | None
1588
+ payload: DatasourceEmbeddingEvaluationsTaskPayload
1589
+ created_at: str
1590
+ updated_at: str
1591
+
1592
+
1593
+ class OrcaClient(Client):
1594
+ @staticmethod
1595
+ def _parse_params(
1596
+ params: Mapping[str, Any],
1597
+ path: str,
1598
+ ) -> tuple[dict[str, Any], dict[str, Any]]:
1599
+ placeholders = {name for _, name, _, _ in Formatter().parse(path) if name}
1600
+ path_params = {k: v for k, v in params.items() if k in placeholders}
1601
+ query_params = {k: v for k, v in params.items() if k not in placeholders and v is not None}
1602
+ if placeholders - path_params.keys():
1603
+ raise ValueError(f"Missing path params: {', '.join(placeholders - path_params.keys())}")
1604
+ return path_params, query_params
1605
+
1606
+ @overload
1607
+ def DELETE(
1608
+ self,
1609
+ path: Literal["/cleanup"],
1610
+ *,
1611
+ params: None = None,
1612
+ parse_as: Literal["json"] = "json",
1613
+ headers: HeaderTypes | None = None,
1614
+ cookies: CookieTypes | None = None,
1615
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1616
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1617
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1618
+ extensions: RequestExtensions | None = None,
1619
+ ) -> CleanupResponse:
1620
+ """Cleanup orphaned milvus collections and blobs"""
1621
+ pass
1622
+
1623
+ @overload
1624
+ def DELETE(
1625
+ self,
1626
+ path: Literal["/auth/api_key/{name_or_id}"],
1627
+ *,
1628
+ params: DeleteAuthApiKeyByNameOrIdParams,
1629
+ parse_as: Literal["json"] = "json",
1630
+ headers: HeaderTypes | None = None,
1631
+ cookies: CookieTypes | None = None,
1632
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1633
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1634
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1635
+ extensions: RequestExtensions | None = None,
1636
+ ) -> None:
1637
+ """Delete an API key by name or ID."""
1638
+ pass
1639
+
1640
+ @overload
1641
+ def DELETE(
1642
+ self,
1643
+ path: Literal["/auth/org"],
1644
+ *,
1645
+ params: None = None,
1646
+ parse_as: Literal["json"] = "json",
1647
+ headers: HeaderTypes | None = None,
1648
+ cookies: CookieTypes | None = None,
1649
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1650
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1651
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1652
+ extensions: RequestExtensions | None = None,
1653
+ ) -> None:
1654
+ """Deletes the org and all associated resources"""
1655
+ pass
1656
+
1657
+ @overload
1658
+ def DELETE(
1659
+ self,
1660
+ path: Literal["/memoryset/{name_or_id}"],
1661
+ *,
1662
+ params: DeleteMemorysetByNameOrIdParams,
1663
+ parse_as: Literal["json"] = "json",
1664
+ headers: HeaderTypes | None = None,
1665
+ cookies: CookieTypes | None = None,
1666
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1667
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1668
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1669
+ extensions: RequestExtensions | None = None,
1670
+ ) -> None:
1671
+ pass
1672
+
1673
+ @overload
1674
+ def DELETE(
1675
+ self,
1676
+ path: Literal["/memoryset/{name_or_id}/memory/{memory_id}"],
1677
+ *,
1678
+ params: DeleteMemorysetByNameOrIdMemoryByMemoryIdParams,
1679
+ parse_as: Literal["json"] = "json",
1680
+ headers: HeaderTypes | None = None,
1681
+ cookies: CookieTypes | None = None,
1682
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1683
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1684
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1685
+ extensions: RequestExtensions | None = None,
1686
+ ) -> None:
1687
+ pass
1688
+
1689
+ @overload
1690
+ def DELETE(
1691
+ self,
1692
+ path: Literal["/finetuned_embedding_model/{name_or_id}"],
1693
+ *,
1694
+ params: DeleteFinetunedEmbeddingModelByNameOrIdParams,
1695
+ parse_as: Literal["json"] = "json",
1696
+ headers: HeaderTypes | None = None,
1697
+ cookies: CookieTypes | None = None,
1698
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1699
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1700
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1701
+ extensions: RequestExtensions | None = None,
1702
+ ) -> None:
1703
+ """Delete a finetuned embedding model by name or ID."""
1704
+ pass
1705
+
1706
+ @overload
1707
+ def DELETE(
1708
+ self,
1709
+ path: Literal["/datasource/{name_or_id}"],
1710
+ *,
1711
+ params: DeleteDatasourceByNameOrIdParams,
1712
+ parse_as: Literal["json"] = "json",
1713
+ headers: HeaderTypes | None = None,
1714
+ cookies: CookieTypes | None = None,
1715
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1716
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1717
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1718
+ extensions: RequestExtensions | None = None,
1719
+ ) -> None:
1720
+ """Delete a datasource by name or ID."""
1721
+ pass
1722
+
1723
+ @overload
1724
+ def DELETE(
1725
+ self,
1726
+ path: Literal["/classification_model/{name_or_id}"],
1727
+ *,
1728
+ params: DeleteClassificationModelByNameOrIdParams,
1729
+ parse_as: Literal["json"] = "json",
1730
+ headers: HeaderTypes | None = None,
1731
+ cookies: CookieTypes | None = None,
1732
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1733
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1734
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1735
+ extensions: RequestExtensions | None = None,
1736
+ ) -> None:
1737
+ pass
1738
+
1739
+ @overload
1740
+ def DELETE(
1741
+ self,
1742
+ path: Literal["/classification_model/{model_name_or_id}/evaluation/{task_id}"],
1743
+ *,
1744
+ params: DeleteClassificationModelByModelNameOrIdEvaluationByTaskIdParams,
1745
+ parse_as: Literal["json"] = "json",
1746
+ headers: HeaderTypes | None = None,
1747
+ cookies: CookieTypes | None = None,
1748
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1749
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1750
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1751
+ extensions: RequestExtensions | None = None,
1752
+ ) -> None:
1753
+ pass
1754
+
1755
+ @overload
1756
+ def DELETE(
1757
+ self,
1758
+ path: Literal["/regression_model/{name_or_id}"],
1759
+ *,
1760
+ params: DeleteRegressionModelByNameOrIdParams,
1761
+ parse_as: Literal["json"] = "json",
1762
+ headers: HeaderTypes | None = None,
1763
+ cookies: CookieTypes | None = None,
1764
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1765
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1766
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1767
+ extensions: RequestExtensions | None = None,
1768
+ ) -> None:
1769
+ pass
1770
+
1771
+ @overload
1772
+ def DELETE(
1773
+ self,
1774
+ path: Literal["/regression_model/{model_name_or_id}/evaluation/{task_id}"],
1775
+ *,
1776
+ params: DeleteRegressionModelByModelNameOrIdEvaluationByTaskIdParams,
1777
+ parse_as: Literal["json"] = "json",
1778
+ headers: HeaderTypes | None = None,
1779
+ cookies: CookieTypes | None = None,
1780
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1781
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1782
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1783
+ extensions: RequestExtensions | None = None,
1784
+ ) -> None:
1785
+ pass
1786
+
1787
+ @overload
1788
+ def DELETE(
1789
+ self,
1790
+ path: Literal["/task/{task_id}/abort"],
1791
+ *,
1792
+ params: DeleteTaskByTaskIdAbortParams,
1793
+ parse_as: Literal["json"] = "json",
1794
+ headers: HeaderTypes | None = None,
1795
+ cookies: CookieTypes | None = None,
1796
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1797
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1798
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1799
+ extensions: RequestExtensions | None = None,
1800
+ ) -> None:
1801
+ pass
1802
+
1803
+ @overload
1804
+ def DELETE(
1805
+ self,
1806
+ path: Literal["/telemetry/feedback_category/{name_or_id}"],
1807
+ *,
1808
+ params: DeleteTelemetryFeedbackCategoryByNameOrIdParams,
1809
+ parse_as: Literal["json"] = "json",
1810
+ headers: HeaderTypes | None = None,
1811
+ cookies: CookieTypes | None = None,
1812
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1813
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1814
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1815
+ extensions: RequestExtensions | None = None,
1816
+ ) -> None:
1817
+ """Delete a feedback category and all associated feedback records."""
1818
+ pass
1819
+
1820
+ def DELETE(
1821
+ self,
1822
+ path: str,
1823
+ *,
1824
+ params: Mapping[str, Any] | None = None,
1825
+ parse_as: Literal["json", "text"] | None = "json",
1826
+ headers: HeaderTypes | None = None,
1827
+ cookies: CookieTypes | None = None,
1828
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1829
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1830
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1831
+ extensions: RequestExtensions | None = None,
1832
+ ) -> Any:
1833
+ path_params, query_params = self._parse_params(params or {}, path)
1834
+ res = self.delete(
1835
+ path.format(**path_params),
1836
+ params=query_params,
1837
+ headers=headers,
1838
+ cookies=cookies,
1839
+ auth=auth,
1840
+ follow_redirects=follow_redirects,
1841
+ timeout=timeout,
1842
+ extensions=extensions,
1843
+ ).raise_for_status()
1844
+ return (
1845
+ None
1846
+ if res.status_code == 204
1847
+ else res.json() if parse_as == "json" else res.text if parse_as == "text" else res.content
1848
+ )
1849
+
1850
+ @overload
1851
+ def GET(
1852
+ self,
1853
+ path: Literal["/check/alive"],
1854
+ *,
1855
+ params: None = None,
1856
+ parse_as: Literal["json"] = "json",
1857
+ headers: HeaderTypes | None = None,
1858
+ cookies: CookieTypes | None = None,
1859
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1860
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1861
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1862
+ extensions: RequestExtensions | None = None,
1863
+ ) -> AliveResponse:
1864
+ pass
1865
+
1866
+ @overload
1867
+ def GET(
1868
+ self,
1869
+ path: Literal["/check/ready"],
1870
+ *,
1871
+ params: None = None,
1872
+ parse_as: Literal["json"] = "json",
1873
+ headers: HeaderTypes | None = None,
1874
+ cookies: CookieTypes | None = None,
1875
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1876
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1877
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1878
+ extensions: RequestExtensions | None = None,
1879
+ ) -> ReadyResponse:
1880
+ pass
1881
+
1882
+ @overload
1883
+ def GET(
1884
+ self,
1885
+ path: Literal["/gpu/check/healthy"],
1886
+ *,
1887
+ params: None = None,
1888
+ parse_as: Literal["json"] = "json",
1889
+ headers: HeaderTypes | None = None,
1890
+ cookies: CookieTypes | None = None,
1891
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1892
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1893
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1894
+ extensions: RequestExtensions | None = None,
1895
+ ) -> HealthyResponse:
1896
+ pass
1897
+
1898
+ @overload
1899
+ def GET(
1900
+ self,
1901
+ path: Literal["/check/healthy"],
1902
+ *,
1903
+ params: None = None,
1904
+ parse_as: Literal["json"] = "json",
1905
+ headers: HeaderTypes | None = None,
1906
+ cookies: CookieTypes | None = None,
1907
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1908
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1909
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1910
+ extensions: RequestExtensions | None = None,
1911
+ ) -> HealthyResponse:
1912
+ pass
1913
+
1914
+ @overload
1915
+ def GET(
1916
+ self,
1917
+ path: Literal["/gpu/config"],
1918
+ *,
1919
+ params: None = None,
1920
+ parse_as: Literal["json"] = "json",
1921
+ headers: HeaderTypes | None = None,
1922
+ cookies: CookieTypes | None = None,
1923
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1924
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1925
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1926
+ extensions: RequestExtensions | None = None,
1927
+ ) -> dict[str, str | float | int | bool | None]:
1928
+ pass
1929
+
1930
+ @overload
1931
+ def GET(
1932
+ self,
1933
+ path: Literal["/config"],
1934
+ *,
1935
+ params: None = None,
1936
+ parse_as: Literal["json"] = "json",
1937
+ headers: HeaderTypes | None = None,
1938
+ cookies: CookieTypes | None = None,
1939
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1940
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1941
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1942
+ extensions: RequestExtensions | None = None,
1943
+ ) -> dict[str, str | float | int | bool | None]:
1944
+ pass
1945
+
1946
+ @overload
1947
+ def GET(
1948
+ self,
1949
+ path: Literal["/gpu/"],
1950
+ *,
1951
+ params: None = None,
1952
+ parse_as: Literal["text"],
1953
+ headers: HeaderTypes | None = None,
1954
+ cookies: CookieTypes | None = None,
1955
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1956
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1957
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1958
+ extensions: RequestExtensions | None = None,
1959
+ ) -> str:
1960
+ pass
1961
+
1962
+ @overload
1963
+ def GET(
1964
+ self,
1965
+ path: Literal["/"],
1966
+ *,
1967
+ params: None = None,
1968
+ parse_as: Literal["text"],
1969
+ headers: HeaderTypes | None = None,
1970
+ cookies: CookieTypes | None = None,
1971
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1972
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1973
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1974
+ extensions: RequestExtensions | None = None,
1975
+ ) -> str:
1976
+ pass
1977
+
1978
+ @overload
1979
+ def GET(
1980
+ self,
1981
+ path: Literal["/auth/root"],
1982
+ *,
1983
+ params: None = None,
1984
+ parse_as: Literal["json"] = "json",
1985
+ headers: HeaderTypes | None = None,
1986
+ cookies: CookieTypes | None = None,
1987
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1988
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
1989
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
1990
+ extensions: RequestExtensions | None = None,
1991
+ ) -> bool:
1992
+ """Return true only when called with a valid root API key; otherwise 401 Unauthenticated."""
1993
+ pass
1994
+
1995
+ @overload
1996
+ def GET(
1997
+ self,
1998
+ path: Literal["/auth/api_key"],
1999
+ *,
2000
+ params: None = None,
2001
+ parse_as: Literal["json"] = "json",
2002
+ headers: HeaderTypes | None = None,
2003
+ cookies: CookieTypes | None = None,
2004
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2005
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2006
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2007
+ extensions: RequestExtensions | None = None,
2008
+ ) -> list[ApiKeyMetadata]:
2009
+ """List all API keys for the organization."""
2010
+ pass
2011
+
2012
+ @overload
2013
+ def GET(
2014
+ self,
2015
+ path: Literal["/auth"],
2016
+ *,
2017
+ params: None = None,
2018
+ parse_as: Literal["json"] = "json",
2019
+ headers: HeaderTypes | None = None,
2020
+ cookies: CookieTypes | None = None,
2021
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2022
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2023
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2024
+ extensions: RequestExtensions | None = None,
2025
+ ) -> bool:
2026
+ """Returns true if the api key header is valid for the org (will be false for admin api key)"""
2027
+ pass
2028
+
2029
+ @overload
2030
+ def GET(
2031
+ self,
2032
+ path: Literal["/auth/org/plan"],
2033
+ *,
2034
+ params: None = None,
2035
+ parse_as: Literal["json"] = "json",
2036
+ headers: HeaderTypes | None = None,
2037
+ cookies: CookieTypes | None = None,
2038
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2039
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2040
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2041
+ extensions: RequestExtensions | None = None,
2042
+ ) -> OrgPlan:
2043
+ """Get the organization plan."""
2044
+ pass
2045
+
2046
+ @overload
2047
+ def GET(
2048
+ self,
2049
+ path: Literal["/memoryset"],
2050
+ *,
2051
+ params: GetMemorysetParams,
2052
+ parse_as: Literal["json"] = "json",
2053
+ headers: HeaderTypes | None = None,
2054
+ cookies: CookieTypes | None = None,
2055
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2056
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2057
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2058
+ extensions: RequestExtensions | None = None,
2059
+ ) -> list[MemorysetMetadata]:
2060
+ pass
2061
+
2062
+ @overload
2063
+ def GET(
2064
+ self,
2065
+ path: Literal["/memoryset/{name_or_id}"],
2066
+ *,
2067
+ params: GetMemorysetByNameOrIdParams,
2068
+ parse_as: Literal["json"] = "json",
2069
+ headers: HeaderTypes | None = None,
2070
+ cookies: CookieTypes | None = None,
2071
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2072
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2073
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2074
+ extensions: RequestExtensions | None = None,
2075
+ ) -> MemorysetMetadata:
2076
+ pass
2077
+
2078
+ @overload
2079
+ def GET(
2080
+ self,
2081
+ path: Literal["/memoryset/{name_or_id}/memory/{memory_id}"],
2082
+ *,
2083
+ params: GetMemorysetByNameOrIdMemoryByMemoryIdParams,
2084
+ parse_as: Literal["json"] = "json",
2085
+ headers: HeaderTypes | None = None,
2086
+ cookies: CookieTypes | None = None,
2087
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2088
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2089
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2090
+ extensions: RequestExtensions | None = None,
2091
+ ) -> LabeledMemory | ScoredMemory:
2092
+ pass
2093
+
2094
+ @overload
2095
+ def GET(
2096
+ self,
2097
+ path: Literal["/memoryset/{name_or_id}/potential_duplicate_groups"],
2098
+ *,
2099
+ params: GetMemorysetByNameOrIdPotentialDuplicateGroupsParams,
2100
+ parse_as: Literal["json"] = "json",
2101
+ headers: HeaderTypes | None = None,
2102
+ cookies: CookieTypes | None = None,
2103
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2104
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2105
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2106
+ extensions: RequestExtensions | None = None,
2107
+ ) -> list[list[LabeledMemory]] | list[list[ScoredMemory]]:
2108
+ pass
2109
+
2110
+ @overload
2111
+ def GET(
2112
+ self,
2113
+ path: Literal["/memoryset/{name_or_id}/analysis"],
2114
+ *,
2115
+ params: GetMemorysetByNameOrIdAnalysisParams,
2116
+ parse_as: Literal["json"] = "json",
2117
+ headers: HeaderTypes | None = None,
2118
+ cookies: CookieTypes | None = None,
2119
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2120
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2121
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2122
+ extensions: RequestExtensions | None = None,
2123
+ ) -> list[MemorysetAnalysisResponse]:
2124
+ pass
2125
+
2126
+ @overload
2127
+ def GET(
2128
+ self,
2129
+ path: Literal["/memoryset/{name_or_id}/analysis/{analysis_task_id}"],
2130
+ *,
2131
+ params: GetMemorysetByNameOrIdAnalysisByAnalysisTaskIdParams,
2132
+ parse_as: Literal["json"] = "json",
2133
+ headers: HeaderTypes | None = None,
2134
+ cookies: CookieTypes | None = None,
2135
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2136
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2137
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2138
+ extensions: RequestExtensions | None = None,
2139
+ ) -> MemorysetAnalysisResponse:
2140
+ pass
2141
+
2142
+ @overload
2143
+ def GET(
2144
+ self,
2145
+ path: Literal["/finetuned_embedding_model"],
2146
+ *,
2147
+ params: None = None,
2148
+ parse_as: Literal["json"] = "json",
2149
+ headers: HeaderTypes | None = None,
2150
+ cookies: CookieTypes | None = None,
2151
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2152
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2153
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2154
+ extensions: RequestExtensions | None = None,
2155
+ ) -> list[FinetunedEmbeddingModelMetadata]:
2156
+ """List all finetuned embedding models for the organization."""
2157
+ pass
2158
+
2159
+ @overload
2160
+ def GET(
2161
+ self,
2162
+ path: Literal["/finetuned_embedding_model/{name_or_id}"],
2163
+ *,
2164
+ params: GetFinetunedEmbeddingModelByNameOrIdParams,
2165
+ parse_as: Literal["json"] = "json",
2166
+ headers: HeaderTypes | None = None,
2167
+ cookies: CookieTypes | None = None,
2168
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2169
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2170
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2171
+ extensions: RequestExtensions | None = None,
2172
+ ) -> FinetunedEmbeddingModelMetadata:
2173
+ """Get a finetuned embedding model by name or ID."""
2174
+ pass
2175
+
2176
+ @overload
2177
+ def GET(
2178
+ self,
2179
+ path: Literal["/finetuned_embedding_model/{name_or_id}/evaluation/{task_id}"],
2180
+ *,
2181
+ params: GetFinetunedEmbeddingModelByNameOrIdEvaluationByTaskIdParams,
2182
+ parse_as: Literal["json"] = "json",
2183
+ headers: HeaderTypes | None = None,
2184
+ cookies: CookieTypes | None = None,
2185
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2186
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2187
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2188
+ extensions: RequestExtensions | None = None,
2189
+ ) -> EmbeddingEvaluationResponseUnionClassificationMetricsRegressionMetrics:
2190
+ """Get evaluation results for a finetuned embedding model by task ID."""
2191
+ pass
2192
+
2193
+ @overload
2194
+ def GET(
2195
+ self,
2196
+ path: Literal["/finetuned_embedding_model/{name_or_id}/evaluations"],
2197
+ *,
2198
+ params: GetFinetunedEmbeddingModelByNameOrIdEvaluationsParams,
2199
+ parse_as: Literal["json"] = "json",
2200
+ headers: HeaderTypes | None = None,
2201
+ cookies: CookieTypes | None = None,
2202
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2203
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2204
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2205
+ extensions: RequestExtensions | None = None,
2206
+ ) -> list[EmbeddingEvaluationResponseUnionClassificationMetricsRegressionMetrics]:
2207
+ """List all evaluation results for a finetuned embedding model."""
2208
+ pass
2209
+
2210
+ @overload
2211
+ def GET(
2212
+ self,
2213
+ path: Literal["/pretrained_embedding_model"],
2214
+ *,
2215
+ params: None = None,
2216
+ parse_as: Literal["json"] = "json",
2217
+ headers: HeaderTypes | None = None,
2218
+ cookies: CookieTypes | None = None,
2219
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2220
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2221
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2222
+ extensions: RequestExtensions | None = None,
2223
+ ) -> list[PretrainedEmbeddingModelMetadata]:
2224
+ """List all available pretrained embedding models."""
2225
+ pass
2226
+
2227
+ @overload
2228
+ def GET(
2229
+ self,
2230
+ path: Literal["/pretrained_embedding_model/{model_name}"],
2231
+ *,
2232
+ params: GetPretrainedEmbeddingModelByModelNameParams,
2233
+ parse_as: Literal["json"] = "json",
2234
+ headers: HeaderTypes | None = None,
2235
+ cookies: CookieTypes | None = None,
2236
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2237
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2238
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2239
+ extensions: RequestExtensions | None = None,
2240
+ ) -> PretrainedEmbeddingModelMetadata:
2241
+ """Get metadata for a specific pretrained embedding model."""
2242
+ pass
2243
+
2244
+ @overload
2245
+ def GET(
2246
+ self,
2247
+ path: Literal["/pretrained_embedding_model/{model_name}/evaluation/{task_id}"],
2248
+ *,
2249
+ params: GetPretrainedEmbeddingModelByModelNameEvaluationByTaskIdParams,
2250
+ parse_as: Literal["json"] = "json",
2251
+ headers: HeaderTypes | None = None,
2252
+ cookies: CookieTypes | None = None,
2253
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2254
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2255
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2256
+ extensions: RequestExtensions | None = None,
2257
+ ) -> EmbeddingEvaluationResponseUnionClassificationMetricsRegressionMetrics:
2258
+ """Get evaluation results for a pretrained embedding model by task ID."""
2259
+ pass
2260
+
2261
+ @overload
2262
+ def GET(
2263
+ self,
2264
+ path: Literal["/pretrained_embedding_model/{model_name}/evaluations"],
2265
+ *,
2266
+ params: GetPretrainedEmbeddingModelByModelNameEvaluationsParams,
2267
+ parse_as: Literal["json"] = "json",
2268
+ headers: HeaderTypes | None = None,
2269
+ cookies: CookieTypes | None = None,
2270
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2271
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2272
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2273
+ extensions: RequestExtensions | None = None,
2274
+ ) -> list[EmbeddingEvaluationResponseUnionClassificationMetricsRegressionMetrics]:
2275
+ """List all evaluation results for a pretrained embedding model."""
2276
+ pass
2277
+
2278
+ @overload
2279
+ def GET(
2280
+ self,
2281
+ path: Literal["/datasource"],
2282
+ *,
2283
+ params: None = None,
2284
+ parse_as: Literal["json"] = "json",
2285
+ headers: HeaderTypes | None = None,
2286
+ cookies: CookieTypes | None = None,
2287
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2288
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2289
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2290
+ extensions: RequestExtensions | None = None,
2291
+ ) -> list[DatasourceMetadata]:
2292
+ """List all datasources for the organization."""
2293
+ pass
2294
+
2295
+ @overload
2296
+ def GET(
2297
+ self,
2298
+ path: Literal["/datasource/{name_or_id}"],
2299
+ *,
2300
+ params: GetDatasourceByNameOrIdParams,
2301
+ parse_as: Literal["json"] = "json",
2302
+ headers: HeaderTypes | None = None,
2303
+ cookies: CookieTypes | None = None,
2304
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2305
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2306
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2307
+ extensions: RequestExtensions | None = None,
2308
+ ) -> DatasourceMetadata:
2309
+ """Get a datasource by name or ID."""
2310
+ pass
2311
+
2312
+ @overload
2313
+ def GET(
2314
+ self,
2315
+ path: Literal["/datasource/{name_or_id}/embedding_evaluation"],
2316
+ *,
2317
+ params: GetDatasourceByNameOrIdEmbeddingEvaluationParams,
2318
+ parse_as: Literal["json"] = "json",
2319
+ headers: HeaderTypes | None = None,
2320
+ cookies: CookieTypes | None = None,
2321
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2322
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2323
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2324
+ extensions: RequestExtensions | None = None,
2325
+ ) -> list[DatasourceEmbeddingEvaluationsResponse]:
2326
+ """List embedding evaluation tasks for a datasource."""
2327
+ pass
2328
+
2329
+ @overload
2330
+ def GET(
2331
+ self,
2332
+ path: Literal["/datasource/{name_or_id}/embedding_evaluation/{task_id}"],
2333
+ *,
2334
+ params: GetDatasourceByNameOrIdEmbeddingEvaluationByTaskIdParams,
2335
+ parse_as: Literal["json"] = "json",
2336
+ headers: HeaderTypes | None = None,
2337
+ cookies: CookieTypes | None = None,
2338
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2339
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2340
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2341
+ extensions: RequestExtensions | None = None,
2342
+ ) -> DatasourceEmbeddingEvaluationsResponse:
2343
+ """Get an embedding evaluation task by ID."""
2344
+ pass
2345
+
2346
+ @overload
2347
+ def GET(
2348
+ self,
2349
+ path: Literal["/datasource/{name_or_id}/download"],
2350
+ *,
2351
+ params: GetDatasourceByNameOrIdDownloadParams,
2352
+ parse_as: Literal["json"] = "json",
2353
+ headers: HeaderTypes | None = None,
2354
+ cookies: CookieTypes | None = None,
2355
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2356
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2357
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2358
+ extensions: RequestExtensions | None = None,
2359
+ ) -> list[dict[str, Any]]:
2360
+ """Download datasource in the specified format."""
2361
+ pass
2362
+
2363
+ @overload
2364
+ def GET(
2365
+ self,
2366
+ path: Literal["/datasource/{name_or_id}/download"],
2367
+ *,
2368
+ params: GetDatasourceByNameOrIdDownloadParams,
2369
+ parse_as: Literal["text"],
2370
+ headers: HeaderTypes | None = None,
2371
+ cookies: CookieTypes | None = None,
2372
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2373
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2374
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2375
+ extensions: RequestExtensions | None = None,
2376
+ ) -> str:
2377
+ """Download datasource in the specified format."""
2378
+ pass
2379
+
2380
+ @overload
2381
+ def GET(
2382
+ self,
2383
+ path: Literal["/datasource/{name_or_id}/download"],
2384
+ *,
2385
+ params: GetDatasourceByNameOrIdDownloadParams,
2386
+ parse_as: None,
2387
+ headers: HeaderTypes | None = None,
2388
+ cookies: CookieTypes | None = None,
2389
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2390
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2391
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2392
+ extensions: RequestExtensions | None = None,
2393
+ ) -> bytes:
2394
+ """Download datasource in the specified format."""
2395
+ pass
2396
+
2397
+ @overload
2398
+ def GET(
2399
+ self,
2400
+ path: Literal["/predictive_model"],
2401
+ *,
2402
+ params: None = None,
2403
+ parse_as: Literal["json"] = "json",
2404
+ headers: HeaderTypes | None = None,
2405
+ cookies: CookieTypes | None = None,
2406
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2407
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2408
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2409
+ extensions: RequestExtensions | None = None,
2410
+ ) -> list[ClassificationModelMetadata | RegressionModelMetadata]:
2411
+ pass
2412
+
2413
+ @overload
2414
+ def GET(
2415
+ self,
2416
+ path: Literal["/classification_model"],
2417
+ *,
2418
+ params: None = None,
2419
+ parse_as: Literal["json"] = "json",
2420
+ headers: HeaderTypes | None = None,
2421
+ cookies: CookieTypes | None = None,
2422
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2423
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2424
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2425
+ extensions: RequestExtensions | None = None,
2426
+ ) -> list[ClassificationModelMetadata]:
2427
+ pass
2428
+
2429
+ @overload
2430
+ def GET(
2431
+ self,
2432
+ path: Literal["/classification_model/{name_or_id}"],
2433
+ *,
2434
+ params: GetClassificationModelByNameOrIdParams,
2435
+ parse_as: Literal["json"] = "json",
2436
+ headers: HeaderTypes | None = None,
2437
+ cookies: CookieTypes | None = None,
2438
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2439
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2440
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2441
+ extensions: RequestExtensions | None = None,
2442
+ ) -> ClassificationModelMetadata:
2443
+ pass
2444
+
2445
+ @overload
2446
+ def GET(
2447
+ self,
2448
+ path: Literal["/classification_model/{model_name_or_id}/evaluation"],
2449
+ *,
2450
+ params: GetClassificationModelByModelNameOrIdEvaluationParams,
2451
+ parse_as: Literal["json"] = "json",
2452
+ headers: HeaderTypes | None = None,
2453
+ cookies: CookieTypes | None = None,
2454
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2455
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2456
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2457
+ extensions: RequestExtensions | None = None,
2458
+ ) -> list[EvaluationResponseClassificationMetrics]:
2459
+ pass
2460
+
2461
+ @overload
2462
+ def GET(
2463
+ self,
2464
+ path: Literal["/classification_model/{model_name_or_id}/evaluation/{task_id}"],
2465
+ *,
2466
+ params: GetClassificationModelByModelNameOrIdEvaluationByTaskIdParams,
2467
+ parse_as: Literal["json"] = "json",
2468
+ headers: HeaderTypes | None = None,
2469
+ cookies: CookieTypes | None = None,
2470
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2471
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2472
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2473
+ extensions: RequestExtensions | None = None,
2474
+ ) -> EvaluationResponseClassificationMetrics:
2475
+ pass
2476
+
2477
+ @overload
2478
+ def GET(
2479
+ self,
2480
+ path: Literal["/regression_model"],
2481
+ *,
2482
+ params: None = None,
2483
+ parse_as: Literal["json"] = "json",
2484
+ headers: HeaderTypes | None = None,
2485
+ cookies: CookieTypes | None = None,
2486
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2487
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2488
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2489
+ extensions: RequestExtensions | None = None,
2490
+ ) -> list[RegressionModelMetadata]:
2491
+ pass
2492
+
2493
+ @overload
2494
+ def GET(
2495
+ self,
2496
+ path: Literal["/regression_model/{name_or_id}"],
2497
+ *,
2498
+ params: GetRegressionModelByNameOrIdParams,
2499
+ parse_as: Literal["json"] = "json",
2500
+ headers: HeaderTypes | None = None,
2501
+ cookies: CookieTypes | None = None,
2502
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2503
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2504
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2505
+ extensions: RequestExtensions | None = None,
2506
+ ) -> RegressionModelMetadata:
2507
+ pass
2508
+
2509
+ @overload
2510
+ def GET(
2511
+ self,
2512
+ path: Literal["/regression_model/{model_name_or_id}/evaluation"],
2513
+ *,
2514
+ params: GetRegressionModelByModelNameOrIdEvaluationParams,
2515
+ parse_as: Literal["json"] = "json",
2516
+ headers: HeaderTypes | None = None,
2517
+ cookies: CookieTypes | None = None,
2518
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2519
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2520
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2521
+ extensions: RequestExtensions | None = None,
2522
+ ) -> list[EvaluationResponseRegressionMetrics]:
2523
+ pass
2524
+
2525
+ @overload
2526
+ def GET(
2527
+ self,
2528
+ path: Literal["/regression_model/{model_name_or_id}/evaluation/{task_id}"],
2529
+ *,
2530
+ params: GetRegressionModelByModelNameOrIdEvaluationByTaskIdParams,
2531
+ parse_as: Literal["json"] = "json",
2532
+ headers: HeaderTypes | None = None,
2533
+ cookies: CookieTypes | None = None,
2534
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2535
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2536
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2537
+ extensions: RequestExtensions | None = None,
2538
+ ) -> EvaluationResponseRegressionMetrics:
2539
+ pass
2540
+
2541
+ @overload
2542
+ def GET(
2543
+ self,
2544
+ path: Literal["/task/{task_id}"],
2545
+ *,
2546
+ params: GetTaskByTaskIdParams,
2547
+ parse_as: Literal["json"] = "json",
2548
+ headers: HeaderTypes | None = None,
2549
+ cookies: CookieTypes | None = None,
2550
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2551
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2552
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2553
+ extensions: RequestExtensions | None = None,
2554
+ ) -> Task:
2555
+ pass
2556
+
2557
+ @overload
2558
+ def GET(
2559
+ self,
2560
+ path: Literal["/task/{task_id}/status"],
2561
+ *,
2562
+ params: GetTaskByTaskIdStatusParams,
2563
+ parse_as: Literal["json"] = "json",
2564
+ headers: HeaderTypes | None = None,
2565
+ cookies: CookieTypes | None = None,
2566
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2567
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2568
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2569
+ extensions: RequestExtensions | None = None,
2570
+ ) -> TaskStatusInfo:
2571
+ pass
2572
+
2573
+ @overload
2574
+ def GET(
2575
+ self,
2576
+ path: Literal["/task"],
2577
+ *,
2578
+ params: GetTaskParams,
2579
+ parse_as: Literal["json"] = "json",
2580
+ headers: HeaderTypes | None = None,
2581
+ cookies: CookieTypes | None = None,
2582
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2583
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2584
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2585
+ extensions: RequestExtensions | None = None,
2586
+ ) -> PaginatedTask:
2587
+ pass
2588
+
2589
+ @overload
2590
+ def GET(
2591
+ self,
2592
+ path: Literal["/telemetry/prediction/{prediction_id}"],
2593
+ *,
2594
+ params: GetTelemetryPredictionByPredictionIdParams,
2595
+ parse_as: Literal["json"] = "json",
2596
+ headers: HeaderTypes | None = None,
2597
+ cookies: CookieTypes | None = None,
2598
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2599
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2600
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2601
+ extensions: RequestExtensions | None = None,
2602
+ ) -> LabelPredictionWithMemoriesAndFeedback | ScorePredictionWithMemoriesAndFeedback:
2603
+ """Get a specific prediction by ID."""
2604
+ pass
2605
+
2606
+ @overload
2607
+ def GET(
2608
+ self,
2609
+ path: Literal["/telemetry/prediction/{prediction_id}/explanation"],
2610
+ *,
2611
+ params: GetTelemetryPredictionByPredictionIdExplanationParams,
2612
+ parse_as: Literal["text"],
2613
+ headers: HeaderTypes | None = None,
2614
+ cookies: CookieTypes | None = None,
2615
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2616
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2617
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2618
+ extensions: RequestExtensions | None = None,
2619
+ ) -> str:
2620
+ """Get explanation for a prediction, optionally streaming the response."""
2621
+ pass
2622
+
2623
+ @overload
2624
+ def GET(
2625
+ self,
2626
+ path: Literal["/telemetry/prediction/{prediction_id}/action"],
2627
+ *,
2628
+ params: GetTelemetryPredictionByPredictionIdActionParams,
2629
+ parse_as: Literal["json"] = "json",
2630
+ headers: HeaderTypes | None = None,
2631
+ cookies: CookieTypes | None = None,
2632
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2633
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2634
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2635
+ extensions: RequestExtensions | None = None,
2636
+ ) -> ActionRecommendation:
2637
+ """Get action recommendation for improving a specific prediction."""
2638
+ pass
2639
+
2640
+ @overload
2641
+ def GET(
2642
+ self,
2643
+ path: Literal["/telemetry/prediction/{prediction_id}/memory_suggestions"],
2644
+ *,
2645
+ params: GetTelemetryPredictionByPredictionIdMemorySuggestionsParams,
2646
+ parse_as: Literal["json"] = "json",
2647
+ headers: HeaderTypes | None = None,
2648
+ cookies: CookieTypes | None = None,
2649
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2650
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2651
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2652
+ extensions: RequestExtensions | None = None,
2653
+ ) -> AddMemoryRecommendations:
2654
+ """
2655
+ Generate synthetic memory suggestions to improve a specific prediction.
2656
+
2657
+ The returned suggestions have labels as string representations of integer indices
2658
+ corresponding to the memoryset's label_names.
2659
+ """
2660
+ pass
2661
+
2662
+ @overload
2663
+ def GET(
2664
+ self,
2665
+ path: Literal["/telemetry/feedback_category"],
2666
+ *,
2667
+ params: None = None,
2668
+ parse_as: Literal["json"] = "json",
2669
+ headers: HeaderTypes | None = None,
2670
+ cookies: CookieTypes | None = None,
2671
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2672
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2673
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2674
+ extensions: RequestExtensions | None = None,
2675
+ ) -> list[PredictionFeedbackCategory]:
2676
+ """List all feedback categories for the organization."""
2677
+ pass
2678
+
2679
+ @overload
2680
+ def GET(
2681
+ self,
2682
+ path: Literal["/telemetry/feedback_category/{name_or_id}"],
2683
+ *,
2684
+ params: GetTelemetryFeedbackCategoryByNameOrIdParams,
2685
+ parse_as: Literal["json"] = "json",
2686
+ headers: HeaderTypes | None = None,
2687
+ cookies: CookieTypes | None = None,
2688
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2689
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2690
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2691
+ extensions: RequestExtensions | None = None,
2692
+ ) -> PredictionFeedbackCategory:
2693
+ """Get a feedback category by name or ID."""
2694
+ pass
2695
+
2696
+ @overload
2697
+ def GET(
2698
+ self,
2699
+ path: Literal["/agents/bootstrap_classification_model/{task_id}"],
2700
+ *,
2701
+ params: GetAgentsBootstrapClassificationModelByTaskIdParams,
2702
+ parse_as: Literal["json"] = "json",
2703
+ headers: HeaderTypes | None = None,
2704
+ cookies: CookieTypes | None = None,
2705
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2706
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2707
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2708
+ extensions: RequestExtensions | None = None,
2709
+ ) -> BootstrapClassificationModelResponse:
2710
+ """Get the status of a bootstrap classification model task"""
2711
+ pass
2712
+
2713
+ def GET(
2714
+ self,
2715
+ path: str,
2716
+ *,
2717
+ params: Mapping[str, Any] | None = None,
2718
+ parse_as: Literal["json", "text"] | None = "json",
2719
+ headers: HeaderTypes | None = None,
2720
+ cookies: CookieTypes | None = None,
2721
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2722
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2723
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2724
+ extensions: RequestExtensions | None = None,
2725
+ ) -> Any:
2726
+ path_params, query_params = self._parse_params(params or {}, path)
2727
+ res = self.get(
2728
+ path.format(**path_params),
2729
+ params=query_params,
2730
+ headers=headers,
2731
+ cookies=cookies,
2732
+ auth=auth,
2733
+ follow_redirects=follow_redirects,
2734
+ timeout=timeout,
2735
+ extensions=extensions,
2736
+ ).raise_for_status()
2737
+ return (
2738
+ None
2739
+ if res.status_code == 204
2740
+ else res.json() if parse_as == "json" else res.text if parse_as == "text" else res.content
2741
+ )
2742
+
2743
+ @overload
2744
+ def POST(
2745
+ self,
2746
+ path: Literal["/auth/api_key"],
2747
+ *,
2748
+ params: None = None,
2749
+ json: CreateApiKeyRequest,
2750
+ data: None = None,
2751
+ files: None = None,
2752
+ content: None = None,
2753
+ parse_as: Literal["json"] = "json",
2754
+ headers: HeaderTypes | None = None,
2755
+ cookies: CookieTypes | None = None,
2756
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2757
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2758
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2759
+ extensions: RequestExtensions | None = None,
2760
+ ) -> CreateApiKeyResponse:
2761
+ """Create a new API key for the organization."""
2762
+ pass
2763
+
2764
+ @overload
2765
+ def POST(
2766
+ self,
2767
+ path: Literal["/auth/org/plan"],
2768
+ *,
2769
+ params: None = None,
2770
+ json: CreateOrgPlanRequest,
2771
+ data: None = None,
2772
+ files: None = None,
2773
+ content: None = None,
2774
+ parse_as: Literal["json"] = "json",
2775
+ headers: HeaderTypes | None = None,
2776
+ cookies: CookieTypes | None = None,
2777
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2778
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2779
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2780
+ extensions: RequestExtensions | None = None,
2781
+ ) -> OrgPlan:
2782
+ """Create an organization plan."""
2783
+ pass
2784
+
2785
+ @overload
2786
+ def POST(
2787
+ self,
2788
+ path: Literal["/memoryset"],
2789
+ *,
2790
+ params: None = None,
2791
+ json: CreateMemorysetRequest,
2792
+ data: None = None,
2793
+ files: None = None,
2794
+ content: None = None,
2795
+ parse_as: Literal["json"] = "json",
2796
+ headers: HeaderTypes | None = None,
2797
+ cookies: CookieTypes | None = None,
2798
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2799
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2800
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2801
+ extensions: RequestExtensions | None = None,
2802
+ ) -> MemorysetMetadata:
2803
+ pass
2804
+
2805
+ @overload
2806
+ def POST(
2807
+ self,
2808
+ path: Literal["/memoryset/{name_or_id}/clone"],
2809
+ *,
2810
+ params: PostMemorysetByNameOrIdCloneParams,
2811
+ json: CloneMemorysetRequest,
2812
+ data: None = None,
2813
+ files: None = None,
2814
+ content: None = None,
2815
+ parse_as: Literal["json"] = "json",
2816
+ headers: HeaderTypes | None = None,
2817
+ cookies: CookieTypes | None = None,
2818
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2819
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2820
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2821
+ extensions: RequestExtensions | None = None,
2822
+ ) -> MemorysetMetadata:
2823
+ pass
2824
+
2825
+ @overload
2826
+ def POST(
2827
+ self,
2828
+ path: Literal["/batch_delete_memoryset"],
2829
+ *,
2830
+ params: None = None,
2831
+ json: DeleteMemorysetsRequest,
2832
+ data: None = None,
2833
+ files: None = None,
2834
+ content: None = None,
2835
+ parse_as: Literal["json"] = "json",
2836
+ headers: HeaderTypes | None = None,
2837
+ cookies: CookieTypes | None = None,
2838
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2839
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2840
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2841
+ extensions: RequestExtensions | None = None,
2842
+ ) -> None:
2843
+ pass
2844
+
2845
+ @overload
2846
+ def POST(
2847
+ self,
2848
+ path: Literal["/memoryset/{name_or_id}/memories/get"],
2849
+ *,
2850
+ params: PostMemorysetByNameOrIdMemoriesGetParams,
2851
+ json: GetMemoriesRequest,
2852
+ data: None = None,
2853
+ files: None = None,
2854
+ content: None = None,
2855
+ parse_as: Literal["json"] = "json",
2856
+ headers: HeaderTypes | None = None,
2857
+ cookies: CookieTypes | None = None,
2858
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2859
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2860
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2861
+ extensions: RequestExtensions | None = None,
2862
+ ) -> list[LabeledMemory] | list[ScoredMemory]:
2863
+ pass
2864
+
2865
+ @overload
2866
+ def POST(
2867
+ self,
2868
+ path: Literal["/memoryset/{name_or_id}/memories"],
2869
+ *,
2870
+ params: PostMemorysetByNameOrIdMemoriesParams,
2871
+ json: ListMemoriesRequest | None = None,
2872
+ data: None = None,
2873
+ files: None = None,
2874
+ content: None = None,
2875
+ parse_as: Literal["json"] = "json",
2876
+ headers: HeaderTypes | None = None,
2877
+ cookies: CookieTypes | None = None,
2878
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2879
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2880
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2881
+ extensions: RequestExtensions | None = None,
2882
+ ) -> list[LabeledMemory] | list[ScoredMemory]:
2883
+ pass
2884
+
2885
+ @overload
2886
+ def POST(
2887
+ self,
2888
+ path: Literal["/memoryset/{name_or_id}/memories/delete"],
2889
+ *,
2890
+ params: PostMemorysetByNameOrIdMemoriesDeleteParams,
2891
+ json: DeleteMemoriesRequest,
2892
+ data: None = None,
2893
+ files: None = None,
2894
+ content: None = None,
2895
+ parse_as: Literal["json"] = "json",
2896
+ headers: HeaderTypes | None = None,
2897
+ cookies: CookieTypes | None = None,
2898
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2899
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2900
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2901
+ extensions: RequestExtensions | None = None,
2902
+ ) -> None:
2903
+ pass
2904
+
2905
+ @overload
2906
+ def POST(
2907
+ self,
2908
+ path: Literal["/memoryset/{name_or_id}/analysis"],
2909
+ *,
2910
+ params: PostMemorysetByNameOrIdAnalysisParams,
2911
+ json: MemorysetAnalysisRequest,
2912
+ data: None = None,
2913
+ files: None = None,
2914
+ content: None = None,
2915
+ parse_as: Literal["json"] = "json",
2916
+ headers: HeaderTypes | None = None,
2917
+ cookies: CookieTypes | None = None,
2918
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2919
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2920
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2921
+ extensions: RequestExtensions | None = None,
2922
+ ) -> MemorysetAnalysisResponse:
2923
+ pass
2924
+
2925
+ @overload
2926
+ def POST(
2927
+ self,
2928
+ path: Literal["/memoryset/{name_or_id}/memory/{memory_id}/cascading_edits"],
2929
+ *,
2930
+ params: PostMemorysetByNameOrIdMemoryByMemoryIdCascadingEditsParams,
2931
+ json: CascadeEditSuggestionsRequest,
2932
+ data: None = None,
2933
+ files: None = None,
2934
+ content: None = None,
2935
+ parse_as: Literal["json"] = "json",
2936
+ headers: HeaderTypes | None = None,
2937
+ cookies: CookieTypes | None = None,
2938
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2939
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2940
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2941
+ extensions: RequestExtensions | None = None,
2942
+ ) -> list[CascadingEditSuggestion]:
2943
+ pass
2944
+
2945
+ @overload
2946
+ def POST(
2947
+ self,
2948
+ path: Literal["/finetuned_embedding_model"],
2949
+ *,
2950
+ params: None = None,
2951
+ json: FinetuneEmbeddingModelRequest,
2952
+ data: None = None,
2953
+ files: None = None,
2954
+ content: None = None,
2955
+ parse_as: Literal["json"] = "json",
2956
+ headers: HeaderTypes | None = None,
2957
+ cookies: CookieTypes | None = None,
2958
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2959
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2960
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2961
+ extensions: RequestExtensions | None = None,
2962
+ ) -> FinetunedEmbeddingModelMetadata:
2963
+ """Create a finetuned embedding model."""
2964
+ pass
2965
+
2966
+ @overload
2967
+ def POST(
2968
+ self,
2969
+ path: Literal["/finetuned_embedding_model/{name_or_id}/evaluation"],
2970
+ *,
2971
+ params: PostFinetunedEmbeddingModelByNameOrIdEvaluationParams,
2972
+ json: EmbeddingEvaluationRequest,
2973
+ data: None = None,
2974
+ files: None = None,
2975
+ content: None = None,
2976
+ parse_as: Literal["json"] = "json",
2977
+ headers: HeaderTypes | None = None,
2978
+ cookies: CookieTypes | None = None,
2979
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2980
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
2981
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
2982
+ extensions: RequestExtensions | None = None,
2983
+ ) -> EmbeddingEvaluationResponse:
2984
+ """Evaluate a finetuned embedding model as a KNN classifier or regressor."""
2985
+ pass
2986
+
2987
+ @overload
2988
+ def POST(
2989
+ self,
2990
+ path: Literal["/pretrained_embedding_model/{model_name}/evaluation"],
2991
+ *,
2992
+ params: PostPretrainedEmbeddingModelByModelNameEvaluationParams,
2993
+ json: EmbeddingEvaluationRequest,
2994
+ data: None = None,
2995
+ files: None = None,
2996
+ content: None = None,
2997
+ parse_as: Literal["json"] = "json",
2998
+ headers: HeaderTypes | None = None,
2999
+ cookies: CookieTypes | None = None,
3000
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3001
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3002
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3003
+ extensions: RequestExtensions | None = None,
3004
+ ) -> EmbeddingEvaluationResponse:
3005
+ """Evaluate a pretrained embedding model as a KNN classifier or regressor."""
3006
+ pass
3007
+
3008
+ @overload
3009
+ def POST(
3010
+ self,
3011
+ path: Literal["/datasource/upload"],
3012
+ *,
3013
+ params: None = None,
3014
+ json: None = None,
3015
+ data: PostDatasourceUploadRequest,
3016
+ files: dict[Literal["files"], FileTypes] | list[tuple[Literal["files"], FileTypes]],
3017
+ content: None = None,
3018
+ parse_as: Literal["json"] = "json",
3019
+ headers: HeaderTypes | None = None,
3020
+ cookies: CookieTypes | None = None,
3021
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3022
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3023
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3024
+ extensions: RequestExtensions | None = None,
3025
+ ) -> DatasourceMetadata:
3026
+ """
3027
+ Create a datasource by uploading files.
3028
+
3029
+ Supports multiple file upload scenarios:
3030
+ - Multiple files: HuggingFace Dataset format (dataset_info.json, state.json, .arrow files, etc.)
3031
+ - Single file: CSV, JSON, JSONL, Parquet, or Pickle files
3032
+ """
3033
+ pass
3034
+
3035
+ @overload
3036
+ def POST(
3037
+ self,
3038
+ path: Literal["/datasource"],
3039
+ *,
3040
+ params: None = None,
3041
+ json: CreateDatasourceFromContentRequest,
3042
+ data: None = None,
3043
+ files: None = None,
3044
+ content: None = None,
3045
+ parse_as: Literal["json"] = "json",
3046
+ headers: HeaderTypes | None = None,
3047
+ cookies: CookieTypes | None = None,
3048
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3049
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3050
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3051
+ extensions: RequestExtensions | None = None,
3052
+ ) -> DatasourceMetadata:
3053
+ """
3054
+ Create a datasource from JSON content.
3055
+
3056
+ Automatically detects and supports multiple JSON formats:
3057
+ - List of records: [{"col1": val1, "col2": val2}, {"col1": val3, "col2": val4}, ...]
3058
+ - Dictionary of columns: {"col1": [val1, val3, ...], "col2": [val2, val4, ...]}
3059
+ """
3060
+ pass
3061
+
3062
+ @overload
3063
+ def POST(
3064
+ self,
3065
+ path: Literal["/datasource/{name_or_id}/embedding_evaluation"],
3066
+ *,
3067
+ params: PostDatasourceByNameOrIdEmbeddingEvaluationParams,
3068
+ json: DatasourceEmbeddingEvaluationsRequest,
3069
+ data: None = None,
3070
+ files: None = None,
3071
+ content: None = None,
3072
+ parse_as: Literal["json"] = "json",
3073
+ headers: HeaderTypes | None = None,
3074
+ cookies: CookieTypes | None = None,
3075
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3076
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3077
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3078
+ extensions: RequestExtensions | None = None,
3079
+ ) -> DatasourceEmbeddingEvaluationsResponse:
3080
+ """Create an embedding evaluation task for a datasource."""
3081
+ pass
3082
+
3083
+ @overload
3084
+ def POST(
3085
+ self,
3086
+ path: Literal["/classification_model"],
3087
+ *,
3088
+ params: None = None,
3089
+ json: CreateClassificationModelRequest,
3090
+ data: None = None,
3091
+ files: None = None,
3092
+ content: None = None,
3093
+ parse_as: Literal["json"] = "json",
3094
+ headers: HeaderTypes | None = None,
3095
+ cookies: CookieTypes | None = None,
3096
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3097
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3098
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3099
+ extensions: RequestExtensions | None = None,
3100
+ ) -> ClassificationModelMetadata:
3101
+ pass
3102
+
3103
+ @overload
3104
+ def POST(
3105
+ self,
3106
+ path: Literal["/classification_model/{model_name_or_id}/evaluation"],
3107
+ *,
3108
+ params: PostClassificationModelByModelNameOrIdEvaluationParams,
3109
+ json: ClassificationEvaluationRequest,
3110
+ data: None = None,
3111
+ files: None = None,
3112
+ content: None = None,
3113
+ parse_as: Literal["json"] = "json",
3114
+ headers: HeaderTypes | None = None,
3115
+ cookies: CookieTypes | None = None,
3116
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3117
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3118
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3119
+ extensions: RequestExtensions | None = None,
3120
+ ) -> EvaluationResponse:
3121
+ pass
3122
+
3123
+ @overload
3124
+ def POST(
3125
+ self,
3126
+ path: Literal["/regression_model"],
3127
+ *,
3128
+ params: None = None,
3129
+ json: CreateRegressionModelRequest,
3130
+ data: None = None,
3131
+ files: None = None,
3132
+ content: None = None,
3133
+ parse_as: Literal["json"] = "json",
3134
+ headers: HeaderTypes | None = None,
3135
+ cookies: CookieTypes | None = None,
3136
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3137
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3138
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3139
+ extensions: RequestExtensions | None = None,
3140
+ ) -> RegressionModelMetadata:
3141
+ pass
3142
+
3143
+ @overload
3144
+ def POST(
3145
+ self,
3146
+ path: Literal["/regression_model/{model_name_or_id}/evaluation"],
3147
+ *,
3148
+ params: PostRegressionModelByModelNameOrIdEvaluationParams,
3149
+ json: RegressionEvaluationRequest,
3150
+ data: None = None,
3151
+ files: None = None,
3152
+ content: None = None,
3153
+ parse_as: Literal["json"] = "json",
3154
+ headers: HeaderTypes | None = None,
3155
+ cookies: CookieTypes | None = None,
3156
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3157
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3158
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3159
+ extensions: RequestExtensions | None = None,
3160
+ ) -> EvaluationResponse:
3161
+ pass
3162
+
3163
+ @overload
3164
+ def POST(
3165
+ self,
3166
+ path: Literal["/telemetry/prediction"],
3167
+ *,
3168
+ params: None = None,
3169
+ json: ListPredictionsRequest | None = None,
3170
+ data: None = None,
3171
+ files: None = None,
3172
+ content: None = None,
3173
+ parse_as: Literal["json"] = "json",
3174
+ headers: HeaderTypes | None = None,
3175
+ cookies: CookieTypes | None = None,
3176
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3177
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3178
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3179
+ extensions: RequestExtensions | None = None,
3180
+ ) -> list[LabelPredictionWithMemoriesAndFeedback | ScorePredictionWithMemoriesAndFeedback]:
3181
+ """List predictions with optional filtering and sorting."""
3182
+ pass
3183
+
3184
+ @overload
3185
+ def POST(
3186
+ self,
3187
+ path: Literal["/telemetry/prediction/count"],
3188
+ *,
3189
+ params: None = None,
3190
+ json: CountPredictionsRequest | None = None,
3191
+ data: None = None,
3192
+ files: None = None,
3193
+ content: None = None,
3194
+ parse_as: Literal["json"] = "json",
3195
+ headers: HeaderTypes | None = None,
3196
+ cookies: CookieTypes | None = None,
3197
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3198
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3199
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3200
+ extensions: RequestExtensions | None = None,
3201
+ ) -> int:
3202
+ """Count predictions with optional filtering."""
3203
+ pass
3204
+
3205
+ @overload
3206
+ def POST(
3207
+ self,
3208
+ path: Literal["/telemetry/memories"],
3209
+ *,
3210
+ params: None = None,
3211
+ json: TelemetryMemoriesRequest,
3212
+ data: None = None,
3213
+ files: None = None,
3214
+ content: None = None,
3215
+ parse_as: Literal["json"] = "json",
3216
+ headers: HeaderTypes | None = None,
3217
+ cookies: CookieTypes | None = None,
3218
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3219
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3220
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3221
+ extensions: RequestExtensions | None = None,
3222
+ ) -> PaginatedUnionLabeledMemoryWithFeedbackMetricsScoredMemoryWithFeedbackMetrics:
3223
+ """
3224
+ List memories with feedback metrics.
3225
+ **Note**: This endpoint will ONLY return memories that have been used in a prediction.
3226
+ If you want to query ALL memories WITHOUT feedback metrics, use the query_memoryset endpoint.
3227
+ """
3228
+ pass
3229
+
3230
+ @overload
3231
+ def POST(
3232
+ self,
3233
+ path: Literal["/agents/bootstrap_classification_model"],
3234
+ *,
3235
+ params: None = None,
3236
+ json: BootstrapClassificationModelRequest,
3237
+ data: None = None,
3238
+ files: None = None,
3239
+ content: None = None,
3240
+ parse_as: Literal["json"] = "json",
3241
+ headers: HeaderTypes | None = None,
3242
+ cookies: CookieTypes | None = None,
3243
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3244
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3245
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3246
+ extensions: RequestExtensions | None = None,
3247
+ ) -> BootstrapClassificationModelResponse:
3248
+ """
3249
+ Bootstrap a classification model by creating a memoryset with generated memories and a classification model.
3250
+
3251
+ This endpoint uses the bootstrap_classification_model agent to generate:
3252
+ 1. Memoryset configuration with appropriate settings
3253
+ 2. Model configuration with optimal parameters
3254
+ 3. High-quality training memories for each label
3255
+
3256
+ The process involves:
3257
+ 1. Calling the agent to generate configurations and memories
3258
+ 2. Creating a datasource from the generated memories
3259
+ 3. Creating a memoryset from the datasource
3260
+ 4. Creating a classification model from the memoryset
3261
+ """
3262
+ pass
3263
+
3264
+ @overload
3265
+ def POST(
3266
+ self,
3267
+ path: Literal["/gpu/memoryset/{name_or_id}/lookup"],
3268
+ *,
3269
+ params: PostGpuMemorysetByNameOrIdLookupParams,
3270
+ json: LookupRequest,
3271
+ data: None = None,
3272
+ files: None = None,
3273
+ content: None = None,
3274
+ parse_as: Literal["json"] = "json",
3275
+ headers: HeaderTypes | None = None,
3276
+ cookies: CookieTypes | None = None,
3277
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3278
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3279
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3280
+ extensions: RequestExtensions | None = None,
3281
+ ) -> list[list[LabeledMemoryLookup | ScoredMemoryLookup]]:
3282
+ pass
3283
+
3284
+ @overload
3285
+ def POST(
3286
+ self,
3287
+ path: Literal["/gpu/memoryset/{name_or_id}/memory"],
3288
+ *,
3289
+ params: PostGpuMemorysetByNameOrIdMemoryParams,
3290
+ json: PostGpuMemorysetByNameOrIdMemoryRequest,
3291
+ data: None = None,
3292
+ files: None = None,
3293
+ content: None = None,
3294
+ parse_as: Literal["json"] = "json",
3295
+ headers: HeaderTypes | None = None,
3296
+ cookies: CookieTypes | None = None,
3297
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3298
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3299
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3300
+ extensions: RequestExtensions | None = None,
3301
+ ) -> list[str]:
3302
+ pass
3303
+
3304
+ @overload
3305
+ def POST(
3306
+ self,
3307
+ path: Literal["/gpu/classification_model/{name_or_id}/prediction"],
3308
+ *,
3309
+ params: PostGpuClassificationModelByNameOrIdPredictionParams,
3310
+ json: ClassificationPredictionRequest,
3311
+ data: None = None,
3312
+ files: None = None,
3313
+ content: None = None,
3314
+ parse_as: Literal["json"] = "json",
3315
+ headers: HeaderTypes | None = None,
3316
+ cookies: CookieTypes | None = None,
3317
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3318
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3319
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3320
+ extensions: RequestExtensions | None = None,
3321
+ ) -> list[BaseLabelPredictionResult]:
3322
+ pass
3323
+
3324
+ @overload
3325
+ def POST(
3326
+ self,
3327
+ path: Literal["/gpu/regression_model/{name_or_id}/prediction"],
3328
+ *,
3329
+ params: PostGpuRegressionModelByNameOrIdPredictionParams,
3330
+ json: RegressionPredictionRequest,
3331
+ data: None = None,
3332
+ files: None = None,
3333
+ content: None = None,
3334
+ parse_as: Literal["json"] = "json",
3335
+ headers: HeaderTypes | None = None,
3336
+ cookies: CookieTypes | None = None,
3337
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3338
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3339
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3340
+ extensions: RequestExtensions | None = None,
3341
+ ) -> list[BaseScorePredictionResult]:
3342
+ pass
3343
+
3344
+ @overload
3345
+ def POST(
3346
+ self,
3347
+ path: Literal["/gpu/finetuned_embedding_model/{name_or_id}/embedding"],
3348
+ *,
3349
+ params: PostGpuFinetunedEmbeddingModelByNameOrIdEmbeddingParams,
3350
+ json: EmbedRequest,
3351
+ data: None = None,
3352
+ files: None = None,
3353
+ content: None = None,
3354
+ parse_as: Literal["json"] = "json",
3355
+ headers: HeaderTypes | None = None,
3356
+ cookies: CookieTypes | None = None,
3357
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3358
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3359
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3360
+ extensions: RequestExtensions | None = None,
3361
+ ) -> list[list[float]]:
3362
+ """Embed values using a finetuned embedding model."""
3363
+ pass
3364
+
3365
+ @overload
3366
+ def POST(
3367
+ self,
3368
+ path: Literal["/gpu/pretrained_embedding_model/{model_name}/embedding"],
3369
+ *,
3370
+ params: PostGpuPretrainedEmbeddingModelByModelNameEmbeddingParams,
3371
+ json: EmbedRequest,
3372
+ data: None = None,
3373
+ files: None = None,
3374
+ content: None = None,
3375
+ parse_as: Literal["json"] = "json",
3376
+ headers: HeaderTypes | None = None,
3377
+ cookies: CookieTypes | None = None,
3378
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3379
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3380
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3381
+ extensions: RequestExtensions | None = None,
3382
+ ) -> list[list[float]]:
3383
+ """Embed values using a pretrained embedding model."""
3384
+ pass
3385
+
3386
+ def POST(
3387
+ self,
3388
+ path: str,
3389
+ *,
3390
+ params: Mapping[str, Any] | None = None,
3391
+ json: Any | None = None,
3392
+ data: Mapping[str, Any] | None = None,
3393
+ content: RequestContent | None = None,
3394
+ files: dict[Any, FileTypes] | list[tuple[Any, FileTypes]] | None = None,
3395
+ parse_as: Literal["json", "text"] | None = "json",
3396
+ headers: HeaderTypes | None = None,
3397
+ cookies: CookieTypes | None = None,
3398
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3399
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3400
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3401
+ extensions: RequestExtensions | None = None,
3402
+ ) -> Any:
3403
+ path_params, query_params = self._parse_params(params or {}, path)
3404
+ res = self.post(
3405
+ path.format(**path_params),
3406
+ params=query_params,
3407
+ content=content,
3408
+ data=data,
3409
+ files=files,
3410
+ json=json,
3411
+ headers=headers,
3412
+ cookies=cookies,
3413
+ auth=auth,
3414
+ follow_redirects=follow_redirects,
3415
+ timeout=timeout,
3416
+ extensions=extensions,
3417
+ ).raise_for_status()
3418
+ return (
3419
+ None
3420
+ if res.status_code == 204
3421
+ else res.json() if parse_as == "json" else res.text if parse_as == "text" else res.content
3422
+ )
3423
+
3424
+ @overload
3425
+ def PUT(
3426
+ self,
3427
+ path: Literal["/auth/org/plan"],
3428
+ *,
3429
+ params: None = None,
3430
+ json: UpdateOrgPlanRequest,
3431
+ data: None = None,
3432
+ files: None = None,
3433
+ content: None = None,
3434
+ parse_as: Literal["json"] = "json",
3435
+ headers: HeaderTypes | None = None,
3436
+ cookies: CookieTypes | None = None,
3437
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3438
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3439
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3440
+ extensions: RequestExtensions | None = None,
3441
+ ) -> OrgPlan:
3442
+ """Update the organization plan."""
3443
+ pass
3444
+
3445
+ @overload
3446
+ def PUT(
3447
+ self,
3448
+ path: Literal["/telemetry/prediction/feedback"],
3449
+ *,
3450
+ params: None = None,
3451
+ json: PutTelemetryPredictionFeedbackRequest,
3452
+ data: None = None,
3453
+ files: None = None,
3454
+ content: None = None,
3455
+ parse_as: Literal["json"] = "json",
3456
+ headers: HeaderTypes | None = None,
3457
+ cookies: CookieTypes | None = None,
3458
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3459
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3460
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3461
+ extensions: RequestExtensions | None = None,
3462
+ ) -> PredictionFeedbackResult:
3463
+ """Record feedback for predictions, handling updates, deletions, and insertions."""
3464
+ pass
3465
+
3466
+ def PUT(
3467
+ self,
3468
+ path: str,
3469
+ *,
3470
+ params: Mapping[str, Any] | None = None,
3471
+ json: Any | None = None,
3472
+ data: Mapping[str, Any] | None = None,
3473
+ content: RequestContent | None = None,
3474
+ files: dict[Any, FileTypes] | list[tuple[Any, FileTypes]] | None = None,
3475
+ parse_as: Literal["json", "text"] | None = "json",
3476
+ headers: HeaderTypes | None = None,
3477
+ cookies: CookieTypes | None = None,
3478
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3479
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3480
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3481
+ extensions: RequestExtensions | None = None,
3482
+ ) -> Any:
3483
+ path_params, query_params = self._parse_params(params or {}, path)
3484
+ res = self.put(
3485
+ path.format(**path_params),
3486
+ params=query_params,
3487
+ content=content,
3488
+ data=data,
3489
+ files=files,
3490
+ json=json,
3491
+ headers=headers,
3492
+ cookies=cookies,
3493
+ auth=auth,
3494
+ follow_redirects=follow_redirects,
3495
+ timeout=timeout,
3496
+ extensions=extensions,
3497
+ ).raise_for_status()
3498
+ return (
3499
+ None
3500
+ if res.status_code == 204
3501
+ else res.json() if parse_as == "json" else res.text if parse_as == "text" else res.content
3502
+ )
3503
+
3504
+ @overload
3505
+ def PATCH(
3506
+ self,
3507
+ path: Literal["/memoryset/{name_or_id}"],
3508
+ *,
3509
+ params: PatchMemorysetByNameOrIdParams,
3510
+ json: MemorysetUpdate,
3511
+ data: None = None,
3512
+ files: None = None,
3513
+ content: None = None,
3514
+ parse_as: Literal["json"] = "json",
3515
+ headers: HeaderTypes | None = None,
3516
+ cookies: CookieTypes | None = None,
3517
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3518
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3519
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3520
+ extensions: RequestExtensions | None = None,
3521
+ ) -> MemorysetMetadata:
3522
+ pass
3523
+
3524
+ @overload
3525
+ def PATCH(
3526
+ self,
3527
+ path: Literal["/classification_model/{name_or_id}"],
3528
+ *,
3529
+ params: PatchClassificationModelByNameOrIdParams,
3530
+ json: PredictiveModelUpdate,
3531
+ data: None = None,
3532
+ files: None = None,
3533
+ content: None = None,
3534
+ parse_as: Literal["json"] = "json",
3535
+ headers: HeaderTypes | None = None,
3536
+ cookies: CookieTypes | None = None,
3537
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3538
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3539
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3540
+ extensions: RequestExtensions | None = None,
3541
+ ) -> ClassificationModelMetadata:
3542
+ pass
3543
+
3544
+ @overload
3545
+ def PATCH(
3546
+ self,
3547
+ path: Literal["/regression_model/{name_or_id}"],
3548
+ *,
3549
+ params: PatchRegressionModelByNameOrIdParams,
3550
+ json: PredictiveModelUpdate,
3551
+ data: None = None,
3552
+ files: None = None,
3553
+ content: None = None,
3554
+ parse_as: Literal["json"] = "json",
3555
+ headers: HeaderTypes | None = None,
3556
+ cookies: CookieTypes | None = None,
3557
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3558
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3559
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3560
+ extensions: RequestExtensions | None = None,
3561
+ ) -> RegressionModelMetadata:
3562
+ pass
3563
+
3564
+ @overload
3565
+ def PATCH(
3566
+ self,
3567
+ path: Literal["/telemetry/prediction/{prediction_id}"],
3568
+ *,
3569
+ params: PatchTelemetryPredictionByPredictionIdParams,
3570
+ json: UpdatePredictionRequest,
3571
+ data: None = None,
3572
+ files: None = None,
3573
+ content: None = None,
3574
+ parse_as: Literal["json"] = "json",
3575
+ headers: HeaderTypes | None = None,
3576
+ cookies: CookieTypes | None = None,
3577
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3578
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3579
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3580
+ extensions: RequestExtensions | None = None,
3581
+ ) -> Any:
3582
+ """Update a prediction with new expected values, tags, or memory ID."""
3583
+ pass
3584
+
3585
+ @overload
3586
+ def PATCH(
3587
+ self,
3588
+ path: Literal["/gpu/memoryset/{name_or_id}/memory"],
3589
+ *,
3590
+ params: PatchGpuMemorysetByNameOrIdMemoryParams,
3591
+ json: PatchGpuMemorysetByNameOrIdMemoryRequest,
3592
+ data: None = None,
3593
+ files: None = None,
3594
+ content: None = None,
3595
+ parse_as: Literal["json"] = "json",
3596
+ headers: HeaderTypes | None = None,
3597
+ cookies: CookieTypes | None = None,
3598
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3599
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3600
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3601
+ extensions: RequestExtensions | None = None,
3602
+ ) -> LabeledMemory | ScoredMemory:
3603
+ pass
3604
+
3605
+ @overload
3606
+ def PATCH(
3607
+ self,
3608
+ path: Literal["/gpu/memoryset/{name_or_id}/memories"],
3609
+ *,
3610
+ params: PatchGpuMemorysetByNameOrIdMemoriesParams,
3611
+ json: PatchGpuMemorysetByNameOrIdMemoriesRequest,
3612
+ data: None = None,
3613
+ files: None = None,
3614
+ content: None = None,
3615
+ parse_as: Literal["json"] = "json",
3616
+ headers: HeaderTypes | None = None,
3617
+ cookies: CookieTypes | None = None,
3618
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3619
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3620
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3621
+ extensions: RequestExtensions | None = None,
3622
+ ) -> list[LabeledMemory] | list[ScoredMemory]:
3623
+ pass
3624
+
3625
+ def PATCH(
3626
+ self,
3627
+ path: str,
3628
+ *,
3629
+ params: Mapping[str, Any] | None = None,
3630
+ json: Any | None = None,
3631
+ data: Mapping[str, Any] | None = None,
3632
+ content: RequestContent | None = None,
3633
+ files: dict[Any, FileTypes] | list[tuple[Any, FileTypes]] | None = None,
3634
+ parse_as: Literal["json", "text"] | None = "json",
3635
+ headers: HeaderTypes | None = None,
3636
+ cookies: CookieTypes | None = None,
3637
+ auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3638
+ follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
3639
+ timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
3640
+ extensions: RequestExtensions | None = None,
3641
+ ) -> Any:
3642
+ path_params, query_params = self._parse_params(params or {}, path)
3643
+ res = self.patch(
3644
+ path.format(**path_params),
3645
+ params=query_params,
3646
+ content=content,
3647
+ data=data,
3648
+ files=files,
3649
+ json=json,
3650
+ headers=headers,
3651
+ cookies=cookies,
3652
+ auth=auth,
3653
+ follow_redirects=follow_redirects,
3654
+ timeout=timeout,
3655
+ extensions=extensions,
3656
+ ).raise_for_status()
3657
+ return (
3658
+ None
3659
+ if res.status_code == 204
3660
+ else res.json() if parse_as == "json" else res.text if parse_as == "text" else res.content
3661
+ )
3662
+
3663
+ @property
3664
+ def base_url(self) -> URL:
3665
+ # lazy init base_url from environment variable
3666
+ if str(self._base_url) == "":
3667
+ self.base_url = os.environ.get("ORCA_API_URL", "https://api.orcadb.ai/")
3668
+ return self._base_url
3669
+
3670
+ @base_url.setter
3671
+ def base_url(self, url: URL | str) -> None:
3672
+ Client.base_url.__set__(self, url)
3673
+
3674
+ @property
3675
+ def headers(self) -> Headers:
3676
+ # lazy init headers from environment variable
3677
+ if not self._headers.get("Api-Key"):
3678
+ Client.headers.__set__(self, Headers({"Api-Key": os.environ.get("ORCA_API_KEY", "")}))
3679
+ return self._headers
3680
+
3681
+ @headers.setter
3682
+ def headers(self, headers: HeaderTypes) -> None:
3683
+ Client.headers.__set__(self, headers)
3684
+
3685
+
3686
+ def _read_json_response(response: Response) -> dict[str, Any]:
3687
+ content = response.read()
3688
+ text = content.decode(response.encoding or "utf-8")
3689
+ return json.loads(text)
3690
+
3691
+
3692
+ def _raise_error_for_response(response: Response) -> None:
3693
+ if response.status_code == 401:
3694
+ raise ValueError("Invalid API key")
3695
+ # elif response.status_code == 402:
3696
+ # res = cast(QuotaExceededErrorResponse, _read_json_response(response))
3697
+ # raise RuntimeError(
3698
+ # f"{res['quota_type'].replace('_', ' ').title()} limit reached ({res['current']}/{res['quota_limit']})"
3699
+ # )
3700
+ elif response.status_code == 403:
3701
+ raise PermissionError(_read_json_response(response)["reason"])
3702
+ elif response.status_code == 404:
3703
+ res = cast(NotFoundErrorResponse, _read_json_response(response))
3704
+ if res["resource"] is not None:
3705
+ raise LookupError(f"The {res['resource']} you are looking for does not exist")
3706
+ else:
3707
+ raise RuntimeError(f"Unknown API route: {response.url}")
3708
+ elif response.status_code == 405:
3709
+ raise RuntimeError(f"Unknown method {response.request.method} for API route: {response.url}")
3710
+ elif response.status_code == 409:
3711
+ res = cast(ConstraintViolationErrorResponse, _read_json_response(response))
3712
+ raise RuntimeError(res["constraint"])
3713
+ elif response.status_code == 422:
3714
+ res = cast(InvalidInputErrorResponse, _read_json_response(response))
3715
+ issues = [f"{issue['loc'][-1]}: {issue['msg']}" for issue in res["validation_issues"]]
3716
+ raise ValueError("Invalid input:\n\t" + "\n\t".join(issues))
3717
+ elif response.status_code == 500:
3718
+ res = cast(InternalServerErrorResponse, _read_json_response(response))
3719
+ raise RuntimeError(f"Unexpected server error: {res['message']}")
3720
+ elif response.status_code == 503:
3721
+ raise RuntimeError("Orca API is currently unavailable, please try again later")
3722
+ elif response.status_code >= 400:
3723
+ raise RuntimeError(f"Unexpected status code: {response.status_code}")
3724
+
3725
+
3726
+ def _instrument_request(request: Request) -> None:
3727
+ request.headers["X-Request-ID"] = str(uuid.uuid4())
3728
+
3729
+
3730
+ logging.getLogger("httpx").setLevel(logging.WARNING)
3731
+ logging.getLogger("httpcore").setLevel(logging.ERROR)
3732
+
3733
+ orca_api = OrcaClient(
3734
+ transport=RetryTransport(
3735
+ transport=HTTPTransport(),
3736
+ retry=Retry(
3737
+ total=5,
3738
+ backoff_factor=0.5,
3739
+ allowed_methods=["GET", "POST", "PUT", "PATCH", "DELETE"],
3740
+ status_forcelist=[429, 500, 502, 503, 504],
3741
+ ),
3742
+ ),
3743
+ event_hooks={"request": [_instrument_request], "response": [_raise_error_for_response]},
3744
+ follow_redirects=True,
3745
+ timeout=Timeout(connect=3, read=20, write=10, pool=5),
3746
+ )
3747
+ """Typed client for the Orca API"""