usecortex-ai 0.1.0__py3-none-any.whl

cortex_ai/__init__.py

@@ -0,0 +1,103 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .types import (
+    ActualErrorResponse,
+    AppSourcesUploadData,
+    AttachmentModel,
+    BatchUploadData,
+    Bm25OperatorType,
+    ContentModel,
+    DeleteMemoryRequest,
+    EmbeddingsCreateCollectionData,
+    EmbeddingsDeleteData,
+    EmbeddingsGetData,
+    EmbeddingsSearchData,
+    ErrorResponse,
+    ExtendedContext,
+    FetchContentData,
+    FileUploadResult,
+    FullTextSearchData,
+    HttpValidationError,
+    ListSourcesResponse,
+    MarkdownUploadRequest,
+    ProcessingStatus,
+    RelatedChunk,
+    SearchChunk,
+    SearchData,
+    SingleUploadData,
+    Source,
+    SourceContent,
+    SourceModel,
+    TenantCreateData,
+    TenantStats,
+    ValidationError,
+    ValidationErrorLocItem,
+)
+from .errors import (
+    BadRequestError,
+    ForbiddenError,
+    InternalServerError,
+    NotFoundError,
+    ServiceUnavailableError,
+    UnauthorizedError,
+    UnprocessableEntityError,
+)
+from . import embeddings, fetch, search, sources, tenant, upload, user, user_memory
+from .client import AsyncCortexAI, CortexAI
+from .environment import CortexAIEnvironment
+from .search import Alpha
+
+__all__ = [
+    "ActualErrorResponse",
+    "Alpha",
+    "AppSourcesUploadData",
+    "AsyncCortexAI",
+    "AttachmentModel",
+    "BadRequestError",
+    "BatchUploadData",
+    "Bm25OperatorType",
+    "ContentModel",
+    "CortexAI",
+    "CortexAIEnvironment",
+    "DeleteMemoryRequest",
+    "EmbeddingsCreateCollectionData",
+    "EmbeddingsDeleteData",
+    "EmbeddingsGetData",
+    "EmbeddingsSearchData",
+    "ErrorResponse",
+    "ExtendedContext",
+    "FetchContentData",
+    "FileUploadResult",
+    "ForbiddenError",
+    "FullTextSearchData",
+    "HttpValidationError",
+    "InternalServerError",
+    "ListSourcesResponse",
+    "MarkdownUploadRequest",
+    "NotFoundError",
+    "ProcessingStatus",
+    "RelatedChunk",
+    "SearchChunk",
+    "SearchData",
+    "ServiceUnavailableError",
+    "SingleUploadData",
+    "Source",
+    "SourceContent",
+    "SourceModel",
+    "TenantCreateData",
+    "TenantStats",
+    "UnauthorizedError",
+    "UnprocessableEntityError",
+    "ValidationError",
+    "ValidationErrorLocItem",
+    "embeddings",
+    "fetch",
+    "search",
+    "sources",
+    "tenant",
+    "upload",
+    "user",
+    "user_memory",
+]

cortex_ai/client.py

@@ -0,0 +1,244 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .core.request_options import RequestOptions
+from .embeddings.client import AsyncEmbeddingsClient, EmbeddingsClient
+from .environment import CortexAIEnvironment
+from .fetch.client import AsyncFetchClient, FetchClient
+from .raw_client import AsyncRawCortexAI, RawCortexAI
+from .search.client import AsyncSearchClient, SearchClient
+from .sources.client import AsyncSourcesClient, SourcesClient
+from .tenant.client import AsyncTenantClient, TenantClient
+from .upload.client import AsyncUploadClient, UploadClient
+from .user.client import AsyncUserClient, UserClient
+from .user_memory.client import AsyncUserMemoryClient, UserMemoryClient
+
+
+class CortexAI:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : CortexAIEnvironment
+        The environment to use for requests from the client. from .environment import CortexAIEnvironment
+
+
+
+        Defaults to CortexAIEnvironment.CORTEX_PROD
+
+
+
+    token : typing.Optional[typing.Union[str, typing.Callable[[], str]]]
+    headers : typing.Optional[typing.Dict[str, str]]
+        Additional headers to send with every request.
+
+    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 this default is not enforced.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    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.
+
+    Examples
+    --------
+    from cortex-ai import CortexAI
+
+    client = CortexAI(token="YOUR_TOKEN", )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: CortexAIEnvironment = CortexAIEnvironment.CORTEX_PROD,
+        token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        timeout: typing.Optional[float] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.Client] = None,
+    ):
+        _defaulted_timeout = (
+            timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
+        )
+        self._client_wrapper = SyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            token=token,
+            headers=headers,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.Client(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
+            if follow_redirects is not None
+            else httpx.Client(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
+        )
+        self._raw_client = RawCortexAI(client_wrapper=self._client_wrapper)
+        self.search = SearchClient(client_wrapper=self._client_wrapper)
+        self.sources = SourcesClient(client_wrapper=self._client_wrapper)
+        self.user_memory = UserMemoryClient(client_wrapper=self._client_wrapper)
+        self.fetch = FetchClient(client_wrapper=self._client_wrapper)
+        self.upload = UploadClient(client_wrapper=self._client_wrapper)
+        self.embeddings = EmbeddingsClient(client_wrapper=self._client_wrapper)
+        self.user = UserClient(client_wrapper=self._client_wrapper)
+        self.tenant = TenantClient(client_wrapper=self._client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawCortexAI:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawCortexAI
+        """
+        return self._raw_client
+
+    def root_get(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Optional[typing.Any]:
+        """
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Optional[typing.Any]
+            Successful Response
+
+        Examples
+        --------
+        from cortex-ai import CortexAI
+
+        client = CortexAI(token="YOUR_TOKEN", )
+        client.root_get()
+        """
+        _response = self._raw_client.root_get(request_options=request_options)
+        return _response.data
+
+
+class AsyncCortexAI:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
+
+    Parameters
+    ----------
+    base_url : typing.Optional[str]
+        The base url to use for requests from the client.
+
+    environment : CortexAIEnvironment
+        The environment to use for requests from the client. from .environment import CortexAIEnvironment
+
+
+
+        Defaults to CortexAIEnvironment.CORTEX_PROD
+
+
+
+    token : typing.Optional[typing.Union[str, typing.Callable[[], str]]]
+    headers : typing.Optional[typing.Dict[str, str]]
+        Additional headers to send with every request.
+
+    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 this default is not enforced.
+
+    follow_redirects : typing.Optional[bool]
+        Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
+
+    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.
+
+    Examples
+    --------
+    from cortex-ai import AsyncCortexAI
+
+    client = AsyncCortexAI(token="YOUR_TOKEN", )
+    """
+
+    def __init__(
+        self,
+        *,
+        base_url: typing.Optional[str] = None,
+        environment: CortexAIEnvironment = CortexAIEnvironment.CORTEX_PROD,
+        token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        timeout: typing.Optional[float] = None,
+        follow_redirects: typing.Optional[bool] = True,
+        httpx_client: typing.Optional[httpx.AsyncClient] = None,
+    ):
+        _defaulted_timeout = (
+            timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
+        )
+        self._client_wrapper = AsyncClientWrapper(
+            base_url=_get_base_url(base_url=base_url, environment=environment),
+            token=token,
+            headers=headers,
+            httpx_client=httpx_client
+            if httpx_client is not None
+            else httpx.AsyncClient(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
+            if follow_redirects is not None
+            else httpx.AsyncClient(timeout=_defaulted_timeout),
+            timeout=_defaulted_timeout,
+        )
+        self._raw_client = AsyncRawCortexAI(client_wrapper=self._client_wrapper)
+        self.search = AsyncSearchClient(client_wrapper=self._client_wrapper)
+        self.sources = AsyncSourcesClient(client_wrapper=self._client_wrapper)
+        self.user_memory = AsyncUserMemoryClient(client_wrapper=self._client_wrapper)
+        self.fetch = AsyncFetchClient(client_wrapper=self._client_wrapper)
+        self.upload = AsyncUploadClient(client_wrapper=self._client_wrapper)
+        self.embeddings = AsyncEmbeddingsClient(client_wrapper=self._client_wrapper)
+        self.user = AsyncUserClient(client_wrapper=self._client_wrapper)
+        self.tenant = AsyncTenantClient(client_wrapper=self._client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawCortexAI:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawCortexAI
+        """
+        return self._raw_client
+
+    async def root_get(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.Optional[typing.Any]:
+        """
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Optional[typing.Any]
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from cortex-ai import AsyncCortexAI
+
+        client = AsyncCortexAI(token="YOUR_TOKEN", )
+        async def main() -> None:
+            await client.root_get()
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.root_get(request_options=request_options)
+        return _response.data
+
+
+def _get_base_url(*, base_url: typing.Optional[str] = None, environment: CortexAIEnvironment) -> 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")

cortex_ai/core/__init__.py

@@ -0,0 +1,52 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+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, with_content_type
+from .http_client import AsyncHttpClient, HttpClient
+from .http_response import AsyncHttpResponse, HttpResponse
+from .jsonable_encoder import jsonable_encoder
+from .pydantic_utilities import (
+    IS_PYDANTIC_V2,
+    UniversalBaseModel,
+    UniversalRootModel,
+    parse_obj_as,
+    universal_field_validator,
+    universal_root_validator,
+    update_forward_refs,
+)
+from .query_encoder import encode_query
+from .remove_none_from_dict import remove_none_from_dict
+from .request_options import RequestOptions
+from .serialization import FieldMetadata, convert_and_respect_annotation_metadata
+
+__all__ = [
+    "ApiError",
+    "AsyncClientWrapper",
+    "AsyncHttpClient",
+    "AsyncHttpResponse",
+    "BaseClientWrapper",
+    "FieldMetadata",
+    "File",
+    "HttpClient",
+    "HttpResponse",
+    "IS_PYDANTIC_V2",
+    "RequestOptions",
+    "SyncClientWrapper",
+    "UniversalBaseModel",
+    "UniversalRootModel",
+    "convert_and_respect_annotation_metadata",
+    "convert_file_dict_to_httpx_tuples",
+    "encode_query",
+    "jsonable_encoder",
+    "parse_obj_as",
+    "remove_none_from_dict",
+    "serialize_datetime",
+    "universal_field_validator",
+    "universal_root_validator",
+    "update_forward_refs",
+    "with_content_type",
+]

cortex_ai/core/api_error.py

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

cortex_ai/core/client_wrapper.py

@@ -0,0 +1,84 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+from .http_client import AsyncHttpClient, HttpClient
+
+
+class BaseClientWrapper:
+    def __init__(
+        self,
+        *,
+        token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        base_url: str,
+        timeout: typing.Optional[float] = None,
+    ):
+        self._token = token
+        self._headers = headers
+        self._base_url = base_url
+        self._timeout = timeout
+
+    def get_headers(self) -> typing.Dict[str, str]:
+        headers: typing.Dict[str, str] = {
+            "X-Fern-Language": "Python",
+            **(self.get_custom_headers() or {}),
+        }
+        token = self._get_token()
+        if token is not None:
+            headers["Authorization"] = f"Bearer {token}"
+        return headers
+
+    def _get_token(self) -> typing.Optional[str]:
+        if isinstance(self._token, str) or self._token is None:
+            return self._token
+        else:
+            return self._token()
+
+    def get_custom_headers(self) -> typing.Optional[typing.Dict[str, str]]:
+        return self._headers
+
+    def get_base_url(self) -> str:
+        return self._base_url
+
+    def get_timeout(self) -> typing.Optional[float]:
+        return self._timeout
+
+
+class SyncClientWrapper(BaseClientWrapper):
+    def __init__(
+        self,
+        *,
+        token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        base_url: str,
+        timeout: typing.Optional[float] = None,
+        httpx_client: httpx.Client,
+    ):
+        super().__init__(token=token, headers=headers, base_url=base_url, timeout=timeout)
+        self.httpx_client = HttpClient(
+            httpx_client=httpx_client,
+            base_headers=self.get_headers,
+            base_timeout=self.get_timeout,
+            base_url=self.get_base_url,
+        )
+
+
+class AsyncClientWrapper(BaseClientWrapper):
+    def __init__(
+        self,
+        *,
+        token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
+        headers: typing.Optional[typing.Dict[str, str]] = None,
+        base_url: str,
+        timeout: typing.Optional[float] = None,
+        httpx_client: httpx.AsyncClient,
+    ):
+        super().__init__(token=token, headers=headers, base_url=base_url, timeout=timeout)
+        self.httpx_client = AsyncHttpClient(
+            httpx_client=httpx_client,
+            base_headers=self.get_headers,
+            base_timeout=self.get_timeout,
+            base_url=self.get_base_url,
+        )

cortex_ai/core/datetime_utils.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+
+
+def serialize_datetime(v: dt.datetime) -> str:
+    """
+    Serialize a datetime including timezone info.
+
+    Uses the timezone info provided if present, otherwise uses the current runtime's timezone info.
+
+    UTC datetimes end in "Z" while all other timezones are represented as offset from UTC, e.g. +05:00.
+    """
+
+    def _serialize_zoned_datetime(v: dt.datetime) -> str:
+        if v.tzinfo is not None and v.tzinfo.tzname(None) == dt.timezone.utc.tzname(None):
+            # UTC is a special case where we use "Z" at the end instead of "+00:00"
+            return v.isoformat().replace("+00:00", "Z")
+        else:
+            # Delegate to the typical +/- offset format
+            return v.isoformat()
+
+    if v.tzinfo is not None:
+        return _serialize_zoned_datetime(v)
+    else:
+        local_tz = dt.datetime.now().astimezone().tzinfo
+        localized_dt = v.replace(tzinfo=local_tz)
+        return _serialize_zoned_datetime(localized_dt)

cortex_ai/core/file.py

@@ -0,0 +1,67 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from typing import IO, Dict, List, Mapping, Optional, Tuple, Union, cast
+
+# File typing inspired by the flexibility of types within the httpx library
+# https://github.com/encode/httpx/blob/master/httpx/_types.py
+FileContent = Union[IO[bytes], bytes, str]
+File = Union[
+    # file (or bytes)
+    FileContent,
+    # (filename, file (or bytes))
+    Tuple[Optional[str], FileContent],
+    # (filename, file (or bytes), content_type)
+    Tuple[Optional[str], FileContent, Optional[str]],
+    # (filename, file (or bytes), content_type, headers)
+    Tuple[
+        Optional[str],
+        FileContent,
+        Optional[str],
+        Mapping[str, str],
+    ],
+]
+
+
+def convert_file_dict_to_httpx_tuples(
+    d: Dict[str, Union[File, List[File]]],
+) -> List[Tuple[str, File]]:
+    """
+    The format we use is a list of tuples, where the first element is the
+    name of the file and the second is the file object. Typically HTTPX wants
+    a dict, but to be able to send lists of files, you have to use the list
+    approach (which also works for non-lists)
+    https://github.com/encode/httpx/pull/1032
+    """
+
+    httpx_tuples = []
+    for key, file_like in d.items():
+        if isinstance(file_like, list):
+            for file_like_item in file_like:
+                httpx_tuples.append((key, file_like_item))
+        else:
+            httpx_tuples.append((key, file_like))
+    return httpx_tuples
+
+
+def with_content_type(*, file: File, default_content_type: str) -> File:
+    """
+    This function resolves to the file's content type, if provided, and defaults
+    to the default_content_type value if not.
+    """
+    if isinstance(file, tuple):
+        if len(file) == 2:
+            filename, content = cast(Tuple[Optional[str], FileContent], file)  # type: ignore
+            return (filename, content, default_content_type)
+        elif len(file) == 3:
+            filename, content, file_content_type = cast(Tuple[Optional[str], FileContent, Optional[str]], file)  # type: ignore
+            out_content_type = file_content_type or default_content_type
+            return (filename, content, out_content_type)
+        elif len(file) == 4:
+            filename, content, file_content_type, headers = cast(  # type: ignore
+                Tuple[Optional[str], FileContent, Optional[str], Mapping[str, str]], file
+            )
+            out_content_type = file_content_type or default_content_type
+            return (filename, content, out_content_type, headers)
+        else:
+            raise ValueError(f"Unexpected tuple length: {len(file)}")
+    return (None, file, default_content_type)

cortex_ai/core/force_multipart.py

@@ -0,0 +1,18 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from typing import Any, Dict
+
+
+class ForceMultipartDict(Dict[str, Any]):
+    """
+    A dictionary subclass that always evaluates to True in boolean contexts.
+
+    This is used to force multipart/form-data encoding in HTTP requests even when
+    the dictionary is empty, which would normally evaluate to False.
+    """
+
+    def __bool__(self) -> bool:
+        return True
+
+
+FORCE_MULTIPART = ForceMultipartDict()