COH-31299 - Add documentation for AI in Sphinx

Author: dhirupandey

docs/api_reference.rst

@@ -112,6 +112,7 @@ Modules
    :maxdepth: 3
    :titlesonly:
 
+   api_reference/ai.rst
    api_reference/aggregator.rst
    api_reference/comparator.rst
    api_reference/event.rst

pyproject.toml

@@ -37,6 +37,7 @@ pytest-asyncio = "~0.25"
 pytest-cov = "~6.0"
 pytest-unordered = "~0.6"
 pre-commit = "~4.1"
+docutils="~0.20"
 Sphinx = "~7.4"
 sphinx-rtd-theme = "~3.0"
 sphinxcontrib-napoleon = "~0.7"

src/coherence/ai.py

@@ -26,6 +26,8 @@
 class Vector(ABC):
     """
     Base class that represents a Vector
+
+    **NOTE:** This requires using Coherence CE 24.09.2+ on the server side
     """
 
     def __init__(self) -> None:
@@ -39,6 +41,8 @@ def __init__(self) -> None:
 class BitVector(Vector):
     """
     Class that represents a Vector of Bits
+
+    **NOTE:** This requires using Coherence CE 24.09.2+ on the server side
     """
 
     def __init__(
@@ -73,6 +77,8 @@ def __init__(
 class ByteVector(Vector):
     """
     Class that represents Vector of bytes
+
+    **NOTE:** This requires using Coherence CE 24.09.2+ on the server side
     """
 
     def __init__(self, byte_array: bytes):
@@ -89,6 +95,8 @@ def __init__(self, byte_array: bytes):
 class FloatVector(Vector):
     """
     Class that represents Vector of floats
+
+    **NOTE:** This requires using Coherence CE 24.09.2+ on the server side
     """
 
     def __init__(self, float_array: List[float]):
@@ -111,12 +119,14 @@ def __init__(self, data_version: int = 0, bin_future: Optional[Any] = None):
 class DocumentChunk(AbstractEvolvable):
     """
     Class that represents a chunk of text extracted from a document.
+
+    **NOTE:** This requires using Coherence CE 24.09.2+ on the server side
     """
 
     def __init__(
         self,
         text: str,
-        metadata: Optional[Dict[str, Any] | OrderedDict[str, Any]] = None,
+        metadata: Optional[Union[Dict[str, Any], OrderedDict[str, Any]]] = None,
         vector: Optional[Vector] = None,
     ):
         """
@@ -183,6 +193,8 @@ def restore(self, obj: Dict[str, Any]) -> DocumentChunk:
 class DistanceAlgorithm(ABC):
     """
     Base class that represents algorithm that can calculate distance to a given vector
+
+    **NOTE:** This requires using Coherence CE 24.09.2+ on the server side
     """
 
     def __init__(self) -> None:
@@ -198,6 +210,8 @@ class CosineDistance(DistanceAlgorithm):
     between two vectors and determines whether two vectors are pointing in
     roughly the same direction. It is often used to measure document similarity
     in text analysis.
+
+    **NOTE:** This requires using Coherence CE 24.09.2+ on the server side
     """
 
     def __init__(self) -> None:
@@ -209,6 +223,8 @@ class InnerProductDistance(DistanceAlgorithm):
     """
     Represents a DistanceAlgorithm that performs inner product distance
     calculation between two vectors.
+
+    **NOTE:** This requires using Coherence CE 24.09.2+ on the server side
     """
 
     def __init__(self) -> None:
@@ -220,6 +236,8 @@ class L2SquaredDistance(DistanceAlgorithm):
     """
     Represents a DistanceAlgorithm that performs an L2 squared distance
     calculation between two vectors.
+
+    **NOTE:** This requires using Coherence CE 24.09.2+ on the server side
     """
 
     def __init__(self) -> None:
@@ -230,6 +248,8 @@ def __init__(self) -> None:
 class SimilaritySearch(EntryAggregator):
     """
     This class represents an aggregator to execute a similarity query.
+
+    **NOTE:** This requires using Coherence CE 24.09.2+ on the server side
     """
 
     def __init__(
@@ -265,6 +285,8 @@ def __init__(
 class BaseQueryResult(ABC):
     """
     A base class for QueryResult implementation
+
+    **NOTE:** This requires using Coherence CE 24.09.2+ on the server side
     """
 
     def __init__(self, result: float, key: K, value: V) -> None:
@@ -277,6 +299,8 @@ def __init__(self, result: float, key: K, value: V) -> None:
 class QueryResult(BaseQueryResult):
     """
     QueryResult class
+
+    **NOTE:** This requires using Coherence CE 24.09.2+ on the server side
     """
 
     def __init__(self, result: float, key: K, value: V) -> None:
@@ -297,6 +321,8 @@ def __str__(self) -> str:
 class BinaryQuantIndex(AbstractEvolvable):
     """
     This class represents a custom index using binary quantization of vectors
+
+    **NOTE:** This requires using Coherence CE 24.09.2+ on the server side
     """
 
     def __init__(self, extractor: Union[ValueExtractor[T, E], str], over_sampling_factor: int = 3) -> None: