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

mixpeek/client.py

@@ -1,9 +1,7 @@
-
 import typing
 import httpx
 
-from .base_client import BaseMixpeek, \
-    AsyncBaseMixpeek
+from .base_client import BaseMixpeek, AsyncBaseMixpeek
 from .types.message import Message
 from .types.model import Model
 from .types.settings import Settings
@@ -15,7 +13,7 @@ from .core.request_options import RequestOptions
 OMIT = typing.cast(typing.Any, ...)
 
 
-class Mixpeek(BaseMixpeek): 
+class Mixpeek(BaseMixpeek):
 
     def generate(
         self,
@@ -30,7 +28,8 @@ class Mixpeek(BaseMixpeek):
     ) -> GenerationResponse:
         if response_format is not None:
             response_format = response_format.model_json_schema()
-        return self.generators.generate(
+
+        return self.base_generate(
             model=model,
             response_format=response_format,
             context=context,
@@ -55,11 +54,12 @@ class AsyncMixpeek(AsyncBaseMixpeek):
     ) -> GenerationResponse:
         if response_format is not None:
             response_format = response_format.model_json_schema()
-        return await self.generators.generate(
+
+        return await self.base_generate(
             model=model,
             response_format=response_format,
             context=context,
             messages=messages,
             settings=settings,
             request_options=request_options,
-        )
+        )

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.5",
         }
         if self._authorization is not None:
             headers["Authorization"] = self._authorization

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/{pipelines → pipeline}/client.py

@@ -1,6 +1,5 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import datetime as dt
 import typing
 import urllib.parse
 from json.decoder import JSONDecodeError
@@ -16,12 +15,11 @@ 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.connection import Connection
-from ..types.destination_schema import DestinationSchema
 from ..types.error_response import ErrorResponse
 from ..types.http_validation_error import HttpValidationError
 from ..types.pipeline_response import PipelineResponse
-from ..types.source_schema import SourceSchema
+from ..types.pipeline_task_response import PipelineTaskResponse
+from ..types.source_destination_mapping import SourceDestinationMapping
 
 try:
     import pydantic.v1 as pydantic  # type: ignore
@@ -32,11 +30,13 @@ except ImportError:
 OMIT = typing.cast(typing.Any, ...)
 
 
-class PipelinesClient:
+class PipelineClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    def invoke(self, pipeline_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
+    def invoke(
+        self, pipeline_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PipelineTaskResponse:
         """
         Parameters:
             - pipeline_id: str.
@@ -49,9 +49,8 @@ class PipelinesClient:
             authorization="YOUR_AUTHORIZATION",
             index_id="YOUR_INDEX_ID",
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
-        client.pipelines.invoke(
+        client.pipeline.invoke(
             pipeline_id="pipeline_id",
         )
         """
@@ -81,7 +80,7 @@ class PipelinesClient:
             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(typing.Any, _response.json())  # type: ignore
+            return pydantic.parse_obj_as(PipelineTaskResponse, _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:
@@ -103,87 +102,52 @@ class PipelinesClient:
     def create(
         self,
         *,
-        connection_id: str,
-        pipeline_id: typing.Optional[str] = OMIT,
-        connection: typing.Optional[Connection] = OMIT,
-        source: SourceSchema,
-        destination: DestinationSchema,
+        source_destination_mappings: typing.Sequence[SourceDestinationMapping],
         metadata: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
-        enabled: typing.Optional[bool] = OMIT,
-        last_run: typing.Optional[dt.datetime] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> PipelineResponse:
         """
         Parameters:
-            - connection_id: str.
-
-            - pipeline_id: typing.Optional[str].
-
-            - connection: typing.Optional[Connection].
-
-            - source: SourceSchema.
-
-            - destination: DestinationSchema.
+            - source_destination_mappings: typing.Sequence[SourceDestinationMapping]. The source-destination mappings
 
             - metadata: typing.Optional[typing.Dict[str, typing.Any]].
 
-            - enabled: typing.Optional[bool].
-
-            - last_run: typing.Optional[dt.datetime].
-
             - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
         ---
-        from mixpeek import DestinationSchema, FieldSchema, SourceSchema
+        from mixpeek import Destination, Source, SourceDestinationMapping
         from mixpeek.client import Mixpeek
 
         client = Mixpeek(
             authorization="YOUR_AUTHORIZATION",
             index_id="YOUR_INDEX_ID",
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
-        client.pipelines.create(
-            connection_id="connection_id",
-            source=SourceSchema(
-                filters={},
-                on_operation=["on_operation"],
-                field=FieldSchema(
-                    name="name",
-                    type="url",
-                ),
-            ),
-            destination=DestinationSchema(
-                collection="collection",
-                new_field_name="new_field_name",
-                new_embeddings="new_embeddings",
-            ),
+        client.pipeline.create(
+            source_destination_mappings=[
+                SourceDestinationMapping(
+                    embedding_model="embedding_model",
+                    source=Source(
+                        field="field",
+                        type="file_url",
+                        settings={},
+                    ),
+                    destination=Destination(
+                        collection="collection",
+                        field="field",
+                        embedding="embedding",
+                    ),
+                )
+            ],
         )
         """
-        _request: typing.Dict[str, typing.Any] = {"source": source, "destination": destination}
-        if pipeline_id is not OMIT:
-            _request["pipeline_id"] = pipeline_id
-        if connection is not OMIT:
-            _request["connection"] = connection
+        _request: typing.Dict[str, typing.Any] = {"source_destination_mappings": source_destination_mappings}
         if metadata is not OMIT:
             _request["metadata"] = metadata
-        if enabled is not OMIT:
-            _request["enabled"] = enabled
-        if last_run is not OMIT:
-            _request["last_run"] = last_run
         _response = self._client_wrapper.httpx_client.request(
             "POST",
             urllib.parse.urljoin(f"{self._client_wrapper.get_base_url()}/", "pipelines"),
             params=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        "connection_id": connection_id,
-                        **(
-                            request_options.get("additional_query_parameters", {})
-                            if request_options is not None
-                            else {}
-                        ),
-                    }
-                )
+                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
@@ -225,7 +189,7 @@ class PipelinesClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def get_status(self, task_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
+    def status(self, task_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
         """
         Query tasks status.
 
@@ -240,9 +204,8 @@ class PipelinesClient:
             authorization="YOUR_AUTHORIZATION",
             index_id="YOUR_INDEX_ID",
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
-        client.pipelines.get_status(
+        client.pipeline.status(
             task_id="task_id",
         )
         """
@@ -289,11 +252,13 @@ class PipelinesClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
 
-class AsyncPipelinesClient:
+class AsyncPipelineClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    async def invoke(self, pipeline_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
+    async def invoke(
+        self, pipeline_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PipelineTaskResponse:
         """
         Parameters:
             - pipeline_id: str.
@@ -306,9 +271,8 @@ class AsyncPipelinesClient:
             authorization="YOUR_AUTHORIZATION",
             index_id="YOUR_INDEX_ID",
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
-        await client.pipelines.invoke(
+        await client.pipeline.invoke(
             pipeline_id="pipeline_id",
         )
         """
@@ -338,7 +302,7 @@ class AsyncPipelinesClient:
             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(typing.Any, _response.json())  # type: ignore
+            return pydantic.parse_obj_as(PipelineTaskResponse, _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:
@@ -360,87 +324,52 @@ class AsyncPipelinesClient:
     async def create(
         self,
         *,
-        connection_id: str,
-        pipeline_id: typing.Optional[str] = OMIT,
-        connection: typing.Optional[Connection] = OMIT,
-        source: SourceSchema,
-        destination: DestinationSchema,
+        source_destination_mappings: typing.Sequence[SourceDestinationMapping],
         metadata: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
-        enabled: typing.Optional[bool] = OMIT,
-        last_run: typing.Optional[dt.datetime] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> PipelineResponse:
         """
         Parameters:
-            - connection_id: str.
-
-            - pipeline_id: typing.Optional[str].
-
-            - connection: typing.Optional[Connection].
-
-            - source: SourceSchema.
-
-            - destination: DestinationSchema.
+            - source_destination_mappings: typing.Sequence[SourceDestinationMapping]. The source-destination mappings
 
             - metadata: typing.Optional[typing.Dict[str, typing.Any]].
 
-            - enabled: typing.Optional[bool].
-
-            - last_run: typing.Optional[dt.datetime].
-
             - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
         ---
-        from mixpeek import DestinationSchema, FieldSchema, SourceSchema
+        from mixpeek import Destination, Source, SourceDestinationMapping
         from mixpeek.client import AsyncMixpeek
 
         client = AsyncMixpeek(
             authorization="YOUR_AUTHORIZATION",
             index_id="YOUR_INDEX_ID",
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
-        await client.pipelines.create(
-            connection_id="connection_id",
-            source=SourceSchema(
-                filters={},
-                on_operation=["on_operation"],
-                field=FieldSchema(
-                    name="name",
-                    type="url",
-                ),
-            ),
-            destination=DestinationSchema(
-                collection="collection",
-                new_field_name="new_field_name",
-                new_embeddings="new_embeddings",
-            ),
+        await client.pipeline.create(
+            source_destination_mappings=[
+                SourceDestinationMapping(
+                    embedding_model="embedding_model",
+                    source=Source(
+                        field="field",
+                        type="file_url",
+                        settings={},
+                    ),
+                    destination=Destination(
+                        collection="collection",
+                        field="field",
+                        embedding="embedding",
+                    ),
+                )
+            ],
         )
         """
-        _request: typing.Dict[str, typing.Any] = {"source": source, "destination": destination}
-        if pipeline_id is not OMIT:
-            _request["pipeline_id"] = pipeline_id
-        if connection is not OMIT:
-            _request["connection"] = connection
+        _request: typing.Dict[str, typing.Any] = {"source_destination_mappings": source_destination_mappings}
         if metadata is not OMIT:
             _request["metadata"] = metadata
-        if enabled is not OMIT:
-            _request["enabled"] = enabled
-        if last_run is not OMIT:
-            _request["last_run"] = last_run
         _response = await self._client_wrapper.httpx_client.request(
             "POST",
             urllib.parse.urljoin(f"{self._client_wrapper.get_base_url()}/", "pipelines"),
             params=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        "connection_id": connection_id,
-                        **(
-                            request_options.get("additional_query_parameters", {})
-                            if request_options is not None
-                            else {}
-                        ),
-                    }
-                )
+                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
@@ -482,7 +411,7 @@ class AsyncPipelinesClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def get_status(self, task_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
+    async def status(self, task_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
         """
         Query tasks status.
 
@@ -497,9 +426,8 @@ class AsyncPipelinesClient:
             authorization="YOUR_AUTHORIZATION",
             index_id="YOUR_INDEX_ID",
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
-        await client.pipelines.get_status(
+        await client.pipeline.status(
             task_id="task_id",
         )
         """

mixpeek/storage/__init__.py

@@ -1,2 +1,5 @@
 # This file was auto-generated by Fern from our API Definition.
 
+from . import sample
+
+__all__ = ["sample"]

mixpeek/storage/client.py

@@ -17,6 +17,7 @@ from ..errors.unauthorized_error import UnauthorizedError
 from ..errors.unprocessable_entity_error import UnprocessableEntityError
 from ..types.error_response import ErrorResponse
 from ..types.http_validation_error import HttpValidationError
+from .sample.client import AsyncSampleClient, SampleClient
 
 try:
     import pydantic.v1 as pydantic  # type: ignore
@@ -27,8 +28,9 @@ except ImportError:
 class StorageClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
+        self.sample = SampleClient(client_wrapper=self._client_wrapper)
 
-    def test_connection(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
+    def connect(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
         """
         Parameters:
             - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
@@ -39,9 +41,8 @@ class StorageClient:
             authorization="YOUR_AUTHORIZATION",
             index_id="YOUR_INDEX_ID",
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
-        client.storage.test_connection()
+        client.storage.connect()
         """
         _response = self._client_wrapper.httpx_client.request(
             "GET",
@@ -83,67 +84,13 @@ class StorageClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def sample_database(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
-        """
-        Parameters:
-            - 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",
-            base_url="https://yourhost.com/path/to/api",
-        )
-        client.storage.sample_database()
-        """
-        _response = self._client_wrapper.httpx_client.request(
-            "GET",
-            urllib.parse.urljoin(f"{self._client_wrapper.get_base_url()}/", "storage/sample/database"),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            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(typing.Any, _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 AsyncStorageClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
+        self.sample = AsyncSampleClient(client_wrapper=self._client_wrapper)
 
-    async def test_connection(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
+    async def connect(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
         """
         Parameters:
             - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
@@ -154,9 +101,8 @@ class AsyncStorageClient:
             authorization="YOUR_AUTHORIZATION",
             index_id="YOUR_INDEX_ID",
             api_key="YOUR_API_KEY",
-            base_url="https://yourhost.com/path/to/api",
         )
-        await client.storage.test_connection()
+        await client.storage.connect()
         """
         _response = await self._client_wrapper.httpx_client.request(
             "GET",
@@ -197,58 +143,3 @@ class AsyncStorageClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
-
-    async def sample_database(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
-        """
-        Parameters:
-            - 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",
-            base_url="https://yourhost.com/path/to/api",
-        )
-        await client.storage.sample_database()
-        """
-        _response = await self._client_wrapper.httpx_client.request(
-            "GET",
-            urllib.parse.urljoin(f"{self._client_wrapper.get_base_url()}/", "storage/sample/database"),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            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(typing.Any, _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)