orca-sdk 0.1.10__py3-none-any.whl → 0.1.12__py3-none-any.whl

orca_sdk/client.py

@@ -85,7 +85,7 @@ class BaseLabelPredictionResult(TypedDict):
     anomaly_score: float | None
     label: int | None
     label_name: str | None
-    logits: list[float]
+    logits: list[float] | None
 
 
 class BaseModel(TypedDict):
@@ -160,6 +160,18 @@ The type of a column in a datasource
 """
 
 
+class ComputeClassificationMetricsRequest(TypedDict):
+    expected_labels: list[int]
+    logits: list[list[float] | None]
+    anomaly_scores: NotRequired[list[float] | None]
+
+
+class ComputeRegressionMetricsRequest(TypedDict):
+    expected_scores: list[float]
+    predicted_scores: list[float | None]
+    anomaly_scores: NotRequired[list[float] | None]
+
+
 class ConstraintViolationErrorResponse(TypedDict):
     status_code: Literal[409]
     constraint: str
@@ -209,12 +221,13 @@ class DatasetFilterItem(TypedDict):
     value: Any
 
 
-class DeleteMemoriesRequest(TypedDict):
-    memory_ids: list[str]
+class DeleteMemoriesResponse(TypedDict):
+    deleted_count: int
 
 
 class DeleteMemorysetsRequest(TypedDict):
     memoryset_ids: list[str]
+    cascade: NotRequired[bool]
 
 
 class EmbedRequest(TypedDict):
@@ -290,7 +303,20 @@ class FilterItem(TypedDict):
         ]
     )
     op: Literal["==", "!=", ">", ">=", "<", "<=", "in", "not in", "like", "contains all", "contains any"]
-    value: str | int | float | bool | list[str | None] | list[int] | list[float] | list[bool] | None
+    value: (
+        str
+        | int
+        | float
+        | bool
+        | list[None]
+        | list[str]
+        | list[str | None]
+        | list[int]
+        | list[int | None]
+        | list[float]
+        | list[bool]
+        | None
+    )
     transform: NotRequired[Literal["length"]]
 
 
@@ -308,6 +334,7 @@ class GetDatasourceRowsRequest(TypedDict):
 
 class GetMemoriesRequest(TypedDict):
     memory_ids: list[str]
+    consistency_level: NotRequired[Literal["Bounded", "Session", "Strong", "Eventual"]]
 
 
 class HealthyResponse(TypedDict):
@@ -353,6 +380,13 @@ class LabelPercentage(TypedDict):
     percentage: float
 
 
+class LabeledBatchMemoryUpdatePatch(TypedDict):
+    metadata: NotRequired[dict[str, str | int | float | bool | None] | None]
+    source_id: NotRequired[str | None]
+    partition_id: NotRequired[str | None]
+    label: NotRequired[int | None]
+
+
 class LabeledExample(TypedDict):
     text: str
     label_name: str
@@ -371,8 +405,7 @@ class ListMemoriesRequest(TypedDict):
     offset: NotRequired[int]
     limit: NotRequired[int]
     filters: NotRequired[list[FilterItem]]
-    partition_id: NotRequired[str | None]
-    partition_filter_mode: NotRequired[Literal["ignore_partitions", "include_global", "exclude_global", "only_global"]]
+    consistency_level: NotRequired[Literal["Bounded", "Session", "Strong", "Eventual"]]
 
 
 class LookupRequest(TypedDict):
@@ -381,6 +414,7 @@ class LookupRequest(TypedDict):
     prompt: NotRequired[str | None]
     partition_id: NotRequired[str | list[str | None] | None]
     partition_filter_mode: NotRequired[Literal["ignore_partitions", "include_global", "exclude_global", "only_global"]]
+    consistency_level: NotRequired[Literal["Bounded", "Session", "Strong", "Eventual"]]
 
 
 class LookupScoreMetrics(TypedDict):
@@ -524,6 +558,7 @@ class NotFoundErrorResponse(TypedDict):
             "api_key",
             "datasource",
             "memoryset",
+            "predictive_model",
             "classification_model",
             "regression_model",
             "prediction",
@@ -550,8 +585,17 @@ class OrgPlan(TypedDict):
 
 class PRCurve(TypedDict):
     thresholds: list[float]
+    """
+    Threshold values for the curve
+    """
     precisions: list[float]
+    """
+    Precision values at each threshold
+    """
     recalls: list[float]
+    """
+    Recall values at each threshold
+    """
 
 
 class PredictionFeedback(TypedDict):
@@ -622,8 +666,17 @@ RARHeadType: TypeAlias = Literal["MMOE", "KNN"]
 
 class ROCCurve(TypedDict):
     thresholds: list[float]
+    """
+    Threshold values for the curve
+    """
     false_positive_rates: list[float]
+    """
+    False positive rate values at each threshold
+    """
     true_positive_rates: list[float]
+    """
+    True positive rate values at each threshold
+    """
 
 
 class ReadyResponse(TypedDict):
@@ -646,15 +699,49 @@ class RegressionEvaluationRequest(TypedDict):
 
 class RegressionMetrics(TypedDict):
     coverage: float
+    """
+    Percentage of predictions that are not none
+    """
     mse: float
+    """
+    Mean squared error of the predictions
+    """
     rmse: float
+    """
+    Root mean squared error of the predictions
+    """
     mae: float
+    """
+    Mean absolute error of the predictions
+    """
     r2: float
+    """
+    R-squared score (coefficient of determination) of the predictions
+    """
     explained_variance: float
+    """
+    Explained variance score of the predictions
+    """
     loss: float
+    """
+    Mean squared error loss of the predictions
+    """
     anomaly_score_mean: NotRequired[float | None]
+    """
+    Mean of anomaly scores across the dataset
+    """
     anomaly_score_median: NotRequired[float | None]
+    """
+    Median of anomaly scores across the dataset
+    """
     anomaly_score_variance: NotRequired[float | None]
+    """
+    Variance of anomaly scores across the dataset
+    """
+    warnings: NotRequired[list[str]]
+    """
+    Human-readable warnings about skipped or adjusted metrics
+    """
 
 
 class RegressionModelMetadata(TypedDict):
@@ -683,7 +770,7 @@ class RegressionPredictionRequest(TypedDict):
     save_telemetry_synchronously: NotRequired[bool]
     prompt: NotRequired[str | None]
     use_lookup_cache: NotRequired[bool]
-    consistency_level: NotRequired[Literal["Bounded", "Session", "Strong", "Eventual"] | None]
+    consistency_level: NotRequired[Literal["Bounded", "Session", "Strong", "Eventual"]]
     ignore_unlabeled: NotRequired[bool]
     partition_ids: NotRequired[str | list[str | None] | None]
     partition_filter_mode: NotRequired[Literal["ignore_partitions", "include_global", "exclude_global", "only_global"]]
@@ -728,6 +815,13 @@ class ScorePredictionWithMemoriesAndFeedback(TypedDict):
     feedbacks: list[PredictionFeedback]
 
 
+class ScoredBatchMemoryUpdatePatch(TypedDict):
+    metadata: NotRequired[dict[str, str | int | float | bool | None] | None]
+    source_id: NotRequired[str | None]
+    partition_id: NotRequired[str | None]
+    score: NotRequired[float | None]
+
+
 class ScoredMemory(TypedDict):
     value: str | bytes
     embedding: list[float]
@@ -833,6 +927,10 @@ class UnauthorizedErrorResponse(TypedDict):
     reason: str
 
 
+class UpdateMemoriesResponse(TypedDict):
+    updated_count: int
+
+
 class UpdateOrgPlanRequest(TypedDict):
     tier: Literal["FREE", "PRO", "ENTERPRISE", "CANCELLED"]
 
@@ -883,6 +981,7 @@ class GetMemorysetByNameOrIdParams(TypedDict):
 
 class DeleteMemorysetByNameOrIdParams(TypedDict):
     name_or_id: str
+    cascade: NotRequired[bool]
 
 
 class PostGpuMemorysetByNameOrIdLookupParams(TypedDict):
@@ -895,6 +994,7 @@ class GetMemorysetByNameOrIdMemoryByMemoryIdParams(TypedDict):
     """
     ID of the memory
     """
+    consistency_level: NotRequired[Literal["Bounded", "Session", "Strong", "Eventual"]]
 
 
 class DeleteMemorysetByNameOrIdMemoryByMemoryIdParams(TypedDict):
@@ -963,6 +1063,7 @@ class GetFinetunedEmbeddingModelByNameOrIdParams(TypedDict):
 
 class DeleteFinetunedEmbeddingModelByNameOrIdParams(TypedDict):
     name_or_id: str
+    cascade: NotRequired[bool]
 
 
 class PostGpuFinetunedEmbeddingModelByNameOrIdEmbeddingParams(TypedDict):
@@ -1056,6 +1157,20 @@ class GetDatasourceByNameOrIdDownloadParams(TypedDict):
     """
 
 
+class GetClassificationModelParams(TypedDict):
+    memoryset_name_or_id: NotRequired[str | None]
+    """
+    Filter by memoryset name or ID
+    """
+
+
+class GetRegressionModelParams(TypedDict):
+    memoryset_name_or_id: NotRequired[str | None]
+    """
+    Filter by memoryset name or ID
+    """
+
+
 class PatchClassificationModelByNameOrIdParams(TypedDict):
     name_or_id: str
 
@@ -1080,6 +1195,13 @@ class DeleteRegressionModelByNameOrIdParams(TypedDict):
     name_or_id: str
 
 
+class GetPredictiveModelParams(TypedDict):
+    memoryset_name_or_id: NotRequired[str | None]
+    """
+    Filter by memoryset name or ID
+    """
+
+
 class PostGpuClassificationModelByNameOrIdPredictionParams(TypedDict):
     name_or_id: str
 
@@ -1250,18 +1372,57 @@ class BootstrapLabeledMemoryDataResult(TypedDict):
 
 class ClassificationMetrics(TypedDict):
     coverage: float
+    """
+    Percentage of predictions that are not none
+    """
     f1_score: float
+    """
+    F1 score of the predictions
+    """
     accuracy: float
+    """
+    Accuracy of the predictions
+    """
     loss: float | None
+    """
+    Cross-entropy loss of the logits
+    """
     anomaly_score_mean: NotRequired[float | None]
+    """
+    Mean of anomaly scores across the dataset
+    """
     anomaly_score_median: NotRequired[float | None]
+    """
+    Median of anomaly scores across the dataset
+    """
     anomaly_score_variance: NotRequired[float | None]
+    """
+    Variance of anomaly scores across the dataset
+    """
     roc_auc: NotRequired[float | None]
+    """
+    Receiver operating characteristic area under the curve
+    """
     pr_auc: NotRequired[float | None]
+    """
+    Average precision (area under the curve of the precision-recall curve)
+    """
     pr_curve: NotRequired[PRCurve | None]
+    """
+    Precision-recall curve
+    """
     roc_curve: NotRequired[ROCCurve | None]
+    """
+    Receiver operating characteristic curve
+    """
     confusion_matrix: NotRequired[list[list[int]] | None]
+    """
+    Confusion matrix where the entry at row i, column j is the count of samples with true label i predicted as label j
+    """
     warnings: NotRequired[list[str]]
+    """
+    Human-readable warnings about skipped or adjusted metrics
+    """
 
 
 class ClassificationModelMetadata(TypedDict):
@@ -1294,7 +1455,7 @@ class ClassificationPredictionRequest(TypedDict):
     save_telemetry_synchronously: NotRequired[bool]
     prompt: NotRequired[str | None]
     use_lookup_cache: NotRequired[bool]
-    consistency_level: NotRequired[Literal["Bounded", "Session", "Strong", "Eventual"] | None]
+    consistency_level: NotRequired[Literal["Bounded", "Session", "Strong", "Eventual"]]
     ignore_unlabeled: NotRequired[bool]
     partition_ids: NotRequired[str | list[str | None] | None]
     partition_filter_mode: NotRequired[Literal["ignore_partitions", "include_global", "exclude_global", "only_global"]]
@@ -1308,6 +1469,7 @@ class CloneMemorysetRequest(TypedDict):
     finetuned_embedding_model_name_or_id: NotRequired[str | None]
     max_seq_length_override: NotRequired[int | None]
     prompt: NotRequired[str]
+    is_partitioned: NotRequired[bool | None]
 
 
 class ColumnInfo(TypedDict):
@@ -1355,6 +1517,7 @@ class CreateMemorysetFromDatasourceRequest(TypedDict):
     prompt: NotRequired[str]
     hidden: NotRequired[bool]
     memory_type: NotRequired[MemoryType | None]
+    is_partitioned: NotRequired[bool]
     datasource_name_or_id: str
     datasource_label_column: NotRequired[str | None]
     datasource_score_column: NotRequired[str | None]
@@ -1379,6 +1542,7 @@ class CreateMemorysetRequest(TypedDict):
     prompt: NotRequired[str]
     hidden: NotRequired[bool]
     memory_type: NotRequired[MemoryType | None]
+    is_partitioned: NotRequired[bool]
 
 
 class CreateRegressionModelRequest(TypedDict):
@@ -1402,6 +1566,11 @@ class DatasourceMetadata(TypedDict):
     updated_at: str
 
 
+class DeleteMemoriesRequest(TypedDict):
+    memory_ids: NotRequired[list[str] | None]
+    filters: NotRequired[list[FilterItem] | None]
+
+
 class EmbeddingEvaluationResponse(TypedDict):
     job_id: str
     org_id: str
@@ -1531,7 +1700,7 @@ class LabelPredictionWithMemoriesAndFeedback(TypedDict):
     anomaly_score: float | None
     label: int | None
     label_name: str | None
-    logits: list[float]
+    logits: list[float] | None
     timestamp: str
     input_value: str | bytes
     input_embedding: list[float]
@@ -1687,6 +1856,7 @@ class TelemetryMemoriesRequest(TypedDict):
     limit: NotRequired[int]
     filters: NotRequired[list[FilterItem | TelemetryFilterItem]]
     sort: NotRequired[list[TelemetrySortOptions] | None]
+    consistency_level: NotRequired[Literal["Bounded", "Session", "Strong", "Eventual"]]
 
 
 class WorkerInfo(TypedDict):
@@ -1702,7 +1872,10 @@ class WorkerInfo(TypedDict):
 PatchGpuMemorysetByNameOrIdMemoryRequest: TypeAlias = LabeledMemoryUpdate | ScoredMemoryUpdate
 
 
-PatchGpuMemorysetByNameOrIdMemoriesRequest: TypeAlias = list[LabeledMemoryUpdate] | list[ScoredMemoryUpdate]
+class BatchMemoryUpdateRequest(TypedDict):
+    updates: NotRequired[list[LabeledMemoryUpdate | ScoredMemoryUpdate] | None]
+    filters: NotRequired[list[FilterItem] | None]
+    patch: NotRequired[LabeledBatchMemoryUpdatePatch | ScoredBatchMemoryUpdatePatch | None]
 
 
 class CascadingEditSuggestion(TypedDict):
@@ -1750,6 +1923,7 @@ class MemorysetMetadata(TypedDict):
     document_prompt_override: str | None
     query_prompt_override: str | None
     hidden: bool
+    is_partitioned: bool
     insertion_task_id: str | None
 
 
@@ -1990,7 +2164,7 @@ class OrcaClient(Client):
         self,
         path: Literal["/memoryset"],
         *,
-        params: GetMemorysetParams,
+        params: GetMemorysetParams | None = None,
         parse_as: Literal["json"] = "json",
         headers: HeaderTypes | None = None,
         cookies: CookieTypes | None = None,
@@ -2046,7 +2220,7 @@ class OrcaClient(Client):
         follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
         timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
         extensions: RequestExtensions | None = None,
-    ) -> list[list[LabeledMemory]] | list[list[ScoredMemory]]:
+    ) -> list[list[LabeledMemory]] | list[list[ScoredMemory]] | None:
         pass
 
     @overload
@@ -2324,7 +2498,7 @@ class OrcaClient(Client):
         self,
         path: Literal["/classification_model"],
         *,
-        params: None = None,
+        params: GetClassificationModelParams | None = None,
         parse_as: Literal["json"] = "json",
         headers: HeaderTypes | None = None,
         cookies: CookieTypes | None = None,
@@ -2340,7 +2514,7 @@ class OrcaClient(Client):
         self,
         path: Literal["/regression_model"],
         *,
-        params: None = None,
+        params: GetRegressionModelParams | None = None,
         parse_as: Literal["json"] = "json",
         headers: HeaderTypes | None = None,
         cookies: CookieTypes | None = None,
@@ -2388,7 +2562,7 @@ class OrcaClient(Client):
         self,
         path: Literal["/predictive_model"],
         *,
-        params: None = None,
+        params: GetPredictiveModelParams | None = None,
         parse_as: Literal["json"] = "json",
         headers: HeaderTypes | None = None,
         cookies: CookieTypes | None = None,
@@ -2500,7 +2674,7 @@ class OrcaClient(Client):
         self,
         path: Literal["/job"],
         *,
-        params: GetJobParams,
+        params: GetJobParams | None = None,
         parse_as: Literal["json"] = "json",
         headers: HeaderTypes | None = None,
         cookies: CookieTypes | None = None,
@@ -2516,7 +2690,7 @@ class OrcaClient(Client):
         self,
         path: Literal["/worker"],
         *,
-        params: GetWorkerParams,
+        params: GetWorkerParams | None = None,
         parse_as: Literal["json"] = "json",
         headers: HeaderTypes | None = None,
         cookies: CookieTypes | None = None,
@@ -3148,7 +3322,7 @@ class OrcaClient(Client):
         follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
         timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
         extensions: RequestExtensions | None = None,
-    ) -> None:
+    ) -> DeleteMemoriesResponse:
         pass
 
     @overload
@@ -3598,6 +3772,46 @@ class OrcaClient(Client):
     ) -> EvaluationResponse:
         pass
 
+    @overload
+    def POST(
+        self,
+        path: Literal["/classification_model/metrics"],
+        *,
+        params: None = None,
+        json: ComputeClassificationMetricsRequest,
+        data: None = None,
+        files: None = None,
+        content: None = None,
+        parse_as: Literal["json"] = "json",
+        headers: HeaderTypes | None = None,
+        cookies: CookieTypes | None = None,
+        auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
+        follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
+        timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
+        extensions: RequestExtensions | None = None,
+    ) -> ClassificationMetrics:
+        pass
+
+    @overload
+    def POST(
+        self,
+        path: Literal["/regression_model/metrics"],
+        *,
+        params: None = None,
+        json: ComputeRegressionMetricsRequest,
+        data: None = None,
+        files: None = None,
+        content: None = None,
+        parse_as: Literal["json"] = "json",
+        headers: HeaderTypes | None = None,
+        cookies: CookieTypes | None = None,
+        auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT,
+        follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
+        timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
+        extensions: RequestExtensions | None = None,
+    ) -> RegressionMetrics:
+        pass
+
     @overload
     def POST(
         self,
@@ -3865,7 +4079,7 @@ class OrcaClient(Client):
         path: Literal["/gpu/memoryset/{name_or_id}/memories"],
         *,
         params: PatchGpuMemorysetByNameOrIdMemoriesParams,
-        json: PatchGpuMemorysetByNameOrIdMemoriesRequest,
+        json: BatchMemoryUpdateRequest,
         data: None = None,
         files: None = None,
         content: None = None,
@@ -3876,7 +4090,7 @@ class OrcaClient(Client):
         follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT,
         timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT,
         extensions: RequestExtensions | None = None,
-    ) -> list[LabeledMemory] | list[ScoredMemory]:
+    ) -> UpdateMemoriesResponse:
         pass
 
     @overload