mixpeek 0.2__tar.gz → 0.6.2__tar.gz

mixpeek-0.2/LICENSE.rst → mixpeek-0.6.2/LICENSE

@@ -1,5 +1,6 @@
-The MIT License (MIT)
-Copyright (c) 2021 mixpeek
+MIT License
+
+Copyright (c) 2024 Mixpeek.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -11,10 +12,10 @@ furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
-OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
-OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mixpeek-0.6.2/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.1
+Name: mixpeek
+Version: 0.6.2
+Summary: 
+Requires-Python: >=3.8,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: typing_extensions (>=4.0.0)
+Description-Content-Type: text/markdown
+
+# Mixpeek Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
+
+The Mixpeek Python Library provides convenient access to the Mixpeek API from applications written in Python.
+
+## Installation
+Add this dependency to your project's build file:
+
+```bash
+pip install mixpeek
+# or
+poetry add mixpeek
+```
+
+## Usage
+Simply import `Mixpeek` and start making calls to our API. 
+
+```python
+from mixpeek.client import Mixpeek
+
+client = Mixpeek(
+    api_key="..."
+)
+```
+
+## Async Client
+
+The SDK also exports an async client so that you can make non-blocking
+calls to our API. 
+
+```python
+from mixpeek.client import AsymcMixpeek
+
+client = AsyncMixpeek(
+    api_key="..."
+)
+```
+
+## Exception Handling
+All errors thrown by the SDK will be subclasses of [`ApiError`](./src/mixpeek/core/api_error.py).
+
+```python
+import mixpeek
+
+try:
+  client.search(...)
+except mixpeek.core.ApiError as e: # Handle all errors
+  print(e.status_code)
+  print(e.body)
+```
+
+## Advanced
+
+### Retries
+The Mixpeek SDK is instrumented with automatic retries with exponential backoff. A request will be
+retried as long as the request is deemed retriable and the number of retry attempts has not grown larger
+than the configured retry limit.
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+  
+Use the `max_retries` request option to configure this behavior. 
+
+```python
+from mixpeek.client import Mixpeek
+
+client = Mixpeek(...)
+
+# Override retries for a specific method
+client.search(..., {
+    max_retries=5
+})
+```
+
+### Timeouts
+By default, requests time out after 60 seconds. You can configure this with a 
+timeout option at the client or request level.
+
+```python
+from mixpeek.client import Mixpeek
+
+client = Mixpeek(
+    # All timeouts are 20 seconds
+    timeout=20.0,
+)
+
+# Override timeout for a specific method
+client.search(..., {
+    timeout_in_seconds=20.0
+})
+```
+
+### Custom HTTP client
+You can override the httpx client to customize it for your use-case. Some common use-cases 
+include support for proxies and transports.
+
+```python
+import httpx
+
+from mixpeek.client import Mixpeek
+
+client = Mixpeek(
+    http_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Beta Status
+
+This SDK is in beta, and there may be breaking changes between versions without a major 
+version update. Therefore, we recommend pinning the package version to a specific version. 
+This way, you can install the same version each time without breaking changes.
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically. 
+Additions made directly to this library would have to be moved over to our generation code, 
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening 
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+

mixpeek-0.6.2/README.md

@@ -0,0 +1,129 @@
+# Mixpeek Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
+
+The Mixpeek Python Library provides convenient access to the Mixpeek API from applications written in Python.
+
+## Installation
+Add this dependency to your project's build file:
+
+```bash
+pip install mixpeek
+# or
+poetry add mixpeek
+```
+
+## Usage
+Simply import `Mixpeek` and start making calls to our API. 
+
+```python
+from mixpeek.client import Mixpeek
+
+client = Mixpeek(
+    api_key="..."
+)
+```
+
+## Async Client
+
+The SDK also exports an async client so that you can make non-blocking
+calls to our API. 
+
+```python
+from mixpeek.client import AsymcMixpeek
+
+client = AsyncMixpeek(
+    api_key="..."
+)
+```
+
+## Exception Handling
+All errors thrown by the SDK will be subclasses of [`ApiError`](./src/mixpeek/core/api_error.py).
+
+```python
+import mixpeek
+
+try:
+  client.search(...)
+except mixpeek.core.ApiError as e: # Handle all errors
+  print(e.status_code)
+  print(e.body)
+```
+
+## Advanced
+
+### Retries
+The Mixpeek SDK is instrumented with automatic retries with exponential backoff. A request will be
+retried as long as the request is deemed retriable and the number of retry attempts has not grown larger
+than the configured retry limit.
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+  
+Use the `max_retries` request option to configure this behavior. 
+
+```python
+from mixpeek.client import Mixpeek
+
+client = Mixpeek(...)
+
+# Override retries for a specific method
+client.search(..., {
+    max_retries=5
+})
+```
+
+### Timeouts
+By default, requests time out after 60 seconds. You can configure this with a 
+timeout option at the client or request level.
+
+```python
+from mixpeek.client import Mixpeek
+
+client = Mixpeek(
+    # All timeouts are 20 seconds
+    timeout=20.0,
+)
+
+# Override timeout for a specific method
+client.search(..., {
+    timeout_in_seconds=20.0
+})
+```
+
+### Custom HTTP client
+You can override the httpx client to customize it for your use-case. Some common use-cases 
+include support for proxies and transports.
+
+```python
+import httpx
+
+from mixpeek.client import Mixpeek
+
+client = Mixpeek(
+    http_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Beta Status
+
+This SDK is in beta, and there may be breaking changes between versions without a major 
+version update. Therefore, we recommend pinning the package version to a specific version. 
+This way, you can install the same version each time without breaking changes.
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically. 
+Additions made directly to this library would have to be moved over to our generation code, 
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening 
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

mixpeek-0.6.2/pyproject.toml

@@ -0,0 +1,33 @@
+[tool.poetry]
+name = "mixpeek"
+version = "0.6.2"
+description = ""
+readme = "README.md"
+authors = []
+packages = [
+    { include = "mixpeek", from = "src"}
+]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+httpx = ">=0.21.2"
+pydantic = ">= 1.9.2"
+typing_extensions = ">= 4.0.0"
+
+[tool.poetry.dev-dependencies]
+mypy = "^1.8.0"
+pytest = "^7.4.0"
+pytest-asyncio = "^0.23.5"
+python-dateutil = "^2.9.0"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

mixpeek-0.6.2/src/mixpeek/__init__.py

@@ -0,0 +1,102 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import (
+    ApiKey,
+    AudioParams,
+    ConfigsResponse,
+    Connection,
+    ConnectionEngine,
+    CsvParams,
+    Destination,
+    EmbeddingResponse,
+    ErrorMessage,
+    ErrorResponse,
+    FieldType,
+    GenerationResponse,
+    HtmlParams,
+    HttpValidationError,
+    ImageParams,
+    Message,
+    Metadata,
+    Modality,
+    Model,
+    Models,
+    PdfParams,
+    PptParams,
+    PptxParams,
+    Settings,
+    Source,
+    SourceDestinationMapping,
+    TxtParams,
+    User,
+    ValidationError,
+    ValidationErrorLocItem,
+    VideoParams,
+    WorkflowResponse,
+    WorkflowSettings,
+    XlsxParams,
+)
+from .errors import (
+    BadRequestError,
+    ForbiddenError,
+    InternalServerError,
+    NotFoundError,
+    UnauthorizedError,
+    UnprocessableEntityError,
+)
+from . import embed, extract, generators, parse, pipelines, storage, users, workflows
+from .environment import MixpeekEnvironment
+from .version import __version__
+
+__all__ = [
+    "ApiKey",
+    "AudioParams",
+    "BadRequestError",
+    "ConfigsResponse",
+    "Connection",
+    "ConnectionEngine",
+    "CsvParams",
+    "Destination",
+    "EmbeddingResponse",
+    "ErrorMessage",
+    "ErrorResponse",
+    "FieldType",
+    "ForbiddenError",
+    "GenerationResponse",
+    "HtmlParams",
+    "HttpValidationError",
+    "ImageParams",
+    "InternalServerError",
+    "Message",
+    "Metadata",
+    "MixpeekEnvironment",
+    "Modality",
+    "Model",
+    "Models",
+    "NotFoundError",
+    "PdfParams",
+    "PptParams",
+    "PptxParams",
+    "Settings",
+    "Source",
+    "SourceDestinationMapping",
+    "TxtParams",
+    "UnauthorizedError",
+    "UnprocessableEntityError",
+    "User",
+    "ValidationError",
+    "ValidationErrorLocItem",
+    "VideoParams",
+    "WorkflowResponse",
+    "WorkflowSettings",
+    "XlsxParams",
+    "__version__",
+    "embed",
+    "extract",
+    "generators",
+    "parse",
+    "pipelines",
+    "storage",
+    "users",
+    "workflows",
+]

mixpeek-0.6.2/src/mixpeek/base_client.py

@@ -0,0 +1,155 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import os
+import typing
+
+import httpx
+
+from .core.api_error import ApiError
+from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .embed.client import AsyncEmbedClient, EmbedClient
+from .environment import MixpeekEnvironment
+from .extract.client import AsyncExtractClient, ExtractClient
+from .generators.client import AsyncGeneratorsClient, GeneratorsClient
+from .parse.client import AsyncParseClient, ParseClient
+from .pipelines.client import AsyncPipelinesClient, PipelinesClient
+from .storage.client import AsyncStorageClient, StorageClient
+from .users.client import AsyncUsersClient, UsersClient
+from .workflows.client import AsyncWorkflowsClient, WorkflowsClient
+
+
+class BaseMixpeek:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propogate to these functions.
+
+    Parameters:
+        - base_url: typing.Optional[str]. The base url to use for requests from the client.
+
+        - environment: MixpeekEnvironment. The environment to use for requests from the client. from .environment import MixpeekEnvironment
+
+                                           Defaults to MixpeekEnvironment.DEFAULT
+
+        - authorization: typing.Optional[str].
+
+        - index_id: typing.Optional[str].
+
+        - api_key: typing.Optional[typing.Union[str, typing.Callable[[], str]]].
+
+        - timeout: typing.Optional[float]. The timeout to be used, in seconds, for requests by default the timeout is 60 seconds, unless a custom httpx client is used, in which case a default is not set.
+
+        - httpx_client: typing.Optional[httpx.Client]. The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+    ---
+    from mixpeek.client import Mixpeek
+
+    client = Mixpeek(
+        authorization="YOUR_AUTHORIZATION",
+        index_id="YOUR_INDEX_ID",
+        api_key="YOUR_API_KEY",
+    )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: MixpeekEnvironment = MixpeekEnvironment.DEFAULT,
+        authorization: typing.Optional[str] = None,
+        index_id: typing.Optional[str] = None,
+        api_key: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = os.getenv("MIXPEEK_API_KEY"),
+        timeout: typing.Optional[float] = None,
+        httpx_client: typing.Optional[httpx.Client] = None
+    ):
+        _defaulted_timeout = timeout if timeout is not None else 60 if httpx_client is None else None
+        if api_key is None:
+            raise ApiError(
+                body="The client must be instantiated be either passing in api_key or setting MIXPEEK_API_KEY"
+            )
+        self._client_wrapper = SyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            authorization=authorization,
+            index_id=index_id,
+            api_key=api_key,
+            httpx_client=httpx.Client(timeout=_defaulted_timeout) if httpx_client is None else httpx_client,
+            timeout=_defaulted_timeout,
+        )
+        self.users = UsersClient(client_wrapper=self._client_wrapper)
+        self.extract = ExtractClient(client_wrapper=self._client_wrapper)
+        self.generators = GeneratorsClient(client_wrapper=self._client_wrapper)
+        self.embed = EmbedClient(client_wrapper=self._client_wrapper)
+        self.pipelines = PipelinesClient(client_wrapper=self._client_wrapper)
+        self.workflows = WorkflowsClient(client_wrapper=self._client_wrapper)
+        self.storage = StorageClient(client_wrapper=self._client_wrapper)
+        self.parse = ParseClient(client_wrapper=self._client_wrapper)
+
+
+class AsyncBaseMixpeek:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propogate to these functions.
+
+    Parameters:
+        - base_url: typing.Optional[str]. The base url to use for requests from the client.
+
+        - environment: MixpeekEnvironment. The environment to use for requests from the client. from .environment import MixpeekEnvironment
+
+                                           Defaults to MixpeekEnvironment.DEFAULT
+
+        - authorization: typing.Optional[str].
+
+        - index_id: typing.Optional[str].
+
+        - api_key: typing.Optional[typing.Union[str, typing.Callable[[], str]]].
+
+        - timeout: typing.Optional[float]. The timeout to be used, in seconds, for requests by default the timeout is 60 seconds, unless a custom httpx client is used, in which case a default is not set.
+
+        - httpx_client: typing.Optional[httpx.AsyncClient]. The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+    ---
+    from mixpeek.client import AsyncMixpeek
+
+    client = AsyncMixpeek(
+        authorization="YOUR_AUTHORIZATION",
+        index_id="YOUR_INDEX_ID",
+        api_key="YOUR_API_KEY",
+    )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: MixpeekEnvironment = MixpeekEnvironment.DEFAULT,
+        authorization: typing.Optional[str] = None,
+        index_id: typing.Optional[str] = None,
+        api_key: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = os.getenv("MIXPEEK_API_KEY"),
+        timeout: typing.Optional[float] = None,
+        httpx_client: typing.Optional[httpx.AsyncClient] = None
+    ):
+        _defaulted_timeout = timeout if timeout is not None else 60 if httpx_client is None else None
+        if api_key is None:
+            raise ApiError(
+                body="The client must be instantiated be either passing in api_key or setting MIXPEEK_API_KEY"
+            )
+        self._client_wrapper = AsyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            authorization=authorization,
+            index_id=index_id,
+            api_key=api_key,
+            httpx_client=httpx.AsyncClient(timeout=_defaulted_timeout) if httpx_client is None else httpx_client,
+            timeout=_defaulted_timeout,
+        )
+        self.users = AsyncUsersClient(client_wrapper=self._client_wrapper)
+        self.extract = AsyncExtractClient(client_wrapper=self._client_wrapper)
+        self.generators = AsyncGeneratorsClient(client_wrapper=self._client_wrapper)
+        self.embed = AsyncEmbedClient(client_wrapper=self._client_wrapper)
+        self.pipelines = AsyncPipelinesClient(client_wrapper=self._client_wrapper)
+        self.workflows = AsyncWorkflowsClient(client_wrapper=self._client_wrapper)
+        self.storage = AsyncStorageClient(client_wrapper=self._client_wrapper)
+        self.parse = AsyncParseClient(client_wrapper=self._client_wrapper)
+
+
+def _get_base_url(*, base_url: typing.Optional[str] = None, environment: MixpeekEnvironment) -> str:
+    if base_url is not None:
+        return base_url
+    elif environment is not None:
+        return environment.value
+    else:
+        raise Exception("Please pass in either base_url or environment to construct the client")

mixpeek-0.6.2/src/mixpeek/client.py

@@ -0,0 +1,65 @@
+
+import typing
+import httpx
+
+from .base_client import BaseMixpeek, \
+    AsyncBaseMixpeek
+from .types.message import Message
+from .types.model import Model
+from .types.settings import Settings
+from .types.generation_response import GenerationResponse
+from .core.request_options import RequestOptions
+
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class Mixpeek(BaseMixpeek): 
+
+    def generate(
+        self,
+        *,
+        model: Model,
+        # Pydantic model that represents the JSON schema of the response
+        response_format: typing.Optional[typing.Any],
+        context: typing.Optional[str] = OMIT,
+        messages: typing.Sequence[Message],
+        settings: typing.Optional[Settings] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GenerationResponse:
+        if response_format is not None:
+            response_format = response_format.model_json_schema()
+        return self.generators.generate(
+            model=model,
+            response_format=response_format,
+            context=context,
+            messages=messages,
+            settings=settings,
+            request_options=request_options,
+        )
+
+
+class AsyncMixpeek(AsyncBaseMixpeek):
+
+    async def generate(
+        self,
+        *,
+        model: Model,
+        # Pydantic model that represents the JSON schema of the response
+        response_format: typing.Optional[typing.Any],
+        context: typing.Optional[str] = OMIT,
+        messages: typing.Sequence[Message],
+        settings: typing.Optional[Settings] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GenerationResponse:
+        if response_format is not None:
+            response_format = response_format.model_json_schema()
+        return await self.generators.generate(
+            model=model,
+            response_format=response_format,
+            context=context,
+            messages=messages,
+            settings=settings,
+            request_options=request_options,
+        )

mixpeek-0.6.2/src/mixpeek/core/__init__.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .api_error import ApiError
+from .client_wrapper import AsyncClientWrapper, BaseClientWrapper, SyncClientWrapper
+from .datetime_utils import serialize_datetime
+from .file import File, convert_file_dict_to_httpx_tuples
+from .http_client import AsyncHttpClient, HttpClient
+from .jsonable_encoder import jsonable_encoder
+from .remove_none_from_dict import remove_none_from_dict
+from .request_options import RequestOptions
+
+__all__ = [
+    "ApiError",
+    "AsyncClientWrapper",
+    "AsyncHttpClient",
+    "BaseClientWrapper",
+    "File",
+    "HttpClient",
+    "RequestOptions",
+    "SyncClientWrapper",
+    "convert_file_dict_to_httpx_tuples",
+    "jsonable_encoder",
+    "remove_none_from_dict",
+    "serialize_datetime",
+]

mixpeek-0.6.2/src/mixpeek/core/api_error.py

@@ -0,0 +1,15 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+
+class ApiError(Exception):
+    status_code: typing.Optional[int]
+    body: typing.Any
+
+    def __init__(self, *, status_code: typing.Optional[int] = None, body: typing.Any = None):
+        self.status_code = status_code
+        self.body = body
+
+    def __str__(self) -> str:
+        return f"status_code: {self.status_code}, body: {self.body}"