usecortex-ai 0.2.2__py3-none-any.whl → 0.3.0__py3-none-any.whl

usecortex_ai/search/client.py

@@ -119,7 +119,7 @@ class SearchClient:
         from usecortex-ai import CortexAI
 
         client = CortexAI(token="YOUR_TOKEN", )
-        client.search.qna(question='question', session_id='session_id', tenant_id='tenant_id', )
+        client.search.qna(question='What is Cortex AI', session_id='chat_session_1234', tenant_id='tenant_1234', )
         """
         _response = self._raw_client.qna(
             question=question,
@@ -152,6 +152,7 @@ class SearchClient:
         max_chunks: typing.Optional[int] = OMIT,
         alpha: typing.Optional[Alpha] = OMIT,
         recency_bias: typing.Optional[float] = OMIT,
+        personalise_search: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[SearchChunk]:
         """
@@ -169,7 +170,7 @@ class SearchClient:
             Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
-            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
+            Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
 
         max_chunks : typing.Optional[int]
             Maximum number of results to return
@@ -180,6 +181,9 @@ class SearchClient:
         recency_bias : typing.Optional[float]
             Preference for newer content (0.0 = no bias, 1.0 = strong recency preference)
 
+        personalise_search : typing.Optional[bool]
+            Enable personalized search results based on user preferences
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -193,7 +197,7 @@ class SearchClient:
         from usecortex-ai import CortexAI
 
         client = CortexAI(token="YOUR_TOKEN", )
-        client.search.retrieve(query='query', tenant_id='tenant_id', )
+        client.search.retrieve(query='Which mode does user prefer', tenant_id='tenant_1234', )
         """
         _response = self._raw_client.retrieve(
             query=query,
@@ -202,6 +206,7 @@ class SearchClient:
             max_chunks=max_chunks,
             alpha=alpha,
             recency_bias=recency_bias,
+            personalise_search=personalise_search,
             request_options=request_options,
         )
         return _response.data
@@ -220,7 +225,7 @@ class SearchClient:
         Perform full text search for exact matches within your indexed sources.
 
         Use this endpoint to find content chunks using BM25-based text matching with configurable operators.
-        Choose between OR and AND operators to control how search terms are combined for precise text matching.
+        Choose between 'OR' and 'AND' operators to control how search terms are combined for precise text matching.
 
         Parameters
         ----------
@@ -231,7 +236,7 @@ class SearchClient:
             Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
-            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
+            Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
 
         operator : typing.Optional[Bm25OperatorType]
             How to combine search terms (OR or AND)
@@ -252,7 +257,7 @@ class SearchClient:
         from usecortex-ai import CortexAI
 
         client = CortexAI(token="YOUR_TOKEN", )
-        client.search.full_text_search(query='query', tenant_id='tenant_id', )
+        client.search.full_text_search(query='John Smith Jake', tenant_id='tenant_1234', )
         """
         _response = self._raw_client.full_text_search(
             query=query,
@@ -374,7 +379,7 @@ class AsyncSearchClient:
 
         client = AsyncCortexAI(token="YOUR_TOKEN", )
         async def main() -> None:
-            await client.search.qna(question='question', session_id='session_id', tenant_id='tenant_id', )
+            await client.search.qna(question='What is Cortex AI', session_id='chat_session_1234', tenant_id='tenant_1234', )
         asyncio.run(main())
         """
         _response = await self._raw_client.qna(
@@ -408,6 +413,7 @@ class AsyncSearchClient:
         max_chunks: typing.Optional[int] = OMIT,
         alpha: typing.Optional[Alpha] = OMIT,
         recency_bias: typing.Optional[float] = OMIT,
+        personalise_search: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[SearchChunk]:
         """
@@ -425,7 +431,7 @@ class AsyncSearchClient:
             Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
-            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
+            Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
 
         max_chunks : typing.Optional[int]
             Maximum number of results to return
@@ -436,6 +442,9 @@ class AsyncSearchClient:
         recency_bias : typing.Optional[float]
             Preference for newer content (0.0 = no bias, 1.0 = strong recency preference)
 
+        personalise_search : typing.Optional[bool]
+            Enable personalized search results based on user preferences
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -452,7 +461,7 @@ class AsyncSearchClient:
 
         client = AsyncCortexAI(token="YOUR_TOKEN", )
         async def main() -> None:
-            await client.search.retrieve(query='query', tenant_id='tenant_id', )
+            await client.search.retrieve(query='Which mode does user prefer', tenant_id='tenant_1234', )
         asyncio.run(main())
         """
         _response = await self._raw_client.retrieve(
@@ -462,6 +471,7 @@ class AsyncSearchClient:
             max_chunks=max_chunks,
             alpha=alpha,
             recency_bias=recency_bias,
+            personalise_search=personalise_search,
             request_options=request_options,
         )
         return _response.data
@@ -480,7 +490,7 @@ class AsyncSearchClient:
         Perform full text search for exact matches within your indexed sources.
 
         Use this endpoint to find content chunks using BM25-based text matching with configurable operators.
-        Choose between OR and AND operators to control how search terms are combined for precise text matching.
+        Choose between 'OR' and 'AND' operators to control how search terms are combined for precise text matching.
 
         Parameters
         ----------
@@ -491,7 +501,7 @@ class AsyncSearchClient:
             Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
-            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
+            Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
 
         operator : typing.Optional[Bm25OperatorType]
             How to combine search terms (OR or AND)
@@ -515,7 +525,7 @@ class AsyncSearchClient:
 
         client = AsyncCortexAI(token="YOUR_TOKEN", )
         async def main() -> None:
-            await client.search.full_text_search(query='query', tenant_id='tenant_id', )
+            await client.search.full_text_search(query='John Smith Jake', tenant_id='tenant_1234', )
         asyncio.run(main())
         """
         _response = await self._raw_client.full_text_search(

usecortex_ai/search/raw_client.py

@@ -246,6 +246,7 @@ class RawSearchClient:
         max_chunks: typing.Optional[int] = OMIT,
         alpha: typing.Optional[Alpha] = OMIT,
         recency_bias: typing.Optional[float] = OMIT,
+        personalise_search: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[typing.List[SearchChunk]]:
         """
@@ -263,7 +264,7 @@ class RawSearchClient:
             Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
-            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
+            Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
 
         max_chunks : typing.Optional[int]
             Maximum number of results to return
@@ -274,6 +275,9 @@ class RawSearchClient:
         recency_bias : typing.Optional[float]
             Preference for newer content (0.0 = no bias, 1.0 = strong recency preference)
 
+        personalise_search : typing.Optional[bool]
+            Enable personalized search results based on user preferences
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -292,6 +296,7 @@ class RawSearchClient:
                 "max_chunks": max_chunks,
                 "alpha": convert_and_respect_annotation_metadata(object_=alpha, annotation=Alpha, direction="write"),
                 "recency_bias": recency_bias,
+                "personalise_search": personalise_search,
             },
             headers={
                 "content-type": "application/json",
@@ -405,7 +410,7 @@ class RawSearchClient:
         Perform full text search for exact matches within your indexed sources.
 
         Use this endpoint to find content chunks using BM25-based text matching with configurable operators.
-        Choose between OR and AND operators to control how search terms are combined for precise text matching.
+        Choose between 'OR' and 'AND' operators to control how search terms are combined for precise text matching.
 
         Parameters
         ----------
@@ -416,7 +421,7 @@ class RawSearchClient:
             Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
-            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
+            Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
 
         operator : typing.Optional[Bm25OperatorType]
             How to combine search terms (OR or AND)
@@ -762,6 +767,7 @@ class AsyncRawSearchClient:
         max_chunks: typing.Optional[int] = OMIT,
         alpha: typing.Optional[Alpha] = OMIT,
         recency_bias: typing.Optional[float] = OMIT,
+        personalise_search: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[typing.List[SearchChunk]]:
         """
@@ -779,7 +785,7 @@ class AsyncRawSearchClient:
             Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
-            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
+            Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
 
         max_chunks : typing.Optional[int]
             Maximum number of results to return
@@ -790,6 +796,9 @@ class AsyncRawSearchClient:
         recency_bias : typing.Optional[float]
             Preference for newer content (0.0 = no bias, 1.0 = strong recency preference)
 
+        personalise_search : typing.Optional[bool]
+            Enable personalized search results based on user preferences
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -808,6 +817,7 @@ class AsyncRawSearchClient:
                 "max_chunks": max_chunks,
                 "alpha": convert_and_respect_annotation_metadata(object_=alpha, annotation=Alpha, direction="write"),
                 "recency_bias": recency_bias,
+                "personalise_search": personalise_search,
             },
             headers={
                 "content-type": "application/json",
@@ -921,7 +931,7 @@ class AsyncRawSearchClient:
         Perform full text search for exact matches within your indexed sources.
 
         Use this endpoint to find content chunks using BM25-based text matching with configurable operators.
-        Choose between OR and AND operators to control how search terms are combined for precise text matching.
+        Choose between 'OR' and 'AND' operators to control how search terms are combined for precise text matching.
 
         Parameters
         ----------
@@ -932,7 +942,7 @@ class AsyncRawSearchClient:
             Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
-            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
+            Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
 
         operator : typing.Optional[Bm25OperatorType]
             How to combine search terms (OR or AND)

usecortex_ai/sources/client.py

@@ -27,52 +27,11 @@ class SourcesClient:
         return self._raw_client
 
     def get_all(
-        self,
-        *,
-        tenant_id: str,
-        sub_tenant_id: typing.Optional[str] = None,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> ListSourcesResponse:
-        """
-        Retrieve all sources for a specific tenant.
-
-        Use this endpoint to fetch a complete list of all sources associated with your tenant. This includes documents, files, and other content you've uploaded for processing.
-
-        You can optionally specify a sub-tenant to narrow down the results to sources within that specific sub-tenant scope.
-
-        Parameters
-        ----------
-        tenant_id : str
-            Unique identifier for the tenant/organization
-
-        sub_tenant_id : typing.Optional[str]
-            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        ListSourcesResponse
-            Successful Response
-
-        Examples
-        --------
-        from usecortex-ai import CortexAI
-
-        client = CortexAI(token="YOUR_TOKEN", )
-        client.sources.get_all(tenant_id='tenant_id', )
-        """
-        _response = self._raw_client.get_all(
-            tenant_id=tenant_id, sub_tenant_id=sub_tenant_id, request_options=request_options
-        )
-        return _response.data
-
-    def get_by_ids(
         self,
         *,
         tenant_id: str,
         source_ids: typing.Sequence[str],
+        sub_tenant_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ListSourcesResponse:
         """
@@ -85,8 +44,13 @@ class SourcesClient:
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         source_ids : typing.Sequence[str]
+            List of source IDs to fetch
+
+        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.
@@ -101,10 +65,10 @@ class SourcesClient:
         from usecortex-ai import CortexAI
 
         client = CortexAI(token="YOUR_TOKEN", )
-        client.sources.get_by_ids(tenant_id='tenant_id', source_ids=['source_ids'], )
+        client.sources.get_all(tenant_id='tenant_1234', source_ids=['CortexDoc1234', 'CortexDoc4567'], )
         """
-        _response = self._raw_client.get_by_ids(
-            tenant_id=tenant_id, source_ids=source_ids, request_options=request_options
+        _response = self._raw_client.get_all(
+            tenant_id=tenant_id, source_ids=source_ids, sub_tenant_id=sub_tenant_id, request_options=request_options
         )
         return _response.data
 
@@ -125,56 +89,11 @@ class AsyncSourcesClient:
         return self._raw_client
 
     async def get_all(
-        self,
-        *,
-        tenant_id: str,
-        sub_tenant_id: typing.Optional[str] = None,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> ListSourcesResponse:
-        """
-        Retrieve all sources for a specific tenant.
-
-        Use this endpoint to fetch a complete list of all sources associated with your tenant. This includes documents, files, and other content you've uploaded for processing.
-
-        You can optionally specify a sub-tenant to narrow down the results to sources within that specific sub-tenant scope.
-
-        Parameters
-        ----------
-        tenant_id : str
-            Unique identifier for the tenant/organization
-
-        sub_tenant_id : typing.Optional[str]
-            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        ListSourcesResponse
-            Successful Response
-
-        Examples
-        --------
-        import asyncio
-
-        from usecortex-ai import AsyncCortexAI
-
-        client = AsyncCortexAI(token="YOUR_TOKEN", )
-        async def main() -> None:
-            await client.sources.get_all(tenant_id='tenant_id', )
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.get_all(
-            tenant_id=tenant_id, sub_tenant_id=sub_tenant_id, request_options=request_options
-        )
-        return _response.data
-
-    async def get_by_ids(
         self,
         *,
         tenant_id: str,
         source_ids: typing.Sequence[str],
+        sub_tenant_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ListSourcesResponse:
         """
@@ -187,8 +106,13 @@ class AsyncSourcesClient:
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         source_ids : typing.Sequence[str]
+            List of source IDs to fetch
+
+        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.
@@ -206,10 +130,10 @@ class AsyncSourcesClient:
 
         client = AsyncCortexAI(token="YOUR_TOKEN", )
         async def main() -> None:
-            await client.sources.get_by_ids(tenant_id='tenant_id', source_ids=['source_ids'], )
+            await client.sources.get_all(tenant_id='tenant_1234', source_ids=['CortexDoc1234', 'CortexDoc4567'], )
         asyncio.run(main())
         """
-        _response = await self._raw_client.get_by_ids(
-            tenant_id=tenant_id, source_ids=source_ids, request_options=request_options
+        _response = await self._raw_client.get_all(
+            tenant_id=tenant_id, source_ids=source_ids, sub_tenant_id=sub_tenant_id, request_options=request_options
         )
         return _response.data