synapsai-python 0.1.0__py3-none-any.whl

synapsai/types/completion.py

@@ -0,0 +1,244 @@
+# Copyright 2026 SynapsAI Technologies Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Chat completion type definitions
+"""
+
+from typing import Optional, Dict, Any, Union, List, Literal
+from pydantic import BaseModel, Field, ConfigDict
+from enum import Enum
+
+from .common import APIResponse, FinishReason, Usage
+
+
+class ChatRole(str, Enum):
+    """Chat message roles"""
+    SYSTEM = "system"
+    USER = "user"
+    ASSISTANT = "assistant"
+    FUNCTION = "function"
+    TOOL = "tool"
+    DEVELOPER = "developer"
+
+
+class ReasoningEffort(str, Enum):
+    """Reasoning effort levels for reasoning models (vLLM only)"""
+    NONE = "none"
+    MINIMAL = "minimal"
+    LOW = "low"
+    MEDIUM = "medium"
+    HIGH = "high"
+    XHIGH = "xhigh"
+    MAX = "max"
+
+
+class FunctionCall(BaseModel):
+    """Function call object (legacy; prefer tool_calls)"""
+    name: str
+    arguments: str
+
+
+class ChatCompletionMessageToolCallFunction(BaseModel):
+    """The function that the model called."""
+    name: str
+    arguments: str
+
+
+class ToolCall(BaseModel):
+    """A tool call generated by the model (OpenAI-compatible)."""
+    id: str
+    type: Literal["function"] = "function"
+    function: ChatCompletionMessageToolCallFunction
+
+
+# OpenAI SDK alias
+ChatCompletionMessageToolCall = ToolCall
+
+
+class DeltaFunctionCall(BaseModel):
+    """Partial function call fields in a streaming delta."""
+    name: Optional[str] = None
+    arguments: Optional[str] = None
+
+
+class DeltaToolCall(BaseModel):
+    """A tool call delta in a streaming response (OpenAI-compatible)."""
+    index: int
+    id: Optional[str] = None
+    type: Optional[Literal["function"]] = None
+    function: Optional[DeltaFunctionCall] = None
+
+
+# OpenAI SDK alias
+ChoiceDeltaToolCall = DeltaToolCall
+
+
+class ChatCompletionNamedToolChoice(BaseModel):
+    """Force the model to call a specific function."""
+    type: Literal["function"] = "function"
+    function: Dict[str, str]
+
+
+ToolChoice = Union[
+    Literal["none", "auto", "required"],
+    ChatCompletionNamedToolChoice,
+    Dict[str, Any],
+]
+
+
+class ChatMessage(BaseModel):
+    """Chat message object"""
+    model_config = ConfigDict(extra="ignore")
+
+    role: Union[ChatRole, str]
+    content: Optional[str] = None
+    name: Optional[str] = None
+    refusal: Optional[str] = None
+    reasoning: Optional[str] = None
+    function_call: Optional[FunctionCall] = None
+    tool_calls: Optional[List[ToolCall]] = None
+    tool_call_id: Optional[str] = None
+
+
+class Function(BaseModel):
+    """Function definition"""
+    name: str
+    description: Optional[str] = None
+    parameters: Optional[Dict[str, Any]] = None
+
+
+class Tool(BaseModel):
+    """Tool definition"""
+    type: Literal["function"] = "function"
+    function: Function
+
+
+class ResponseFormat(BaseModel):
+    """Response format specification"""
+    type: Literal["text", "json_object"] = "text"
+
+
+class ChatCompletionRequest(BaseModel):
+    """Chat completion request"""
+    model: str
+    messages: List[ChatMessage]
+    temperature: Optional[float] = Field(default=1.0, ge=0.0, le=2.0)
+    top_p: Optional[float] = Field(default=1.0, ge=0.0, le=1.0)
+    n: Optional[int] = Field(default=1, ge=1)
+    stream: Optional[bool] = False
+    stop: Optional[Union[str, List[str]]] = None
+    max_tokens: Optional[int] = Field(default=None, gt=0)
+    presence_penalty: Optional[float] = Field(default=0.0, ge=-2.0, le=2.0)
+    frequency_penalty: Optional[float] = Field(default=0.0, ge=-2.0, le=2.0)
+    logit_bias: Optional[Dict[str, float]] = None
+    functions: Optional[List[Function]] = None
+    function_call: Optional[Union[str, Dict[str, str]]] = None
+    tools: Optional[List[Tool]] = None
+    tool_choice: Optional[ToolChoice] = None
+    response_format: Optional[ResponseFormat] = None
+    seed: Optional[int] = None
+    reasoning_effort: Optional[ReasoningEffort] = None
+
+
+class CompletionRequest(BaseModel):
+    """Completion request"""
+    model: str
+    prompt: str
+    temperature: Optional[float] = Field(default=1.0, ge=0.0, le=2.0)
+    top_p: Optional[float] = Field(default=1.0, ge=0.0, le=1.0)
+    n: Optional[int] = Field(default=1, ge=1)
+    stream: Optional[bool] = False
+    stop: Optional[Union[str, List[str]]] = None
+    max_tokens: Optional[int] = Field(default=None, gt=0)
+    presence_penalty: Optional[float] = Field(default=0.0, ge=-2.0, le=2.0)
+    frequency_penalty: Optional[float] = Field(default=0.0, ge=-2.0, le=2.0)
+    logit_bias: Optional[Dict[str, float]] = None
+    response_format: Optional[ResponseFormat] = None
+    seed: Optional[int] = None
+
+
+class Delta(BaseModel):
+    """Delta object for streaming responses"""
+    model_config = ConfigDict(extra="ignore")
+
+    role: Optional[Union[ChatRole, str]] = None
+    content: Optional[str] = None
+    refusal: Optional[str] = None
+    reasoning: Optional[str] = None
+    function_call: Optional[DeltaFunctionCall] = None
+    tool_calls: Optional[List[DeltaToolCall]] = None
+
+
+# OpenAI SDK alias
+ChoiceDelta = Delta
+
+
+class ChatCompletionChoice(BaseModel):
+    """Choice object"""
+    model_config = ConfigDict(extra="ignore")
+
+    index: int = Field(default=0)
+    message: Optional[ChatMessage] = None
+    delta: Optional[Delta] = None
+    logprobs: Optional[dict | list[dict]] = None
+    finish_reason: Optional[Union[FinishReason, str]] = None
+
+
+class CompletionChoice(BaseModel):
+    """Choice object"""
+    index: int = Field(default=0)
+    text: str
+    logprobs: Optional[dict | list[dict]] = None
+    finish_reason: Optional[Union[FinishReason, str]] = None
+
+
+class ChatCompletionResponse(APIResponse):
+    """Chat completion response"""
+    model_config = ConfigDict(extra="ignore")
+
+    model: str
+    object: str
+    choices: List[ChatCompletionChoice]
+    system_fingerprint: Optional[str] = None
+    usage: Optional[Usage] = None
+
+
+class CompletionResponse(APIResponse):
+    """Completion response"""
+    model: str
+    object: str
+    choices: List[CompletionChoice]
+    system_fingerprint: Optional[str] = None
+    usage: Optional[Usage] = None
+
+
+class ChatCompletionChunk(APIResponse):
+    """Chat completion chunk for streaming"""
+    model_config = ConfigDict(extra="ignore")
+
+    model: str
+    object: str
+    choices: List[ChatCompletionChoice]
+    system_fingerprint: Optional[str] = None
+    usage: Optional[Usage] = None
+
+
+class CompletionChunk(APIResponse):
+    """Completion chunk for streaming"""
+    model: str
+    object: str
+    choices: List[CompletionChoice]
+    system_fingerprint: Optional[str] = None
+    usage: Optional[Usage] = None

synapsai/types/embeddings.py

@@ -0,0 +1,68 @@
+# Copyright 2026 SynapsAI Technologies Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Embeddings type definitions
+"""
+
+from typing import Optional, List, Literal, Union
+from pydantic import BaseModel, Field
+
+from .common import APIResponse, Usage
+
+
+class Embedding(BaseModel):
+    """Embedding object"""
+    object: Literal["embedding"] = "embedding"
+    embedding: Union[List[float], str]
+    index: int = Field(default=0)
+
+
+class EmbeddingRequest(BaseModel):
+    """Embedding request"""
+    model: str
+    input: Union[str, List[str], List[int], List[List[int]]]
+    encoding_format: Optional[Literal["float", "base64"]] = "float"
+    dimensions: Optional[int] = Field(default=None, gt=0)
+
+
+class EmbeddingResponse(APIResponse):
+    """Embedding response"""
+    object: Literal["list"] = "list"
+    data: List[Embedding]
+    model: str
+    usage: Optional[Usage] = None
+
+
+class SimilarityRequest(BaseModel):
+    """Similarity request for sentence/embedding similarity"""
+    model: str
+    source_sentence: str
+    sentences: List[str]
+    return_embeddings: Optional[bool] = False
+    encoding_format: Optional[Literal["float", "base64"]] = "float"
+
+class SimilarityResult(BaseModel):
+    """Single similarity result for a sentence"""
+    object: Literal["similarity"] = "similarity"
+    similarity: float
+    embedding: Optional[Union[List[float], str]] = Field(default=None)
+    index: int = Field(default=0)
+
+class SimilarityResponse(APIResponse):
+    """Similarity response object"""
+    object: Literal["list"] = "list"
+    data: List[SimilarityResult]
+    model: str
+    usage: Optional[Usage] = None

synapsai/types/feature_extraction.py

@@ -0,0 +1,31 @@
+# Copyright 2026 SynapsAI Technologies Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Feature extraction type definitions
+"""
+
+from typing import Optional, Dict, Any, Union, List, Literal
+from pydantic import BaseModel
+from .common import APIResponse, Usage
+
+class FeatureExtractionRequest(BaseModel):
+    model: str
+    inputs: Union[str, List[str]]
+
+class FeatureExtractionResponse(APIResponse):
+    object: Literal["list"] = "list"
+    data: List[Dict[str, Any]]
+    model: str
+    usage: Optional[Usage] = None

synapsai/types/fill_mask.py

@@ -0,0 +1,38 @@
+# Copyright 2026 SynapsAI Technologies Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Fill mask type definitions
+"""
+
+from typing import Optional, Union, List, Literal
+from pydantic import BaseModel
+from .common import APIResponse, Usage
+
+class FillMaskRequest(BaseModel):
+    model: str
+    inputs: Union[str, List[str]]
+    targets: Optional[Union[str, List[str]]] = None
+    top_k: int = 5
+
+class FillMaskData(BaseModel):
+    """Data model for fill mask result"""
+    masks: List[str]
+    score: float
+
+class FillMaskResponse(APIResponse):
+    object: Literal["list"] = "list"
+    data: List[FillMaskData]
+    model: str
+    usage: Optional[Usage] = None

synapsai/types/images.py

@@ -0,0 +1,172 @@
+# Copyright 2026 SynapsAI Technologies Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Image generation, editing, and analysis type definitions
+"""
+
+from typing import Optional, Dict, Any, Union, List, Literal, Tuple
+from pydantic import BaseModel, Field
+from enum import Enum
+
+from .common import APIResponse, Usage
+
+ImageSource = Union[str, bytes, List[str], List[bytes]]
+
+class ResponseFormat(str, Enum):
+    """Image response format"""
+    URL = "url"
+    B64_JSON = "b64_json"
+
+class Image(BaseModel):
+    """Image object"""
+    url: Optional[str] = None
+    b64_json: Optional[str] = None
+    image_bytes: Optional[bytes] = None
+    revised_prompt: Optional[str] = None
+
+class ImageGenerateRequest(BaseModel):
+    """Image generation request"""
+    model: str
+    prompt: str = Field(max_length=4000)
+    n: Optional[int] = Field(default=1, ge=1, le=10)
+    response_format: ResponseFormat = ResponseFormat.URL
+    size: Union[Tuple[int, int], str] = "512x512"
+
+class ImageGenerateResponse(APIResponse):
+    """Image generation response"""
+    object: Literal["list"] = "list"
+    data: List[Image]
+    usage: Optional[Usage] = None
+
+class ImageEditRequest(BaseModel):
+    """Image edit request"""
+    model: str
+    image: ImageSource = Field(description="The image to edit (base64 encoded, URL, or file)")
+    mask: Optional[ImageSource] = Field(default=None, description="Mask image (base64 encoded, URL, or file)")
+    prompt: str = Field(max_length=1000)
+    n: Optional[int] = Field(default=1, ge=1, le=10)
+    size: Union[Tuple[int, int], str] = "512x512"
+    response_format: ResponseFormat = ResponseFormat.URL
+
+class ImageEditResponse(APIResponse):
+    """Image edit response"""
+    object: Literal["list"] = "list"
+    data: List[Image]
+    usage: Optional[Usage] = None
+
+class ImageAnalysisRequest(BaseModel):
+    """Image analysis request"""
+    model: str
+    image: ImageSource = Field(description="The image to analyze (base64 encoded, URL, or file)")
+    prompt: Optional[str] = None
+    fields: Optional[List[str]] = Field(
+        default=None,
+        description="Specific fields to extract (e.g., ['objects', 'text', 'colors', 'mood'])"
+    )
+    detail: Optional[Literal["low", "high", "auto"]] = "auto"
+    max_tokens: Optional[int] = Field(default=300, gt=0)
+
+class ImageAnalysisResponse(APIResponse):
+    """Image analysis response"""
+    object: Literal["list"] = "list"
+    model: str
+    data: List[Dict[str, Any]]
+    usage: Optional[Usage] = None
+
+class ImageSegmentationRequest(BaseModel):
+    """Image segmentation request"""
+    model: str
+    image: ImageSource = Field(description="The image to analyze (base64 encoded, URL, or file)")
+    subtask: str = 'panoptic'
+    threshold: float = 0.9
+    mask_threshold: float = 0.5
+    overlap_mask_area_threshold: float = 0.5
+
+class ImageSegmentationResponse(APIResponse):
+    """Image segmentation response"""
+    object: Literal["list"] = "list"
+    model: str
+    data: List[Dict[str, Any]]
+    usage: Optional[Usage] = None
+
+class ImageFeatureExtractionRequest(BaseModel):
+    """Image feature extraction request"""
+    model: str
+    images: ImageSource = Field(description="The image to extract features from (base64 encoded, URL, or file)")
+
+class ImageFeatureExtractionResponse(APIResponse):
+    """Image feature extraction response"""
+    object: Literal["list"] = "list"
+    model: str
+    data: List[Dict[str, Any]]
+    usage: Optional[Usage] = None
+
+class ObjectDetectionRequest(BaseModel):
+    """Object detection request"""
+    model: str
+    inputs: ImageSource = Field(description="The image to analyze (base64 encoded, URL, or file)")
+    threshold: float = 0.5
+
+class ObjectDetectionResponse(APIResponse):
+    """Object detection response"""
+    object: Literal["list"] = "list"
+    model: str
+    data: List[Dict[str, Any]]
+    usage: Optional[Usage] = None
+
+class DepthEstimationRequest(BaseModel):
+    """Depth estimation request"""
+    model: str
+    inputs: ImageSource = Field(description="The image to analyze (base64 encoded, URL, or file)")
+    parameters: Optional[Dict] = None
+
+class DepthEstimationResponse(APIResponse):
+    """Depth estimation response"""
+    object: Literal["list"] = "list"
+    model: str
+    data: List[Dict[str, Any]]
+    usage: Optional[Usage] = None
+
+class ImageFeatureExtractionRequest(BaseModel):
+    """Feature extraction request"""
+    model: str
+    inputs: ImageSource = Field(description="The image to extract features from (base64 encoded, URL, or file)")
+
+class ImageFeatureExtractionResponse(APIResponse):
+    """Feature extraction response"""
+    object: Literal["list"] = "list"
+    model: str
+    data: List[Dict[str, Any]]
+    usage: Optional[Usage] = None
+
+class MaskGenerationRequest(BaseModel):
+    """Mask Generation Request"""
+    model: str
+    image: ImageSource
+    mask_threshold: float = 0.0
+    pred_iou_thresh: float = 0.88
+    stability_score_thresh: float = 0.95
+    stability_score_offset: int = 1
+    crops_nms_thresh: float = 0.7
+    crops_n_layers: int = 0
+    crop_overlap_ratio: float = 0.3413
+    crop_n_points_downscale_factor: int = 1
+
+class MaskGenerationResponse(APIResponse):
+    """Mask Generation Response"""
+    object: Literal["list"] = "list"
+    model: str
+    data: List[Dict[str, Any]]
+    usage: Optional[Usage] = None

synapsai/types/models.py

@@ -0,0 +1,28 @@
+# Copyright 2026 SynapsAI Technologies Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from typing import Literal, List
+from pydantic import BaseModel
+
+class Model(BaseModel):
+    id: str
+    object: Literal["model"] = "model"
+    created: int
+    owned_by: str
+    status: Literal["building", "sleeping", "ready", "failed"]
+
+
+class Models(BaseModel):
+    object: Literal["list"] = "list"
+    data: List[Model]