Merge pull request #161 from objectstack-ai/copilot/create-example-folders

Author: hotlong

examples/ai/metadata-examples/README.md

@@ -0,0 +1,105 @@
+# ObjectStack AI Protocol Examples
+
+This package contains comprehensive examples demonstrating all aspects of the ObjectStack AI Protocol.
+
+## 📚 What's Included
+
+### Core Examples
+
+1. **agent.examples.ts** - AI agent configuration examples
+   - Conversational agents
+   - Task-specific agents
+   - Multi-agent systems
+   - Agent tools and capabilities
+
+2. **conversation.examples.ts** - Conversation management examples
+   - Chat interfaces
+   - Message threading
+   - Context management
+   - Conversation history
+
+3. **cost.examples.ts** - Cost tracking examples
+   - Token usage tracking
+   - Cost allocation
+   - Budget management
+   - Usage analytics
+
+4. **model-registry.examples.ts** - Model registry examples
+   - Model configurations
+   - Provider settings
+   - Model capabilities
+   - Fallback strategies
+
+5. **nlq.examples.ts** - Natural Language Query examples
+   - Text-to-SQL generation
+   - Query understanding
+   - Semantic search
+   - Intent recognition
+
+6. **orchestration.examples.ts** - AI orchestration examples
+   - Multi-step workflows
+   - Agent coordination
+   - Task routing
+   - Error handling
+
+7. **predictive.examples.ts** - Predictive analytics examples
+   - Forecasting models
+   - Classification
+   - Regression
+   - Anomaly detection
+
+8. **rag-pipeline.examples.ts** - RAG pipeline examples
+   - Document indexing
+   - Vector search
+   - Context retrieval
+   - Answer generation
+
+## 🚀 Usage
+
+```typescript
+import {
+  SalesAssistantAgent,
+  CustomerConversation,
+  CostTracker,
+  OpenAIModel,
+  NaturalLanguageQuery,
+  AgentOrchestration,
+  SalesForecast,
+  DocumentRAGPipeline,
+} from '@objectstack/example-ai';
+```
+
+## 🏗️ Building
+
+```bash
+npm run build
+```
+
+This compiles all TypeScript examples to JavaScript and generates type declarations.
+
+## 📖 Example Structure
+
+Each example follows this pattern:
+- Descriptive constant name (e.g., `SalesAssistantAgent`)
+- Comprehensive JSDoc comment explaining the use case
+- Complete, valid example using proper schemas
+- Realistic, practical scenarios
+
+## 🎯 Use Cases
+
+These examples are designed for:
+- **Learning**: Understand ObjectStack AI Protocol patterns
+- **Reference**: Copy-paste starting points for your own metadata
+- **Testing**: Validate implementations against standard patterns
+- **Documentation**: Illustrate best practices and conventions
+
+## 📝 Naming Conventions
+
+- **Configuration Keys**: camelCase (e.g., `modelName`, `maxTokens`)
+- **Machine Names**: snake_case (e.g., `sales_agent`, `rag_pipeline`)
+- **Example Constants**: PascalCase (e.g., `SalesAgent`, `RAGPipeline`)
+
+## 🔗 Related
+
+- [ObjectStack Spec](../../../packages/spec) - Core schema definitions
+- [Data Examples](../../data/metadata-examples) - Data Protocol examples

examples/ai/metadata-examples/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@objectstack/example-ai",
+  "version": "1.0.0",
+  "description": "Comprehensive AI Protocol examples demonstrating Agents, Conversations, Models, NLQ, Orchestration, Predictive Analytics, and RAG Pipelines",
+  "private": true,
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "@objectstack/spec": "workspace:*"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

examples/ai/metadata-examples/src/agent.examples.ts

@@ -0,0 +1,9 @@
+/**
+ * Agent Examples
+ * 
+ * This file contains examples demonstrating AI Agent configurations
+ * in the ObjectStack AI Protocol.
+ */
+
+// TODO: Add agent examples
+// Example: ConversationalAgent, TaskAgent, MultiAgentSystem

examples/ai/metadata-examples/src/conversation.examples.ts

@@ -0,0 +1,9 @@
+/**
+ * Conversation Examples
+ * 
+ * This file contains examples demonstrating Conversation configurations
+ * in the ObjectStack AI Protocol.
+ */
+
+// TODO: Add conversation examples
+// Example: ChatInterface, MessageThreading, ContextManagement

examples/ai/metadata-examples/src/cost.examples.ts

@@ -0,0 +1,9 @@
+/**
+ * Cost Examples
+ * 
+ * This file contains examples demonstrating Cost Tracking configurations
+ * in the ObjectStack AI Protocol.
+ */
+
+// TODO: Add cost tracking examples
+// Example: TokenUsageTracking, CostAllocation, BudgetManagement

examples/ai/metadata-examples/src/index.ts

@@ -0,0 +1,33 @@
+// @ts-nocheck
+/**
+ * ObjectStack AI Protocol Examples
+ * 
+ * This module exports comprehensive examples demonstrating all aspects
+ * of the ObjectStack AI Protocol.
+ * 
+ * @packageDocumentation
+ */
+
+// Agent Examples
+export * from './agent.examples';
+
+// Conversation Examples
+export * from './conversation.examples';
+
+// Cost Examples
+export * from './cost.examples';
+
+// Model Registry Examples
+export * from './model-registry.examples';
+
+// NLQ Examples
+export * from './nlq.examples';
+
+// Orchestration Examples
+export * from './orchestration.examples';
+
+// Predictive Examples
+export * from './predictive.examples';
+
+// RAG Pipeline Examples
+export * from './rag-pipeline.examples';

examples/ai/metadata-examples/src/model-registry.examples.ts

@@ -0,0 +1,9 @@
+/**
+ * Model Registry Examples
+ * 
+ * This file contains examples demonstrating Model Registry configurations
+ * in the ObjectStack AI Protocol.
+ */
+
+// TODO: Add model registry examples
+// Example: OpenAIModel, AnthropicModel, CustomModel, FallbackStrategy

examples/ai/metadata-examples/src/nlq.examples.ts

@@ -0,0 +1,9 @@
+/**
+ * NLQ Examples
+ * 
+ * This file contains examples demonstrating Natural Language Query configurations
+ * in the ObjectStack AI Protocol.
+ */
+
+// TODO: Add NLQ examples
+// Example: TextToSqlQuery, SemanticSearch, IntentRecognition

examples/ai/metadata-examples/src/orchestration.examples.ts

@@ -0,0 +1,9 @@
+/**
+ * Orchestration Examples
+ * 
+ * This file contains examples demonstrating AI Orchestration configurations
+ * in the ObjectStack AI Protocol.
+ */
+
+// TODO: Add orchestration examples
+// Example: MultiStepWorkflow, AgentCoordination, TaskRouting

examples/ai/metadata-examples/src/predictive.examples.ts

@@ -0,0 +1,9 @@
+/**
+ * Predictive Examples
+ * 
+ * This file contains examples demonstrating Predictive Analytics configurations
+ * in the ObjectStack AI Protocol.
+ */
+
+// TODO: Add predictive analytics examples
+// Example: ForecastingModel, Classification, Regression, AnomalyDetection