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

mixpeek/storage/sample/client.py

@@ -0,0 +1,282 @@
+# 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.error_response import ErrorResponse
+from ...types.http_validation_error import HttpValidationError
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class SampleClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def database(self, database_name: str, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Any:
+        """
+        Parameters:
+            - database_name: 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.storage.sample.database(
+            database_name="database_name",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "GET",
+            urllib.parse.urljoin(
+                f"{self._client_wrapper.get_base_url()}/", f"storage/sample/database/{jsonable_encoder(database_name)}"
+            ),
+            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)
+
+    def collection(
+        self, collection_name: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.Any:
+        """
+        Parameters:
+            - collection_name: 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.storage.sample.collection(
+            collection_name="collection_name",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "GET",
+            urllib.parse.urljoin(
+                f"{self._client_wrapper.get_base_url()}/",
+                f"storage/sample/collection/{jsonable_encoder(collection_name)}",
+            ),
+            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 AsyncSampleClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def database(
+        self, database_name: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.Any:
+        """
+        Parameters:
+            - database_name: 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.storage.sample.database(
+            database_name="database_name",
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "GET",
+            urllib.parse.urljoin(
+                f"{self._client_wrapper.get_base_url()}/", f"storage/sample/database/{jsonable_encoder(database_name)}"
+            ),
+            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)
+
+    async def collection(
+        self, collection_name: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.Any:
+        """
+        Parameters:
+            - collection_name: 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.storage.sample.collection(
+            collection_name="collection_name",
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "GET",
+            urllib.parse.urljoin(
+                f"{self._client_wrapper.get_base_url()}/",
+                f"storage/sample/collection/{jsonable_encoder(collection_name)}",
+            ),
+            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)

mixpeek/types/__init__.py

@@ -1,17 +1,16 @@
 # This file was auto-generated by Fern from our API Definition.
 
+from .api_key import ApiKey
 from .audio_params import AudioParams
-from .configs_request import ConfigsRequest
 from .configs_response import ConfigsResponse
 from .connection import Connection
 from .connection_engine import ConnectionEngine
 from .csv_params import CsvParams
-from .destination_schema import DestinationSchema
-from .embedding_request import EmbeddingRequest
+from .destination import Destination
 from .embedding_response import EmbeddingResponse
 from .error_message import ErrorMessage
 from .error_response import ErrorResponse
-from .field_schema import FieldSchema
+from .extract_response import ExtractResponse
 from .field_type import FieldType
 from .generation_response import GenerationResponse
 from .html_params import HtmlParams
@@ -21,33 +20,37 @@ from .message import Message
 from .metadata import Metadata
 from .modality import Modality
 from .model import Model
+from .models import Models
 from .pdf_params import PdfParams
 from .pipeline_response import PipelineResponse
+from .pipeline_task_response import PipelineTaskResponse
 from .ppt_params import PptParams
 from .pptx_params import PptxParams
 from .settings import Settings
-from .source_schema import SourceSchema
+from .source import Source
+from .source_destination_mapping import SourceDestinationMapping
 from .txt_params import TxtParams
+from .user import User
 from .validation_error import ValidationError
 from .validation_error_loc_item import ValidationErrorLocItem
 from .video_params import VideoParams
+from .workflow_code_response import WorkflowCodeResponse
 from .workflow_response import WorkflowResponse
 from .workflow_settings import WorkflowSettings
 from .xlsx_params import XlsxParams
 
 __all__ = [
+    "ApiKey",
     "AudioParams",
-    "ConfigsRequest",
     "ConfigsResponse",
     "Connection",
     "ConnectionEngine",
     "CsvParams",
-    "DestinationSchema",
-    "EmbeddingRequest",
+    "Destination",
     "EmbeddingResponse",
     "ErrorMessage",
     "ErrorResponse",
-    "FieldSchema",
+    "ExtractResponse",
     "FieldType",
     "GenerationResponse",
     "HtmlParams",
@@ -57,16 +60,21 @@ __all__ = [
     "Metadata",
     "Modality",
     "Model",
+    "Models",
     "PdfParams",
     "PipelineResponse",
+    "PipelineTaskResponse",
     "PptParams",
     "PptxParams",
     "Settings",
-    "SourceSchema",
+    "Source",
+    "SourceDestinationMapping",
     "TxtParams",
+    "User",
     "ValidationError",
     "ValidationErrorLocItem",
     "VideoParams",
+    "WorkflowCodeResponse",
     "WorkflowResponse",
     "WorkflowSettings",
     "XlsxParams",

mixpeek/types/{embedding_request.py → api_key.py}

@@ -4,7 +4,6 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
-from .modality import Modality
 
 try:
     import pydantic.v1 as pydantic  # type: ignore
@@ -12,10 +11,10 @@ except ImportError:
     import pydantic  # type: ignore
 
 
-class EmbeddingRequest(pydantic.BaseModel):
-    input: str
-    modality: typing.Optional[Modality] = None
-    model: typing.Optional[str] = None
+class ApiKey(pydantic.BaseModel):
+    key: typing.Optional[str] = None
+    name: typing.Optional[str] = None
+    created_at: typing.Optional[dt.datetime] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

mixpeek/types/configs_response.py

@@ -12,9 +12,20 @@ except ImportError:
 
 
 class ConfigsResponse(pydantic.BaseModel):
-    dimensions: int
-    elapsed_time: float
-    token_size: int
+    dimensions: int = pydantic.Field()
+    """
+    The dimensions of the processed data.
+    """
+
+    elapsed_time: float = pydantic.Field()
+    """
+    The time taken to process the data.
+    """
+
+    token_size: int = pydantic.Field()
+    """
+    The size of the tokens in the processed data.
+    """
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

mixpeek/types/connection.py

@@ -18,7 +18,7 @@ class Connection(pydantic.BaseModel):
     port: typing.Optional[int] = None
     database: str
     username: str
-    password: typing.Optional[str] = None
+    password: str
     extra_params: typing.Optional[typing.Dict[str, typing.Any]] = None
 
     def json(self, **kwargs: typing.Any) -> str:

mixpeek/types/{field_schema.py → destination.py}

@@ -4,7 +4,6 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
-from .field_type import FieldType
 
 try:
     import pydantic.v1 as pydantic  # type: ignore
@@ -12,11 +11,21 @@ except ImportError:
     import pydantic  # type: ignore
 
 
-class FieldSchema(pydantic.BaseModel):
-    name: str
-    type: FieldType
-    embedding_model: typing.Optional[str] = None
-    settings: typing.Optional[typing.Dict[str, typing.Any]] = None
+class Destination(pydantic.BaseModel):
+    collection: str = pydantic.Field()
+    """
+    The collection name
+    """
+
+    field: str = pydantic.Field()
+    """
+    The field name
+    """
+
+    embedding: str = pydantic.Field()
+    """
+    The embedding
+    """
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

mixpeek/types/embedding_response.py

@@ -12,8 +12,12 @@ except ImportError:
 
 
 class EmbeddingResponse(pydantic.BaseModel):
-    embedding: typing.List[float]
-    elapsed_time: float
+    embedding: typing.List[float] = pydantic.Field()
+    """
+    The embedding of the processed data.
+    """
+
+    elapsed_time: typing.Optional[float] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

mixpeek/types/extract_response.py

@@ -0,0 +1,39 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class ExtractResponse(pydantic.BaseModel):
+    output: typing.List[typing.Any] = pydantic.Field()
+    """
+    The output of the extraction process.
+    """
+
+    metadata: typing.Dict[str, typing.Any] = pydantic.Field()
+    """
+    Metadata related to the extraction process.
+    """
+
+    elapsed_time: typing.Optional[float] = None
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

mixpeek/types/field_type.py

@@ -2,4 +2,4 @@
 
 import typing
 
-FieldType = typing.Union[typing.AnyStr, typing.Literal["url", "inline"]]
+FieldType = typing.Union[typing.AnyStr, typing.Literal["file_url", "contents"]]

mixpeek/types/generation_response.py

@@ -13,11 +13,13 @@ except ImportError:
 
 
 class GenerationResponse(pydantic.BaseModel):
-    success: bool
-    status: int
-    error: typing.Optional[typing.Dict[str, typing.Any]] = None
-    response: typing.Dict[str, typing.Any]
+    response: typing.Dict[str, typing.Any] = pydantic.Field()
+    """
+    The response from the generation.
+    """
+
     metadata: typing.Optional[Metadata] = None
+    elapsed_time: typing.Optional[float] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

mixpeek/types/message.py

@@ -12,8 +12,15 @@ except ImportError:
 
 
 class Message(pydantic.BaseModel):
-    role: str
-    content: str
+    role: str = pydantic.Field()
+    """
+    The role of the message sender.
+    """
+
+    content: str = pydantic.Field()
+    """
+    The content of the message.
+    """
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

mixpeek/types/metadata.py

@@ -13,11 +13,9 @@ except ImportError:
 
 
 class Metadata(pydantic.BaseModel):
-    elapsed_time: typing.Optional[float] = None
     total_tokens: typing.Optional[int] = None
     generation_id: typing.Optional[str] = None
     model: typing.Optional[Model] = None
-    created_at: typing.Optional[dt.datetime] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

mixpeek/types/modality.py

@@ -2,4 +2,4 @@
 
 import typing
 
-Modality = typing.Union[typing.AnyStr, typing.Literal["video", "image", "audio", "text"]]
+Modality = typing.Any

mixpeek/types/model.py

@@ -4,6 +4,7 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from .models import Models
 
 try:
     import pydantic.v1 as pydantic  # type: ignore
@@ -12,8 +13,15 @@ except ImportError:
 
 
 class Model(pydantic.BaseModel):
-    provider: str
-    model: str
+    provider: str = pydantic.Field()
+    """
+    The provider of the model.
+    """
+
+    model: Models = pydantic.Field()
+    """
+    The model to be used.
+    """
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

mixpeek/types/models.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+Models = typing.Union[typing.AnyStr, typing.Literal["gpt-3.5-turbo", "gpt-4-turbo-preview"]]

mixpeek/types/pipeline_response.py

@@ -5,8 +5,7 @@ import typing
 
 from ..core.datetime_utils import serialize_datetime
 from .connection import Connection
-from .destination_schema import DestinationSchema
-from .source_schema import SourceSchema
+from .source_destination_mapping import SourceDestinationMapping
 
 try:
     import pydantic.v1 as pydantic  # type: ignore
@@ -15,14 +14,25 @@ except ImportError:
 
 
 class PipelineResponse(pydantic.BaseModel):
-    pipeline_id: str
-    created_at: dt.datetime
-    last_run: typing.Optional[dt.datetime] = None
-    enabled: bool
-    connection: Connection
-    source: SourceSchema
-    destination: DestinationSchema
+    pipeline_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The ID of the pipeline
+    """
+
+    enabled: typing.Optional[bool] = None
+    connection: typing.Optional[Connection] = None
+    source_destination_mappings: typing.List[SourceDestinationMapping] = pydantic.Field()
+    """
+    The source-destination mappings
+    """
+
     metadata: typing.Optional[typing.Dict[str, typing.Any]] = None
+    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    The creation time
+    """
+
+    last_run: typing.Optional[dt.datetime] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}