@exulu/backend 1.48.2 → 1.49.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +351 -42
- package/dist/index.d.cts +96 -1
- package/dist/index.d.ts +96 -1
- package/dist/index.js +340 -38
- package/ee/{markdown.ts → chunking/markdown.ts} +2 -2
- package/ee/python/README.md +295 -0
- package/ee/python/documents/processing/README.md +155 -0
- package/ee/{documents → python/documents}/processing/doc_processor.ts +25 -17
- package/ee/{documents/processing/pdf_to_markdown.py → python/documents/processing/document_to_markdown.py} +3 -10
- package/ee/python/setup.sh +180 -0
- package/package.json +14 -3
- package/scripts/postinstall.cjs +149 -0
- package/.agents/skills/mintlify/SKILL.md +0 -347
- package/.editorconfig +0 -15
- package/.eslintrc.json +0 -52
- package/.github/workflows/release-backend.yml +0 -38
- package/.husky/commit-msg +0 -1
- package/.jscpd.json +0 -18
- package/.mcp.json +0 -25
- package/.nvmrc +0 -1
- package/.prettierignore +0 -5
- package/.prettierrc.json +0 -12
- package/CHANGELOG.md +0 -8
- package/SECURITY.md +0 -5
- package/commitlint.config.js +0 -4
- package/devops/documentation/patch-older-releases.md +0 -42
- package/ee/documents/processing/build_pdf_processor.sh +0 -35
- package/ee/documents/processing/chunk_markdown.py +0 -263
- package/ee/documents/processing/pdf_processor.spec +0 -115
- package/eslint.config.js +0 -88
- package/jest.config.ts +0 -25
- package/mintlify-docs/.mintignore +0 -7
- package/mintlify-docs/AGENTS.md +0 -33
- package/mintlify-docs/CLAUDE.MD +0 -50
- package/mintlify-docs/CONTRIBUTING.md +0 -32
- package/mintlify-docs/LICENSE +0 -21
- package/mintlify-docs/README.md +0 -55
- package/mintlify-docs/ai-tools/claude-code.mdx +0 -43
- package/mintlify-docs/ai-tools/cursor.mdx +0 -39
- package/mintlify-docs/ai-tools/windsurf.mdx +0 -39
- package/mintlify-docs/api-reference/core-types/agent-types.mdx +0 -110
- package/mintlify-docs/api-reference/core-types/analytics-types.mdx +0 -95
- package/mintlify-docs/api-reference/core-types/configuration-types.mdx +0 -83
- package/mintlify-docs/api-reference/core-types/evaluation-types.mdx +0 -106
- package/mintlify-docs/api-reference/core-types/job-types.mdx +0 -135
- package/mintlify-docs/api-reference/core-types/overview.mdx +0 -73
- package/mintlify-docs/api-reference/core-types/prompt-types.mdx +0 -102
- package/mintlify-docs/api-reference/core-types/rbac-types.mdx +0 -163
- package/mintlify-docs/api-reference/core-types/session-types.mdx +0 -77
- package/mintlify-docs/api-reference/core-types/user-management.mdx +0 -112
- package/mintlify-docs/api-reference/core-types/workflow-types.mdx +0 -88
- package/mintlify-docs/api-reference/core-types.mdx +0 -585
- package/mintlify-docs/api-reference/dynamic-types.mdx +0 -851
- package/mintlify-docs/api-reference/endpoint/create.mdx +0 -4
- package/mintlify-docs/api-reference/endpoint/delete.mdx +0 -4
- package/mintlify-docs/api-reference/endpoint/get.mdx +0 -4
- package/mintlify-docs/api-reference/endpoint/webhook.mdx +0 -4
- package/mintlify-docs/api-reference/introduction.mdx +0 -661
- package/mintlify-docs/api-reference/mutations.mdx +0 -1012
- package/mintlify-docs/api-reference/openapi.json +0 -217
- package/mintlify-docs/api-reference/queries.mdx +0 -1154
- package/mintlify-docs/backend/introduction.mdx +0 -218
- package/mintlify-docs/changelog.mdx +0 -387
- package/mintlify-docs/community-edition.mdx +0 -304
- package/mintlify-docs/core/exulu-agent/api-reference.mdx +0 -894
- package/mintlify-docs/core/exulu-agent/configuration.mdx +0 -690
- package/mintlify-docs/core/exulu-agent/introduction.mdx +0 -552
- package/mintlify-docs/core/exulu-app/api-reference.mdx +0 -481
- package/mintlify-docs/core/exulu-app/configuration.mdx +0 -319
- package/mintlify-docs/core/exulu-app/introduction.mdx +0 -117
- package/mintlify-docs/core/exulu-authentication.mdx +0 -810
- package/mintlify-docs/core/exulu-chunkers/api-reference.mdx +0 -1011
- package/mintlify-docs/core/exulu-chunkers/configuration.mdx +0 -596
- package/mintlify-docs/core/exulu-chunkers/introduction.mdx +0 -403
- package/mintlify-docs/core/exulu-context/api-reference.mdx +0 -911
- package/mintlify-docs/core/exulu-context/configuration.mdx +0 -648
- package/mintlify-docs/core/exulu-context/introduction.mdx +0 -394
- package/mintlify-docs/core/exulu-database.mdx +0 -811
- package/mintlify-docs/core/exulu-default-agents.mdx +0 -545
- package/mintlify-docs/core/exulu-eval/api-reference.mdx +0 -772
- package/mintlify-docs/core/exulu-eval/configuration.mdx +0 -680
- package/mintlify-docs/core/exulu-eval/introduction.mdx +0 -459
- package/mintlify-docs/core/exulu-logging.mdx +0 -464
- package/mintlify-docs/core/exulu-otel.mdx +0 -670
- package/mintlify-docs/core/exulu-queues/api-reference.mdx +0 -648
- package/mintlify-docs/core/exulu-queues/configuration.mdx +0 -650
- package/mintlify-docs/core/exulu-queues/introduction.mdx +0 -474
- package/mintlify-docs/core/exulu-reranker/api-reference.mdx +0 -630
- package/mintlify-docs/core/exulu-reranker/configuration.mdx +0 -663
- package/mintlify-docs/core/exulu-reranker/introduction.mdx +0 -516
- package/mintlify-docs/core/exulu-tool/api-reference.mdx +0 -723
- package/mintlify-docs/core/exulu-tool/configuration.mdx +0 -805
- package/mintlify-docs/core/exulu-tool/introduction.mdx +0 -539
- package/mintlify-docs/core/exulu-variables/api-reference.mdx +0 -699
- package/mintlify-docs/core/exulu-variables/configuration.mdx +0 -736
- package/mintlify-docs/core/exulu-variables/introduction.mdx +0 -511
- package/mintlify-docs/development.mdx +0 -94
- package/mintlify-docs/docs.json +0 -248
- package/mintlify-docs/enterprise-edition.mdx +0 -538
- package/mintlify-docs/essentials/code.mdx +0 -35
- package/mintlify-docs/essentials/images.mdx +0 -59
- package/mintlify-docs/essentials/markdown.mdx +0 -88
- package/mintlify-docs/essentials/navigation.mdx +0 -87
- package/mintlify-docs/essentials/reusable-snippets.mdx +0 -110
- package/mintlify-docs/essentials/settings.mdx +0 -318
- package/mintlify-docs/favicon.svg +0 -3
- package/mintlify-docs/frontend/introduction.mdx +0 -39
- package/mintlify-docs/getting-started.mdx +0 -267
- package/mintlify-docs/guides/custom-agent.mdx +0 -608
- package/mintlify-docs/guides/first-agent.mdx +0 -315
- package/mintlify-docs/images/admin_ui.png +0 -0
- package/mintlify-docs/images/contexts.png +0 -0
- package/mintlify-docs/images/create_agents.png +0 -0
- package/mintlify-docs/images/evals.png +0 -0
- package/mintlify-docs/images/graphql.png +0 -0
- package/mintlify-docs/images/graphql_api.png +0 -0
- package/mintlify-docs/images/hero-dark.png +0 -0
- package/mintlify-docs/images/hero-light.png +0 -0
- package/mintlify-docs/images/hero.png +0 -0
- package/mintlify-docs/images/knowledge_sources.png +0 -0
- package/mintlify-docs/images/mcp.png +0 -0
- package/mintlify-docs/images/scaling.png +0 -0
- package/mintlify-docs/index.mdx +0 -411
- package/mintlify-docs/logo/dark.svg +0 -9
- package/mintlify-docs/logo/light.svg +0 -9
- package/mintlify-docs/partners.mdx +0 -558
- package/mintlify-docs/products.mdx +0 -77
- package/mintlify-docs/snippets/snippet-intro.mdx +0 -4
- package/mintlify-docs/styles.css +0 -207
- package/ngrok.bash +0 -1
- package/ngrok.md +0 -6
- package/ngrok.yml +0 -10
- package/release.config.cjs +0 -15
- package/skills-lock.json +0 -10
- package/types/context-processor.ts +0 -45
- package/types/enums/eval-types.ts +0 -5
- package/types/enums/field-types.ts +0 -1
- package/types/enums/jobs.ts +0 -11
- package/types/enums/statistics.ts +0 -13
- package/types/exulu-table-definition.ts +0 -79
- package/types/file-types.ts +0 -18
- package/types/models/agent-session.ts +0 -27
- package/types/models/agent.ts +0 -68
- package/types/models/context.ts +0 -53
- package/types/models/embedding.ts +0 -17
- package/types/models/eval-run.ts +0 -40
- package/types/models/exulu-agent-tool-config.ts +0 -11
- package/types/models/item.ts +0 -21
- package/types/models/job.ts +0 -8
- package/types/models/project.ts +0 -16
- package/types/models/rate-limiter-rules.ts +0 -7
- package/types/models/test-case.ts +0 -25
- package/types/models/tool.ts +0 -9
- package/types/models/user-role.ts +0 -12
- package/types/models/user.ts +0 -20
- package/types/models/variable.ts +0 -8
- package/types/models/vector-methods.ts +0 -7
- package/types/provider-config.ts +0 -21
- package/types/queue-config.ts +0 -16
- package/types/rbac-rights-modes.ts +0 -1
- package/types/statistics.ts +0 -20
- package/types/workflow.ts +0 -31
- /package/ee/{documents → python/documents}/THIRD_PARTY_LICENSES/docling.txt +0 -0
- /package/ee/{documents/processing → python}/requirements.txt +0 -0
package/mintlify-docs/README.md
DELETED
|
@@ -1,55 +0,0 @@
|
|
|
1
|
-
# Mintlify Starter Kit
|
|
2
|
-
|
|
3
|
-
Use the starter kit to get your docs deployed and ready to customize.
|
|
4
|
-
|
|
5
|
-
Click the green **Use this template** button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with
|
|
6
|
-
|
|
7
|
-
- Guide pages
|
|
8
|
-
- Navigation
|
|
9
|
-
- Customizations
|
|
10
|
-
- API reference pages
|
|
11
|
-
- Use of popular components
|
|
12
|
-
|
|
13
|
-
**[Follow the full quickstart guide](https://starter.mintlify.com/quickstart)**
|
|
14
|
-
|
|
15
|
-
## AI-assisted writing
|
|
16
|
-
|
|
17
|
-
Set up your AI coding tool to work with Mintlify:
|
|
18
|
-
|
|
19
|
-
```bash
|
|
20
|
-
npx skills add https://mintlify.com/docs
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
This command installs Mintlify's documentation skill for your configured AI tools like Claude Code, Cursor, Windsurf, and others. The skill includes component reference, writing standards, and workflow guidance.
|
|
24
|
-
|
|
25
|
-
See the [AI tools guides](/ai-tools) for tool-specific setup.
|
|
26
|
-
|
|
27
|
-
## Development
|
|
28
|
-
|
|
29
|
-
Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:
|
|
30
|
-
|
|
31
|
-
```
|
|
32
|
-
npm i -g mint
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
Run the following command at the root of your documentation, where your `docs.json` is located:
|
|
36
|
-
|
|
37
|
-
```
|
|
38
|
-
mint dev
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
View your local preview at `http://localhost:3000`.
|
|
42
|
-
|
|
43
|
-
## Publishing changes
|
|
44
|
-
|
|
45
|
-
Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.
|
|
46
|
-
|
|
47
|
-
## Need help?
|
|
48
|
-
|
|
49
|
-
### Troubleshooting
|
|
50
|
-
|
|
51
|
-
- If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI.
|
|
52
|
-
- If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.
|
|
53
|
-
|
|
54
|
-
### Resources
|
|
55
|
-
- [Mintlify documentation](https://mintlify.com/docs)
|
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Claude Code setup"
|
|
3
|
-
description: "Configure Claude Code for your documentation workflow"
|
|
4
|
-
icon: "asterisk"
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
Set up Claude Code to help you write and maintain your Mintlify documentation.
|
|
8
|
-
|
|
9
|
-
## Prerequisites
|
|
10
|
-
|
|
11
|
-
- Active Claude subscription (Pro, Max, or API access)
|
|
12
|
-
|
|
13
|
-
## Setup
|
|
14
|
-
|
|
15
|
-
<Steps>
|
|
16
|
-
<Step title="Install Claude Code">
|
|
17
|
-
```bash
|
|
18
|
-
npm install -g @anthropic-ai/claude-code
|
|
19
|
-
```
|
|
20
|
-
</Step>
|
|
21
|
-
|
|
22
|
-
<Step title="Install the Mintlify skill">
|
|
23
|
-
In your docs directory, run:
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
npx skills add https://mintlify.com/docs
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
This gives Claude Code Mintlify's component reference, writing standards,
|
|
30
|
-
and workflow guidance.
|
|
31
|
-
</Step>
|
|
32
|
-
|
|
33
|
-
<Step title="Customize project instructions">
|
|
34
|
-
Edit `AGENTS.md` in your project root to add project-specific terminology,
|
|
35
|
-
style preferences, and content boundaries.
|
|
36
|
-
</Step>
|
|
37
|
-
|
|
38
|
-
<Step title="Start writing with Claude Code">
|
|
39
|
-
```bash
|
|
40
|
-
claude
|
|
41
|
-
```
|
|
42
|
-
</Step>
|
|
43
|
-
</Steps>
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Cursor setup"
|
|
3
|
-
description: "Configure Cursor for your documentation workflow"
|
|
4
|
-
icon: "arrow-pointer"
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
Set up Cursor to help you write and maintain your Mintlify documentation.
|
|
8
|
-
|
|
9
|
-
## Prerequisites
|
|
10
|
-
|
|
11
|
-
- Cursor editor installed
|
|
12
|
-
|
|
13
|
-
## Setup
|
|
14
|
-
|
|
15
|
-
<Steps>
|
|
16
|
-
<Step title="Open your docs directory in Cursor">
|
|
17
|
-
Open the root of your documentation repository where `docs.json` is located.
|
|
18
|
-
</Step>
|
|
19
|
-
|
|
20
|
-
<Step title="Install the Mintlify skill">
|
|
21
|
-
In the integrated terminal, run:
|
|
22
|
-
|
|
23
|
-
```bash
|
|
24
|
-
npx skills add https://mintlify.com/docs
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
This gives Cursor Mintlify's component reference, writing standards,
|
|
28
|
-
and workflow guidance.
|
|
29
|
-
</Step>
|
|
30
|
-
|
|
31
|
-
<Step title="Customize project instructions">
|
|
32
|
-
Edit `AGENTS.md` in your project root to add project-specific terminology,
|
|
33
|
-
style preferences, and content boundaries.
|
|
34
|
-
</Step>
|
|
35
|
-
|
|
36
|
-
<Step title="Start writing with Cursor">
|
|
37
|
-
Open a file and use Cursor's AI features to draft and edit documentation.
|
|
38
|
-
</Step>
|
|
39
|
-
</Steps>
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Windsurf setup"
|
|
3
|
-
description: "Configure Windsurf for your documentation workflow"
|
|
4
|
-
icon: "water"
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
Set up Windsurf's Cascade AI assistant to help you write and maintain your Mintlify documentation.
|
|
8
|
-
|
|
9
|
-
## Prerequisites
|
|
10
|
-
|
|
11
|
-
- Windsurf editor installed
|
|
12
|
-
|
|
13
|
-
## Setup
|
|
14
|
-
|
|
15
|
-
<Steps>
|
|
16
|
-
<Step title="Open your docs directory in Windsurf">
|
|
17
|
-
Open the root of your documentation repository where `docs.json` is located.
|
|
18
|
-
</Step>
|
|
19
|
-
|
|
20
|
-
<Step title="Install the Mintlify skill">
|
|
21
|
-
In the integrated terminal, run:
|
|
22
|
-
|
|
23
|
-
```bash
|
|
24
|
-
npx skills add https://mintlify.com/docs
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
This gives Windsurf Mintlify's component reference, writing standards,
|
|
28
|
-
and workflow guidance.
|
|
29
|
-
</Step>
|
|
30
|
-
|
|
31
|
-
<Step title="Customize project instructions">
|
|
32
|
-
Edit `AGENTS.md` in your project root to add project-specific terminology,
|
|
33
|
-
style preferences, and content boundaries.
|
|
34
|
-
</Step>
|
|
35
|
-
|
|
36
|
-
<Step title="Start writing with Cascade">
|
|
37
|
-
Open a file and use Cascade to draft and edit documentation.
|
|
38
|
-
</Step>
|
|
39
|
-
</Steps>
|
|
@@ -1,110 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Agents'
|
|
3
|
-
description: 'GraphQL types for AI agent configurations and capabilities'
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
## agent
|
|
7
|
-
|
|
8
|
-
AI agent configurations and instances.
|
|
9
|
-
|
|
10
|
-
```graphql
|
|
11
|
-
type agent {
|
|
12
|
-
id: ID!
|
|
13
|
-
name: String!
|
|
14
|
-
description: String
|
|
15
|
-
backend: String!
|
|
16
|
-
type: String!
|
|
17
|
-
createdAt: Date!
|
|
18
|
-
updatedAt: Date!
|
|
19
|
-
|
|
20
|
-
# Backend-specific fields
|
|
21
|
-
provider: String
|
|
22
|
-
providerName: String
|
|
23
|
-
modelName: String
|
|
24
|
-
systemInstructions: String
|
|
25
|
-
authenticationInformation: String
|
|
26
|
-
|
|
27
|
-
# Configuration
|
|
28
|
-
rateLimit: RateLimiterRule
|
|
29
|
-
streaming: Boolean
|
|
30
|
-
capabilities: AgentCapabilities
|
|
31
|
-
maxContextLength: Int
|
|
32
|
-
|
|
33
|
-
# Workflows
|
|
34
|
-
workflows: AgentWorkflows
|
|
35
|
-
|
|
36
|
-
# Access control (if RBAC enabled)
|
|
37
|
-
RBAC: RBACData
|
|
38
|
-
|
|
39
|
-
# Routing
|
|
40
|
-
slug: String
|
|
41
|
-
}
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
**Example query:**
|
|
45
|
-
|
|
46
|
-
```graphql
|
|
47
|
-
query {
|
|
48
|
-
agentById(id: "agent-123") {
|
|
49
|
-
id
|
|
50
|
-
name
|
|
51
|
-
provider
|
|
52
|
-
modelName
|
|
53
|
-
capabilities {
|
|
54
|
-
text
|
|
55
|
-
images
|
|
56
|
-
files
|
|
57
|
-
}
|
|
58
|
-
workflows {
|
|
59
|
-
enabled
|
|
60
|
-
queue {
|
|
61
|
-
name
|
|
62
|
-
}
|
|
63
|
-
}
|
|
64
|
-
}
|
|
65
|
-
}
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
## AgentCapabilities
|
|
69
|
-
|
|
70
|
-
Defines what content types the agent can process.
|
|
71
|
-
|
|
72
|
-
```graphql
|
|
73
|
-
type AgentCapabilities {
|
|
74
|
-
text: Boolean
|
|
75
|
-
images: [String] # e.g., [".png", ".jpg"]
|
|
76
|
-
files: [String] # e.g., [".pdf", ".docx"]
|
|
77
|
-
audio: [String]
|
|
78
|
-
video: [String]
|
|
79
|
-
}
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
## RateLimiterRule
|
|
83
|
-
|
|
84
|
-
Rate limiting configuration for agent requests.
|
|
85
|
-
|
|
86
|
-
```graphql
|
|
87
|
-
type RateLimiterRule {
|
|
88
|
-
name: String
|
|
89
|
-
rate_limit: RateLimiterRuleRateLimit
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
type RateLimiterRuleRateLimit {
|
|
93
|
-
time: Int # Time window in seconds
|
|
94
|
-
limit: Int # Max requests per time window
|
|
95
|
-
}
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
## Related Types
|
|
99
|
-
|
|
100
|
-
<CardGroup cols={2}>
|
|
101
|
-
<Card title="Session Types" icon="comments" href="/api-reference/core-types/session-types">
|
|
102
|
-
Agent sessions and messages
|
|
103
|
-
</Card>
|
|
104
|
-
<Card title="Workflow Types" icon="workflow" href="/api-reference/core-types/workflow-types">
|
|
105
|
-
Agent workflow configurations
|
|
106
|
-
</Card>
|
|
107
|
-
<Card title="Back to Overview" icon="arrow-left" href="/api-reference/core-types/overview">
|
|
108
|
-
View all core types
|
|
109
|
-
</Card>
|
|
110
|
-
</CardGroup>
|
|
@@ -1,95 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Analytics'
|
|
3
|
-
description: 'GraphQL types for usage statistics and reporting'
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
## statistics
|
|
7
|
-
|
|
8
|
-
Usage statistics and analytics.
|
|
9
|
-
|
|
10
|
-
```graphql
|
|
11
|
-
type statistics {
|
|
12
|
-
id: ID!
|
|
13
|
-
name: String!
|
|
14
|
-
label: String!
|
|
15
|
-
type: String!
|
|
16
|
-
trigger: String!
|
|
17
|
-
count: Int!
|
|
18
|
-
user: ID
|
|
19
|
-
role: ID
|
|
20
|
-
createdAt: Date!
|
|
21
|
-
updatedAt: Date!
|
|
22
|
-
}
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
## Aggregate Statistics
|
|
26
|
-
|
|
27
|
-
Query aggregate statistics with grouping:
|
|
28
|
-
|
|
29
|
-
```graphql
|
|
30
|
-
query {
|
|
31
|
-
statisticsStatistics(
|
|
32
|
-
groupBy: "label"
|
|
33
|
-
filters: [
|
|
34
|
-
{ type: { eq: "agent_run" } }
|
|
35
|
-
]
|
|
36
|
-
limit: 10
|
|
37
|
-
) {
|
|
38
|
-
group
|
|
39
|
-
count
|
|
40
|
-
}
|
|
41
|
-
}
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
## Common Statistics Types
|
|
45
|
-
|
|
46
|
-
- **agent_run** - Agent execution count
|
|
47
|
-
- **api_call** - API request count
|
|
48
|
-
- **workflow_execution** - Workflow run count
|
|
49
|
-
- **eval_run** - Evaluation execution count
|
|
50
|
-
- **context_search** - Vector search count
|
|
51
|
-
|
|
52
|
-
## Usage Analytics
|
|
53
|
-
|
|
54
|
-
Statistics track usage across:
|
|
55
|
-
|
|
56
|
-
- **Per user** - Track individual user activity
|
|
57
|
-
- **Per role** - Aggregate by role
|
|
58
|
-
- **Per resource** - Track specific agents, workflows, etc.
|
|
59
|
-
- **Time-based** - Query by date ranges
|
|
60
|
-
|
|
61
|
-
## Example: Agent Usage Report
|
|
62
|
-
|
|
63
|
-
```graphql
|
|
64
|
-
query {
|
|
65
|
-
statisticsStatistics(
|
|
66
|
-
groupBy: "label"
|
|
67
|
-
filters: [
|
|
68
|
-
{
|
|
69
|
-
type: { eq: "agent_run" }
|
|
70
|
-
createdAt: { gte: "2025-01-01T00:00:00Z" }
|
|
71
|
-
}
|
|
72
|
-
]
|
|
73
|
-
) {
|
|
74
|
-
group # Agent name
|
|
75
|
-
count # Number of executions
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
## Related Types
|
|
81
|
-
|
|
82
|
-
<CardGroup cols={2}>
|
|
83
|
-
<Card title="User Management" icon="users" href="/api-reference/core-types/user-management">
|
|
84
|
-
User and role statistics
|
|
85
|
-
</Card>
|
|
86
|
-
<Card title="Agent Types" icon="robot" href="/api-reference/core-types/agent-types">
|
|
87
|
-
Agent usage tracking
|
|
88
|
-
</Card>
|
|
89
|
-
<Card title="Workflow Types" icon="workflow" href="/api-reference/core-types/workflow-types">
|
|
90
|
-
Workflow execution stats
|
|
91
|
-
</Card>
|
|
92
|
-
<Card title="Back to Overview" icon="arrow-left" href="/api-reference/core-types/overview">
|
|
93
|
-
View all core types
|
|
94
|
-
</Card>
|
|
95
|
-
</CardGroup>
|
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Configuration'
|
|
3
|
-
description: 'GraphQL types for encrypted variables and project organization'
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
## variables
|
|
7
|
-
|
|
8
|
-
Encrypted configuration values (alternative to .env files).
|
|
9
|
-
|
|
10
|
-
```graphql
|
|
11
|
-
type variables {
|
|
12
|
-
id: ID!
|
|
13
|
-
name: String!
|
|
14
|
-
value: String!
|
|
15
|
-
encrypted: Boolean!
|
|
16
|
-
description: String
|
|
17
|
-
createdAt: Date!
|
|
18
|
-
updatedAt: Date!
|
|
19
|
-
}
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
<Note>
|
|
23
|
-
Values are encrypted with AES using `NEXTAUTH_SECRET`. Use [`ExuluVariables.get()`](/core/exulu-variables/api-reference#get) to retrieve decrypted values.
|
|
24
|
-
</Note>
|
|
25
|
-
|
|
26
|
-
**Example usage:**
|
|
27
|
-
|
|
28
|
-
```graphql
|
|
29
|
-
mutation {
|
|
30
|
-
variablesCreateOne(
|
|
31
|
-
input: {
|
|
32
|
-
name: "openai_api_key"
|
|
33
|
-
value: "sk-..."
|
|
34
|
-
encrypted: true
|
|
35
|
-
description: "OpenAI API key for production"
|
|
36
|
-
}
|
|
37
|
-
) {
|
|
38
|
-
item {
|
|
39
|
-
id
|
|
40
|
-
name
|
|
41
|
-
}
|
|
42
|
-
}
|
|
43
|
-
}
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
## projects
|
|
47
|
-
|
|
48
|
-
Project organization for grouping resources.
|
|
49
|
-
|
|
50
|
-
```graphql
|
|
51
|
-
type projects {
|
|
52
|
-
id: ID!
|
|
53
|
-
name: String!
|
|
54
|
-
description: String
|
|
55
|
-
createdAt: Date!
|
|
56
|
-
updatedAt: Date!
|
|
57
|
-
}
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
Projects provide a way to organize related resources for better management and organization.
|
|
61
|
-
|
|
62
|
-
## Security
|
|
63
|
-
|
|
64
|
-
<Warning>
|
|
65
|
-
Variable values are write-only. Once encrypted, they cannot be retrieved through GraphQL - use the ExuluVariables API instead.
|
|
66
|
-
</Warning>
|
|
67
|
-
|
|
68
|
-
## Related Types
|
|
69
|
-
|
|
70
|
-
<CardGroup cols={2}>
|
|
71
|
-
<Card title="Workflow Types" icon="workflow" href="/api-reference/core-types/workflow-types">
|
|
72
|
-
Workflow variables
|
|
73
|
-
</Card>
|
|
74
|
-
<Card title="Agent Types" icon="robot" href="/api-reference/core-types/agent-types">
|
|
75
|
-
Agent configuration
|
|
76
|
-
</Card>
|
|
77
|
-
<Card title="User Management" icon="users" href="/api-reference/core-types/user-management">
|
|
78
|
-
Access permissions
|
|
79
|
-
</Card>
|
|
80
|
-
<Card title="Back to Overview" icon="arrow-left" href="/api-reference/core-types/overview">
|
|
81
|
-
View all core types
|
|
82
|
-
</Card>
|
|
83
|
-
</CardGroup>
|
|
@@ -1,106 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Evaluations'
|
|
3
|
-
description: 'GraphQL types for testing and evaluating agent performance'
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
## test_cases
|
|
7
|
-
|
|
8
|
-
Test cases for evaluating agent performance.
|
|
9
|
-
|
|
10
|
-
```graphql
|
|
11
|
-
type test_cases {
|
|
12
|
-
id: ID!
|
|
13
|
-
name: String!
|
|
14
|
-
description: String
|
|
15
|
-
inputs: JSON! # UIMessage[]
|
|
16
|
-
expected_output: String!
|
|
17
|
-
expected_tools: JSON # string[]
|
|
18
|
-
expected_knowledge_sources: JSON # string[]
|
|
19
|
-
expected_agent_tools: JSON # string[]
|
|
20
|
-
createdAt: Date!
|
|
21
|
-
updatedAt: Date!
|
|
22
|
-
RBAC: RBACData
|
|
23
|
-
}
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
**Example:**
|
|
27
|
-
|
|
28
|
-
```graphql
|
|
29
|
-
mutation {
|
|
30
|
-
test_casesCreateOne(
|
|
31
|
-
input: {
|
|
32
|
-
name: "Weather Query"
|
|
33
|
-
description: "User asks about weather"
|
|
34
|
-
inputs: [
|
|
35
|
-
{ role: "user", content: "What's the weather like?" }
|
|
36
|
-
]
|
|
37
|
-
expected_output: "Based on current data, it's 68°F and sunny."
|
|
38
|
-
expected_tools: ["get_weather"]
|
|
39
|
-
}
|
|
40
|
-
) {
|
|
41
|
-
item {
|
|
42
|
-
id
|
|
43
|
-
name
|
|
44
|
-
}
|
|
45
|
-
}
|
|
46
|
-
}
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
## eval_sets
|
|
50
|
-
|
|
51
|
-
Collections of test cases for batch evaluation.
|
|
52
|
-
|
|
53
|
-
```graphql
|
|
54
|
-
type eval_sets {
|
|
55
|
-
id: ID!
|
|
56
|
-
name: String!
|
|
57
|
-
description: String
|
|
58
|
-
test_case_ids: JSON # string[]
|
|
59
|
-
createdAt: Date!
|
|
60
|
-
updatedAt: Date!
|
|
61
|
-
RBAC: RBACData
|
|
62
|
-
}
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
## eval_runs
|
|
66
|
-
|
|
67
|
-
Evaluation execution records.
|
|
68
|
-
|
|
69
|
-
```graphql
|
|
70
|
-
type eval_runs {
|
|
71
|
-
id: ID!
|
|
72
|
-
name: String!
|
|
73
|
-
description: String
|
|
74
|
-
agent_id: ID!
|
|
75
|
-
test_case_ids: JSON # string[]
|
|
76
|
-
eval_functions: JSON # string[]
|
|
77
|
-
config: JSON
|
|
78
|
-
scoring_method: String
|
|
79
|
-
pass_threshold: Float
|
|
80
|
-
timeout_in_seconds: Int
|
|
81
|
-
createdAt: Date!
|
|
82
|
-
updatedAt: Date!
|
|
83
|
-
RBAC: RBACData
|
|
84
|
-
}
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
## Evaluation Workflow
|
|
88
|
-
|
|
89
|
-
1. Create **test_cases** with expected inputs and outputs
|
|
90
|
-
2. Group test cases into **eval_sets** for organized testing
|
|
91
|
-
3. Run **eval_runs** to evaluate agent performance
|
|
92
|
-
4. Review results and iterate on agent improvements
|
|
93
|
-
|
|
94
|
-
## Related Types
|
|
95
|
-
|
|
96
|
-
<CardGroup cols={2}>
|
|
97
|
-
<Card title="Agent Types" icon="robot" href="/api-reference/core-types/agent-types">
|
|
98
|
-
Agents being evaluated
|
|
99
|
-
</Card>
|
|
100
|
-
<Card title="Job Types" icon="gears" href="/api-reference/core-types/job-types">
|
|
101
|
-
Background eval execution
|
|
102
|
-
</Card>
|
|
103
|
-
<Card title="Back to Overview" icon="arrow-left" href="/api-reference/core-types/overview">
|
|
104
|
-
View all core types
|
|
105
|
-
</Card>
|
|
106
|
-
</CardGroup>
|
|
@@ -1,135 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Job Management'
|
|
3
|
-
description: 'GraphQL types for background job tracking with BullMQ'
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
## Job
|
|
7
|
-
|
|
8
|
-
Background job information from BullMQ.
|
|
9
|
-
|
|
10
|
-
```graphql
|
|
11
|
-
type Job {
|
|
12
|
-
id: String!
|
|
13
|
-
name: String!
|
|
14
|
-
returnvalue: JSON
|
|
15
|
-
stacktrace: [String]
|
|
16
|
-
finishedOn: Date
|
|
17
|
-
processedOn: Date
|
|
18
|
-
attemptsMade: Int
|
|
19
|
-
failedReason: String
|
|
20
|
-
state: String!
|
|
21
|
-
data: JSON
|
|
22
|
-
timestamp: Date
|
|
23
|
-
}
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
## Query Jobs
|
|
27
|
-
|
|
28
|
-
**By queue and status:**
|
|
29
|
-
|
|
30
|
-
```graphql
|
|
31
|
-
query {
|
|
32
|
-
jobs(
|
|
33
|
-
queue: eval_runs
|
|
34
|
-
statusses: [active, waiting, failed]
|
|
35
|
-
page: 1
|
|
36
|
-
limit: 50
|
|
37
|
-
) {
|
|
38
|
-
items {
|
|
39
|
-
id
|
|
40
|
-
name
|
|
41
|
-
state
|
|
42
|
-
failedReason
|
|
43
|
-
}
|
|
44
|
-
}
|
|
45
|
-
}
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
## Job States
|
|
49
|
-
|
|
50
|
-
- **waiting** - Job is queued
|
|
51
|
-
- **active** - Job is currently processing
|
|
52
|
-
- **completed** - Job finished successfully
|
|
53
|
-
- **failed** - Job failed with error
|
|
54
|
-
- **delayed** - Job is scheduled for later
|
|
55
|
-
- **paused** - Queue is paused
|
|
56
|
-
|
|
57
|
-
## Queue Information
|
|
58
|
-
|
|
59
|
-
Get detailed queue status:
|
|
60
|
-
|
|
61
|
-
```graphql
|
|
62
|
-
query {
|
|
63
|
-
queue(queue: eval_runs) {
|
|
64
|
-
name
|
|
65
|
-
concurrency {
|
|
66
|
-
worker
|
|
67
|
-
queue
|
|
68
|
-
}
|
|
69
|
-
timeoutInSeconds
|
|
70
|
-
ratelimit
|
|
71
|
-
isMaxed
|
|
72
|
-
isPaused
|
|
73
|
-
jobs {
|
|
74
|
-
paused
|
|
75
|
-
completed
|
|
76
|
-
failed
|
|
77
|
-
waiting
|
|
78
|
-
active
|
|
79
|
-
delayed
|
|
80
|
-
}
|
|
81
|
-
}
|
|
82
|
-
}
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
## Queue Management
|
|
86
|
-
|
|
87
|
-
Manage queue operations:
|
|
88
|
-
|
|
89
|
-
```graphql
|
|
90
|
-
mutation {
|
|
91
|
-
# Pause a queue
|
|
92
|
-
pauseQueue(queue: eval_runs) {
|
|
93
|
-
success
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
# Resume a queue
|
|
97
|
-
resumeQueue(queue: eval_runs) {
|
|
98
|
-
success
|
|
99
|
-
}
|
|
100
|
-
|
|
101
|
-
# Drain waiting jobs
|
|
102
|
-
drainQueue(queue: eval_runs) {
|
|
103
|
-
success
|
|
104
|
-
}
|
|
105
|
-
|
|
106
|
-
# Delete a specific job
|
|
107
|
-
deleteJob(queue: eval_runs, id: "job-123") {
|
|
108
|
-
success
|
|
109
|
-
}
|
|
110
|
-
}
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
## Common Queues
|
|
114
|
-
|
|
115
|
-
- **eval_runs** - Evaluation execution
|
|
116
|
-
- **chunk_generation** - Vector embedding generation
|
|
117
|
-
- **workflow_execution** - Workflow runs
|
|
118
|
-
- **context_processing** - Context data processing
|
|
119
|
-
|
|
120
|
-
## Related Types
|
|
121
|
-
|
|
122
|
-
<CardGroup cols={2}>
|
|
123
|
-
<Card title="Evaluation Types" icon="chart-line" href="/api-reference/core-types/evaluation-types">
|
|
124
|
-
Eval run jobs
|
|
125
|
-
</Card>
|
|
126
|
-
<Card title="Workflow Types" icon="workflow" href="/api-reference/core-types/workflow-types">
|
|
127
|
-
Workflow execution jobs
|
|
128
|
-
</Card>
|
|
129
|
-
<Card title="Dynamic Types" icon="wand-magic-sparkles" href="/api-reference/dynamic-types">
|
|
130
|
-
Context chunk jobs
|
|
131
|
-
</Card>
|
|
132
|
-
<Card title="Back to Overview" icon="arrow-left" href="/api-reference/core-types/overview">
|
|
133
|
-
View all core types
|
|
134
|
-
</Card>
|
|
135
|
-
</CardGroup>
|