mixpeek 0.6.1__py3-none-any.whl → 0.6.2__py3-none-any.whl

mixpeek/__init__.py

@@ -1,18 +1,16 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from .types import (
+    ApiKey,
     AudioParams,
-    ConfigsRequest,
     ConfigsResponse,
     Connection,
     ConnectionEngine,
     CsvParams,
-    DestinationSchema,
-    EmbeddingRequest,
+    Destination,
     EmbeddingResponse,
     ErrorMessage,
     ErrorResponse,
-    FieldSchema,
     FieldType,
     GenerationResponse,
     HtmlParams,
@@ -22,13 +20,15 @@ from .types import (
     Metadata,
     Modality,
     Model,
+    Models,
     PdfParams,
-    PipelineResponse,
     PptParams,
     PptxParams,
     Settings,
-    SourceSchema,
+    Source,
+    SourceDestinationMapping,
     TxtParams,
+    User,
     ValidationError,
     ValidationErrorLocItem,
     VideoParams,
@@ -44,23 +44,22 @@ from .errors import (
     UnauthorizedError,
     UnprocessableEntityError,
 )
-from . import generators, parse, pipelines, storage, workflows
+from . import embed, extract, generators, parse, pipelines, storage, users, workflows
+from .environment import MixpeekEnvironment
 from .version import __version__
 
 __all__ = [
+    "ApiKey",
     "AudioParams",
     "BadRequestError",
-    "ConfigsRequest",
     "ConfigsResponse",
     "Connection",
     "ConnectionEngine",
     "CsvParams",
-    "DestinationSchema",
-    "EmbeddingRequest",
+    "Destination",
     "EmbeddingResponse",
     "ErrorMessage",
     "ErrorResponse",
-    "FieldSchema",
     "FieldType",
     "ForbiddenError",
     "GenerationResponse",
@@ -70,18 +69,21 @@ __all__ = [
     "InternalServerError",
     "Message",
     "Metadata",
+    "MixpeekEnvironment",
     "Modality",
     "Model",
+    "Models",
     "NotFoundError",
     "PdfParams",
-    "PipelineResponse",
     "PptParams",
     "PptxParams",
     "Settings",
-    "SourceSchema",
+    "Source",
+    "SourceDestinationMapping",
     "TxtParams",
     "UnauthorizedError",
     "UnprocessableEntityError",
+    "User",
     "ValidationError",
     "ValidationErrorLocItem",
     "VideoParams",
@@ -89,9 +91,12 @@ __all__ = [
     "WorkflowSettings",
     "XlsxParams",
     "__version__",
+    "embed",
+    "extract",
     "generators",
     "parse",
     "pipelines",
     "storage",
+    "users",
     "workflows",
 ]

mixpeek/base_client.py

@@ -7,10 +7,14 @@ 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
 
 
@@ -19,7 +23,11 @@ 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: str. The base url to use for requests from the client.
+        - 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].
 
@@ -37,14 +45,14 @@ class BaseMixpeek:
         authorization="YOUR_AUTHORIZATION",
         index_id="YOUR_INDEX_ID",
         api_key="YOUR_API_KEY",
-        base_url="https://yourhost.com/path/to/api",
     )
     """
 
     def __init__(
         self,
         *,
-        base_url: str,
+        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"),
@@ -57,18 +65,21 @@ class BaseMixpeek:
                 body="The client must be instantiated be either passing in api_key or setting MIXPEEK_API_KEY"
             )
         self._client_wrapper = SyncClientWrapper(
-            base_url=base_url,
+            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.parse = ParseClient(client_wrapper=self._client_wrapper)
         self.workflows = WorkflowsClient(client_wrapper=self._client_wrapper)
-        self.generators = GeneratorsClient(client_wrapper=self._client_wrapper)
         self.storage = StorageClient(client_wrapper=self._client_wrapper)
+        self.parse = ParseClient(client_wrapper=self._client_wrapper)
 
 
 class AsyncBaseMixpeek:
@@ -76,7 +87,11 @@ 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: str. The base url to use for requests from the client.
+        - 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].
 
@@ -94,14 +109,14 @@ class AsyncBaseMixpeek:
         authorization="YOUR_AUTHORIZATION",
         index_id="YOUR_INDEX_ID",
         api_key="YOUR_API_KEY",
-        base_url="https://yourhost.com/path/to/api",
     )
     """
 
     def __init__(
         self,
         *,
-        base_url: str,
+        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"),
@@ -114,15 +129,27 @@ class AsyncBaseMixpeek:
                 body="The client must be instantiated be either passing in api_key or setting MIXPEEK_API_KEY"
             )
         self._client_wrapper = AsyncClientWrapper(
-            base_url=base_url,
+            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.parse = AsyncParseClient(client_wrapper=self._client_wrapper)
         self.workflows = AsyncWorkflowsClient(client_wrapper=self._client_wrapper)
-        self.generators = AsyncGeneratorsClient(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/core/client_wrapper.py

@@ -27,7 +27,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "mixpeek",
-            "X-Fern-SDK-Version": "0.6.1",
+            "X-Fern-SDK-Version": "0.6.2",
         }
         if self._authorization is not None:
             headers["Authorization"] = self._authorization

mixpeek/embed/__init__.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+

mixpeek/embed/client.py

@@ -0,0 +1,350 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+import urllib.parse
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.jsonable_encoder import jsonable_encoder
+from ..core.remove_none_from_dict import remove_none_from_dict
+from ..core.request_options import RequestOptions
+from ..errors.bad_request_error import BadRequestError
+from ..errors.forbidden_error import ForbiddenError
+from ..errors.internal_server_error import InternalServerError
+from ..errors.not_found_error import NotFoundError
+from ..errors.unauthorized_error import UnauthorizedError
+from ..errors.unprocessable_entity_error import UnprocessableEntityError
+from ..types.configs_response import ConfigsResponse
+from ..types.embedding_response import EmbeddingResponse
+from ..types.error_response import ErrorResponse
+from ..types.http_validation_error import HttpValidationError
+from ..types.modality import Modality
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class EmbedClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def get_dimensions(
+        self,
+        *,
+        modality: typing.Optional[Modality] = OMIT,
+        model: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ConfigsResponse:
+        """
+        Parameters:
+            - modality: typing.Optional[Modality].
+
+            - model: typing.Optional[str].
+
+            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
+        ---
+        from mixpeek.client import Mixpeek
+
+        client = Mixpeek(
+            authorization="YOUR_AUTHORIZATION",
+            index_id="YOUR_INDEX_ID",
+            api_key="YOUR_API_KEY",
+        )
+        client.embed.get_dimensions()
+        """
+        _request: typing.Dict[str, typing.Any] = {}
+        if modality is not OMIT:
+            _request["modality"] = modality
+        if model is not OMIT:
+            _request["model"] = model
+        _response = self._client_wrapper.httpx_client.request(
+            "POST",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_base_url()}/", "embed/config"),
+            params=jsonable_encoder(
+                request_options.get("additional_query_parameters") if request_options is not None else None
+            ),
+            json=jsonable_encoder(_request)
+            if request_options is None or request_options.get("additional_body_parameters") is None
+            else {
+                **jsonable_encoder(_request),
+                **(jsonable_encoder(remove_none_from_dict(request_options.get("additional_body_parameters", {})))),
+            },
+            headers=jsonable_encoder(
+                remove_none_from_dict(
+                    {
+                        **self._client_wrapper.get_headers(),
+                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
+                    }
+                )
+            ),
+            timeout=request_options.get("timeout_in_seconds")
+            if request_options is not None and request_options.get("timeout_in_seconds") is not None
+            else self._client_wrapper.get_timeout(),
+            retries=0,
+            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(ConfigsResponse, _response.json())  # type: ignore
+        if _response.status_code == 400:
+            raise BadRequestError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        if _response.status_code == 401:
+            raise UnauthorizedError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        if _response.status_code == 403:
+            raise ForbiddenError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        if _response.status_code == 404:
+            raise NotFoundError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        if _response.status_code == 422:
+            raise UnprocessableEntityError(pydantic.parse_obj_as(HttpValidationError, _response.json()))  # type: ignore
+        if _response.status_code == 500:
+            raise InternalServerError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    def input_embed_post(
+        self,
+        *,
+        input: str,
+        modality: typing.Optional[Modality] = OMIT,
+        model: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> EmbeddingResponse:
+        """
+        Parameters:
+            - input: str.
+
+            - modality: typing.Optional[Modality].
+
+            - model: typing.Optional[str].
+
+            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
+        ---
+        from mixpeek.client import Mixpeek
+
+        client = Mixpeek(
+            authorization="YOUR_AUTHORIZATION",
+            index_id="YOUR_INDEX_ID",
+            api_key="YOUR_API_KEY",
+        )
+        client.embed.input_embed_post(
+            input="input",
+        )
+        """
+        _request: typing.Dict[str, typing.Any] = {"input": input}
+        if modality is not OMIT:
+            _request["modality"] = modality
+        if model is not OMIT:
+            _request["model"] = model
+        _response = self._client_wrapper.httpx_client.request(
+            "POST",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_base_url()}/", "embed"),
+            params=jsonable_encoder(
+                request_options.get("additional_query_parameters") if request_options is not None else None
+            ),
+            json=jsonable_encoder(_request)
+            if request_options is None or request_options.get("additional_body_parameters") is None
+            else {
+                **jsonable_encoder(_request),
+                **(jsonable_encoder(remove_none_from_dict(request_options.get("additional_body_parameters", {})))),
+            },
+            headers=jsonable_encoder(
+                remove_none_from_dict(
+                    {
+                        **self._client_wrapper.get_headers(),
+                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
+                    }
+                )
+            ),
+            timeout=request_options.get("timeout_in_seconds")
+            if request_options is not None and request_options.get("timeout_in_seconds") is not None
+            else self._client_wrapper.get_timeout(),
+            retries=0,
+            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(EmbeddingResponse, _response.json())  # type: ignore
+        if _response.status_code == 400:
+            raise BadRequestError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        if _response.status_code == 401:
+            raise UnauthorizedError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        if _response.status_code == 403:
+            raise ForbiddenError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        if _response.status_code == 404:
+            raise NotFoundError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        if _response.status_code == 422:
+            raise UnprocessableEntityError(pydantic.parse_obj_as(HttpValidationError, _response.json()))  # type: ignore
+        if _response.status_code == 500:
+            raise InternalServerError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+
+class AsyncEmbedClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def get_dimensions(
+        self,
+        *,
+        modality: typing.Optional[Modality] = OMIT,
+        model: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ConfigsResponse:
+        """
+        Parameters:
+            - modality: typing.Optional[Modality].
+
+            - model: typing.Optional[str].
+
+            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
+        ---
+        from mixpeek.client import AsyncMixpeek
+
+        client = AsyncMixpeek(
+            authorization="YOUR_AUTHORIZATION",
+            index_id="YOUR_INDEX_ID",
+            api_key="YOUR_API_KEY",
+        )
+        await client.embed.get_dimensions()
+        """
+        _request: typing.Dict[str, typing.Any] = {}
+        if modality is not OMIT:
+            _request["modality"] = modality
+        if model is not OMIT:
+            _request["model"] = model
+        _response = await self._client_wrapper.httpx_client.request(
+            "POST",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_base_url()}/", "embed/config"),
+            params=jsonable_encoder(
+                request_options.get("additional_query_parameters") if request_options is not None else None
+            ),
+            json=jsonable_encoder(_request)
+            if request_options is None or request_options.get("additional_body_parameters") is None
+            else {
+                **jsonable_encoder(_request),
+                **(jsonable_encoder(remove_none_from_dict(request_options.get("additional_body_parameters", {})))),
+            },
+            headers=jsonable_encoder(
+                remove_none_from_dict(
+                    {
+                        **self._client_wrapper.get_headers(),
+                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
+                    }
+                )
+            ),
+            timeout=request_options.get("timeout_in_seconds")
+            if request_options is not None and request_options.get("timeout_in_seconds") is not None
+            else self._client_wrapper.get_timeout(),
+            retries=0,
+            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(ConfigsResponse, _response.json())  # type: ignore
+        if _response.status_code == 400:
+            raise BadRequestError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        if _response.status_code == 401:
+            raise UnauthorizedError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        if _response.status_code == 403:
+            raise ForbiddenError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        if _response.status_code == 404:
+            raise NotFoundError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        if _response.status_code == 422:
+            raise UnprocessableEntityError(pydantic.parse_obj_as(HttpValidationError, _response.json()))  # type: ignore
+        if _response.status_code == 500:
+            raise InternalServerError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def input_embed_post(
+        self,
+        *,
+        input: str,
+        modality: typing.Optional[Modality] = OMIT,
+        model: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> EmbeddingResponse:
+        """
+        Parameters:
+            - input: str.
+
+            - modality: typing.Optional[Modality].
+
+            - model: typing.Optional[str].
+
+            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
+        ---
+        from mixpeek.client import AsyncMixpeek
+
+        client = AsyncMixpeek(
+            authorization="YOUR_AUTHORIZATION",
+            index_id="YOUR_INDEX_ID",
+            api_key="YOUR_API_KEY",
+        )
+        await client.embed.input_embed_post(
+            input="input",
+        )
+        """
+        _request: typing.Dict[str, typing.Any] = {"input": input}
+        if modality is not OMIT:
+            _request["modality"] = modality
+        if model is not OMIT:
+            _request["model"] = model
+        _response = await self._client_wrapper.httpx_client.request(
+            "POST",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_base_url()}/", "embed"),
+            params=jsonable_encoder(
+                request_options.get("additional_query_parameters") if request_options is not None else None
+            ),
+            json=jsonable_encoder(_request)
+            if request_options is None or request_options.get("additional_body_parameters") is None
+            else {
+                **jsonable_encoder(_request),
+                **(jsonable_encoder(remove_none_from_dict(request_options.get("additional_body_parameters", {})))),
+            },
+            headers=jsonable_encoder(
+                remove_none_from_dict(
+                    {
+                        **self._client_wrapper.get_headers(),
+                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
+                    }
+                )
+            ),
+            timeout=request_options.get("timeout_in_seconds")
+            if request_options is not None and request_options.get("timeout_in_seconds") is not None
+            else self._client_wrapper.get_timeout(),
+            retries=0,
+            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(EmbeddingResponse, _response.json())  # type: ignore
+        if _response.status_code == 400:
+            raise BadRequestError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        if _response.status_code == 401:
+            raise UnauthorizedError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        if _response.status_code == 403:
+            raise ForbiddenError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        if _response.status_code == 404:
+            raise NotFoundError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        if _response.status_code == 422:
+            raise UnprocessableEntityError(pydantic.parse_obj_as(HttpValidationError, _response.json()))  # type: ignore
+        if _response.status_code == 500:
+            raise InternalServerError(pydantic.parse_obj_as(ErrorResponse, _response.json()))  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)

mixpeek/environment.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+
+
+class MixpeekEnvironment(enum.Enum):
+    DEFAULT = "https://api.mixpeek.com"

mixpeek/extract/__init__.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+