compress-lightreach 1.0.9 → 1.0.10

package/README.md

@@ -12,8 +12,7 @@ Compress Light Reach is a Node.js/TypeScript SDK that provides intelligent model
 
 - **Intelligent Model Routing**: Automatically selects the optimal model based on admin-configured quality settings and available provider keys
 - **Token-aware Compression**: Replaces repeated substrings with shorter placeholders using a fast greedy algorithm
-- **Lossless**: Perfect decompression guaranteed
-- **Output Compression**: Optional model output compression support
+- **Lossless Input Compression**: Prompt reconstruction is deterministic
 - **Cloud API**: Uses Light Reach's cloud service for compression and routing
 - **Multi-provider Support**: OpenAI, Anthropic, Google, DeepSeek, Moonshot
 - **TypeScript**: Full TypeScript support with type definitions
@@ -154,17 +153,6 @@ const result = await client.complete({
 });
 ```
 
-### With Output Compression
-
-```typescript
-const result = await client.complete({
-  messages: [{ role: 'user', content: 'Generate a long report...' }],
-  compress_output: true,
-});
-
-console.log(result.choices[0].message.content);
-```
-
 ### With Compression Config
 
 Control which message roles get compressed:
@@ -193,35 +181,6 @@ console.log(result.choices[0].message.content);
 console.log(`Model used: ${result.routing_info?.selected_model}`);
 ```
 
-### Compression Only (No LLM Call)
-
-```typescript
-import { PcompresslrAPIClient } from 'compress-lightreach';
-
-const client = new PcompresslrAPIClient("your-lightreach-api-key");
-
-const compressed = await client.compress(
-  "Your text with repeated content here...",
-  "gpt-4",
-  { team: 'backend' },
-);
-
-console.log(compressed.llm_format);
-console.log(`Compression ratio: ${compressed.compression_ratio}`);
-
-// Decompress later
-const decompressed = await client.decompress(compressed.llm_format);
-console.log(decompressed.decompressed);
-```
-
-### Command Line Interface
-
-```bash
-export PCOMPRESLR_API_KEY=your-api-key
-
-npx pcompresslr "Your prompt with repeated text here..."
-```
-
 ## API Reference
 
 ### `PcompresslrAPIClient`
@@ -254,7 +213,7 @@ For direct synchronous calls, use `completeSync()` instead.
 | `messages` | `Message[]` | required | Conversation history with `role` and `content` |
 | `llm_provider` | `'openai' \| 'anthropic' \| 'google' \| 'deepseek' \| 'moonshot'` | — | Optional provider constraint. Omit for cross-provider optimization |
 | `compress` | `boolean` | `true` | Whether to compress messages |
-| `compress_output` | `boolean` | `false` | Whether to request compressed output from LLM |
+| `compress_output` | `boolean` | `false` | Advanced server hint. `complete()` still returns normal OpenAI-style text in `choices[0].message.content` |
 | `compression_config` | `object` | — | Per-role compression settings (see below) |
 | `temperature` | `number` | — | LLM temperature parameter |
 | `max_tokens` | `number` | — | Maximum tokens to generate |
@@ -349,46 +308,6 @@ Explicit async job flow with configurable polling. Called internally by `complet
 - `maxWaitMs` (number, default: timeout): Maximum wait time
 - `idempotencyKey` (string, optional): Idempotency key for job creation
 
-##### `compress(prompt, model?, tags?): Promise<CompressResponse>`
-
-Compression-only (POST `/api/v1/compress`).
-
-**Parameters:**
-- `prompt` (string, required): Text to compress
-- `model` (string, optional): Model for tokenization. Default: `'gpt-4'`
-- `tags` (`Record<string, string>`, optional): Tags for attribution
-
-**Response (`CompressResponse`):**
-
-```typescript
-{
-  compressed: string;
-  dictionary: Record<string, string>;
-  llm_format: string;
-  compression_ratio: number;
-  original_size: number;
-  compressed_size: number;
-  processing_time_ms: number;
-  algorithm: string;
-}
-```
-
-##### `decompress(llmFormat): Promise<DecompressResponse>`
-
-Decompress an LLM-formatted compressed prompt (POST `/api/v1/decompress`).
-
-**Parameters:**
-- `llmFormat` (string, required): The `llm_format` string from a compress response
-
-**Response (`DecompressResponse`):**
-
-```typescript
-{
-  decompressed: string;
-  processing_time_ms: number;
-}
-```
-
 ##### `healthCheck(): Promise<HealthCheckResponse>`
 
 Check API health status (GET `/health`).
@@ -451,7 +370,7 @@ try {
 1. **Compression**: Identifies repeated substrings using efficient algorithms and replaces them with shorter placeholders, reducing token count
 2. **Routing**: Selects the cheapest model that meets the admin-configured quality ceiling (global, tag-level, or integration-level)
 3. **LLM Call**: Sends the compressed prompt to the selected model via your BYOK provider keys
-4. **Decompression**: Losslessly restores the model's response if output compression was enabled
+4. **Response Shaping**: Returns standard OpenAI-style completion fields plus LightReach metadata extensions
 
 ## Examples
 
@@ -479,7 +398,7 @@ console.log(`Token savings: ${result.compression_stats.token_savings} tokens`);
 console.log(`Compression ratio: ${(result.compression_stats.compression_ratio * 100).toFixed(2)}%`);
 ```
 
-### Example 2: Output Compression
+### Example 2: Compression Config
 
 ```typescript
 import { PcompresslrAPIClient } from 'compress-lightreach';
@@ -488,7 +407,12 @@ const client = new PcompresslrAPIClient("your-lightreach-api-key");
 
 const result = await client.complete({
   messages: [{ role: "user", content: "Generate a long report with repeated sections..." }],
-  compress_output: true,
+  compression_config: {
+    compress_system: false,
+    compress_user: true,
+    compress_assistant: false,
+    compress_only_last_n_user: 1,
+  },
 });
 
 console.log(result.choices[0].message.content);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "compress-lightreach",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "OpenAI-compatible LLM routing and compression SDK with LightReach metadata extensions",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",