@opendatalabs/vana-sdk 0.1.0-alpha.d7fc764 → 0.1.0-alpha.dc68f39

package/dist/generated/server/server.d.ts

@@ -1,4 +1,4 @@
-interface paths {
+export interface paths {
     "/operations": {
         parameters: {
             query?: never;
@@ -10,9 +10,39 @@ interface paths {
         put?: never;
         /**
          * Start an operation (asynchronous)
-         *
          * @description Creates a new operation with the provided request data and signature.
          *
+         *     **How it works:**
+         *     1. The `permission_id` in the request references a blockchain permission
+         *     2. The permission contains a link to a grant file (stored on IPFS)
+         *     3. The grant file defines the operation type and parameters
+         *     4. The grant file is cryptographically signed by the grantee
+         *
+         *     **Grant File Examples:**
+         *
+         *     *LLM Inference with JSON mode:*
+         *     ```json
+         *     {
+         *       "grantee": "0x123...",
+         *       "operation": "llm_inference",
+         *       "parameters": {
+         *         "prompt": "Analyze this data: {{data}}",
+         *         "response_format": {"type": "json_object"}
+         *       }
+         *     }
+         *     ```
+         *
+         *     *LLM Inference with text mode (default):*
+         *     ```json
+         *     {
+         *       "grantee": "0x123...",
+         *       "operation": "llm_inference",
+         *       "parameters": {
+         *         "prompt": "Summarize this content: {{data}}"
+         *       }
+         *     }
+         *     ```
+         *
          *     **Possible Errors:**
          *     - `400 VALIDATION_ERROR`: Invalid request format or missing required fields
          *     - `400 VALIDATION_ERROR_PERMISSION_ID`: Invalid or missing permission ID
@@ -26,6 +56,7 @@ interface paths {
          *     - `500 COMPUTE_ERROR`: Compute operation failed
          *     - `500 OPERATION_ERROR`: General operation processing error
          *     - `500 INTERNAL_SERVER_ERROR`: Unexpected server error
+         *
          */
         post: {
             parameters: {
@@ -105,13 +136,13 @@ interface paths {
         };
         /**
          * Poll operation status / result
-         *
          * @description Retrieves the current status and result of an operation.
          *
          *     **Possible Errors:**
          *     - `404 NOT_FOUND_ERROR`: Operation not found
          *     - `500 COMPUTE_ERROR`: Failed to get prediction status
          *     - `500 INTERNAL_SERVER_ERROR`: Unexpected server error
+         *
          */
         get: {
             parameters: {
@@ -162,40 +193,39 @@ interface paths {
         patch?: never;
         trace?: never;
     };
-    "/operations/cancel": {
+    "/operations/{operation_id}/cancel": {
         parameters: {
             query?: never;
             header?: never;
-            path?: never;
+            path: {
+                /** @description The operation ID */
+                operation_id: components["parameters"]["OpId"];
+            };
             cookie?: never;
         };
         get?: never;
         put?: never;
         /**
-         * Cancel a running operation (alternative endpoint)
-         *
+         * Cancel a running operation
          * @description Cancels a running operation.
          *
          *     **Possible Errors:**
          *     - `404 NOT_FOUND_ERROR`: Operation not found
          *     - `500 COMPUTE_ERROR`: Failed to cancel prediction
          *     - `500 INTERNAL_SERVER_ERROR`: Unexpected server error
+         *
          */
         post: {
             parameters: {
                 query?: never;
                 header?: never;
-                path?: never;
-                cookie?: never;
-            };
-            requestBody: {
-                content: {
-                    "application/json": {
-                        /** @description The operation ID to cancel */
-                        operation_id: string;
-                    };
+                path: {
+                    /** @description The operation ID */
+                    operation_id: components["parameters"]["OpId"];
                 };
+                cookie?: never;
             };
+            requestBody?: never;
             responses: {
                 /** @description Operation cancelled or already finished */
                 204: {
@@ -239,13 +269,13 @@ interface paths {
         };
         /**
          * Derive deterministic server identity for a user
-         *
          * @description Derives a deterministic server identity (address and public key) for a user based on their Ethereum address.
          *
          *     **Possible Errors:**
          *     - `400 VALIDATION_ERROR_USER_ADDRESS`: Invalid user address format
          *     - `500 OPERATION_ERROR`: Address derivation failed
          *     - `500 INTERNAL_SERVER_ERROR`: Unexpected server error
+         *
          */
         get: {
             parameters: {
@@ -297,8 +327,8 @@ interface paths {
         trace?: never;
     };
 }
-type webhooks = Record<string, never>;
-interface components {
+export type webhooks = Record<string, never>;
+export interface components {
     schemas: {
         /**
          * @description EIP-55 checksum address, 20 bytes, 0x-prefixed.
@@ -317,7 +347,10 @@ interface components {
              */
             app_signature: string;
             /**
-             * @description The request JSON which contains permission_id
+             * @description The request JSON which contains permission_id.
+             *     The operation type and parameters are defined in the grant file
+             *     referenced by the blockchain permission.
+             *
              * @example {"permission_id": 1024}
              */
             operation_request_json: string;
@@ -336,7 +369,6 @@ interface components {
             id: string;
             /**
              * Format: date-time
-             *
              * @description The timestamp when the operation was created
              * @example 2024-01-01T00:00:00Z
              */
@@ -361,14 +393,12 @@ interface components {
             status: "pending" | "running" | "succeeded" | "failed" | "cancelled";
             /**
              * Format: date-time
-             *
              * @description Optional timestamp when the operation started
              * @example 2024-01-01T00:00:00Z
              */
             started_at?: string | null;
             /**
              * Format: date-time
-             *
              * @description Optional timestamp when the operation finished
              * @example 2024-01-01T00:00:00Z
              */
@@ -419,83 +449,81 @@ interface components {
              */
             field?: string | null;
         };
-        ValidationErrorResponse: components["schemas"]["ErrorResponse"] & {
+        /** @description Response format specification for LLM operations */
+        ResponseFormat: {
             /**
-             * @example VALIDATION_ERROR_PERMISSION_ID
+             * @description The response format type
+             * @example json_object
              * @enum {string}
              */
-            error_code?: "VALIDATION_ERROR" | "VALIDATION_ERROR_PERMISSION_ID" | "VALIDATION_ERROR_USER_ADDRESS" | "VALIDATION_ERROR_OPERATION_REQUEST_JSON";
+            type: "text" | "json_object";
         };
-        AuthenticationErrorResponse: components["schemas"]["ErrorResponse"] & {
+        BaseGrantFile: {
+            grantee: components["schemas"]["EthereumAddress"];
+            /** @description The type of operation to perform */
+            operation: string;
+            /** @description Operation-specific parameters */
+            parameters: Record<string, never>;
             /**
-             * @example AUTHENTICATION_ERROR
-             * @enum {string}
-             */
-            error_code?: "AUTHENTICATION_ERROR";
-        };
-        AuthorizationErrorResponse: components["schemas"]["ErrorResponse"] & {
-            /**
-             * @example AUTHORIZATION_ERROR
-             * @enum {string}
-             */
-            error_code?: "AUTHORIZATION_ERROR";
-        };
-        NotFoundErrorResponse: components["schemas"]["ErrorResponse"] & {
-            /**
-             * @example NOT_FOUND_ERROR
-             * @enum {string}
-             */
-            error_code?: "NOT_FOUND_ERROR";
-        };
-        BlockchainErrorResponse: components["schemas"]["ErrorResponse"] & {
-            /**
-             * @example BLOCKCHAIN_ERROR
-             * @enum {string}
-             */
-            error_code?: "BLOCKCHAIN_ERROR";
-        };
-        FileAccessErrorResponse: components["schemas"]["ErrorResponse"] & {
-            /**
-             * @example FILE_ACCESS_ERROR
-             * @enum {string}
-             */
-            error_code?: "FILE_ACCESS_ERROR";
-        };
-        ComputeErrorResponse: components["schemas"]["ErrorResponse"] & {
-            /**
-             * @example COMPUTE_ERROR
-             * @enum {string}
-             */
-            error_code?: "COMPUTE_ERROR";
-        };
-        DecryptionErrorResponse: components["schemas"]["ErrorResponse"] & {
-            /**
-             * @example DECRYPTION_ERROR
-             * @enum {string}
+             * @description Optional Unix timestamp when grant expires
+             * @example 1736467579
              */
-            error_code?: "DECRYPTION_ERROR";
+            expires?: number;
         };
-        GrantValidationErrorResponse: components["schemas"]["ErrorResponse"] & {
+        LLMInferenceGrantFile: Omit<components["schemas"]["BaseGrantFile"], "operation"> & {
             /**
-             * @example GRANT_VALIDATION_ERROR
+             * @example llm_inference
              * @enum {string}
              */
-            error_code?: "GRANT_VALIDATION_ERROR";
-        };
-        OperationErrorResponse: components["schemas"]["ErrorResponse"] & {
+            operation?: "llm_inference";
+            /** @description LLM inference parameters */
+            parameters?: {
+                /**
+                 * @description The prompt template with {{data}} placeholder
+                 * @example Analyze this data: {{data}}
+                 */
+                prompt: string;
+                response_format?: components["schemas"]["ResponseFormat"];
+            } & {
+                [key: string]: unknown;
+            };
+        } & {
             /**
-             * @example OPERATION_ERROR
+             * @description discriminator enum property added by openapi-typescript
              * @enum {string}
              */
-            error_code?: "OPERATION_ERROR";
-        };
-        InternalServerErrorResponse: components["schemas"]["ErrorResponse"] & {
+            operation: "LLMInferenceGrantFile";
+        } & {
             /**
-             * @example INTERNAL_SERVER_ERROR
+             * @description discriminator enum property added by openapi-typescript
              * @enum {string}
              */
-            error_code?: "INTERNAL_SERVER_ERROR";
+            operation: "llm_inference";
         };
+        /** @description Grant file structure that defines the operation and its parameters.
+         *     The grant file is cryptographically signed and contains the user's intent.
+         *
+         *     **Currently Supported Operations:**
+         *     - `llm_inference`: Large Language Model inference with optional JSON mode
+         *
+         *     **Future Operations:**
+         *     Additional operation types will be added as the platform expands.
+         *
+         *     **JSON Mode (LLM only):**
+         *     When `response_format.type` is `json_object`, the LLM will output valid JSON.
+         *      */
+        GrantFile: components["schemas"]["LLMInferenceGrantFile"];
+        ValidationErrorResponse: components["schemas"]["ErrorResponse"] & Record<string, never>;
+        AuthenticationErrorResponse: components["schemas"]["ErrorResponse"] & Record<string, never>;
+        AuthorizationErrorResponse: components["schemas"]["ErrorResponse"] & Record<string, never>;
+        NotFoundErrorResponse: components["schemas"]["ErrorResponse"] & Record<string, never>;
+        BlockchainErrorResponse: components["schemas"]["ErrorResponse"] & Record<string, never>;
+        FileAccessErrorResponse: components["schemas"]["ErrorResponse"] & Record<string, never>;
+        ComputeErrorResponse: components["schemas"]["ErrorResponse"] & Record<string, never>;
+        DecryptionErrorResponse: components["schemas"]["ErrorResponse"] & Record<string, never>;
+        GrantValidationErrorResponse: components["schemas"]["ErrorResponse"] & Record<string, never>;
+        OperationErrorResponse: components["schemas"]["ErrorResponse"] & Record<string, never>;
+        InternalServerErrorResponse: components["schemas"]["ErrorResponse"] & Record<string, never>;
     };
     responses: never;
     parameters: {
@@ -506,7 +534,5 @@ interface components {
     headers: never;
     pathItems: never;
 }
-type $defs = Record<string, never>;
-type operations = Record<string, never>;
-
-export type { $defs, components, operations, paths, webhooks };
+export type $defs = Record<string, never>;
+export type operations = Record<string, never>;