mixpeek 0.8.41__py3-none-any.whl → 0.9.0__py3-none-any.whl

mixpeek_sdk/types/collections/file_full_params.py

@@ -0,0 +1,22 @@
+# 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__ = ["FileFullParams"]
+
+
+class FileFullParams(TypedDict, total=False):
+    modality: str
+
+    page: int
+
+    page_size: int
+
+    authorization: Annotated[str, PropertyInfo(alias="Authorization")]
+
+    index_id: Annotated[str, PropertyInfo(alias="index-id")]
+    """filter by organization"""

mixpeek_sdk/types/collections/file_update_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["FileUpdateParams"]
+
+
+class FileUpdateParams(TypedDict, total=False):
+    body: Required[object]
+
+    authorization: Annotated[str, PropertyInfo(alias="Authorization")]
+
+    index_id: Annotated[str, PropertyInfo(alias="index-id")]
+    """filter by organization"""

mixpeek_sdk/types/collections/fileresponse.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from datetime import datetime
+
+from ..._models import BaseModel
+
+__all__ = ["Fileresponse"]
+
+
+class Fileresponse(BaseModel):
+    collection_id: str
+
+    created_at: datetime
+
+    file_id: str
+
+    index_id: str
+
+    metadata: object
+
+    status: str
+
+    url: str

mixpeek_sdk/types/collections/groupedfiledata.py

@@ -0,0 +1,38 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from datetime import datetime
+
+from ..._models import BaseModel
+
+__all__ = ["Groupedfiledata", "ImageDetails"]
+
+
+class ImageDetails(BaseModel):
+    caption: Optional[str] = None
+
+    description: Optional[str] = None
+
+    detect: Optional[object] = None
+
+    text: Optional[str] = None
+
+
+class Groupedfiledata(BaseModel):
+    collection_id: str
+
+    created_at: datetime
+
+    file_id: str
+
+    index_id: str
+
+    metadata: object
+
+    status: str
+
+    url: str
+
+    image_details: Optional[ImageDetails] = None
+
+    video_segments: Optional[List[Dict[str, object]]] = None

mixpeek_sdk/types/describe_upload_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 Required, Annotated, TypedDict
+
+from .._types import FileTypes
+from .._utils import PropertyInfo
+
+__all__ = ["DescribeUploadParams"]
+
+
+class DescribeUploadParams(TypedDict, total=False):
+    file: Required[FileTypes]
+
+    prompt: Required[str]
+
+    authorization: Annotated[str, PropertyInfo(alias="Authorization")]
+
+    index_id: Annotated[str, PropertyInfo(alias="index-id")]
+    """filter by organization"""

mixpeek_sdk/types/describe_url_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["DescribeURLParams"]
+
+
+class DescribeURLParams(TypedDict, total=False):
+    prompt: Required[str]
+
+    url: Required[str]
+
+    authorization: Annotated[str, PropertyInfo(alias="Authorization")]
+
+    index_id: Annotated[str, PropertyInfo(alias="index-id")]
+    """filter by organization"""

mixpeek_sdk/types/embed_create_params.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["EmbedCreateParams"]
+
+
+class EmbedCreateParams(TypedDict, total=False):
+    input: Required[str]
+    """The input data to be processed."""
+
+    input_type: Optional[Literal["text", "base64", "url"]]
+    """The type of input data. Can be text, base64, or url."""
+
+    modality: Optional[Literal["video", "image"]]
+    """The modality of the input data."""
+
+    model_id: Optional[object]
+    """The model to be used for processing."""
+
+    authorization: Annotated[str, PropertyInfo(alias="Authorization")]
+
+    index_id: Annotated[str, PropertyInfo(alias="index-id")]
+    """filter by organization"""

mixpeek_sdk/types/embeddingresponse.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["Embeddingresponse"]
+
+
+class Embeddingresponse(BaseModel):
+    embedding: List[float]
+    """The embedding of the processed data."""
+
+    elapsed_time: Optional[float] = None
+    """The time taken to process the data."""

mixpeek_sdk/types/index_face_params.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 Required, Annotated, TypedDict
+
+from .._types import FileTypes
+from .._utils import PropertyInfo
+
+__all__ = ["IndexFaceParams"]
+
+
+class IndexFaceParams(TypedDict, total=False):
+    collection_id: Required[str]
+
+    file: Required[FileTypes]
+
+    metadata: str
+
+    authorization: Annotated[str, PropertyInfo(alias="Authorization")]
+
+    index_id: Annotated[str, PropertyInfo(alias="index-id")]
+    """filter by organization"""

mixpeek_sdk/types/index_upload_params.py

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._types import FileTypes
+from .._utils import PropertyInfo
+
+__all__ = ["IndexUploadParams"]
+
+
+class IndexUploadParams(TypedDict, total=False):
+    collection_id: Required[str]
+
+    file: Required[FileTypes]
+
+    image_settings: str
+
+    metadata: str
+
+    video_settings: str
+
+    authorization: Annotated[str, PropertyInfo(alias="Authorization")]
+
+    index_id: Annotated[str, PropertyInfo(alias="index-id")]
+    """filter by organization"""

mixpeek_sdk/types/index_url_params.py

@@ -0,0 +1,159 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = [
+    "IndexURLParams",
+    "ImageSettings",
+    "ImageSettingsDescribe",
+    "ImageSettingsDetect",
+    "ImageSettingsDetectFaces",
+    "ImageSettingsEmbed",
+    "ImageSettingsJsonOutput",
+    "ImageSettingsRead",
+    "VideoSettings",
+    "VideoSettingsDescribe",
+    "VideoSettingsDetect",
+    "VideoSettingsDetectFaces",
+    "VideoSettingsEmbed",
+    "VideoSettingsJsonOutput",
+    "VideoSettingsRead",
+    "VideoSettingsTranscribe",
+]
+
+
+class IndexURLParams(TypedDict, total=False):
+    collection_id: Required[str]
+
+    url: Required[str]
+
+    image_settings: Optional[ImageSettings]
+
+    metadata: object
+    """Additional metadata associated with the file"""
+
+    should_save: Optional[bool]
+    """Whether to upload the processed file to S3"""
+
+    video_settings: Optional[VideoSettings]
+
+    authorization: Annotated[str, PropertyInfo(alias="Authorization")]
+
+    index_id: Annotated[str, PropertyInfo(alias="index-id")]
+    """filter by organization"""
+
+
+class ImageSettingsDescribe(TypedDict, total=False):
+    model_id: Optional[Literal["image-descriptor-v1"]]
+
+    prompt: Optional[str]
+    """Prompt for image description"""
+
+
+class ImageSettingsDetectFaces(TypedDict, total=False):
+    model_id: Optional[Literal["face-detector-v1"]]
+    """Model ID for face detection"""
+
+
+class ImageSettingsDetect(TypedDict, total=False):
+    faces: Optional[ImageSettingsDetectFaces]
+    """Settings for face detection"""
+
+
+class ImageSettingsEmbed(TypedDict, total=False):
+    model_id: Optional[Literal["image-embed-v1", "multimodal-v1"]]
+
+
+class ImageSettingsJsonOutput(TypedDict, total=False):
+    prompt: Optional[str]
+
+    response_shape: Optional[object]
+
+
+class ImageSettingsRead(TypedDict, total=False):
+    json_format: object
+    """JSON format for the response"""
+
+    model_id: Optional[Literal["image-descriptor-v1"]]
+
+    prompt: Optional[str]
+    """Prompt for reading on-screen text"""
+
+
+class ImageSettings(TypedDict, total=False):
+    describe: Optional[ImageSettingsDescribe]
+
+    detect: Optional[ImageSettingsDetect]
+
+    embed: Optional[ImageSettingsEmbed]
+
+    json_output: Optional[ImageSettingsJsonOutput]
+
+    read: Optional[ImageSettingsRead]
+
+
+class VideoSettingsDescribe(TypedDict, total=False):
+    model_id: Optional[Literal["video-descriptor-v1"]]
+
+    prompt: Optional[str]
+    """Prompt for video description"""
+
+
+class VideoSettingsDetectFaces(TypedDict, total=False):
+    model_id: Optional[Literal["face-detector-v1"]]
+    """Model ID for face detection"""
+
+
+class VideoSettingsDetect(TypedDict, total=False):
+    faces: Optional[VideoSettingsDetectFaces]
+    """Settings for face detection"""
+
+
+class VideoSettingsEmbed(TypedDict, total=False):
+    contextual_text: Optional[str]
+
+    model_id: Optional[Literal["vuse-generic-v1", "multimodal-v1"]]
+
+
+class VideoSettingsJsonOutput(TypedDict, total=False):
+    prompt: Optional[str]
+
+    response_shape: Optional[object]
+
+
+class VideoSettingsRead(TypedDict, total=False):
+    json_format: object
+    """JSON format for the response"""
+
+    model_id: Optional[Literal["video-descriptor-v1"]]
+
+    prompt: Optional[str]
+    """Prompt for reading on-screen text"""
+
+
+class VideoSettingsTranscribe(TypedDict, total=False):
+    model_id: Optional[Literal["polyglot-v1"]]
+
+    prompt: Optional[str]
+
+
+class VideoSettings(TypedDict, total=False):
+    describe: Optional[VideoSettingsDescribe]
+
+    detect: Optional[VideoSettingsDetect]
+
+    embed: Optional[VideoSettingsEmbed]
+
+    interval_sec: int
+    """Interval in seconds for processing video"""
+
+    json_output: Optional[VideoSettingsJsonOutput]
+
+    read: Optional[VideoSettingsRead]
+
+    transcribe: Optional[VideoSettingsTranscribe]

mixpeek_sdk/types/search_text_params.py

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["SearchTextParams", "Pagination"]
+
+
+class SearchTextParams(TypedDict, total=False):
+    input: Required[str]
+    """url, text, or base64 input"""
+
+    filters: object
+    """Additional filters for the search"""
+
+    group_by_file: bool
+    """Whether to group search results by file"""
+
+    input_type: Optional[str]
+
+    modality: Optional[str]
+
+    model_id: Optional[str]
+
+    pagination: Pagination
+    """Pagination parameters"""
+
+    source: Optional[str]
+
+    authorization: Annotated[str, PropertyInfo(alias="Authorization")]
+
+    index_id: Annotated[str, PropertyInfo(alias="index-id")]
+    """filter by organization"""
+
+
+class Pagination(TypedDict, total=False):
+    page: int
+    """Page number"""
+
+    page_size: int
+    """Number of items per page"""

mixpeek_sdk/types/search_upload_params.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._types import FileTypes
+from .._utils import PropertyInfo
+
+__all__ = ["SearchUploadParams"]
+
+
+class SearchUploadParams(TypedDict, total=False):
+    file: Required[FileTypes]
+
+    filters: str
+
+    page: int
+
+    page_size: int
+
+    authorization: Annotated[str, PropertyInfo(alias="Authorization")]
+
+    index_id: Annotated[str, PropertyInfo(alias="index-id")]
+    """filter by organization"""

mixpeek_sdk/types/search_url_params.py

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["SearchURLParams", "Pagination"]
+
+
+class SearchURLParams(TypedDict, total=False):
+    input: Required[str]
+    """url, text, or base64 input"""
+
+    filters: object
+    """Additional filters for the search"""
+
+    group_by_file: bool
+    """Whether to group search results by file"""
+
+    input_type: Optional[str]
+
+    modality: Optional[str]
+
+    model_id: Optional[str]
+
+    pagination: Pagination
+    """Pagination parameters"""
+
+    source: Optional[str]
+
+    authorization: Annotated[str, PropertyInfo(alias="Authorization")]
+
+    index_id: Annotated[str, PropertyInfo(alias="index-id")]
+    """filter by organization"""
+
+
+class Pagination(TypedDict, total=False):
+    page: int
+    """Page number"""
+
+    page_size: int
+    """Number of items per page"""

mixpeek_sdk/types/taskresponse.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["Taskresponse"]
+
+
+class Taskresponse(BaseModel):
+    file_id: str
+
+    status: Literal["DONE", "FAILED", "PROCESSING", "DOWNLOADING", "INITIALIZING"]
+
+    task_id: str

mixpeek_sdk/types/transcribe_url_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["TranscribeURLParams"]
+
+
+class TranscribeURLParams(TypedDict, total=False):
+    url: Required[str]
+
+    authorization: Annotated[str, PropertyInfo(alias="Authorization")]
+
+    index_id: Annotated[str, PropertyInfo(alias="index-id")]
+    """filter by organization"""

mixpeek/__init__.py

@@ -1 +0,0 @@
-from .client import Mixpeek

mixpeek/client.py

@@ -1,27 +0,0 @@
-import requests
-
-from .endpoints.embed import Embed
-from .endpoints.collections import Collections
-from .endpoints.index import Index
-from .endpoints.search import Search
-from .endpoints.tools import Tools
-from .endpoints.register import Register
-
-
-class Mixpeek:
-    def __init__(self, api_key: str):
-        self.api_key = api_key
-        self.base_url = "https://api.mixpeek.com/"
-        self.headers = {
-            "Authorization": f"Bearer {self.api_key}",
-            "Content-Type": "application/json"
-        }
-        # these are remote
-        self.embed = Embed(self.base_url, self.headers)
-        self.collections = Collections(self.base_url, self.headers)
-        self.index = Index(self.base_url, self.headers)
-        self.search = Search(self.base_url, self.headers)
-        self.register = Register(self.base_url, self.headers)
-
-        # tools is all local
-        self.tools = Tools()

mixpeek/endpoints/collections.py

@@ -1,86 +0,0 @@
-import requests
-
-class Collections:
-    def __init__(self, base_url, headers):
-        self.base_url = base_url
-        self.headers = headers
-
-    def list_files(self, collection_id, randomize=False, page=1, page_size=10, filters=None, sort_by=None, sort_order="asc"):
-        try:
-            url = f"{self.base_url}collections/"
-            data = {
-                "collection_id": collection_id,
-                "randomize": randomize,
-                "page": page,
-                "page_size": page_size,
-                "filters": filters,
-                "sort_by": sort_by,
-                "sort_order": sort_order
-            }
-            response = requests.post(url, json=data, headers=self.headers)
-            response.raise_for_status()
-            return response.json()
-        except requests.RequestException as e:
-            return {"error": str(e)}
-
-    def list_collections(self):
-        try:
-            url = f"{self.base_url}collections/"
-            response = requests.get(url, headers=self.headers)
-            response.raise_for_status()
-            return response.json()
-        except requests.RequestException as e:
-            return {"error": str(e)}
-
-    def search_files(self, query, collection_id, page=1, page_size=10, sort_by=None, sort_order="asc"):
-        try:
-            url = f"{self.base_url}collections/search"
-            data = {
-                "query": query,
-                "collection_id": collection_id,
-                "page": page,
-                "page_size": page_size,
-                "sort_by": sort_by,
-                "sort_order": sort_order
-            }
-            response = requests.post(url, json=data, headers=self.headers)
-            response.raise_for_status()
-            return response.json()
-        except requests.RequestException as e:
-            return {"error": str(e)}
-
-    def get_file_by_id(self, file_id):
-        try:
-            url = f"{self.base_url}collections/file/{file_id}"
-            response = requests.get(url, headers=self.headers)
-            response.raise_for_status()
-            return response.json()
-        except requests.RequestException as e:
-            return {"error": str(e)}
-
-    def get_full_file(self, file_id):
-        try:
-            url = f"{self.base_url}collections/file/{file_id}/full"
-            response = requests.get(url, headers=self.headers)
-            response.raise_for_status()
-            return response.json()
-        except requests.RequestException as e:
-            return {"error": str(e)}
-
-    def delete_file_by_id(self, file_id):
-        try:
-            url = f"{self.base_url}collections/file/{file_id}"
-            response = requests.delete(url, headers=self.headers)
-            response.raise_for_status()
-            return response.json()
-        except requests.RequestException as e:
-            return {"error": str(e)}
-
-    def delete_collection(self, collection_id):
-        try:
-            url = f"{self.base_url}collections/{collection_id}"
-            response = requests.delete(url, headers=self.headers)
-            response.raise_for_status()
-            return response.json()
-        except requests.RequestException as e:
-            return {"error": str(e)}