@exulu/backend 1.46.1 → 1.47.0

package/mintlify-docs/api-reference/core-types/agent-types.mdx

@@ -0,0 +1,110 @@
+---
+title: 'Agents'
+description: 'GraphQL types for AI agent configurations and capabilities'
+---
+
+## agent
+
+AI agent configurations and instances.
+
+```graphql
+type agent {
+  id: ID!
+  name: String!
+  description: String
+  backend: String!
+  type: String!
+  createdAt: Date!
+  updatedAt: Date!
+
+  # Backend-specific fields
+  provider: String
+  providerName: String
+  modelName: String
+  systemInstructions: String
+  authenticationInformation: String
+
+  # Configuration
+  rateLimit: RateLimiterRule
+  streaming: Boolean
+  capabilities: AgentCapabilities
+  maxContextLength: Int
+
+  # Workflows
+  workflows: AgentWorkflows
+
+  # Access control (if RBAC enabled)
+  RBAC: RBACData
+
+  # Routing
+  slug: String
+}
+```
+
+**Example query:**
+
+```graphql
+query {
+  agentById(id: "agent-123") {
+    id
+    name
+    provider
+    modelName
+    capabilities {
+      text
+      images
+      files
+    }
+    workflows {
+      enabled
+      queue {
+        name
+      }
+    }
+  }
+}
+```
+
+## AgentCapabilities
+
+Defines what content types the agent can process.
+
+```graphql
+type AgentCapabilities {
+  text: Boolean
+  images: [String]    # e.g., [".png", ".jpg"]
+  files: [String]     # e.g., [".pdf", ".docx"]
+  audio: [String]
+  video: [String]
+}
+```
+
+## RateLimiterRule
+
+Rate limiting configuration for agent requests.
+
+```graphql
+type RateLimiterRule {
+  name: String
+  rate_limit: RateLimiterRuleRateLimit
+}
+
+type RateLimiterRuleRateLimit {
+  time: Int    # Time window in seconds
+  limit: Int   # Max requests per time window
+}
+```
+
+## Related Types
+
+<CardGroup cols={2}>
+  <Card title="Session Types" icon="comments" href="/api-reference/core-types/session-types">
+    Agent sessions and messages
+  </Card>
+  <Card title="Workflow Types" icon="workflow" href="/api-reference/core-types/workflow-types">
+    Agent workflow configurations
+  </Card>
+  <Card title="Back to Overview" icon="arrow-left" href="/api-reference/core-types/overview">
+    View all core types
+  </Card>
+</CardGroup>

package/mintlify-docs/api-reference/core-types/analytics-types.mdx

@@ -0,0 +1,95 @@
+---
+title: 'Analytics'
+description: 'GraphQL types for usage statistics and reporting'
+---
+
+## statistics
+
+Usage statistics and analytics.
+
+```graphql
+type statistics {
+  id: ID!
+  name: String!
+  label: String!
+  type: String!
+  trigger: String!
+  count: Int!
+  user: ID
+  role: ID
+  createdAt: Date!
+  updatedAt: Date!
+}
+```
+
+## Aggregate Statistics
+
+Query aggregate statistics with grouping:
+
+```graphql
+query {
+  statisticsStatistics(
+    groupBy: "label"
+    filters: [
+      { type: { eq: "agent_run" } }
+    ]
+    limit: 10
+  ) {
+    group
+    count
+  }
+}
+```
+
+## Common Statistics Types
+
+- **agent_run** - Agent execution count
+- **api_call** - API request count
+- **workflow_execution** - Workflow run count
+- **eval_run** - Evaluation execution count
+- **context_search** - Vector search count
+
+## Usage Analytics
+
+Statistics track usage across:
+
+- **Per user** - Track individual user activity
+- **Per role** - Aggregate by role
+- **Per resource** - Track specific agents, workflows, etc.
+- **Time-based** - Query by date ranges
+
+## Example: Agent Usage Report
+
+```graphql
+query {
+  statisticsStatistics(
+    groupBy: "label"
+    filters: [
+      {
+        type: { eq: "agent_run" }
+        createdAt: { gte: "2025-01-01T00:00:00Z" }
+      }
+    ]
+  ) {
+    group  # Agent name
+    count  # Number of executions
+  }
+}
+```
+
+## Related Types
+
+<CardGroup cols={2}>
+  <Card title="User Management" icon="users" href="/api-reference/core-types/user-management">
+    User and role statistics
+  </Card>
+  <Card title="Agent Types" icon="robot" href="/api-reference/core-types/agent-types">
+    Agent usage tracking
+  </Card>
+  <Card title="Workflow Types" icon="workflow" href="/api-reference/core-types/workflow-types">
+    Workflow execution stats
+  </Card>
+  <Card title="Back to Overview" icon="arrow-left" href="/api-reference/core-types/overview">
+    View all core types
+  </Card>
+</CardGroup>

package/mintlify-docs/api-reference/core-types/configuration-types.mdx

@@ -0,0 +1,83 @@
+---
+title: 'Configuration'
+description: 'GraphQL types for encrypted variables and project organization'
+---
+
+## variables
+
+Encrypted configuration values (alternative to .env files).
+
+```graphql
+type variables {
+  id: ID!
+  name: String!
+  value: String!
+  encrypted: Boolean!
+  description: String
+  createdAt: Date!
+  updatedAt: Date!
+}
+```
+
+<Note>
+  Values are encrypted with AES using `NEXTAUTH_SECRET`. Use [`ExuluVariables.get()`](/core/exulu-variables/api-reference#get) to retrieve decrypted values.
+</Note>
+
+**Example usage:**
+
+```graphql
+mutation {
+  variablesCreateOne(
+    input: {
+      name: "openai_api_key"
+      value: "sk-..."
+      encrypted: true
+      description: "OpenAI API key for production"
+    }
+  ) {
+    item {
+      id
+      name
+    }
+  }
+}
+```
+
+## projects
+
+Project organization for grouping resources.
+
+```graphql
+type projects {
+  id: ID!
+  name: String!
+  description: String
+  createdAt: Date!
+  updatedAt: Date!
+}
+```
+
+Projects provide a way to organize related resources for better management and organization.
+
+## Security
+
+<Warning>
+  Variable values are write-only. Once encrypted, they cannot be retrieved through GraphQL - use the ExuluVariables API instead.
+</Warning>
+
+## Related Types
+
+<CardGroup cols={2}>
+  <Card title="Workflow Types" icon="workflow" href="/api-reference/core-types/workflow-types">
+    Workflow variables
+  </Card>
+  <Card title="Agent Types" icon="robot" href="/api-reference/core-types/agent-types">
+    Agent configuration
+  </Card>
+  <Card title="User Management" icon="users" href="/api-reference/core-types/user-management">
+    Access permissions
+  </Card>
+  <Card title="Back to Overview" icon="arrow-left" href="/api-reference/core-types/overview">
+    View all core types
+  </Card>
+</CardGroup>

package/mintlify-docs/api-reference/core-types/evaluation-types.mdx

@@ -0,0 +1,106 @@
+---
+title: 'Evaluations'
+description: 'GraphQL types for testing and evaluating agent performance'
+---
+
+## test_cases
+
+Test cases for evaluating agent performance.
+
+```graphql
+type test_cases {
+  id: ID!
+  name: String!
+  description: String
+  inputs: JSON!                           # UIMessage[]
+  expected_output: String!
+  expected_tools: JSON                    # string[]
+  expected_knowledge_sources: JSON        # string[]
+  expected_agent_tools: JSON              # string[]
+  createdAt: Date!
+  updatedAt: Date!
+  RBAC: RBACData
+}
+```
+
+**Example:**
+
+```graphql
+mutation {
+  test_casesCreateOne(
+    input: {
+      name: "Weather Query"
+      description: "User asks about weather"
+      inputs: [
+        { role: "user", content: "What's the weather like?" }
+      ]
+      expected_output: "Based on current data, it's 68°F and sunny."
+      expected_tools: ["get_weather"]
+    }
+  ) {
+    item {
+      id
+      name
+    }
+  }
+}
+```
+
+## eval_sets
+
+Collections of test cases for batch evaluation.
+
+```graphql
+type eval_sets {
+  id: ID!
+  name: String!
+  description: String
+  test_case_ids: JSON       # string[]
+  createdAt: Date!
+  updatedAt: Date!
+  RBAC: RBACData
+}
+```
+
+## eval_runs
+
+Evaluation execution records.
+
+```graphql
+type eval_runs {
+  id: ID!
+  name: String!
+  description: String
+  agent_id: ID!
+  test_case_ids: JSON           # string[]
+  eval_functions: JSON          # string[]
+  config: JSON
+  scoring_method: String
+  pass_threshold: Float
+  timeout_in_seconds: Int
+  createdAt: Date!
+  updatedAt: Date!
+  RBAC: RBACData
+}
+```
+
+## Evaluation Workflow
+
+1. Create **test_cases** with expected inputs and outputs
+2. Group test cases into **eval_sets** for organized testing
+3. Run **eval_runs** to evaluate agent performance
+4. Review results and iterate on agent improvements
+
+## Related Types
+
+<CardGroup cols={2}>
+  <Card title="Agent Types" icon="robot" href="/api-reference/core-types/agent-types">
+    Agents being evaluated
+  </Card>
+  <Card title="Job Types" icon="gears" href="/api-reference/core-types/job-types">
+    Background eval execution
+  </Card>
+  <Card title="Back to Overview" icon="arrow-left" href="/api-reference/core-types/overview">
+    View all core types
+  </Card>
+</CardGroup>

package/mintlify-docs/api-reference/core-types/job-types.mdx

@@ -0,0 +1,135 @@
+---
+title: 'Job Management'
+description: 'GraphQL types for background job tracking with BullMQ'
+---
+
+## Job
+
+Background job information from BullMQ.
+
+```graphql
+type Job {
+  id: String!
+  name: String!
+  returnvalue: JSON
+  stacktrace: [String]
+  finishedOn: Date
+  processedOn: Date
+  attemptsMade: Int
+  failedReason: String
+  state: String!
+  data: JSON
+  timestamp: Date
+}
+```
+
+## Query Jobs
+
+**By queue and status:**
+
+```graphql
+query {
+  jobs(
+    queue: eval_runs
+    statusses: [active, waiting, failed]
+    page: 1
+    limit: 50
+  ) {
+    items {
+      id
+      name
+      state
+      failedReason
+    }
+  }
+}
+```
+
+## Job States
+
+- **waiting** - Job is queued
+- **active** - Job is currently processing
+- **completed** - Job finished successfully
+- **failed** - Job failed with error
+- **delayed** - Job is scheduled for later
+- **paused** - Queue is paused
+
+## Queue Information
+
+Get detailed queue status:
+
+```graphql
+query {
+  queue(queue: eval_runs) {
+    name
+    concurrency {
+      worker
+      queue
+    }
+    timeoutInSeconds
+    ratelimit
+    isMaxed
+    isPaused
+    jobs {
+      paused
+      completed
+      failed
+      waiting
+      active
+      delayed
+    }
+  }
+}
+```
+
+## Queue Management
+
+Manage queue operations:
+
+```graphql
+mutation {
+  # Pause a queue
+  pauseQueue(queue: eval_runs) {
+    success
+  }
+
+  # Resume a queue
+  resumeQueue(queue: eval_runs) {
+    success
+  }
+
+  # Drain waiting jobs
+  drainQueue(queue: eval_runs) {
+    success
+  }
+
+  # Delete a specific job
+  deleteJob(queue: eval_runs, id: "job-123") {
+    success
+  }
+}
+```
+
+## Common Queues
+
+- **eval_runs** - Evaluation execution
+- **chunk_generation** - Vector embedding generation
+- **workflow_execution** - Workflow runs
+- **context_processing** - Context data processing
+
+## Related Types
+
+<CardGroup cols={2}>
+  <Card title="Evaluation Types" icon="chart-line" href="/api-reference/core-types/evaluation-types">
+    Eval run jobs
+  </Card>
+  <Card title="Workflow Types" icon="workflow" href="/api-reference/core-types/workflow-types">
+    Workflow execution jobs
+  </Card>
+  <Card title="Dynamic Types" icon="wand-magic-sparkles" href="/api-reference/dynamic-types">
+    Context chunk jobs
+  </Card>
+  <Card title="Back to Overview" icon="arrow-left" href="/api-reference/core-types/overview">
+    View all core types
+  </Card>
+</CardGroup>

package/mintlify-docs/api-reference/core-types/overview.mdx

@@ -0,0 +1,73 @@
+---
+title: 'Overview'
+description: 'Predefined GraphQL types for Exulu IMP platform resources'
+---
+
+## Overview
+
+Core types are predefined GraphQL types provided by Exulu IMP for managing platform resources. These types are always available in the schema, regardless of your implementation.
+
+## Type Categories
+
+<CardGroup cols={2}>
+  <Card title="Agent Types" icon="robot" href="/api-reference/core-types/agent-types">
+    Agent configurations, capabilities, and rate limiting
+  </Card>
+  <Card title="Session Types" icon="comments" href="/api-reference/core-types/session-types">
+    Conversation sessions and messages
+  </Card>
+  <Card title="User Management" icon="users" href="/api-reference/core-types/user-management">
+    Users, roles, and authentication
+  </Card>
+  <Card title="Evaluation Types" icon="chart-line" href="/api-reference/core-types/evaluation-types">
+    Test cases, eval sets, and eval runs
+  </Card>
+  <Card title="Workflow Types" icon="workflow" href="/api-reference/core-types/workflow-types">
+    Workflow templates and execution
+  </Card>
+  <Card title="Configuration" icon="gear" href="/api-reference/core-types/configuration-types">
+    Variables and project organization
+  </Card>
+  <Card title="Prompt Management" icon="pen-to-square" href="/api-reference/core-types/prompt-types">
+    Prompt library and favorites
+  </Card>
+  <Card title="Analytics" icon="chart-bar" href="/api-reference/core-types/analytics-types">
+    Usage statistics and reporting
+  </Card>
+  <Card title="Job Management" icon="gears" href="/api-reference/core-types/job-types">
+    Background job tracking
+  </Card>
+  <Card title="RBAC Types" icon="shield" href="/api-reference/core-types/rbac-types">
+    Access control and permissions
+  </Card>
+</CardGroup>
+
+## Common Fields
+
+Most core types include these standard fields:
+
+- **id** - Unique identifier (ID or Int)
+- **createdAt** - Timestamp when resource was created
+- **updatedAt** - Timestamp when resource was last modified
+- **RBAC** - Access control settings (when RBAC is enabled)
+
+## Type Safety
+
+All core types are fully typed in the GraphQL schema with TypeScript support. Use GraphQL introspection to explore available fields and their types.
+
+## Next Steps
+
+<CardGroup cols={2}>
+  <Card title="Dynamic Types" icon="wand-magic-sparkles" href="/api-reference/dynamic-types">
+    Learn about context-generated types
+  </Card>
+  <Card title="Queries" icon="magnifying-glass" href="/api-reference/queries">
+    Explore all query operations
+  </Card>
+  <Card title="Mutations" icon="pen-to-square" href="/api-reference/mutations">
+    Explore all mutation operations
+  </Card>
+  <Card title="API Introduction" icon="book" href="/api-reference/introduction">
+    Back to API overview
+  </Card>
+</CardGroup>

package/mintlify-docs/api-reference/core-types/prompt-types.mdx

@@ -0,0 +1,102 @@
+---
+title: 'Prompt Library'
+description: 'GraphQL types for prompt library and favorites'
+---
+
+## prompt_library
+
+Saved prompts for reuse across agents.
+
+```graphql
+type prompt_library {
+  id: ID!
+  name: String!
+  content: String!
+  tags: JSON          # string[]
+  category: String
+  description: String
+  createdAt: Date!
+  updatedAt: Date!
+  RBAC: RBACData
+}
+```
+
+**Example query:**
+
+```graphql
+query {
+  prompt_libraryPagination(
+    filters: [
+      { tags: { contains: ["support", "greeting"] } }
+    ]
+  ) {
+    items {
+      id
+      name
+      content
+      tags
+    }
+  }
+}
+```
+
+## prompt_favorites
+
+User's favorited prompts.
+
+```graphql
+type prompt_favorites {
+  id: ID!
+  user: ID!
+  prompt: ID!
+  createdAt: Date!
+  updatedAt: Date!
+}
+```
+
+## Usage
+
+The prompt library allows teams to:
+
+- **Share prompts** across multiple agents
+- **Organize prompts** with tags and categories
+- **Version control** prompt templates
+- **Favorite prompts** for quick access
+
+## Example: Creating a Reusable Prompt
+
+```graphql
+mutation {
+  prompt_libraryCreateOne(
+    input: {
+      name: "Customer Greeting"
+      content: "Hello! I'm here to help you with {{topic}}. What can I assist you with today?"
+      tags: ["greeting", "support", "customer-service"]
+      category: "support"
+      description: "Standard greeting for customer support agents"
+    }
+  ) {
+    item {
+      id
+      name
+    }
+  }
+}
+```
+
+## Related Types
+
+<CardGroup cols={2}>
+  <Card title="Agent Types" icon="robot" href="/api-reference/core-types/agent-types">
+    Agent system instructions
+  </Card>
+  <Card title="User Management" icon="users" href="/api-reference/core-types/user-management">
+    User favorites
+  </Card>
+  <Card title="RBAC Types" icon="shield" href="/api-reference/core-types/rbac-types">
+    Prompt access control
+  </Card>
+  <Card title="Back to Overview" icon="arrow-left" href="/api-reference/core-types/overview">
+    View all core types
+  </Card>
+</CardGroup>