Athena Generated Types¶

This document describes the TypeScript types and interfaces generated from the Athena protobuf definitions.

See the Athena Protobufs Documentation for more information about the protobuf definitions.

Request Types¶

interface ClassifyRequest [source]¶

The request message containing the image data to classify. Each request represents a batch of images that should be processed within the same deployment context.

deploymentId: string¶

inputs: ClassificationInput[]¶

interface ClassificationInput [source]¶

A single image within a classification request batch. Contains all necessary metadata and data for classifying one image.

affiliate: string¶

correlationId: string¶

encoding: RequestEncoding¶

data: Uint8Array¶

format: ImageFormat¶

hashes: ImageHash[]¶

Response Types¶

interface ClassifyResponse [source]¶

The response message containing the classification results. Sent back to clients for each processed batch, containing either a global error or individual results for each image in the batch.

globalError: ClassificationError | undefined¶

outputs: ClassificationOutput[]¶

interface ClassificationOutput [source]¶

Individual classification result for a single image. Contains the correlation ID and classification results for one image.

correlationId: string¶

classifications: Classification[]¶

error: ClassificationError | undefined¶

Classification¶

interface Classification [source]¶

A single classification result for an image. Represents one detected category with its confidence score.

label: string¶

weight: number¶

ClassificationError¶

interface ClassificationError [source]¶

Error information for failed classification attempts. Provides details about why a classification could not be completed.

code: ErrorCode¶

message: string¶

details: string¶

Deployment Types¶

interface ListDeploymentsResponse [source]¶

Response message for ListDeployments RPC Contains the list of active deployments and their details.

deployments: Deployment[]¶

interface Deployment [source]¶

A single active deployment part of a ListDeployments response

deploymentId: string¶

backlog: number¶

Utility Types¶

interface ImageHash [source]¶

Hash information for an image.

value: string¶

type: HashType¶

Enums¶

export enum ErrorCode [source]¶: Enumeration of possible classification error codes.

Members¶

ErrorCode.ERROR_CODE_UNSPECIFIED = 0¶: ERROR_CODE_UNSPECIFIED - Unknown or unspecified error

ErrorCode.ERROR_CODE_IMAGE_TOO_LARGE = 2¶: ERROR_CODE_IMAGE_TOO_LARGE - Image is too large to process

ErrorCode.ERROR_CODE_MODEL_ERROR = 3¶: ERROR_CODE_MODEL_ERROR - Opaque error from the classifier

ErrorCode.ERROR_CODE_AFFILIATE_NOT_PERMITTED = 4¶: ERROR_CODE_AFFILIATE_NOT_PERMITTED - Attempt to send data for an affiliate which is not granted to the current client.

ErrorCode.ERROR_CODE_DEPLOYMENT_ID_INVALID = 5¶: ERROR_CODE_DEPLOYMENT_ID_INVALID - The format of the deployment ID is not valid. Deployment IDs must be non-empty strings of up to 64 characters.

ErrorCode.ERROR_CODE_CORRELATION_ID_INVALID = 6¶: ERROR_CODE_CORRELATION_ID_INVALID - The format of the correlation ID is not valid. Correlation IDs must be non-empty strings of up to 64 characters.

ErrorCode.UNRECOGNIZED = -1¶: No description available.

export enum RequestEncoding [source]¶: Enumeration of supported image data encoding formats. Determines how the server should interpret the image data bytes.

Members¶

RequestEncoding.REQUEST_ENCODING_UNSPECIFIED = 0¶: REQUEST_ENCODING_UNSPECIFIED - Unspecified encoding. Assumed to be uncompressed.

RequestEncoding.REQUEST_ENCODING_UNCOMPRESSED = 1¶: REQUEST_ENCODING_UNCOMPRESSED - Uncompressed raw image data (e.g., raw RGB pixels, BMP, etc.)

RequestEncoding.REQUEST_ENCODING_BROTLI = 2¶: REQUEST_ENCODING_BROTLI - Brotli-compressed image data for reduced bandwidth usage Server will decompress using Brotli algorithm before processing

RequestEncoding.UNRECOGNIZED = -1¶: No description available.

export enum ImageFormat [source]¶: Enumeration of supported image file formats. Specifies the image file format structure for proper parsing.

Members¶

ImageFormat.IMAGE_FORMAT_UNSPECIFIED = 0¶: No description available.

ImageFormat.IMAGE_FORMAT_GIF = 1¶: No description available.

ImageFormat.IMAGE_FORMAT_JPEG = 2¶: IMAGE_FORMAT_JPEG - Covers .jpeg, .jpg, .jpe extensions

ImageFormat.IMAGE_FORMAT_BMP = 3¶: No description available.

ImageFormat.IMAGE_FORMAT_DIB = 4¶: No description available.

ImageFormat.IMAGE_FORMAT_PNG = 5¶: No description available.

ImageFormat.IMAGE_FORMAT_WEBP = 6¶: No description available.

ImageFormat.IMAGE_FORMAT_PBM = 7¶: No description available.

ImageFormat.IMAGE_FORMAT_PGM = 8¶: No description available.

ImageFormat.IMAGE_FORMAT_PPM = 9¶: No description available.

ImageFormat.IMAGE_FORMAT_PXM = 10¶: No description available.

ImageFormat.IMAGE_FORMAT_PNM = 11¶: No description available.

ImageFormat.IMAGE_FORMAT_PFM = 12¶: No description available.

ImageFormat.IMAGE_FORMAT_SR = 13¶: No description available.

ImageFormat.IMAGE_FORMAT_RAS = 14¶: No description available.

ImageFormat.IMAGE_FORMAT_TIFF = 15¶: IMAGE_FORMAT_TIFF - Covers .tiff, .tif extensions

ImageFormat.IMAGE_FORMAT_HDR = 16¶: No description available.

ImageFormat.IMAGE_FORMAT_PIC = 17¶: No description available.

ImageFormat.IMAGE_FORMAT_RAW_UINT8 = 18¶: IMAGE_FORMAT_RAW_UINT8 - Raw unsigned 8-bit image data (RGB, C order array)

ImageFormat.UNRECOGNIZED = -1¶: No description available.

export enum HashType [source]¶: Enumeration of hash types supported for image hashing.

Members¶

HashType.HASH_TYPE_UNKNOWN = 0¶: No description available.

HashType.HASH_TYPE_MD5 = 1¶: No description available.

HashType.HASH_TYPE_SHA1 = 2¶: No description available.

HashType.UNRECOGNIZED = -1¶: No description available.