scale-gp-beta 0.1.0a35__py3-none-any.whl → 0.1.0a37__py3-none-any.whl

scale_gp_beta/resources/questions.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Any, cast
+from typing import Any, Dict, Iterable, cast
 from typing_extensions import Literal, overload
 
 import httpx
@@ -52,6 +52,7 @@ class QuestionsResource(SyncAPIResource):
         configuration: question_create_params.CategoricalQuestionRequestConfiguration,
         name: str,
         prompt: str,
+        conditions: Iterable[Dict[str, object]] | Omit = omit,
         question_type: Literal["categorical"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -66,6 +67,8 @@ class QuestionsResource(SyncAPIResource):
         Args:
           prompt: user-facing question prompt
 
+          conditions: Conditions for the question to be shown
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -83,6 +86,7 @@ class QuestionsResource(SyncAPIResource):
         configuration: question_create_params.RatingQuestionRequestConfiguration,
         name: str,
         prompt: str,
+        conditions: Iterable[Dict[str, object]] | Omit = omit,
         question_type: Literal["rating"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -97,6 +101,8 @@ class QuestionsResource(SyncAPIResource):
         Args:
           prompt: user-facing question prompt
 
+          conditions: Conditions for the question to be shown
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -113,6 +119,7 @@ class QuestionsResource(SyncAPIResource):
         *,
         name: str,
         prompt: str,
+        conditions: Iterable[Dict[str, object]] | Omit = omit,
         configuration: question_create_params.NumberQuestionRequestConfiguration | Omit = omit,
         question_type: Literal["number"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -128,6 +135,8 @@ class QuestionsResource(SyncAPIResource):
         Args:
           prompt: user-facing question prompt
 
+          conditions: Conditions for the question to be shown
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -144,6 +153,7 @@ class QuestionsResource(SyncAPIResource):
         *,
         name: str,
         prompt: str,
+        conditions: Iterable[Dict[str, object]] | Omit = omit,
         configuration: question_create_params.FreeTextQuestionRequestConfiguration | Omit = omit,
         question_type: Literal["free_text"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -159,6 +169,8 @@ class QuestionsResource(SyncAPIResource):
         Args:
           prompt: user-facing question prompt
 
+          conditions: Conditions for the question to be shown
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -176,6 +188,7 @@ class QuestionsResource(SyncAPIResource):
         configuration: question_create_params.FormQuestionRequestConfiguration,
         name: str,
         prompt: str,
+        conditions: Iterable[Dict[str, object]] | Omit = omit,
         question_type: Literal["form"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -190,6 +203,42 @@ class QuestionsResource(SyncAPIResource):
         Args:
           prompt: user-facing question prompt
 
+          conditions: Conditions for the question to be shown
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        ...
+
+    @overload
+    def create(
+        self,
+        *,
+        name: str,
+        prompt: str,
+        conditions: Iterable[Dict[str, object]] | Omit = omit,
+        configuration: question_create_params.TimestampQuestionRequestConfiguration | Omit = omit,
+        question_type: Literal["timestamp"] | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> Question:
+        """
+        Create Question
+
+        Args:
+          prompt: user-facing question prompt
+
+          conditions: Conditions for the question to be shown
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -209,14 +258,17 @@ class QuestionsResource(SyncAPIResource):
         | question_create_params.NumberQuestionRequestConfiguration
         | question_create_params.FreeTextQuestionRequestConfiguration
         | question_create_params.FormQuestionRequestConfiguration
+        | question_create_params.TimestampQuestionRequestConfiguration
         | Omit = omit,
         name: str,
         prompt: str,
+        conditions: Iterable[Dict[str, object]] | Omit = omit,
         question_type: Literal["categorical"]
         | Literal["rating"]
         | Literal["number"]
         | Literal["free_text"]
         | Literal["form"]
+        | Literal["timestamp"]
         | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -234,6 +286,7 @@ class QuestionsResource(SyncAPIResource):
                         "configuration": configuration,
                         "name": name,
                         "prompt": prompt,
+                        "conditions": conditions,
                         "question_type": question_type,
                     },
                     question_create_params.QuestionCreateParams,
@@ -356,6 +409,7 @@ class AsyncQuestionsResource(AsyncAPIResource):
         configuration: question_create_params.CategoricalQuestionRequestConfiguration,
         name: str,
         prompt: str,
+        conditions: Iterable[Dict[str, object]] | Omit = omit,
         question_type: Literal["categorical"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -370,6 +424,8 @@ class AsyncQuestionsResource(AsyncAPIResource):
         Args:
           prompt: user-facing question prompt
 
+          conditions: Conditions for the question to be shown
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -387,6 +443,7 @@ class AsyncQuestionsResource(AsyncAPIResource):
         configuration: question_create_params.RatingQuestionRequestConfiguration,
         name: str,
         prompt: str,
+        conditions: Iterable[Dict[str, object]] | Omit = omit,
         question_type: Literal["rating"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -401,6 +458,8 @@ class AsyncQuestionsResource(AsyncAPIResource):
         Args:
           prompt: user-facing question prompt
 
+          conditions: Conditions for the question to be shown
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -417,6 +476,7 @@ class AsyncQuestionsResource(AsyncAPIResource):
         *,
         name: str,
         prompt: str,
+        conditions: Iterable[Dict[str, object]] | Omit = omit,
         configuration: question_create_params.NumberQuestionRequestConfiguration | Omit = omit,
         question_type: Literal["number"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -432,6 +492,8 @@ class AsyncQuestionsResource(AsyncAPIResource):
         Args:
           prompt: user-facing question prompt
 
+          conditions: Conditions for the question to be shown
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -448,6 +510,7 @@ class AsyncQuestionsResource(AsyncAPIResource):
         *,
         name: str,
         prompt: str,
+        conditions: Iterable[Dict[str, object]] | Omit = omit,
         configuration: question_create_params.FreeTextQuestionRequestConfiguration | Omit = omit,
         question_type: Literal["free_text"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -463,6 +526,8 @@ class AsyncQuestionsResource(AsyncAPIResource):
         Args:
           prompt: user-facing question prompt
 
+          conditions: Conditions for the question to be shown
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -480,6 +545,7 @@ class AsyncQuestionsResource(AsyncAPIResource):
         configuration: question_create_params.FormQuestionRequestConfiguration,
         name: str,
         prompt: str,
+        conditions: Iterable[Dict[str, object]] | Omit = omit,
         question_type: Literal["form"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -494,6 +560,42 @@ class AsyncQuestionsResource(AsyncAPIResource):
         Args:
           prompt: user-facing question prompt
 
+          conditions: Conditions for the question to be shown
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        ...
+
+    @overload
+    async def create(
+        self,
+        *,
+        name: str,
+        prompt: str,
+        conditions: Iterable[Dict[str, object]] | Omit = omit,
+        configuration: question_create_params.TimestampQuestionRequestConfiguration | Omit = omit,
+        question_type: Literal["timestamp"] | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> Question:
+        """
+        Create Question
+
+        Args:
+          prompt: user-facing question prompt
+
+          conditions: Conditions for the question to be shown
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -513,14 +615,17 @@ class AsyncQuestionsResource(AsyncAPIResource):
         | question_create_params.NumberQuestionRequestConfiguration
         | question_create_params.FreeTextQuestionRequestConfiguration
         | question_create_params.FormQuestionRequestConfiguration
+        | question_create_params.TimestampQuestionRequestConfiguration
         | Omit = omit,
         name: str,
         prompt: str,
+        conditions: Iterable[Dict[str, object]] | Omit = omit,
         question_type: Literal["categorical"]
         | Literal["rating"]
         | Literal["number"]
         | Literal["free_text"]
         | Literal["form"]
+        | Literal["timestamp"]
         | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -538,6 +643,7 @@ class AsyncQuestionsResource(AsyncAPIResource):
                         "configuration": configuration,
                         "name": name,
                         "prompt": prompt,
+                        "conditions": conditions,
                         "question_type": question_type,
                     },
                     question_create_params.QuestionCreateParams,

scale_gp_beta/types/dataset_create_params.py

@@ -18,5 +18,8 @@ class DatasetCreateParams(TypedDict, total=False):
 
     description: str
 
+    files: Iterable[Dict[str, str]]
+    """Files to be associated to the dataset"""
+
     tags: SequenceNotStr[str]
     """The tags associated with the entity"""

scale_gp_beta/types/dataset_item.py

@@ -1,6 +1,6 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Optional
+from typing import Dict, Optional
 from datetime import datetime
 from typing_extensions import Literal
 
@@ -28,4 +28,6 @@ class DatasetItem(BaseModel):
 
     dataset_id: Optional[str] = None
 
+    files: Optional[Dict[str, str]] = None
+
     object: Optional[Literal["dataset.item"]] = None

scale_gp_beta/types/dataset_item_batch_create_params.py

@@ -14,3 +14,6 @@ class DatasetItemBatchCreateParams(TypedDict, total=False):
 
     dataset_id: Required[str]
     """Identifier of the target dataset"""
+
+    files: Iterable[Dict[str, str]]
+    """Files to be associated to the dataset"""

scale_gp_beta/types/dataset_item_update_params.py

@@ -11,3 +11,6 @@ __all__ = ["DatasetItemUpdateParams"]
 class DatasetItemUpdateParams(TypedDict, total=False):
     data: Required[Dict[str, object]]
     """Updated dataset item data"""
+
+    files: Dict[str, str]
+    """Files to be associated to the dataset"""

scale_gp_beta/types/dataset_update_params.py

@@ -2,17 +2,26 @@
 
 from __future__ import annotations
 
-from typing_extensions import TypedDict
+from typing import Union
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
 from .._types import SequenceNotStr
 
-__all__ = ["DatasetUpdateParams"]
+__all__ = ["DatasetUpdateParams", "PartialDatasetRequestBase", "RestoreRequest"]
 
 
-class DatasetUpdateParams(TypedDict, total=False):
+class PartialDatasetRequestBase(TypedDict, total=False):
     description: str
 
     name: str
 
     tags: SequenceNotStr[str]
     """The tags associated with the entity"""
+
+
+class RestoreRequest(TypedDict, total=False):
+    restore: Required[Literal[True]]
+    """Set to true to restore the entity from the database."""
+
+
+DatasetUpdateParams: TypeAlias = Union[PartialDatasetRequestBase, RestoreRequest]

scale_gp_beta/types/evaluation.py

@@ -10,7 +10,43 @@ from .dataset import Dataset
 from .._models import BaseModel
 from .shared.identity import Identity
 
-__all__ = ["Evaluation"]
+__all__ = ["Evaluation", "Progress", "ProgressItems", "ProgressItemsFailedItem", "ProgressWorkflows"]
+
+
+class ProgressItemsFailedItem(BaseModel):
+    item_id: str
+
+    error: Optional[str] = None
+
+    error_type: Optional[str] = None
+
+
+class ProgressItems(BaseModel):
+    failed: int
+
+    pending: int
+
+    successful: int
+
+    total: int
+
+    failed_items: Optional[List[ProgressItemsFailedItem]] = None
+
+
+class ProgressWorkflows(BaseModel):
+    completed: int
+
+    failed: int
+
+    pending: int
+
+    total: int
+
+
+class Progress(BaseModel):
+    items: Optional[ProgressItems] = None
+
+    workflows: Optional[ProgressWorkflows] = None
 
 
 class Evaluation(BaseModel):
@@ -39,6 +75,9 @@ class Evaluation(BaseModel):
 
     object: Optional[Literal["evaluation"]] = None
 
+    progress: Optional[Progress] = None
+    """Progress of the evaluation's underlying async job"""
+
     status_reason: Optional[str] = None
     """Reason for evaluation status"""
 

scale_gp_beta/types/evaluation_create_params.py

@@ -25,6 +25,9 @@ class EvaluationStandaloneCreateRequest(TypedDict, total=False):
 
     description: str
 
+    files: Iterable[Dict[str, str]]
+    """Files to be associated to the evaluation"""
+
     metadata: Dict[str, object]
     """Optional metadata key-value pairs for the evaluation"""
 
@@ -76,6 +79,9 @@ class EvaluationWithDatasetCreateRequest(TypedDict, total=False):
 
     description: str
 
+    files: Iterable[Dict[str, str]]
+    """Files to be associated to the evaluation"""
+
     metadata: Dict[str, object]
     """Optional metadata key-value pairs for the evaluation"""
 

scale_gp_beta/types/evaluation_item.py

@@ -28,4 +28,6 @@ class EvaluationItem(BaseModel):
 
     dataset_item_version_num: Optional[int] = None
 
+    files: Optional[Dict[str, str]] = None
+
     object: Optional[Literal["evaluation.item"]] = None

scale_gp_beta/types/evaluation_task.py

@@ -575,6 +575,9 @@ class ContributorEvaluationQuestionTaskConfiguration(BaseModel):
     queue_id: Optional[str] = None
     """The contributor annotation queue to include this task in. Defaults to `default`"""
 
+    required: Optional[bool] = None
+    """Whether the question is required to be answered"""
+
 
 class ContributorEvaluationQuestionTask(BaseModel):
     configuration: ContributorEvaluationQuestionTaskConfiguration

scale_gp_beta/types/evaluation_task_param.py

@@ -574,6 +574,9 @@ class ContributorEvaluationQuestionTaskConfiguration(TypedDict, total=False):
     queue_id: str
     """The contributor annotation queue to include this task in. Defaults to `default`"""
 
+    required: bool
+    """Whether the question is required to be answered"""
+
 
 class ContributorEvaluationQuestionTask(TypedDict, total=False):
     configuration: Required[ContributorEvaluationQuestionTaskConfiguration]

scale_gp_beta/types/file.py

@@ -27,6 +27,8 @@ class File(BaseModel):
 
     size: int
 
+    duration_seconds: Optional[int] = None
+
     object: Optional[Literal["file"]] = None
 
     tags: Optional[Dict[str, builtins.object]] = None

scale_gp_beta/types/question.py

@@ -20,6 +20,8 @@ __all__ = [
     "FreeTextQuestionConfiguration",
     "FormQuestion",
     "FormQuestionConfiguration",
+    "TimestampQuestion",
+    "TimestampQuestionConfiguration",
 ]
 
 
@@ -27,6 +29,12 @@ class CategoricalQuestionConfiguration(BaseModel):
     choices: List[str]
     """Categorical answer choices (must contain at least one entry)"""
 
+    dropdown: Optional[bool] = None
+    """Whether the question is displayed as a dropdown in the UI."""
+
+    multi: Optional[bool] = None
+    """Whether the question allows multiple answers."""
+
 
 class CategoricalQuestion(BaseModel):
     id: str
@@ -45,6 +53,9 @@ class CategoricalQuestion(BaseModel):
     prompt: str
     """user-facing question prompt"""
 
+    conditions: Optional[List[Dict[str, object]]] = None
+    """Conditions for the question to be shown"""
+
     object: Optional[Literal["question"]] = None
 
     question_type: Optional[Literal["categorical"]] = None
@@ -78,6 +89,9 @@ class RatingQuestion(BaseModel):
     prompt: str
     """user-facing question prompt"""
 
+    conditions: Optional[List[Dict[str, object]]] = None
+    """Conditions for the question to be shown"""
+
     object: Optional[Literal["question"]] = None
 
     question_type: Optional[Literal["rating"]] = None
@@ -106,6 +120,9 @@ class NumberQuestion(BaseModel):
     prompt: str
     """user-facing question prompt"""
 
+    conditions: Optional[List[Dict[str, object]]] = None
+    """Conditions for the question to be shown"""
+
     configuration: Optional[NumberQuestionConfiguration] = None
 
     object: Optional[Literal["question"]] = None
@@ -136,6 +153,9 @@ class FreeTextQuestion(BaseModel):
     prompt: str
     """user-facing question prompt"""
 
+    conditions: Optional[List[Dict[str, object]]] = None
+    """Conditions for the question to be shown"""
+
     configuration: Optional[FreeTextQuestionConfiguration] = None
 
     object: Optional[Literal["question"]] = None
@@ -165,12 +185,45 @@ class FormQuestion(BaseModel):
     prompt: str
     """user-facing question prompt"""
 
+    conditions: Optional[List[Dict[str, object]]] = None
+    """Conditions for the question to be shown"""
+
     object: Optional[Literal["question"]] = None
 
     question_type: Optional[Literal["form"]] = None
 
 
+class TimestampQuestionConfiguration(BaseModel):
+    allow_multi_timestamps: Optional[bool] = None
+    """Whether to allow multiple media timestamps"""
+
+
+class TimestampQuestion(BaseModel):
+    id: str
+    """Unique identifier of the entity"""
+
+    created_at: datetime
+    """ISO-timestamp when the entity was created"""
+
+    created_by: Identity
+    """The identity that created the entity."""
+
+    name: str
+
+    prompt: str
+    """user-facing question prompt"""
+
+    conditions: Optional[List[Dict[str, object]]] = None
+    """Conditions for the question to be shown"""
+
+    configuration: Optional[TimestampQuestionConfiguration] = None
+
+    object: Optional[Literal["question"]] = None
+
+    question_type: Optional[Literal["timestamp"]] = None
+
+
 Question: TypeAlias = Annotated[
-    Union[CategoricalQuestion, RatingQuestion, NumberQuestion, FreeTextQuestion, FormQuestion],
+    Union[CategoricalQuestion, RatingQuestion, NumberQuestion, FreeTextQuestion, FormQuestion, TimestampQuestion],
     PropertyInfo(discriminator="question_type"),
 ]