usecortex-ai 0.3.4__tar.gz → 0.3.6__tar.gz

{usecortex_ai-0.3.4/src/usecortex_ai.egg-info → usecortex_ai-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: usecortex-ai
-Version: 0.3.4
+Version: 0.3.6
 Summary: The official Python SDK for the Cortex AI platform.
 Author-email: Nishkarsh Shrivastava <nishkarsh@usecortex.ai>
 License: Copyright (c) 2024 Cortex AI

{usecortex_ai-0.3.4 → usecortex_ai-0.3.6}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "usecortex-ai"
 
-version = "0.3.4"
+version = "0.3.6"
 
 authors = [
   { name = "Nishkarsh Shrivastava", email = "nishkarsh@usecortex.ai" },

{usecortex_ai-0.3.4 → usecortex_ai-0.3.6}/src/usecortex_ai/__init__.py

@@ -11,6 +11,7 @@ from .types import (
     Bm25OperatorType,
     BodyScrapeWebpageUploadScrapeWebpagePost,
     BodyUpdateScrapeJobUploadUpdateWebpagePatch,
+    ChunkGraphRelationsResponse,
     ContentModel,
     DeleteMemoryRequest,
     DeleteSources,
@@ -20,19 +21,26 @@ from .types import (
     EmbeddingsDeleteData,
     EmbeddingsGetData,
     EmbeddingsSearchData,
+    Entity,
     ErrorResponse,
     ExtendedContext,
     FetchContentData,
     FileUploadResult,
-    GenerateUserMemoryResponse,
+    GraphRelationsResponse,
     HttpValidationError,
     ListSourcesResponse,
     ListUserMemoriesResponse,
     MarkdownUploadRequest,
+    PathTriplet,
     ProcessingStatus,
     RelatedChunk,
+    RelationEvidence,
     Relations,
+    RetrieveMode,
+    RetrieveResponse,
     RetrieveUserMemoryResponse,
+    ScoredPathResponse,
+    ScoredTripletResponse,
     SearchChunk,
     SingleUploadData,
     Source,
@@ -40,9 +48,12 @@ from .types import (
     SubTenantIdsData,
     TenantCreateData,
     TenantStats,
+    TripleWithEvidence,
+    UserAssistantPair,
     UserMemory,
     ValidationError,
     ValidationErrorLocItem,
+    WebpageScrapeRequest,
 )
 from .errors import (
     BadRequestError,
@@ -70,6 +81,7 @@ __all__ = [
     "Bm25OperatorType",
     "BodyScrapeWebpageUploadScrapeWebpagePost",
     "BodyUpdateScrapeJobUploadUpdateWebpagePatch",
+    "ChunkGraphRelationsResponse",
     "ContentModel",
     "CortexAI",
     "CortexAIEnvironment",
@@ -81,22 +93,29 @@ __all__ = [
     "EmbeddingsDeleteData",
     "EmbeddingsGetData",
     "EmbeddingsSearchData",
+    "Entity",
     "ErrorResponse",
     "ExtendedContext",
     "FetchContentData",
     "FileUploadResult",
     "ForbiddenError",
-    "GenerateUserMemoryResponse",
+    "GraphRelationsResponse",
     "HttpValidationError",
     "InternalServerError",
     "ListSourcesResponse",
     "ListUserMemoriesResponse",
     "MarkdownUploadRequest",
     "NotFoundError",
+    "PathTriplet",
     "ProcessingStatus",
     "RelatedChunk",
+    "RelationEvidence",
     "Relations",
+    "RetrieveMode",
+    "RetrieveResponse",
     "RetrieveUserMemoryResponse",
+    "ScoredPathResponse",
+    "ScoredTripletResponse",
     "SearchChunk",
     "ServiceUnavailableError",
     "SingleUploadData",
@@ -105,11 +124,14 @@ __all__ = [
     "SubTenantIdsData",
     "TenantCreateData",
     "TenantStats",
+    "TripleWithEvidence",
     "UnauthorizedError",
     "UnprocessableEntityError",
+    "UserAssistantPair",
     "UserMemory",
     "ValidationError",
     "ValidationErrorLocItem",
+    "WebpageScrapeRequest",
     "document",
     "embeddings",
     "fetch",

{usecortex_ai-0.3.4 → usecortex_ai-0.3.6}/src/usecortex_ai/search/client.py

@@ -5,6 +5,8 @@ import typing
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
 from ..types.bm_25_operator_type import Bm25OperatorType
+from ..types.retrieve_mode import RetrieveMode
+from ..types.retrieve_response import RetrieveResponse
 from ..types.search_chunk import SearchChunk
 from .raw_client import AsyncRawSearchClient, RawSearchClient
 from .types.alpha import Alpha
@@ -150,11 +152,14 @@ class SearchClient:
         tenant_id: str,
         sub_tenant_id: typing.Optional[str] = OMIT,
         max_chunks: typing.Optional[int] = OMIT,
+        mode: typing.Optional[RetrieveMode] = OMIT,
         alpha: typing.Optional[Alpha] = OMIT,
         recency_bias: typing.Optional[float] = OMIT,
         personalise_search: typing.Optional[bool] = OMIT,
+        graph_context: typing.Optional[bool] = OMIT,
+        extra_context: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> typing.List[SearchChunk]:
+    ) -> RetrieveResponse:
         """
         Search for relevant content within your indexed sources.
 
@@ -175,6 +180,9 @@ class SearchClient:
         max_chunks : typing.Optional[int]
             Maximum number of results to return
 
+        mode : typing.Optional[RetrieveMode]
+            Retrieval mode to use ('fast' or 'accurate')
+
         alpha : typing.Optional[Alpha]
             Search ranking algorithm parameter (0.0-1.0 or 'auto')
 
@@ -184,12 +192,18 @@ class SearchClient:
         personalise_search : typing.Optional[bool]
             Enable personalized search results based on user preferences
 
+        graph_context : typing.Optional[bool]
+            Enable graph context for search results
+
+        extra_context : typing.Optional[str]
+            Additional context provided by the user to guide retrieval
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        typing.List[SearchChunk]
+        RetrieveResponse
             Successful Response
 
         Examples
@@ -204,9 +218,12 @@ class SearchClient:
             tenant_id=tenant_id,
             sub_tenant_id=sub_tenant_id,
             max_chunks=max_chunks,
+            mode=mode,
             alpha=alpha,
             recency_bias=recency_bias,
             personalise_search=personalise_search,
+            graph_context=graph_context,
+            extra_context=extra_context,
             request_options=request_options,
         )
         return _response.data
@@ -411,11 +428,14 @@ class AsyncSearchClient:
         tenant_id: str,
         sub_tenant_id: typing.Optional[str] = OMIT,
         max_chunks: typing.Optional[int] = OMIT,
+        mode: typing.Optional[RetrieveMode] = OMIT,
         alpha: typing.Optional[Alpha] = OMIT,
         recency_bias: typing.Optional[float] = OMIT,
         personalise_search: typing.Optional[bool] = OMIT,
+        graph_context: typing.Optional[bool] = OMIT,
+        extra_context: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> typing.List[SearchChunk]:
+    ) -> RetrieveResponse:
         """
         Search for relevant content within your indexed sources.
 
@@ -436,6 +456,9 @@ class AsyncSearchClient:
         max_chunks : typing.Optional[int]
             Maximum number of results to return
 
+        mode : typing.Optional[RetrieveMode]
+            Retrieval mode to use ('fast' or 'accurate')
+
         alpha : typing.Optional[Alpha]
             Search ranking algorithm parameter (0.0-1.0 or 'auto')
 
@@ -445,12 +468,18 @@ class AsyncSearchClient:
         personalise_search : typing.Optional[bool]
             Enable personalized search results based on user preferences
 
+        graph_context : typing.Optional[bool]
+            Enable graph context for search results
+
+        extra_context : typing.Optional[str]
+            Additional context provided by the user to guide retrieval
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        typing.List[SearchChunk]
+        RetrieveResponse
             Successful Response
 
         Examples
@@ -469,9 +498,12 @@ class AsyncSearchClient:
             tenant_id=tenant_id,
             sub_tenant_id=sub_tenant_id,
             max_chunks=max_chunks,
+            mode=mode,
             alpha=alpha,
             recency_bias=recency_bias,
             personalise_search=personalise_search,
+            graph_context=graph_context,
+            extra_context=extra_context,
             request_options=request_options,
         )
         return _response.data

{usecortex_ai-0.3.4 → usecortex_ai-0.3.6}/src/usecortex_ai/search/raw_client.py

@@ -18,6 +18,8 @@ from ..errors.unauthorized_error import UnauthorizedError
 from ..errors.unprocessable_entity_error import UnprocessableEntityError
 from ..types.actual_error_response import ActualErrorResponse
 from ..types.bm_25_operator_type import Bm25OperatorType
+from ..types.retrieve_mode import RetrieveMode
+from ..types.retrieve_response import RetrieveResponse
 from ..types.search_chunk import SearchChunk
 from .types.alpha import Alpha
 
@@ -244,11 +246,14 @@ class RawSearchClient:
         tenant_id: str,
         sub_tenant_id: typing.Optional[str] = OMIT,
         max_chunks: typing.Optional[int] = OMIT,
+        mode: typing.Optional[RetrieveMode] = OMIT,
         alpha: typing.Optional[Alpha] = OMIT,
         recency_bias: typing.Optional[float] = OMIT,
         personalise_search: typing.Optional[bool] = OMIT,
+        graph_context: typing.Optional[bool] = OMIT,
+        extra_context: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[typing.List[SearchChunk]]:
+    ) -> HttpResponse[RetrieveResponse]:
         """
         Search for relevant content within your indexed sources.
 
@@ -269,6 +274,9 @@ class RawSearchClient:
         max_chunks : typing.Optional[int]
             Maximum number of results to return
 
+        mode : typing.Optional[RetrieveMode]
+            Retrieval mode to use ('fast' or 'accurate')
+
         alpha : typing.Optional[Alpha]
             Search ranking algorithm parameter (0.0-1.0 or 'auto')
 
@@ -278,12 +286,18 @@ class RawSearchClient:
         personalise_search : typing.Optional[bool]
             Enable personalized search results based on user preferences
 
+        graph_context : typing.Optional[bool]
+            Enable graph context for search results
+
+        extra_context : typing.Optional[str]
+            Additional context provided by the user to guide retrieval
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        HttpResponse[typing.List[SearchChunk]]
+        HttpResponse[RetrieveResponse]
             Successful Response
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -294,9 +308,12 @@ class RawSearchClient:
                 "tenant_id": tenant_id,
                 "sub_tenant_id": sub_tenant_id,
                 "max_chunks": max_chunks,
+                "mode": mode,
                 "alpha": convert_and_respect_annotation_metadata(object_=alpha, annotation=Alpha, direction="write"),
                 "recency_bias": recency_bias,
                 "personalise_search": personalise_search,
+                "graph_context": graph_context,
+                "extra_context": extra_context,
             },
             headers={
                 "content-type": "application/json",
@@ -307,9 +324,9 @@ class RawSearchClient:
         try:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
-                    typing.List[SearchChunk],
+                    RetrieveResponse,
                     parse_obj_as(
-                        type_=typing.List[SearchChunk],  # type: ignore
+                        type_=RetrieveResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -765,11 +782,14 @@ class AsyncRawSearchClient:
         tenant_id: str,
         sub_tenant_id: typing.Optional[str] = OMIT,
         max_chunks: typing.Optional[int] = OMIT,
+        mode: typing.Optional[RetrieveMode] = OMIT,
         alpha: typing.Optional[Alpha] = OMIT,
         recency_bias: typing.Optional[float] = OMIT,
         personalise_search: typing.Optional[bool] = OMIT,
+        graph_context: typing.Optional[bool] = OMIT,
+        extra_context: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[typing.List[SearchChunk]]:
+    ) -> AsyncHttpResponse[RetrieveResponse]:
         """
         Search for relevant content within your indexed sources.
 
@@ -790,6 +810,9 @@ class AsyncRawSearchClient:
         max_chunks : typing.Optional[int]
             Maximum number of results to return
 
+        mode : typing.Optional[RetrieveMode]
+            Retrieval mode to use ('fast' or 'accurate')
+
         alpha : typing.Optional[Alpha]
             Search ranking algorithm parameter (0.0-1.0 or 'auto')
 
@@ -799,12 +822,18 @@ class AsyncRawSearchClient:
         personalise_search : typing.Optional[bool]
             Enable personalized search results based on user preferences
 
+        graph_context : typing.Optional[bool]
+            Enable graph context for search results
+
+        extra_context : typing.Optional[str]
+            Additional context provided by the user to guide retrieval
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        AsyncHttpResponse[typing.List[SearchChunk]]
+        AsyncHttpResponse[RetrieveResponse]
             Successful Response
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -815,9 +844,12 @@ class AsyncRawSearchClient:
                 "tenant_id": tenant_id,
                 "sub_tenant_id": sub_tenant_id,
                 "max_chunks": max_chunks,
+                "mode": mode,
                 "alpha": convert_and_respect_annotation_metadata(object_=alpha, annotation=Alpha, direction="write"),
                 "recency_bias": recency_bias,
                 "personalise_search": personalise_search,
+                "graph_context": graph_context,
+                "extra_context": extra_context,
             },
             headers={
                 "content-type": "application/json",
@@ -828,9 +860,9 @@ class AsyncRawSearchClient:
         try:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
-                    typing.List[SearchChunk],
+                    RetrieveResponse,
                     parse_obj_as(
-                        type_=typing.List[SearchChunk],  # type: ignore
+                        type_=RetrieveResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )

{usecortex_ai-0.3.4 → usecortex_ai-0.3.6}/src/usecortex_ai/sources/client.py

@@ -4,6 +4,7 @@ import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
+from ..types.graph_relations_response import GraphRelationsResponse
 from ..types.list_sources_response import ListSourcesResponse
 from .raw_client import AsyncRawSourcesClient, RawSourcesClient
 
@@ -114,6 +115,52 @@ class SourcesClient:
         )
         return _response.data
 
+    def get_graph_relations_by_id(
+        self,
+        *,
+        source_id: str,
+        tenant_id: typing.Optional[str] = None,
+        sub_tenant_id: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GraphRelationsResponse:
+        """
+        Retrieve relations for a specific source.
+
+        Use this endpoint to fetch all relations associated with a specific source. This is useful when you need to understand the relationships between entities within a source.
+
+        Provide the source ID in the request body along with your tenant information to get the relations for that source.
+
+        Parameters
+        ----------
+        source_id : str
+            The source ID to fetch relations for
+
+        tenant_id : typing.Optional[str]
+            Unique identifier for the tenant/organization
+
+        sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GraphRelationsResponse
+            Successful Response
+
+        Examples
+        --------
+        from usecortex-ai import CortexAI
+
+        client = CortexAI(token="YOUR_TOKEN", )
+        client.sources.get_graph_relations_by_id(source_id='CortexDoc1234', tenant_id='tenant_1234', )
+        """
+        _response = self._raw_client.get_graph_relations_by_id(
+            source_id=source_id, tenant_id=tenant_id, sub_tenant_id=sub_tenant_id, request_options=request_options
+        )
+        return _response.data
+
 
 class AsyncSourcesClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -225,3 +272,53 @@ class AsyncSourcesClient:
             tenant_id=tenant_id, source_ids=source_ids, sub_tenant_id=sub_tenant_id, request_options=request_options
         )
         return _response.data
+
+    async def get_graph_relations_by_id(
+        self,
+        *,
+        source_id: str,
+        tenant_id: typing.Optional[str] = None,
+        sub_tenant_id: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GraphRelationsResponse:
+        """
+        Retrieve relations for a specific source.
+
+        Use this endpoint to fetch all relations associated with a specific source. This is useful when you need to understand the relationships between entities within a source.
+
+        Provide the source ID in the request body along with your tenant information to get the relations for that source.
+
+        Parameters
+        ----------
+        source_id : str
+            The source ID to fetch relations for
+
+        tenant_id : typing.Optional[str]
+            Unique identifier for the tenant/organization
+
+        sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GraphRelationsResponse
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from usecortex-ai import AsyncCortexAI
+
+        client = AsyncCortexAI(token="YOUR_TOKEN", )
+        async def main() -> None:
+            await client.sources.get_graph_relations_by_id(source_id='CortexDoc1234', tenant_id='tenant_1234', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_graph_relations_by_id(
+            source_id=source_id, tenant_id=tenant_id, sub_tenant_id=sub_tenant_id, request_options=request_options
+        )
+        return _response.data