docs: docs for grpc client without autogen

Author: tcarroll-kroll

docs/api_reference.rst

@@ -12,9 +12,6 @@ Main Classes
 - **ClassifierSdk**: Main entry point for interacting with the Athena service. Handles authentication, deployment management, and image classification.
 - **ClassifierServiceClient**: Low-level gRPC client for direct service calls.
 - **ClassifyImageOptions**: Options for sending image classification requests.
-- **Deployment**: Represents a deployment session.
-- **ClassifyRequest** / **ClassifyResponse**: Request and response types for image classification.
-- **ClassificationInput** / **ClassificationOutput** / **ClassificationError** / **Classification**: Types for input, output, and error handling.
 
 Usage Example
 -------------
@@ -63,29 +60,5 @@ API Classes
 .. js:autoclass:: ClassifierServiceClient
    :members:
 
-.. js:autointerface:: ClassifyImageOptions
-   :members:
-
-.. js:autointerface:: ListDeploymentsResponse
-   :members:
-
-.. js:autointerface:: Deployment
-   :members:
-
-.. js:autointerface:: ClassifyResponse
-   :members:
-
-.. js:autointerface:: ClassifyRequest
-   :members:
-
-.. js:autointerface:: ClassificationOutput
-   :members:
-
-.. js:autointerface:: ClassificationInput
-   :members:
-
-.. js:autointerface:: ClassificationError
-   :members:
-
-.. js:autointerface:: Classification
-   :members:
+.. js:autoclass:: ClassifyImageOptions
+    :members:

docs/athena-grpc-client.rst

@@ -0,0 +1,146 @@
+Athena Generated Types
+======================
+
+This document describes the TypeScript types and interfaces generated from the
+Athena protobuf definitions.
+
+See the :doc:`athena_protobufs:index` for more information about the protobuf
+definitions.
+
+
+Request Types
+-------------
+
+ClassifyRequest
+~~~~~~~~~~~~~~~
+
+Request message for image classification.
+
+* ``deploymentId: string`` - Deployment identifier for routing responses
+* ``inputs: ClassificationInput[]`` - Array of images to classify
+
+ClassificationInput
+~~~~~~~~~~~~~~~~~~~
+
+Single image classification input.
+
+* ``affiliate: string`` - Source system identifier
+* ``correlationId: string`` - Unique ID for matching responses
+* ``encoding: RequestEncoding`` - Data compression format
+* ``data: Uint8Array`` - Raw image bytes
+* ``format: ImageFormat`` - Image file format
+* ``hashes: ImageHash[]`` - Image data hashes
+
+Response Types
+--------------
+
+ClassifyResponse
+~~~~~~~~~~~~~~~~
+
+Response containing classification results.
+
+* ``globalError?: ClassificationError`` - Error affecting entire request
+* ``outputs: ClassificationOutput[]`` - Individual image results
+
+ClassificationOutput
+~~~~~~~~~~~~~~~~~~~~
+
+Result for a single image.
+
+* ``correlationId: string`` - Matches input correlation ID
+* ``classifications: Classification[]`` - Detected classifications
+* ``error?: ClassificationError`` - Image-specific error
+
+Classification
+~~~~~~~~~~~~~~
+
+Single classification result.
+
+* ``label: string`` - Classification label
+* ``weight: number`` - Confidence score (0.0 - 1.0)
+
+ClassificationError
+~~~~~~~~~~~~~~~~~~~
+
+Error information.
+
+* ``code: ErrorCode`` - Error type
+* ``message: string`` - Error description
+* ``details: string`` - Additional error context
+
+Deployment Types
+----------------
+
+ListDeploymentsResponse
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Response listing active deployments.
+
+* ``deployments: Deployment[]`` - Array of deployment info
+
+Deployment
+~~~~~~~~~~
+
+Single deployment information.
+
+* ``deploymentId: string`` - Deployment identifier
+* ``backlog: number`` - Number of queued responses
+
+Utility Types
+-------------
+
+ImageHash
+~~~~~~~~~
+
+Hash of image data.
+
+* ``value: string`` - Hash value
+* ``type: HashType`` - Hash algorithm type
+
+Enums
+-----
+
+ErrorCode
+~~~~~~~~~
+
+* ``UNSPECIFIED = 0`` - Unknown error
+* ``IMAGE_TOO_LARGE = 2`` - Image exceeds size limits
+* ``MODEL_ERROR = 3`` - Classifier internal error
+* ``AFFILIATE_NOT_PERMITTED = 4`` - Access denied for affiliate
+
+RequestEncoding
+~~~~~~~~~~~~~~~
+
+* ``UNSPECIFIED = 0`` - Default (uncompressed)
+* ``UNCOMPRESSED = 1`` - Raw image data
+* ``BROTLI = 2`` - Brotli compressed data
+
+ImageFormat
+~~~~~~~~~~~
+
+* ``UNSPECIFIED = 0`` - Unknown format
+* ``GIF = 1`` - GIF format
+* ``JPEG = 2`` - JPEG format (.jpeg, .jpg, .jpe)
+* ``BMP = 3`` - BMP format
+* ``DIB = 4`` - DIB format
+* ``PNG = 5`` - PNG format
+* ``WEBP = 6`` - WebP format
+* ``PBM = 7`` - PBM format
+* ``PGM = 8`` - PGM format
+* ``PPM = 9`` - PPM format
+* ``PXM = 10`` - PXM format
+* ``PNM = 11`` - PNM format
+* ``PFM = 12`` - PFM format
+* ``SR = 13`` - SR format
+* ``RAS = 14`` - RAS format
+* ``TIFF = 15`` - TIFF format (.tiff, .tif)
+* ``HDR = 16`` - HDR format
+* ``PIC = 17`` - PIC format
+* ``RAW_UINT8 = 18`` - Raw 8-bit RGB data
+
+HashType
+~~~~~~~~
+
+* ``UNKNOWN = 0`` - Unknown hash type
+* ``MD5 = 1`` - MD5 hash
+* ``SHA1 = 2`` - SHA1 hash

docs/athena-types.rst

@@ -1,5 +1,5 @@
 Authentication Manager
-=====================
+======================
 
 Manages OAuth authentication and token refresh for the Athena gRPC client.  Handles acquiring and refreshing access tokens using the OAuth client credentials flow.
 
@@ -9,22 +9,24 @@ Manages OAuth authentication and token refresh for the Athena gRPC client.  Hand
 - Integrates with Athena gRPC client
 
 **Usage Example:**
+
 .. code-block:: typescript
 
    import { AuthenticationManager } from './authenticationManager';
    const auth = new AuthenticationManager({
-      clientId: 'your-client-id',
-      clientSecret: 'your-client-secret',
-      issuerUrl: 'https://issuer.example.com',
-      scope: 'manage:classify',
+       clientId: 'your-client-id',
+       clientSecret: 'your-client-secret',
+       issuerUrl: 'https://issuer.example.com',
+       scope: 'manage:classify',
    });
 
 **Options:**
-- `clientId`: OAuth client ID
-- `clientSecret`: OAuth client secret
-- `issuerUrl`: URL of the OAuth issuer
-- `autoRefresh`: Whether to automatically refresh the access token
-- `scope`: OAuth scope to request
+
+* `clientId`: OAuth client ID
+* `clientSecret`: OAuth client secret
+* `issuerUrl`: URL of the OAuth issuer
+* `autoRefresh`: Whether to automatically refresh the access token
+* `scope`: OAuth scope to request
 
 .. js:autoclass:: AuthenticationManager
    :members:

docs/authenticationManager.rst

@@ -17,18 +17,18 @@
 sys.path.insert(0, str(Path("../athena").resolve()))
 
 # Project information
-project = 'Athena Classifier NodeJS SDK'
+project = "Athena Classifier NodeJS SDK"
 copyright = f"{datetime.now(timezone.utc).year}, Crisp"
 author = "Crisp"
 release = "1.0.0"
 
-js_language = 'typescript'
-js_source_path = '../src/'
-jsdoc_config_path = '../typedoc.json'
+js_language = "typescript"
+js_source_path = "../src/"
+jsdoc_config_path = "../typedoc.json"
 
 # Extensions
 extensions = [
-    'sphinx_js',
+    "sphinx_js",
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
@@ -63,7 +63,6 @@
     # Exclude files with duplicate documented objects
     "../src/athena/google/protobuf/empty.ts",
     "../src/athena/athena.ts",
-
 ]
 
 # The theme to use for HTML and HTML Help pages
@@ -122,6 +121,10 @@
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "grpc": ("https://grpc.github.io/grpc/python/", None),
+    "athena_protobufs": (
+        "https://crispthinking.github.io/athena-protobufs/",
+        None,
+    ),
 }
 
 # Create required directories if they don't exist

docs/conf.py

@@ -0,0 +1,76 @@
+Athena gRPC Client
+==================
+
+This document describes the gRPC client implementation for the Athena classifier service.
+
+Client Interface
+----------------
+
+IClassifierServiceClient
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Interface defining all available operations for the classifier service.
+
+* ``classify()`` - Bidirectional streaming for image classification
+* ``listDeployments()`` - Unary call to list active deployments
+
+Client Implementation
+---------------------
+
+ClassifierServiceClient
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Concrete implementation extending ``grpc.Client``.
+
+Constructor
+^^^^^^^^^^^
+
+``ClassifierServiceClient(address, credentials, options?, binaryOptions?)``
+
+* ``address: string`` - Server address (e.g., "localhost:50051")
+* ``credentials: grpc.ChannelCredentials`` - Authentication credentials
+* ``options: grpc.ClientOptions`` - Optional client configuration
+* ``binaryOptions: Partial<BinaryReadOptions & BinaryWriteOptions>`` - Optional protobuf options
+
+Methods
+-------
+
+classify()
+~~~~~~~~~~
+
+Performs image classification using bidirectional streaming.
+
+**Signatures:**
+
+* ``classify(metadata: grpc.Metadata, options?: grpc.CallOptions): grpc.ClientDuplexStream<ClassifyRequest, ClassifyResponse>``
+* ``classify(options?: grpc.CallOptions): grpc.ClientDuplexStream<ClassifyRequest, ClassifyResponse>``
+
+**Returns:** ``grpc.ClientDuplexStream<ClassifyRequest, ClassifyResponse>``
+
+**Features:**
+
+* Bidirectional streaming for real-time classification
+* Deployment-based context sharing
+* Multiple affiliates can join the same deployment
+* Supports batch processing of multiple images per request
+
+listDeployments()
+~~~~~~~~~~~~~~~~~
+
+Retrieves a list of all active deployment IDs.
+
+**Signatures:**
+
+* ``listDeployments(input: Empty, metadata: grpc.Metadata, options: grpc.CallOptions, callback): grpc.ClientUnaryCall``
+* ``listDeployments(input: Empty, metadata: grpc.Metadata, callback): grpc.ClientUnaryCall``
+* ``listDeployments(input: Empty, options: grpc.CallOptions, callback): grpc.ClientUnaryCall``
+* ``listDeployments(input: Empty, callback): grpc.ClientUnaryCall``
+
+**Parameters:**
+
+* ``input: Empty`` - Empty message (no input parameters required)
+* ``metadata: grpc.Metadata`` - Optional gRPC metadata
+* ``options: grpc.CallOptions`` - Optional call options
+* ``callback: (err: grpc.ServiceError | null, value?: ListDeploymentsResponse) => void`` - Response callback
+
+**Returns:** ``grpc.ClientUnaryCall``