Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions content/docs/references/ai/AITask.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: AITask
description: AITask Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | optional | Optional task ID for referencing |
| **name** | `string` | ✅ | Human-readable task name |
| **type** | `Enum<'classify' \| 'extract' \| 'summarize' \| 'generate' \| 'predict' \| 'translate' \| 'sentiment' \| 'entity_recognition' \| 'anomaly_detection' \| 'recommendation'>` | ✅ | |
| **model** | `string` | optional | Model ID from registry (uses default if not specified) |
| **promptTemplate** | `string` | optional | Prompt template ID for this task |
| **inputFields** | `string[]` | ✅ | Source fields to process (e.g., ["description", "comments"]) |
| **inputContext** | `Record<string, any>` | optional | Additional context for the AI model |
| **outputField** | `string` | ✅ | Target field to store the result |
| **outputFormat** | `Enum<'text' \| 'json' \| 'number' \| 'boolean' \| 'array'>` | optional | |
| **classes** | `string[]` | optional | Valid classes for classification tasks |
| **multiClass** | `boolean` | optional | Allow multiple classes to be selected |
| **extractionSchema** | `Record<string, any>` | optional | JSON schema for structured extraction |
| **maxLength** | `number` | optional | Maximum length for generated content |
| **temperature** | `number` | optional | Model temperature override |
| **fallbackValue** | `any` | optional | Fallback value if AI task fails |
| **retryAttempts** | `integer` | optional | |
| **condition** | `string` | optional | Formula condition - task only runs if TRUE |
| **description** | `string` | optional | |
| **active** | `boolean` | optional | |
17 changes: 17 additions & 0 deletions content/docs/references/ai/AITaskType.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: AITaskType
description: AITaskType Schema Reference
---

## Allowed Values

* `classify`
* `extract`
* `summarize`
* `generate`
* `predict`
* `translate`
* `sentiment`
* `entity_recognition`
* `anomaly_detection`
* `recommendation`
34 changes: 34 additions & 0 deletions content/docs/references/ai/AIWorkflowAutomation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: AIWorkflowAutomation
description: AIWorkflowAutomation Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Workflow unique identifier (snake_case) |
| **label** | `string` | ✅ | Workflow display name |
| **description** | `string` | optional | |
| **objectName** | `string` | ✅ | Target object for this workflow |
| **trigger** | `Enum<'record_created' \| 'record_updated' \| 'field_changed' \| 'scheduled' \| 'manual' \| 'webhook' \| 'batch'>` | ✅ | |
| **fieldConditions** | `object[]` | optional | Fields to monitor (for field_changed trigger) |
| **schedule** | `object` | optional | Schedule configuration (for scheduled trigger) |
| **webhookConfig** | `object` | optional | Webhook configuration (for webhook trigger) |
| **entryCriteria** | `string` | optional | Formula condition - workflow only runs if TRUE |
| **aiTasks** | `object[]` | ✅ | AI tasks to execute in sequence |
| **postActions** | `object[]` | optional | Actions after AI tasks complete |
| **executionMode** | `Enum<'sequential' \| 'parallel'>` | optional | How to execute multiple AI tasks |
| **stopOnError** | `boolean` | optional | Stop workflow if any task fails |
| **timeout** | `number` | optional | Maximum execution time in seconds |
| **priority** | `Enum<'low' \| 'normal' \| 'high' \| 'critical'>` | optional | |
| **enableLogging** | `boolean` | optional | |
| **enableMetrics** | `boolean` | optional | |
| **notifyOnFailure** | `string[]` | optional | User IDs to notify on failure |
| **active** | `boolean` | optional | |
| **version** | `string` | optional | |
| **tags** | `string[]` | optional | |
| **category** | `string` | optional | Workflow category (e.g., "support", "sales", "hr") |
| **owner** | `string` | optional | User ID of workflow owner |
| **createdAt** | `string` | optional | ISO timestamp |
| **updatedAt** | `string` | optional | ISO timestamp |
20 changes: 20 additions & 0 deletions content/docs/references/ai/AIWorkflowExecutionResult.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: AIWorkflowExecutionResult
description: AIWorkflowExecutionResult Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **workflowName** | `string` | ✅ | |
| **recordId** | `string` | ✅ | |
| **status** | `Enum<'success' \| 'partial_success' \| 'failed' \| 'skipped'>` | ✅ | |
| **executionTime** | `number` | ✅ | Execution time in milliseconds |
| **tasksExecuted** | `integer` | ✅ | Number of tasks executed |
| **tasksSucceeded** | `integer` | ✅ | Number of tasks succeeded |
| **tasksFailed** | `integer` | ✅ | Number of tasks failed |
| **taskResults** | `object[]` | optional | |
| **error** | `string` | optional | |
| **startedAt** | `string` | ✅ | ISO timestamp |
| **completedAt** | `string` | optional | ISO timestamp |
14 changes: 14 additions & 0 deletions content/docs/references/ai/AIWorkflowTrigger.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: AIWorkflowTrigger
description: AIWorkflowTrigger Schema Reference
---

## Allowed Values

* `record_created`
* `record_updated`
* `field_changed`
* `scheduled`
* `manual`
* `webhook`
* `batch`
14 changes: 14 additions & 0 deletions content/docs/references/ai/BatchAIWorkflowExecution.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: BatchAIWorkflowExecution
description: BatchAIWorkflowExecution Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **workflowName** | `string` | ✅ | Workflow to execute |
| **recordIds** | `string[]` | ✅ | Records to process |
| **batchSize** | `integer` | optional | |
| **parallelism** | `integer` | optional | |
| **priority** | `Enum<'low' \| 'normal' \| 'high'>` | optional | |
23 changes: 23 additions & 0 deletions content/docs/references/ai/EvaluationMetrics.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: EvaluationMetrics
description: EvaluationMetrics Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **accuracy** | `number` | optional | |
| **precision** | `number` | optional | |
| **recall** | `number` | optional | |
| **f1Score** | `number` | optional | |
| **auc** | `number` | optional | Area Under ROC Curve |
| **mse** | `number` | optional | Mean Squared Error |
| **rmse** | `number` | optional | Root Mean Squared Error |
| **mae** | `number` | optional | Mean Absolute Error |
| **r2Score** | `number` | optional | R-squared score |
| **silhouetteScore** | `number` | optional | |
| **daviesBouldinIndex** | `number` | optional | |
| **mape** | `number` | optional | Mean Absolute Percentage Error |
| **smape** | `number` | optional | Symmetric MAPE |
| **custom** | `Record<string, number>` | optional | |
25 changes: 25 additions & 0 deletions content/docs/references/ai/Hyperparameters.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: Hyperparameters
description: Hyperparameters Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **learningRate** | `number` | optional | Learning rate for training |
| **epochs** | `integer` | optional | Number of training epochs |
| **batchSize** | `integer` | optional | Training batch size |
| **maxDepth** | `integer` | optional | Maximum tree depth |
| **numTrees** | `integer` | optional | Number of trees in ensemble |
| **minSamplesSplit** | `integer` | optional | Minimum samples to split node |
| **minSamplesLeaf** | `integer` | optional | Minimum samples in leaf node |
| **hiddenLayers** | `integer[]` | optional | Hidden layer sizes |
| **activation** | `string` | optional | Activation function |
| **dropout** | `number` | optional | Dropout rate |
| **l1Regularization** | `number` | optional | L1 regularization strength |
| **l2Regularization** | `number` | optional | L2 regularization strength |
| **numClusters** | `integer` | optional | Number of clusters (k-means, etc.) |
| **seasonalPeriod** | `integer` | optional | Seasonal period for time series |
| **forecastHorizon** | `integer` | optional | Number of periods to forecast |
| **custom** | `Record<string, any>` | optional | Algorithm-specific parameters |
16 changes: 16 additions & 0 deletions content/docs/references/ai/ModelDrift.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: ModelDrift
description: ModelDrift Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **modelName** | `string` | ✅ | |
| **driftType** | `Enum<'feature_drift' \| 'prediction_drift' \| 'performance_drift'>` | ✅ | |
| **severity** | `Enum<'low' \| 'medium' \| 'high' \| 'critical'>` | ✅ | |
| **detectedAt** | `string` | ✅ | ISO timestamp |
| **metrics** | `object` | ✅ | |
| **recommendation** | `string` | optional | |
| **autoRetrainTriggered** | `boolean` | optional | |
19 changes: 19 additions & 0 deletions content/docs/references/ai/ModelFeature.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: ModelFeature
description: ModelFeature Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Feature name (snake_case) |
| **label** | `string` | optional | Human-readable label |
| **field** | `string` | ✅ | Source field name |
| **object** | `string` | optional | Source object (if different from target) |
| **dataType** | `Enum<'numeric' \| 'categorical' \| 'text' \| 'datetime' \| 'boolean'>` | ✅ | Feature data type |
| **transformation** | `Enum<'none' \| 'normalize' \| 'standardize' \| 'one_hot_encode' \| 'label_encode' \| 'log_transform' \| 'binning' \| 'embedding'>` | optional | |
| **required** | `boolean` | optional | |
| **defaultValue** | `any` | optional | |
| **description** | `string` | optional | |
| **importance** | `number` | optional | Feature importance score (0-1) |
13 changes: 13 additions & 0 deletions content/docs/references/ai/PostProcessingAction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: PostProcessingAction
description: PostProcessingAction Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **type** | `Enum<'field_update' \| 'send_email' \| 'create_record' \| 'update_related' \| 'trigger_flow' \| 'webhook'>` | ✅ | |
| **name** | `string` | ✅ | Action name |
| **config** | `Record<string, any>` | ✅ | Action-specific configuration |
| **condition** | `string` | optional | Execute only if condition is TRUE |
14 changes: 14 additions & 0 deletions content/docs/references/ai/PredictionRequest.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: PredictionRequest
description: PredictionRequest Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **modelName** | `string` | ✅ | Model to use for prediction |
| **recordIds** | `string[]` | optional | Specific records to predict (if not provided, uses all) |
| **inputData** | `Record<string, any>` | optional | Direct input data (alternative to recordIds) |
| **returnConfidence** | `boolean` | optional | |
| **returnExplanation** | `boolean` | optional | |
17 changes: 17 additions & 0 deletions content/docs/references/ai/PredictionResult.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: PredictionResult
description: PredictionResult Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **modelName** | `string` | ✅ | |
| **modelVersion** | `string` | ✅ | |
| **recordId** | `string` | optional | |
| **prediction** | `any` | optional | The predicted value |
| **confidence** | `number` | optional | Confidence score (0-1) |
| **probabilities** | `Record<string, number>` | optional | Class probabilities (for classification) |
| **explanation** | `object` | optional | |
| **metadata** | `object` | optional | |
40 changes: 40 additions & 0 deletions content/docs/references/ai/PredictiveModel.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: PredictiveModel
description: PredictiveModel Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Model unique identifier (snake_case) |
| **label** | `string` | ✅ | Model display name |
| **description** | `string` | optional | |
| **type** | `Enum<'classification' \| 'regression' \| 'clustering' \| 'forecasting' \| 'anomaly_detection' \| 'recommendation' \| 'ranking'>` | ✅ | |
| **algorithm** | `string` | optional | Specific algorithm (e.g., "random_forest", "xgboost", "lstm") |
| **objectName** | `string` | ✅ | Target object for predictions |
| **target** | `string` | ✅ | Target field to predict |
| **targetType** | `Enum<'numeric' \| 'categorical' \| 'binary'>` | optional | Target field type |
| **features** | `object[]` | ✅ | Input features for the model |
| **hyperparameters** | `object` | optional | |
| **training** | `object` | optional | |
| **metrics** | `object` | optional | Evaluation metrics from last training |
| **deploymentStatus** | `Enum<'draft' \| 'training' \| 'trained' \| 'deployed' \| 'deprecated'>` | optional | |
| **version** | `string` | optional | |
| **predictionField** | `string` | optional | Field to store predictions |
| **confidenceField** | `string` | optional | Field to store confidence scores |
| **updateTrigger** | `Enum<'on_create' \| 'on_update' \| 'manual' \| 'scheduled'>` | optional | |
| **autoRetrain** | `boolean` | optional | |
| **retrainSchedule** | `string` | optional | Cron expression for auto-retraining |
| **retrainThreshold** | `number` | optional | Performance threshold to trigger retraining |
| **enableExplainability** | `boolean` | optional | Generate feature importance & explanations |
| **enableMonitoring** | `boolean` | optional | |
| **alertOnDrift** | `boolean` | optional | Alert when model drift is detected |
| **active** | `boolean` | optional | |
| **owner** | `string` | optional | User ID of model owner |
| **permissions** | `string[]` | optional | User/group IDs with access |
| **tags** | `string[]` | optional | |
| **category** | `string` | optional | Model category (e.g., "sales", "marketing", "operations") |
| **lastTrainedAt** | `string` | optional | ISO timestamp |
| **createdAt** | `string` | optional | ISO timestamp |
| **updatedAt** | `string` | optional | ISO timestamp |
14 changes: 14 additions & 0 deletions content/docs/references/ai/PredictiveModelType.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: PredictiveModelType
description: PredictiveModelType Schema Reference
---

## Allowed Values

* `classification`
* `regression`
* `clustering`
* `forecasting`
* `anomaly_detection`
* `recommendation`
* `ranking`
23 changes: 23 additions & 0 deletions content/docs/references/ai/TrainingConfig.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: TrainingConfig
description: TrainingConfig Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **trainingDataRatio** | `number` | optional | Proportion of data for training |
| **validationDataRatio** | `number` | optional | Proportion for validation |
| **testDataRatio** | `number` | optional | Proportion for testing |
| **dataFilter** | `string` | optional | Formula to filter training data |
| **minRecords** | `integer` | optional | Minimum records required |
| **maxRecords** | `integer` | optional | Maximum records to use |
| **strategy** | `Enum<'full' \| 'incremental' \| 'online' \| 'transfer_learning'>` | optional | |
| **crossValidation** | `boolean` | optional | |
| **folds** | `integer` | optional | Cross-validation folds |
| **earlyStoppingEnabled** | `boolean` | optional | |
| **earlyStoppingPatience** | `integer` | optional | Epochs without improvement before stopping |
| **maxTrainingTime** | `number` | optional | Maximum training time in seconds |
| **gpuEnabled** | `boolean` | optional | |
| **randomSeed** | `integer` | optional | Random seed for reproducibility |
12 changes: 12 additions & 0 deletions content/docs/references/ai/WorkflowFieldCondition.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: WorkflowFieldCondition
description: WorkflowFieldCondition Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **field** | `string` | ✅ | Field name to monitor |
| **operator** | `Enum<'changed' \| 'changed_to' \| 'changed_from' \| 'is' \| 'is_not'>` | optional | |
| **value** | `any` | optional | Value to compare against (for changed_to/changed_from/is/is_not) |
16 changes: 16 additions & 0 deletions content/docs/references/ai/WorkflowSchedule.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: WorkflowSchedule
description: WorkflowSchedule Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **type** | `Enum<'cron' \| 'interval' \| 'daily' \| 'weekly' \| 'monthly'>` | optional | |
| **cron** | `string` | optional | Cron expression (required if type is "cron") |
| **interval** | `number` | optional | Interval in minutes (required if type is "interval") |
| **time** | `string` | optional | Time of day for daily schedules (HH:MM format) |
| **dayOfWeek** | `integer` | optional | Day of week for weekly (0=Sunday) |
| **dayOfMonth** | `integer` | optional | Day of month for monthly |
| **timezone** | `string` | optional | |
Loading
Loading