@albatrossai/albatross-sdk 0.2.0-b → 0.2.1

package/README.md

@@ -1,23 +1,63 @@
-# albatross-sdk
+# @albatrossai/albatross-sdk
 
-## tooling
+[![npm version](https://img.shields.io/npm/v/@albatrossai/albatross-sdk.svg)](https://www.npmjs.com/package/@albatrossai/albatross-sdk)
+[![Documentation](https://img.shields.io/badge/docs-typedoc-blue)](https://albatross-core.github.io/fake-ecommerce/)
 
-- **bundler**: tsup (ESM + CJS outputs)
-- **validation**: zod (runtime type validation)
-- **documentation**: jsdoc + TypeDoc (future)
+Official TypeScript/JavaScript SDK for Albatross AI - intelligent content selection, recommendations, and personalization.
 
-## development
+## Installation
 
 ```bash
-bun run build        # build SDK with tsup
-bun run dev          # watch mode
-bun run typecheck    # type checking
+npm install @albatrossai/albatross-sdk
 ```
 
-## usage
+## Quick Start
 
 ```typescript
-import Client from 'albatross-sdk';
+import { Client } from '@albatrossai/albatross-sdk';
 
-const client = new Client(token, instanceUuid, baseUrl);
-```
+const client = new Client('your-api-token', 'your-tenant-id');
+
+// Search
+const results = await client.search('query', 'use-case', { limit: 10 });
+
+// Recommendations
+const recs = await client.getRecommendations('use-case', {
+  user_id: 'user-123',
+  limit: 10
+});
+
+// Track events
+await client.putEvent({
+  eventType: 'view',
+  payload: { user_id: 'user-123', item_id: 'item-456' }
+});
+```
+
+## Documentation
+
+**📖 [Complete API Documentation](https://albatross-core.github.io/fake-ecommerce/)**
+
+The full API reference with detailed examples, type definitions, and method documentation is available in the auto-generated TypeDoc documentation.
+
+### Key Features
+
+- 🎯 Content selection & search (text, image, vector)
+- 🔮 AI predictions & recommendations
+- 📊 Event tracking
+- 📦 Catalog management
+- 🛡️ Full TypeScript support
+- 🔄 Auto-retry with exponential backoff
+
+## Development
+
+```bash
+bun install       # Install dependencies
+bun run build     # Build the SDK
+bun test          # Run tests
+bun run docs      # Generate documentation
+```
+
+## License
+
+MIT

package/dist/index.cjs

@@ -1029,7 +1029,7 @@ var Client = class {
     if (request.options?.image) {
       this.validateImageSize(request.options.image);
     }
-    const url = `${this.baseUrl}/use-case/content-selection`;
+    const url = `${this.baseUrl}/prediction/content-selection`;
     return this.makeRequest({
       method: "POST",
       url,
@@ -1474,7 +1474,7 @@ var Client = class {
    *
    * @example
    * ```typescript
-   * const prediction = await client.prediction({
+   * const ranking = await client.ranking({
    *   useCase: { uuid: "ranking-use-case" },
    *   context: { user_id: "user-123" },
    *   actions: [
@@ -1484,9 +1484,9 @@ var Client = class {
    * });
    * ```
    */
-  prediction = async (payload) => {
+  ranking = async (payload) => {
     PredictionPayloadSchema.parse(payload);
-    const url = `${this.baseUrl}/use-case/prediction`;
+    const url = `${this.baseUrl}/prediction/ranker`;
     const data = this.predictionPreProcessing(payload);
     return this.makeRequest({
       method: "POST",
@@ -1501,7 +1501,7 @@ var Client = class {
    * submits outcome feedback for a previous prediction.
    *
    * @param payload - feedback payload
-   * @param payload.predictionUuid - id of the prediction to provide feedback for (from prediction() response)
+   * @param payload.predictionUuid - id of the prediction to provide feedback for (from ranking() response)
    * @param payload.value - feedback data (e.g., { reward: 1 }, { clicked: true }, { rating: 4.5 })
    * @param payload.modelUuid - optional specific model uuid to send feedback to
    *
@@ -1513,7 +1513,7 @@ var Client = class {
    *
    * @example
    * ```typescript
-   * const pred = await client.prediction({...});
+   * const pred = await client.ranking({...});
    * // later, after user interaction
    * await client.feedback({
    *   predictionUuid: pred.id,