together 1.5.17__py3-none-any.whl → 2.0.0a8__py3-none-any.whl

together/types/job_list_response.py

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["JobListResponse", "Data", "DataArgs", "DataStatusUpdate"]
+
+
+class DataArgs(BaseModel):
+    description: Optional[str] = None
+
+    x_model_name: Optional[str] = FieldInfo(alias="modelName", default=None)
+
+    x_model_source: Optional[str] = FieldInfo(alias="modelSource", default=None)
+
+
+class DataStatusUpdate(BaseModel):
+    message: str
+
+    status: str
+
+    timestamp: datetime
+
+
+class Data(BaseModel):
+    args: DataArgs
+
+    created_at: datetime
+
+    job_id: str
+
+    status: Literal["Queued", "Running", "Complete", "Failed"]
+
+    status_updates: List[DataStatusUpdate]
+
+    type: str
+
+    updated_at: datetime
+
+
+class JobListResponse(BaseModel):
+    data: List[Data]

together/types/job_retrieve_response.py

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["JobRetrieveResponse", "Args", "StatusUpdate"]
+
+
+class Args(BaseModel):
+    description: Optional[str] = None
+
+    x_model_name: Optional[str] = FieldInfo(alias="modelName", default=None)
+
+    x_model_source: Optional[str] = FieldInfo(alias="modelSource", default=None)
+
+
+class StatusUpdate(BaseModel):
+    message: str
+
+    status: str
+
+    timestamp: datetime
+
+
+class JobRetrieveResponse(BaseModel):
+    args: Args
+
+    created_at: datetime
+
+    job_id: str
+
+    status: Literal["Queued", "Running", "Complete", "Failed"]
+
+    status_updates: List[StatusUpdate]
+
+    type: str
+
+    updated_at: datetime

together/types/log_probs.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["LogProbs"]
+
+
+class LogProbs(BaseModel):
+    token_ids: Optional[List[float]] = None
+    """List of token IDs corresponding to the logprobs"""
+
+    token_logprobs: Optional[List[float]] = None
+    """List of token log probabilities"""
+
+    tokens: Optional[List[str]] = None
+    """List of token strings"""

together/types/model_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 .model_object import ModelObject
+
+__all__ = ["ModelListResponse"]
+
+ModelListResponse: TypeAlias = List[ModelObject]

together/types/model_object.py

@@ -0,0 +1,42 @@
+# 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__ = ["ModelObject", "Pricing"]
+
+
+class Pricing(BaseModel):
+    base: float
+
+    finetune: float
+
+    hourly: float
+
+    input: float
+
+    output: float
+
+
+class ModelObject(BaseModel):
+    id: str
+
+    created: int
+
+    object: str
+
+    type: Literal["chat", "language", "code", "image", "embedding", "moderation", "rerank"]
+
+    context_length: Optional[int] = None
+
+    display_name: Optional[str] = None
+
+    license: Optional[str] = None
+
+    link: Optional[str] = None
+
+    organization: Optional[str] = None
+
+    pricing: Optional[Pricing] = None

together/types/model_upload_params.py

@@ -0,0 +1,36 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["ModelUploadParams"]
+
+
+class ModelUploadParams(TypedDict, total=False):
+    model_name: Required[str]
+    """The name to give to your uploaded model"""
+
+    model_source: Required[str]
+    """The source location of the model (Hugging Face repo or S3 path)"""
+
+    base_model: str
+    """
+    The base model to use for an adapter if setting it to run against a serverless
+    pool. Only used for model_type `adapter`.
+    """
+
+    description: str
+    """A description of your model"""
+
+    hf_token: str
+    """Hugging Face token (if uploading from Hugging Face)"""
+
+    lora_model: str
+    """
+    The lora pool to use for an adapter if setting it to run against, say, a
+    dedicated pool. Only used for model_type `adapter`.
+    """
+
+    model_type: Literal["model", "adapter"]
+    """Whether the model is a full model or an adapter"""

together/types/model_upload_response.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["ModelUploadResponse", "Data"]
+
+
+class Data(BaseModel):
+    job_id: str
+
+    x_model_id: str = FieldInfo(alias="model_id")
+
+    x_model_name: str = FieldInfo(alias="model_name")
+
+    x_model_source: str = FieldInfo(alias="model_source")
+
+
+class ModelUploadResponse(BaseModel):
+    data: Data
+
+    message: str

together/types/rerank_create_params.py

@@ -0,0 +1,36 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Union, Iterable
+from typing_extensions import Literal, Required, TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = ["RerankCreateParams"]
+
+
+class RerankCreateParams(TypedDict, total=False):
+    documents: Required[Union[Iterable[Dict[str, object]], SequenceNotStr[str]]]
+    """List of documents, which can be either strings or objects."""
+
+    model: Required[Union[Literal["Salesforce/Llama-Rank-v1"], str]]
+    """The model to be used for the rerank request.
+
+    [See all of Together AI's rerank models](https://docs.together.ai/docs/serverless-models#rerank-models)
+    """
+
+    query: Required[str]
+    """The search query to be used for ranking."""
+
+    rank_fields: SequenceNotStr[str]
+    """List of keys in the JSON Object document to rank by.
+
+    Defaults to use all supplied keys for ranking.
+    """
+
+    return_documents: bool
+    """Whether to return supplied documents with the response."""
+
+    top_n: int
+    """The number of top results to return."""

together/types/rerank_create_response.py

@@ -0,0 +1,36 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .chat.chat_completion_usage import ChatCompletionUsage
+
+__all__ = ["RerankCreateResponse", "Result", "ResultDocument"]
+
+
+class ResultDocument(BaseModel):
+    text: Optional[str] = None
+
+
+class Result(BaseModel):
+    document: ResultDocument
+
+    index: int
+
+    relevance_score: float
+
+
+class RerankCreateResponse(BaseModel):
+    model: str
+    """The model to be used for the rerank request."""
+
+    object: Literal["rerank"]
+    """Object type"""
+
+    results: List[Result]
+
+    id: Optional[str] = None
+    """Request ID"""
+
+    usage: Optional[ChatCompletionUsage] = None

together/types/tool_choice.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["ToolChoice", "Function"]
+
+
+class Function(BaseModel):
+    arguments: str
+
+    name: str
+
+
+class ToolChoice(BaseModel):
+    id: str
+
+    function: Function
+
+    index: float
+
+    type: Literal["function"]

together/types/tool_choice_param.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["ToolChoiceParam", "Function"]
+
+
+class Function(TypedDict, total=False):
+    arguments: Required[str]
+
+    name: Required[str]
+
+
+class ToolChoiceParam(TypedDict, total=False):
+    id: Required[str]
+
+    function: Required[Function]
+
+    index: Required[float]
+
+    type: Required[Literal["function"]]

together/types/tools_param.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict
+from typing_extensions import TypedDict
+
+__all__ = ["ToolsParam", "Function"]
+
+
+class Function(TypedDict, total=False):
+    description: str
+
+    name: str
+
+    parameters: Dict[str, object]
+    """A map of parameter names to their values."""
+
+
+class ToolsParam(TypedDict, total=False):
+    function: Function
+
+    type: str

together/types/training_method_dpo.py

@@ -0,0 +1,22 @@
+# 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__ = ["TrainingMethodDpo"]
+
+
+class TrainingMethodDpo(BaseModel):
+    method: Literal["dpo"] = "dpo"
+
+    dpo_beta: Optional[float] = None
+
+    dpo_normalize_logratios_by_length: Optional[bool] = None
+
+    dpo_reference_free: Optional[bool] = None
+
+    rpo_alpha: Optional[float] = None
+
+    simpo_gamma: Optional[float] = None

together/types/training_method_sft.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Union
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["TrainingMethodSft"]
+
+
+class TrainingMethodSft(BaseModel):
+    method: Literal["sft"] = "sft"
+
+    train_on_inputs: Union[bool, Literal["auto"]]
+    """
+    Whether to mask the user messages in conversational data or prompts in
+    instruction data.
+    """

together/types/video_create_params.py

@@ -0,0 +1,86 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable
+from typing_extensions import Literal, Required, TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = ["VideoCreateParams", "FrameImage"]
+
+
+class VideoCreateParams(TypedDict, total=False):
+    model: Required[str]
+    """The model to be used for the video creation request."""
+
+    fps: int
+    """Frames per second. Defaults to 24."""
+
+    frame_images: Iterable[FrameImage]
+    """Array of images to guide video generation, similar to keyframes."""
+
+    guidance_scale: int
+    """Controls how closely the video generation follows your prompt.
+
+    Higher values make the model adhere more strictly to your text description,
+    while lower values allow more creative freedom. guidence_scale affects both
+    visual content and temporal consistency.Recommended range is 6.0-10.0 for most
+    video models. Values above 12 may cause over-guidance artifacts or unnatural
+    motion patterns.
+    """
+
+    height: int
+
+    negative_prompt: str
+    """Similar to prompt, but specifies what to avoid instead of what to include"""
+
+    output_format: Literal["MP4", "WEBM"]
+    """Specifies the format of the output video. Defaults to MP4."""
+
+    output_quality: int
+    """Compression quality. Defaults to 20."""
+
+    prompt: str
+    """Text prompt that describes the video to generate."""
+
+    reference_images: SequenceNotStr[str]
+    """
+    Unlike frame_images which constrain specific timeline positions, reference
+    images guide the general appearance that should appear consistently across the
+    video.
+    """
+
+    seconds: str
+    """Clip duration in seconds."""
+
+    seed: int
+    """Seed to use in initializing the video generation.
+
+    Using the same seed allows deterministic video generation. If not provided a
+    random seed is generated for each request.
+    """
+
+    steps: int
+    """The number of denoising steps the model performs during video generation.
+
+    More steps typically result in higher quality output but require longer
+    processing time.
+    """
+
+    width: int
+
+
+class FrameImage(TypedDict, total=False):
+    input_image: Required[str]
+    """URL path to hosted image that is used for a frame"""
+
+    frame: Union[float, Literal["first", "last"]]
+    """Optional param to specify where to insert the frame.
+
+    If this is omitted, the following heuristics are applied:
+
+    - frame_images size is one, frame is first.
+    - If size is two, frames are first and last.
+    - If size is larger, frames are first, last and evenly spaced between.
+    """

together/types/video_job.py

@@ -0,0 +1,57 @@
+# 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__ = ["VideoJob", "Error", "Outputs"]
+
+
+class Error(BaseModel):
+    message: str
+
+    code: Optional[str] = None
+
+
+class Outputs(BaseModel):
+    cost: int
+    """The cost of generated video charged to the owners account."""
+
+    video_url: str
+    """URL hosting the generated video"""
+
+
+class VideoJob(BaseModel):
+    id: str
+    """Unique identifier for the video job."""
+
+    created_at: float
+    """Unix timestamp (seconds) for when the job was created."""
+
+    model: str
+    """The video generation model that produced the job."""
+
+    seconds: str
+    """Duration of the generated clip in seconds."""
+
+    size: str
+    """The resolution of the generated video."""
+
+    status: Literal["in_progress", "completed", "failed"]
+    """Current lifecycle status of the video job."""
+
+    completed_at: Optional[float] = None
+    """Unix timestamp (seconds) for when the job completed, if finished."""
+
+    error: Optional[Error] = None
+    """Error payload that explains why generation failed, if applicable."""
+
+    object: Optional[Literal["video"]] = None
+    """The object type, which is always video."""
+
+    outputs: Optional[Outputs] = None
+    """
+    Available upon completion, the outputs provides the cost charged and the hosted
+    url to access the video
+    """