together 1.5.35__py3-none-any.whl → 2.0.0a6__py3-none-any.whl

together/types/eval_create_params.py

@@ -0,0 +1,263 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = [
+    "EvalCreateParams",
+    "Parameters",
+    "ParametersEvaluationClassifyParameters",
+    "ParametersEvaluationClassifyParametersJudge",
+    "ParametersEvaluationClassifyParametersModelToEvaluate",
+    "ParametersEvaluationClassifyParametersModelToEvaluateEvaluationModelRequest",
+    "ParametersEvaluationScoreParameters",
+    "ParametersEvaluationScoreParametersJudge",
+    "ParametersEvaluationScoreParametersModelToEvaluate",
+    "ParametersEvaluationScoreParametersModelToEvaluateEvaluationModelRequest",
+    "ParametersEvaluationCompareParameters",
+    "ParametersEvaluationCompareParametersJudge",
+    "ParametersEvaluationCompareParametersModelA",
+    "ParametersEvaluationCompareParametersModelAEvaluationModelRequest",
+    "ParametersEvaluationCompareParametersModelB",
+    "ParametersEvaluationCompareParametersModelBEvaluationModelRequest",
+]
+
+
+class EvalCreateParams(TypedDict, total=False):
+    parameters: Required[Parameters]
+    """Type-specific parameters for the evaluation"""
+
+    type: Required[Literal["classify", "score", "compare"]]
+    """The type of evaluation to perform"""
+
+
+class ParametersEvaluationClassifyParametersJudge(TypedDict, total=False):
+    model: Required[str]
+    """Name of the judge model"""
+
+    model_source: Required[Literal["serverless", "dedicated", "external"]]
+    """Source of the judge model."""
+
+    system_template: Required[str]
+    """System prompt template for the judge"""
+
+    external_api_token: str
+    """Bearer/API token for external judge models."""
+
+    external_base_url: str
+    """Base URL for external judge models. Must be OpenAI-compatible base URL."""
+
+
+class ParametersEvaluationClassifyParametersModelToEvaluateEvaluationModelRequest(TypedDict, total=False):
+    input_template: Required[str]
+    """Input prompt template"""
+
+    max_tokens: Required[int]
+    """Maximum number of tokens to generate"""
+
+    model: Required[str]
+    """Name of the model to evaluate"""
+
+    model_source: Required[Literal["serverless", "dedicated", "external"]]
+    """Source of the model."""
+
+    system_template: Required[str]
+    """System prompt template"""
+
+    temperature: Required[float]
+    """Sampling temperature"""
+
+    external_api_token: str
+    """Bearer/API token for external models."""
+
+    external_base_url: str
+    """Base URL for external models. Must be OpenAI-compatible base URL"""
+
+
+ParametersEvaluationClassifyParametersModelToEvaluate: TypeAlias = Union[
+    str, ParametersEvaluationClassifyParametersModelToEvaluateEvaluationModelRequest
+]
+
+
+class ParametersEvaluationClassifyParameters(TypedDict, total=False):
+    input_data_file_path: Required[str]
+    """Data file ID"""
+
+    judge: Required[ParametersEvaluationClassifyParametersJudge]
+
+    labels: Required[SequenceNotStr[str]]
+    """List of possible classification labels"""
+
+    pass_labels: Required[SequenceNotStr[str]]
+    """List of labels that are considered passing"""
+
+    model_to_evaluate: ParametersEvaluationClassifyParametersModelToEvaluate
+    """Field name in the input data"""
+
+
+class ParametersEvaluationScoreParametersJudge(TypedDict, total=False):
+    model: Required[str]
+    """Name of the judge model"""
+
+    model_source: Required[Literal["serverless", "dedicated", "external"]]
+    """Source of the judge model."""
+
+    system_template: Required[str]
+    """System prompt template for the judge"""
+
+    external_api_token: str
+    """Bearer/API token for external judge models."""
+
+    external_base_url: str
+    """Base URL for external judge models. Must be OpenAI-compatible base URL."""
+
+
+class ParametersEvaluationScoreParametersModelToEvaluateEvaluationModelRequest(TypedDict, total=False):
+    input_template: Required[str]
+    """Input prompt template"""
+
+    max_tokens: Required[int]
+    """Maximum number of tokens to generate"""
+
+    model: Required[str]
+    """Name of the model to evaluate"""
+
+    model_source: Required[Literal["serverless", "dedicated", "external"]]
+    """Source of the model."""
+
+    system_template: Required[str]
+    """System prompt template"""
+
+    temperature: Required[float]
+    """Sampling temperature"""
+
+    external_api_token: str
+    """Bearer/API token for external models."""
+
+    external_base_url: str
+    """Base URL for external models. Must be OpenAI-compatible base URL"""
+
+
+ParametersEvaluationScoreParametersModelToEvaluate: TypeAlias = Union[
+    str, ParametersEvaluationScoreParametersModelToEvaluateEvaluationModelRequest
+]
+
+
+class ParametersEvaluationScoreParameters(TypedDict, total=False):
+    input_data_file_path: Required[str]
+    """Data file ID"""
+
+    judge: Required[ParametersEvaluationScoreParametersJudge]
+
+    max_score: Required[float]
+    """Maximum possible score"""
+
+    min_score: Required[float]
+    """Minimum possible score"""
+
+    pass_threshold: Required[float]
+    """Score threshold for passing"""
+
+    model_to_evaluate: ParametersEvaluationScoreParametersModelToEvaluate
+    """Field name in the input data"""
+
+
+class ParametersEvaluationCompareParametersJudge(TypedDict, total=False):
+    model: Required[str]
+    """Name of the judge model"""
+
+    model_source: Required[Literal["serverless", "dedicated", "external"]]
+    """Source of the judge model."""
+
+    system_template: Required[str]
+    """System prompt template for the judge"""
+
+    external_api_token: str
+    """Bearer/API token for external judge models."""
+
+    external_base_url: str
+    """Base URL for external judge models. Must be OpenAI-compatible base URL."""
+
+
+class ParametersEvaluationCompareParametersModelAEvaluationModelRequest(TypedDict, total=False):
+    input_template: Required[str]
+    """Input prompt template"""
+
+    max_tokens: Required[int]
+    """Maximum number of tokens to generate"""
+
+    model: Required[str]
+    """Name of the model to evaluate"""
+
+    model_source: Required[Literal["serverless", "dedicated", "external"]]
+    """Source of the model."""
+
+    system_template: Required[str]
+    """System prompt template"""
+
+    temperature: Required[float]
+    """Sampling temperature"""
+
+    external_api_token: str
+    """Bearer/API token for external models."""
+
+    external_base_url: str
+    """Base URL for external models. Must be OpenAI-compatible base URL"""
+
+
+ParametersEvaluationCompareParametersModelA: TypeAlias = Union[
+    str, ParametersEvaluationCompareParametersModelAEvaluationModelRequest
+]
+
+
+class ParametersEvaluationCompareParametersModelBEvaluationModelRequest(TypedDict, total=False):
+    input_template: Required[str]
+    """Input prompt template"""
+
+    max_tokens: Required[int]
+    """Maximum number of tokens to generate"""
+
+    model: Required[str]
+    """Name of the model to evaluate"""
+
+    model_source: Required[Literal["serverless", "dedicated", "external"]]
+    """Source of the model."""
+
+    system_template: Required[str]
+    """System prompt template"""
+
+    temperature: Required[float]
+    """Sampling temperature"""
+
+    external_api_token: str
+    """Bearer/API token for external models."""
+
+    external_base_url: str
+    """Base URL for external models. Must be OpenAI-compatible base URL"""
+
+
+ParametersEvaluationCompareParametersModelB: TypeAlias = Union[
+    str, ParametersEvaluationCompareParametersModelBEvaluationModelRequest
+]
+
+
+class ParametersEvaluationCompareParameters(TypedDict, total=False):
+    input_data_file_path: Required[str]
+    """Data file name"""
+
+    judge: Required[ParametersEvaluationCompareParametersJudge]
+
+    model_a: ParametersEvaluationCompareParametersModelA
+    """Field name in the input data"""
+
+    model_b: ParametersEvaluationCompareParametersModelB
+    """Field name in the input data"""
+
+
+Parameters: TypeAlias = Union[
+    ParametersEvaluationClassifyParameters, ParametersEvaluationScoreParameters, ParametersEvaluationCompareParameters
+]

together/types/eval_create_response.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["EvalCreateResponse"]
+
+
+class EvalCreateResponse(BaseModel):
+    status: Optional[Literal["pending"]] = None
+    """Initial status of the job"""
+
+    workflow_id: Optional[str] = None
+    """The ID of the created evaluation job"""

together/types/eval_list_params.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["EvalListParams"]
+
+
+class EvalListParams(TypedDict, total=False):
+    limit: int
+
+    status: str
+
+    user_id: Annotated[str, PropertyInfo(alias="userId")]
+    """Admin users can specify a user ID to filter jobs.
+
+    Pass empty string to get all jobs.
+    """

together/types/eval_list_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .evaluation_job import EvaluationJob
+
+__all__ = ["EvalListResponse"]
+
+EvalListResponse: TypeAlias = List[EvaluationJob]

together/types/eval_status_response.py

@@ -0,0 +1,100 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Union, Optional
+from typing_extensions import Literal, TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = [
+    "EvalStatusResponse",
+    "Results",
+    "ResultsEvaluationClassifyResults",
+    "ResultsEvaluationScoreResults",
+    "ResultsEvaluationScoreResultsAggregatedScores",
+    "ResultsEvaluationCompareResults",
+]
+
+
+class ResultsEvaluationClassifyResults(BaseModel):
+    generation_fail_count: Optional[float] = None
+    """Number of failed generations."""
+
+    invalid_label_count: Optional[float] = None
+    """Number of invalid labels"""
+
+    judge_fail_count: Optional[float] = None
+    """Number of failed judge generations"""
+
+    label_counts: Optional[str] = None
+    """JSON string representing label counts"""
+
+    pass_percentage: Optional[float] = None
+    """Pecentage of pass labels."""
+
+    result_file_id: Optional[str] = None
+    """Data File ID"""
+
+
+class ResultsEvaluationScoreResultsAggregatedScores(BaseModel):
+    mean_score: Optional[float] = None
+
+    pass_percentage: Optional[float] = None
+
+    std_score: Optional[float] = None
+
+
+class ResultsEvaluationScoreResults(BaseModel):
+    aggregated_scores: Optional[ResultsEvaluationScoreResultsAggregatedScores] = None
+
+    failed_samples: Optional[float] = None
+    """number of failed samples generated from model"""
+
+    generation_fail_count: Optional[float] = None
+    """Number of failed generations."""
+
+    invalid_score_count: Optional[float] = None
+    """number of invalid scores generated from model"""
+
+    judge_fail_count: Optional[float] = None
+    """Number of failed judge generations"""
+
+    result_file_id: Optional[str] = None
+    """Data File ID"""
+
+
+class ResultsEvaluationCompareResults(BaseModel):
+    a_wins: Optional[int] = FieldInfo(alias="A_wins", default=None)
+    """Number of times model A won"""
+
+    b_wins: Optional[int] = FieldInfo(alias="B_wins", default=None)
+    """Number of times model B won"""
+
+    generation_fail_count: Optional[float] = None
+    """Number of failed generations."""
+
+    judge_fail_count: Optional[float] = None
+    """Number of failed judge generations"""
+
+    num_samples: Optional[int] = None
+    """Total number of samples compared"""
+
+    result_file_id: Optional[str] = None
+    """Data File ID"""
+
+    ties: Optional[int] = FieldInfo(alias="Ties", default=None)
+    """Number of ties"""
+
+
+Results: TypeAlias = Union[
+    ResultsEvaluationClassifyResults, ResultsEvaluationScoreResults, ResultsEvaluationCompareResults
+]
+
+
+class EvalStatusResponse(BaseModel):
+    results: Optional[Results] = None
+    """The results of the evaluation job"""
+
+    status: Optional[Literal["completed", "error", "user_error", "running", "queued", "pending"]] = None
+    """The status of the evaluation job"""

together/types/evaluation_job.py

@@ -0,0 +1,139 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = [
+    "EvaluationJob",
+    "Results",
+    "ResultsEvaluationClassifyResults",
+    "ResultsEvaluationScoreResults",
+    "ResultsEvaluationScoreResultsAggregatedScores",
+    "ResultsEvaluationCompareResults",
+    "ResultsError",
+    "StatusUpdate",
+]
+
+
+class ResultsEvaluationClassifyResults(BaseModel):
+    generation_fail_count: Optional[float] = None
+    """Number of failed generations."""
+
+    invalid_label_count: Optional[float] = None
+    """Number of invalid labels"""
+
+    judge_fail_count: Optional[float] = None
+    """Number of failed judge generations"""
+
+    label_counts: Optional[str] = None
+    """JSON string representing label counts"""
+
+    pass_percentage: Optional[float] = None
+    """Pecentage of pass labels."""
+
+    result_file_id: Optional[str] = None
+    """Data File ID"""
+
+
+class ResultsEvaluationScoreResultsAggregatedScores(BaseModel):
+    mean_score: Optional[float] = None
+
+    pass_percentage: Optional[float] = None
+
+    std_score: Optional[float] = None
+
+
+class ResultsEvaluationScoreResults(BaseModel):
+    aggregated_scores: Optional[ResultsEvaluationScoreResultsAggregatedScores] = None
+
+    failed_samples: Optional[float] = None
+    """number of failed samples generated from model"""
+
+    generation_fail_count: Optional[float] = None
+    """Number of failed generations."""
+
+    invalid_score_count: Optional[float] = None
+    """number of invalid scores generated from model"""
+
+    judge_fail_count: Optional[float] = None
+    """Number of failed judge generations"""
+
+    result_file_id: Optional[str] = None
+    """Data File ID"""
+
+
+class ResultsEvaluationCompareResults(BaseModel):
+    a_wins: Optional[int] = FieldInfo(alias="A_wins", default=None)
+    """Number of times model A won"""
+
+    b_wins: Optional[int] = FieldInfo(alias="B_wins", default=None)
+    """Number of times model B won"""
+
+    generation_fail_count: Optional[float] = None
+    """Number of failed generations."""
+
+    judge_fail_count: Optional[float] = None
+    """Number of failed judge generations"""
+
+    num_samples: Optional[int] = None
+    """Total number of samples compared"""
+
+    result_file_id: Optional[str] = None
+    """Data File ID"""
+
+    ties: Optional[int] = FieldInfo(alias="Ties", default=None)
+    """Number of ties"""
+
+
+class ResultsError(BaseModel):
+    error: Optional[str] = None
+
+
+Results: TypeAlias = Union[
+    ResultsEvaluationClassifyResults, ResultsEvaluationScoreResults, ResultsEvaluationCompareResults, ResultsError, None
+]
+
+
+class StatusUpdate(BaseModel):
+    message: Optional[str] = None
+    """Additional message for this update"""
+
+    status: Optional[str] = None
+    """The status at this update"""
+
+    timestamp: Optional[datetime] = None
+    """When this update occurred"""
+
+
+class EvaluationJob(BaseModel):
+    created_at: Optional[datetime] = None
+    """When the job was created"""
+
+    owner_id: Optional[str] = None
+    """ID of the job owner (admin only)"""
+
+    parameters: Optional[Dict[str, object]] = None
+    """The parameters used for this evaluation"""
+
+    results: Optional[Results] = None
+    """Results of the evaluation (when completed)"""
+
+    status: Optional[Literal["pending", "queued", "running", "completed", "error", "user_error"]] = None
+    """Current status of the job"""
+
+    status_updates: Optional[List[StatusUpdate]] = None
+    """History of status updates (admin only)"""
+
+    type: Optional[Literal["classify", "score", "compare"]] = None
+    """The type of evaluation"""
+
+    updated_at: Optional[datetime] = None
+    """When the job was last updated"""
+
+    workflow_id: Optional[str] = None
+    """The evaluation job ID"""

together/types/execute_response.py

@@ -0,0 +1,108 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Union, Optional
+from typing_extensions import Literal, Annotated, TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from .._utils import PropertyInfo
+from .._models import BaseModel
+
+__all__ = [
+    "ExecuteResponse",
+    "SuccessfulExecution",
+    "SuccessfulExecutionData",
+    "SuccessfulExecutionDataOutput",
+    "SuccessfulExecutionDataOutputStreamOutput",
+    "SuccessfulExecutionDataOutputError",
+    "SuccessfulExecutionDataOutputDisplayorExecuteOutput",
+    "SuccessfulExecutionDataOutputDisplayorExecuteOutputData",
+    "FailedExecution",
+]
+
+
+class SuccessfulExecutionDataOutputStreamOutput(BaseModel):
+    data: str
+
+    type: Literal["stdout", "stderr"]
+
+
+class SuccessfulExecutionDataOutputError(BaseModel):
+    data: str
+
+    type: Literal["error"]
+
+
+class SuccessfulExecutionDataOutputDisplayorExecuteOutputData(BaseModel):
+    application_geo_json: Optional[Dict[str, object]] = FieldInfo(alias="application/geo+json", default=None)
+
+    application_javascript: Optional[str] = FieldInfo(alias="application/javascript", default=None)
+
+    application_json: Optional[Dict[str, object]] = FieldInfo(alias="application/json", default=None)
+
+    application_pdf: Optional[str] = FieldInfo(alias="application/pdf", default=None)
+
+    application_vnd_vega_v5_json: Optional[Dict[str, object]] = FieldInfo(
+        alias="application/vnd.vega.v5+json", default=None
+    )
+
+    application_vnd_vegalite_v4_json: Optional[Dict[str, object]] = FieldInfo(
+        alias="application/vnd.vegalite.v4+json", default=None
+    )
+
+    image_gif: Optional[str] = FieldInfo(alias="image/gif", default=None)
+
+    image_jpeg: Optional[str] = FieldInfo(alias="image/jpeg", default=None)
+
+    image_png: Optional[str] = FieldInfo(alias="image/png", default=None)
+
+    image_svg_xml: Optional[str] = FieldInfo(alias="image/svg+xml", default=None)
+
+    text_html: Optional[str] = FieldInfo(alias="text/html", default=None)
+
+    text_latex: Optional[str] = FieldInfo(alias="text/latex", default=None)
+
+    text_markdown: Optional[str] = FieldInfo(alias="text/markdown", default=None)
+
+    text_plain: Optional[str] = FieldInfo(alias="text/plain", default=None)
+
+
+class SuccessfulExecutionDataOutputDisplayorExecuteOutput(BaseModel):
+    data: SuccessfulExecutionDataOutputDisplayorExecuteOutputData
+
+    type: Literal["display_data", "execute_result"]
+
+
+SuccessfulExecutionDataOutput: TypeAlias = Annotated[
+    Union[
+        SuccessfulExecutionDataOutputStreamOutput,
+        SuccessfulExecutionDataOutputError,
+        SuccessfulExecutionDataOutputDisplayorExecuteOutput,
+    ],
+    PropertyInfo(discriminator="type"),
+]
+
+
+class SuccessfulExecutionData(BaseModel):
+    outputs: List[SuccessfulExecutionDataOutput]
+
+    session_id: str
+    """Identifier of the current session. Used to make follow-up calls."""
+
+    status: Optional[Literal["success"]] = None
+    """Status of the execution. Currently only supports success."""
+
+
+class SuccessfulExecution(BaseModel):
+    data: SuccessfulExecutionData
+
+    errors: None = None
+
+
+class FailedExecution(BaseModel):
+    data: None = None
+
+    errors: List[Union[str, Dict[str, object]]]
+
+
+ExecuteResponse: TypeAlias = Union[SuccessfulExecution, FailedExecution]

together/types/file_delete_response.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["FileDeleteResponse"]
+
+
+class FileDeleteResponse(BaseModel):
+    id: Optional[str] = None
+
+    deleted: Optional[bool] = None

together/types/file_list.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from .._models import BaseModel
+from .file_response import FileResponse
+
+__all__ = ["FileList"]
+
+
+class FileList(BaseModel):
+    data: List[FileResponse]