@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.
Files changed (164) hide show
  1. package/dist/index.cjs +351 -42
  2. package/dist/index.d.cts +96 -1
  3. package/dist/index.d.ts +96 -1
  4. package/dist/index.js +340 -38
  5. package/ee/{markdown.ts → chunking/markdown.ts} +2 -2
  6. package/ee/python/README.md +295 -0
  7. package/ee/python/documents/processing/README.md +155 -0
  8. package/ee/{documents → python/documents}/processing/doc_processor.ts +25 -17
  9. package/ee/{documents/processing/pdf_to_markdown.py → python/documents/processing/document_to_markdown.py} +3 -10
  10. package/ee/python/setup.sh +180 -0
  11. package/package.json +14 -3
  12. package/scripts/postinstall.cjs +149 -0
  13. package/.agents/skills/mintlify/SKILL.md +0 -347
  14. package/.editorconfig +0 -15
  15. package/.eslintrc.json +0 -52
  16. package/.github/workflows/release-backend.yml +0 -38
  17. package/.husky/commit-msg +0 -1
  18. package/.jscpd.json +0 -18
  19. package/.mcp.json +0 -25
  20. package/.nvmrc +0 -1
  21. package/.prettierignore +0 -5
  22. package/.prettierrc.json +0 -12
  23. package/CHANGELOG.md +0 -8
  24. package/SECURITY.md +0 -5
  25. package/commitlint.config.js +0 -4
  26. package/devops/documentation/patch-older-releases.md +0 -42
  27. package/ee/documents/processing/build_pdf_processor.sh +0 -35
  28. package/ee/documents/processing/chunk_markdown.py +0 -263
  29. package/ee/documents/processing/pdf_processor.spec +0 -115
  30. package/eslint.config.js +0 -88
  31. package/jest.config.ts +0 -25
  32. package/mintlify-docs/.mintignore +0 -7
  33. package/mintlify-docs/AGENTS.md +0 -33
  34. package/mintlify-docs/CLAUDE.MD +0 -50
  35. package/mintlify-docs/CONTRIBUTING.md +0 -32
  36. package/mintlify-docs/LICENSE +0 -21
  37. package/mintlify-docs/README.md +0 -55
  38. package/mintlify-docs/ai-tools/claude-code.mdx +0 -43
  39. package/mintlify-docs/ai-tools/cursor.mdx +0 -39
  40. package/mintlify-docs/ai-tools/windsurf.mdx +0 -39
  41. package/mintlify-docs/api-reference/core-types/agent-types.mdx +0 -110
  42. package/mintlify-docs/api-reference/core-types/analytics-types.mdx +0 -95
  43. package/mintlify-docs/api-reference/core-types/configuration-types.mdx +0 -83
  44. package/mintlify-docs/api-reference/core-types/evaluation-types.mdx +0 -106
  45. package/mintlify-docs/api-reference/core-types/job-types.mdx +0 -135
  46. package/mintlify-docs/api-reference/core-types/overview.mdx +0 -73
  47. package/mintlify-docs/api-reference/core-types/prompt-types.mdx +0 -102
  48. package/mintlify-docs/api-reference/core-types/rbac-types.mdx +0 -163
  49. package/mintlify-docs/api-reference/core-types/session-types.mdx +0 -77
  50. package/mintlify-docs/api-reference/core-types/user-management.mdx +0 -112
  51. package/mintlify-docs/api-reference/core-types/workflow-types.mdx +0 -88
  52. package/mintlify-docs/api-reference/core-types.mdx +0 -585
  53. package/mintlify-docs/api-reference/dynamic-types.mdx +0 -851
  54. package/mintlify-docs/api-reference/endpoint/create.mdx +0 -4
  55. package/mintlify-docs/api-reference/endpoint/delete.mdx +0 -4
  56. package/mintlify-docs/api-reference/endpoint/get.mdx +0 -4
  57. package/mintlify-docs/api-reference/endpoint/webhook.mdx +0 -4
  58. package/mintlify-docs/api-reference/introduction.mdx +0 -661
  59. package/mintlify-docs/api-reference/mutations.mdx +0 -1012
  60. package/mintlify-docs/api-reference/openapi.json +0 -217
  61. package/mintlify-docs/api-reference/queries.mdx +0 -1154
  62. package/mintlify-docs/backend/introduction.mdx +0 -218
  63. package/mintlify-docs/changelog.mdx +0 -387
  64. package/mintlify-docs/community-edition.mdx +0 -304
  65. package/mintlify-docs/core/exulu-agent/api-reference.mdx +0 -894
  66. package/mintlify-docs/core/exulu-agent/configuration.mdx +0 -690
  67. package/mintlify-docs/core/exulu-agent/introduction.mdx +0 -552
  68. package/mintlify-docs/core/exulu-app/api-reference.mdx +0 -481
  69. package/mintlify-docs/core/exulu-app/configuration.mdx +0 -319
  70. package/mintlify-docs/core/exulu-app/introduction.mdx +0 -117
  71. package/mintlify-docs/core/exulu-authentication.mdx +0 -810
  72. package/mintlify-docs/core/exulu-chunkers/api-reference.mdx +0 -1011
  73. package/mintlify-docs/core/exulu-chunkers/configuration.mdx +0 -596
  74. package/mintlify-docs/core/exulu-chunkers/introduction.mdx +0 -403
  75. package/mintlify-docs/core/exulu-context/api-reference.mdx +0 -911
  76. package/mintlify-docs/core/exulu-context/configuration.mdx +0 -648
  77. package/mintlify-docs/core/exulu-context/introduction.mdx +0 -394
  78. package/mintlify-docs/core/exulu-database.mdx +0 -811
  79. package/mintlify-docs/core/exulu-default-agents.mdx +0 -545
  80. package/mintlify-docs/core/exulu-eval/api-reference.mdx +0 -772
  81. package/mintlify-docs/core/exulu-eval/configuration.mdx +0 -680
  82. package/mintlify-docs/core/exulu-eval/introduction.mdx +0 -459
  83. package/mintlify-docs/core/exulu-logging.mdx +0 -464
  84. package/mintlify-docs/core/exulu-otel.mdx +0 -670
  85. package/mintlify-docs/core/exulu-queues/api-reference.mdx +0 -648
  86. package/mintlify-docs/core/exulu-queues/configuration.mdx +0 -650
  87. package/mintlify-docs/core/exulu-queues/introduction.mdx +0 -474
  88. package/mintlify-docs/core/exulu-reranker/api-reference.mdx +0 -630
  89. package/mintlify-docs/core/exulu-reranker/configuration.mdx +0 -663
  90. package/mintlify-docs/core/exulu-reranker/introduction.mdx +0 -516
  91. package/mintlify-docs/core/exulu-tool/api-reference.mdx +0 -723
  92. package/mintlify-docs/core/exulu-tool/configuration.mdx +0 -805
  93. package/mintlify-docs/core/exulu-tool/introduction.mdx +0 -539
  94. package/mintlify-docs/core/exulu-variables/api-reference.mdx +0 -699
  95. package/mintlify-docs/core/exulu-variables/configuration.mdx +0 -736
  96. package/mintlify-docs/core/exulu-variables/introduction.mdx +0 -511
  97. package/mintlify-docs/development.mdx +0 -94
  98. package/mintlify-docs/docs.json +0 -248
  99. package/mintlify-docs/enterprise-edition.mdx +0 -538
  100. package/mintlify-docs/essentials/code.mdx +0 -35
  101. package/mintlify-docs/essentials/images.mdx +0 -59
  102. package/mintlify-docs/essentials/markdown.mdx +0 -88
  103. package/mintlify-docs/essentials/navigation.mdx +0 -87
  104. package/mintlify-docs/essentials/reusable-snippets.mdx +0 -110
  105. package/mintlify-docs/essentials/settings.mdx +0 -318
  106. package/mintlify-docs/favicon.svg +0 -3
  107. package/mintlify-docs/frontend/introduction.mdx +0 -39
  108. package/mintlify-docs/getting-started.mdx +0 -267
  109. package/mintlify-docs/guides/custom-agent.mdx +0 -608
  110. package/mintlify-docs/guides/first-agent.mdx +0 -315
  111. package/mintlify-docs/images/admin_ui.png +0 -0
  112. package/mintlify-docs/images/contexts.png +0 -0
  113. package/mintlify-docs/images/create_agents.png +0 -0
  114. package/mintlify-docs/images/evals.png +0 -0
  115. package/mintlify-docs/images/graphql.png +0 -0
  116. package/mintlify-docs/images/graphql_api.png +0 -0
  117. package/mintlify-docs/images/hero-dark.png +0 -0
  118. package/mintlify-docs/images/hero-light.png +0 -0
  119. package/mintlify-docs/images/hero.png +0 -0
  120. package/mintlify-docs/images/knowledge_sources.png +0 -0
  121. package/mintlify-docs/images/mcp.png +0 -0
  122. package/mintlify-docs/images/scaling.png +0 -0
  123. package/mintlify-docs/index.mdx +0 -411
  124. package/mintlify-docs/logo/dark.svg +0 -9
  125. package/mintlify-docs/logo/light.svg +0 -9
  126. package/mintlify-docs/partners.mdx +0 -558
  127. package/mintlify-docs/products.mdx +0 -77
  128. package/mintlify-docs/snippets/snippet-intro.mdx +0 -4
  129. package/mintlify-docs/styles.css +0 -207
  130. package/ngrok.bash +0 -1
  131. package/ngrok.md +0 -6
  132. package/ngrok.yml +0 -10
  133. package/release.config.cjs +0 -15
  134. package/skills-lock.json +0 -10
  135. package/types/context-processor.ts +0 -45
  136. package/types/enums/eval-types.ts +0 -5
  137. package/types/enums/field-types.ts +0 -1
  138. package/types/enums/jobs.ts +0 -11
  139. package/types/enums/statistics.ts +0 -13
  140. package/types/exulu-table-definition.ts +0 -79
  141. package/types/file-types.ts +0 -18
  142. package/types/models/agent-session.ts +0 -27
  143. package/types/models/agent.ts +0 -68
  144. package/types/models/context.ts +0 -53
  145. package/types/models/embedding.ts +0 -17
  146. package/types/models/eval-run.ts +0 -40
  147. package/types/models/exulu-agent-tool-config.ts +0 -11
  148. package/types/models/item.ts +0 -21
  149. package/types/models/job.ts +0 -8
  150. package/types/models/project.ts +0 -16
  151. package/types/models/rate-limiter-rules.ts +0 -7
  152. package/types/models/test-case.ts +0 -25
  153. package/types/models/tool.ts +0 -9
  154. package/types/models/user-role.ts +0 -12
  155. package/types/models/user.ts +0 -20
  156. package/types/models/variable.ts +0 -8
  157. package/types/models/vector-methods.ts +0 -7
  158. package/types/provider-config.ts +0 -21
  159. package/types/queue-config.ts +0 -16
  160. package/types/rbac-rights-modes.ts +0 -1
  161. package/types/statistics.ts +0 -20
  162. package/types/workflow.ts +0 -31
  163. /package/ee/{documents → python/documents}/THIRD_PARTY_LICENSES/docling.txt +0 -0
  164. /package/ee/{documents/processing → python}/requirements.txt +0 -0
@@ -1,88 +0,0 @@
1
- ---
2
- title: 'Markdown syntax'
3
- description: 'Text, title, and styling in standard markdown'
4
- icon: 'text-size'
5
- ---
6
-
7
- ## Titles
8
-
9
- Best used for section headers.
10
-
11
- ```md
12
- ## Titles
13
- ```
14
-
15
- ### Subtitles
16
-
17
- Best used for subsection headers.
18
-
19
- ```md
20
- ### Subtitles
21
- ```
22
-
23
- <Tip>
24
-
25
- Each **title** and **subtitle** creates an anchor and also shows up on the table of contents on the right.
26
-
27
- </Tip>
28
-
29
- ## Text formatting
30
-
31
- We support most markdown formatting. Simply add `**`, `_`, or `~` around text to format it.
32
-
33
- | Style | How to write it | Result |
34
- | ------------- | ----------------- | --------------- |
35
- | Bold | `**bold**` | **bold** |
36
- | Italic | `_italic_` | _italic_ |
37
- | Strikethrough | `~strikethrough~` | ~strikethrough~ |
38
-
39
- You can combine these. For example, write `**_bold and italic_**` to get **_bold and italic_** text.
40
-
41
- You need to use HTML to write superscript and subscript text. That is, add `<sup>` or `<sub>` around your text.
42
-
43
- | Text Size | How to write it | Result |
44
- | ----------- | ------------------------ | ---------------------- |
45
- | Superscript | `<sup>superscript</sup>` | <sup>superscript</sup> |
46
- | Subscript | `<sub>subscript</sub>` | <sub>subscript</sub> |
47
-
48
- ## Linking to pages
49
-
50
- You can add a link by wrapping text in `[]()`. You would write `[link to google](https://google.com)` to [link to google](https://google.com).
51
-
52
- Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, `[link to text](/writing-content/text)` links to the page "Text" in our components section.
53
-
54
- Relative links like `[link to text](../text)` will open slower because we cannot optimize them as easily.
55
-
56
- ## Blockquotes
57
-
58
- ### Singleline
59
-
60
- To create a blockquote, add a `>` in front of a paragraph.
61
-
62
- > Dorothy followed her through many of the beautiful rooms in her castle.
63
-
64
- ```md
65
- > Dorothy followed her through many of the beautiful rooms in her castle.
66
- ```
67
-
68
- ### Multiline
69
-
70
- > Dorothy followed her through many of the beautiful rooms in her castle.
71
- >
72
- > The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
73
-
74
- ```md
75
- > Dorothy followed her through many of the beautiful rooms in her castle.
76
- >
77
- > The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
78
- ```
79
-
80
- ### LaTeX
81
-
82
- Mintlify supports [LaTeX](https://www.latex-project.org) through the Latex component.
83
-
84
- <Latex>8 x (vk x H1 - H2) = (0,1)</Latex>
85
-
86
- ```md
87
- <Latex>8 x (vk x H1 - H2) = (0,1)</Latex>
88
- ```
@@ -1,87 +0,0 @@
1
- ---
2
- title: 'Navigation'
3
- description: 'The navigation field in docs.json defines the pages that go in the navigation menu'
4
- icon: 'map'
5
- ---
6
-
7
- The navigation menu is the list of links on every website.
8
-
9
- You will likely update `docs.json` every time you add a new page. Pages do not show up automatically.
10
-
11
- ## Navigation syntax
12
-
13
- Our navigation syntax is recursive which means you can make nested navigation groups. You don't need to include `.mdx` in page names.
14
-
15
- <CodeGroup>
16
-
17
- ```json Regular Navigation
18
- "navigation": {
19
- "tabs": [
20
- {
21
- "tab": "Docs",
22
- "groups": [
23
- {
24
- "group": "Getting Started",
25
- "pages": ["quickstart"]
26
- }
27
- ]
28
- }
29
- ]
30
- }
31
- ```
32
-
33
- ```json Nested Navigation
34
- "navigation": {
35
- "tabs": [
36
- {
37
- "tab": "Docs",
38
- "groups": [
39
- {
40
- "group": "Getting Started",
41
- "pages": [
42
- "quickstart",
43
- {
44
- "group": "Nested Reference Pages",
45
- "pages": ["nested-reference-page"]
46
- }
47
- ]
48
- }
49
- ]
50
- }
51
- ]
52
- }
53
- ```
54
-
55
- </CodeGroup>
56
-
57
- ## Folders
58
-
59
- Simply put your MDX files in folders and update the paths in `docs.json`.
60
-
61
- For example, to have a page at `https://yoursite.com/your-folder/your-page` you would make a folder called `your-folder` containing an MDX file called `your-page.mdx`.
62
-
63
- <Warning>
64
-
65
- You cannot use `api` for the name of a folder unless you nest it inside another folder. Mintlify uses Next.js which reserves the top-level `api` folder for internal server calls. A folder name such as `api-reference` would be accepted.
66
-
67
- </Warning>
68
-
69
- ```json Navigation With Folder
70
- "navigation": {
71
- "tabs": [
72
- {
73
- "tab": "Docs",
74
- "groups": [
75
- {
76
- "group": "Group Name",
77
- "pages": ["your-folder/your-page"]
78
- }
79
- ]
80
- }
81
- ]
82
- }
83
- ```
84
-
85
- ## Hidden pages
86
-
87
- MDX files not included in `docs.json` will not show up in the sidebar but are accessible through the search bar and by linking directly to them.
@@ -1,110 +0,0 @@
1
- ---
2
- title: "Reusable snippets"
3
- description: "Reusable, custom snippets to keep content in sync"
4
- icon: "recycle"
5
- ---
6
-
7
- import SnippetIntro from '/snippets/snippet-intro.mdx';
8
-
9
- <SnippetIntro />
10
-
11
- ## Creating a custom snippet
12
-
13
- **Pre-condition**: You must create your snippet file in the `snippets` directory.
14
-
15
- <Note>
16
- Any page in the `snippets` directory will be treated as a snippet and will not
17
- be rendered into a standalone page. If you want to create a standalone page
18
- from the snippet, import the snippet into another file and call it as a
19
- component.
20
- </Note>
21
-
22
- ### Default export
23
-
24
- 1. Add content to your snippet file that you want to re-use across multiple
25
- locations. Optionally, you can add variables that can be filled in via props
26
- when you import the snippet.
27
-
28
- ```mdx snippets/my-snippet.mdx
29
- Hello world! This is my content I want to reuse across pages. My keyword of the
30
- day is {word}.
31
- ```
32
-
33
- <Warning>
34
- The content that you want to reuse must be inside the `snippets` directory in
35
- order for the import to work.
36
- </Warning>
37
-
38
- 2. Import the snippet into your destination file.
39
-
40
- ```mdx destination-file.mdx
41
- ---
42
- title: My title
43
- description: My Description
44
- ---
45
-
46
- import MySnippet from '/snippets/path/to/my-snippet.mdx';
47
-
48
- ## Header
49
-
50
- Lorem impsum dolor sit amet.
51
-
52
- <MySnippet word="bananas" />
53
- ```
54
-
55
- ### Reusable variables
56
-
57
- 1. Export a variable from your snippet file:
58
-
59
- ```mdx snippets/path/to/custom-variables.mdx
60
- export const myName = 'my name';
61
-
62
- export const myObject = { fruit: 'strawberries' };
63
- ```
64
-
65
- 2. Import the snippet from your destination file and use the variable:
66
-
67
- ```mdx destination-file.mdx
68
- ---
69
- title: My title
70
- description: My Description
71
- ---
72
-
73
- import { myName, myObject } from '/snippets/path/to/custom-variables.mdx';
74
-
75
- Hello, my name is {myName} and I like {myObject.fruit}.
76
- ```
77
-
78
- ### Reusable components
79
-
80
- 1. Inside your snippet file, create a component that takes in props by exporting
81
- your component in the form of an arrow function.
82
-
83
- ```mdx snippets/custom-component.mdx
84
- export const MyComponent = ({ title }) => (
85
- <div>
86
- <h1>{title}</h1>
87
- <p>... snippet content ...</p>
88
- </div>
89
- );
90
- ```
91
-
92
- <Warning>
93
- MDX does not compile inside the body of an arrow function. Stick to HTML
94
- syntax when you can or use a default export if you need to use MDX.
95
- </Warning>
96
-
97
- 2. Import the snippet into your destination file and pass in the props
98
-
99
- ```mdx destination-file.mdx
100
- ---
101
- title: My title
102
- description: My Description
103
- ---
104
-
105
- import { MyComponent } from '/snippets/custom-component.mdx';
106
-
107
- Lorem ipsum dolor sit amet.
108
-
109
- <MyComponent title={'Custom title'} />
110
- ```
@@ -1,318 +0,0 @@
1
- ---
2
- title: 'Global Settings'
3
- description: 'Mintlify gives you complete control over the look and feel of your documentation using the docs.json file'
4
- icon: 'gear'
5
- ---
6
-
7
- Every Mintlify site needs a `docs.json` file with the core configuration settings. Learn more about the [properties](#properties) below.
8
-
9
- ## Properties
10
-
11
- <ResponseField name="name" type="string" required>
12
- Name of your project. Used for the global title.
13
-
14
- Example: `mintlify`
15
-
16
- </ResponseField>
17
-
18
- <ResponseField name="navigation" type="Navigation[]" required>
19
- An array of groups with all the pages within that group
20
- <Expandable title="Navigation">
21
- <ResponseField name="group" type="string">
22
- The name of the group.
23
-
24
- Example: `Settings`
25
-
26
- </ResponseField>
27
- <ResponseField name="pages" type="string[]">
28
- The relative paths to the markdown files that will serve as pages.
29
-
30
- Example: `["customization", "page"]`
31
-
32
- </ResponseField>
33
-
34
- </Expandable>
35
- </ResponseField>
36
-
37
- <ResponseField name="logo" type="string or object">
38
- Path to logo image or object with path to "light" and "dark" mode logo images
39
- <Expandable title="Logo">
40
- <ResponseField name="light" type="string">
41
- Path to the logo in light mode
42
- </ResponseField>
43
- <ResponseField name="dark" type="string">
44
- Path to the logo in dark mode
45
- </ResponseField>
46
- <ResponseField name="href" type="string" default="/">
47
- Where clicking on the logo links you to
48
- </ResponseField>
49
- </Expandable>
50
- </ResponseField>
51
-
52
- <ResponseField name="favicon" type="string">
53
- Path to the favicon image
54
- </ResponseField>
55
-
56
- <ResponseField name="colors" type="Colors">
57
- Hex color codes for your global theme
58
- <Expandable title="Colors">
59
- <ResponseField name="primary" type="string" required>
60
- The primary color. Used for most often for highlighted content, section
61
- headers, accents, in light mode
62
- </ResponseField>
63
- <ResponseField name="light" type="string">
64
- The primary color for dark mode. Used for most often for highlighted
65
- content, section headers, accents, in dark mode
66
- </ResponseField>
67
- <ResponseField name="dark" type="string">
68
- The primary color for important buttons
69
- </ResponseField>
70
- <ResponseField name="background" type="object">
71
- The color of the background in both light and dark mode
72
- <Expandable title="Object">
73
- <ResponseField name="light" type="string" required>
74
- The hex color code of the background in light mode
75
- </ResponseField>
76
- <ResponseField name="dark" type="string" required>
77
- The hex color code of the background in dark mode
78
- </ResponseField>
79
- </Expandable>
80
- </ResponseField>
81
- </Expandable>
82
- </ResponseField>
83
-
84
- <ResponseField name="topbarLinks" type="TopbarLink[]">
85
- Array of `name`s and `url`s of links you want to include in the topbar
86
- <Expandable title="TopbarLink">
87
- <ResponseField name="name" type="string">
88
- The name of the button.
89
-
90
- Example: `Contact us`
91
- </ResponseField>
92
- <ResponseField name="url" type="string">
93
- The url once you click on the button. Example: `https://mintlify.com/docs`
94
- </ResponseField>
95
-
96
- </Expandable>
97
- </ResponseField>
98
-
99
- <ResponseField name="topbarCtaButton" type="Call to Action">
100
- <Expandable title="Topbar Call to Action">
101
- <ResponseField name="type" type={'"link" or "github"'} default="link">
102
- Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars.
103
- </ResponseField>
104
- <ResponseField name="url" type="string">
105
- If `link`: What the button links to.
106
-
107
- If `github`: Link to the repository to load GitHub information from.
108
- </ResponseField>
109
- <ResponseField name="name" type="string">
110
- Text inside the button. Only required if `type` is a `link`.
111
- </ResponseField>
112
-
113
- </Expandable>
114
- </ResponseField>
115
-
116
- <ResponseField name="versions" type="string[]">
117
- Array of version names. Only use this if you want to show different versions
118
- of docs with a dropdown in the navigation bar.
119
- </ResponseField>
120
-
121
- <ResponseField name="anchors" type="Anchor[]">
122
- An array of the anchors, includes the `icon`, `color`, and `url`.
123
- <Expandable title="Anchor">
124
- <ResponseField name="icon" type="string">
125
- The [Font Awesome](https://fontawesome.com/search?q=heart) icon used to feature the anchor.
126
-
127
- Example: `comments`
128
- </ResponseField>
129
- <ResponseField name="name" type="string">
130
- The name of the anchor label.
131
-
132
- Example: `Community`
133
- </ResponseField>
134
- <ResponseField name="url" type="string">
135
- The start of the URL that marks what pages go in the anchor. Generally, this is the name of the folder you put your pages in.
136
- </ResponseField>
137
- <ResponseField name="color" type="string">
138
- The hex color of the anchor icon background. Can also be a gradient if you pass an object with the properties `from` and `to` that are each a hex color.
139
- </ResponseField>
140
- <ResponseField name="version" type="string">
141
- Used if you want to hide an anchor until the correct docs version is selected.
142
- </ResponseField>
143
- <ResponseField name="isDefaultHidden" type="boolean" default="false">
144
- Pass `true` if you want to hide the anchor until you directly link someone to docs inside it.
145
- </ResponseField>
146
- <ResponseField name="iconType" default="duotone" type="string">
147
- One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"
148
- </ResponseField>
149
-
150
- </Expandable>
151
- </ResponseField>
152
-
153
- <ResponseField name="topAnchor" type="Object">
154
- Override the default configurations for the top-most anchor.
155
- <Expandable title="Object">
156
- <ResponseField name="name" default="Documentation" type="string">
157
- The name of the top-most anchor
158
- </ResponseField>
159
- <ResponseField name="icon" default="book-open" type="string">
160
- Font Awesome icon.
161
- </ResponseField>
162
- <ResponseField name="iconType" default="duotone" type="string">
163
- One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"
164
- </ResponseField>
165
- </Expandable>
166
- </ResponseField>
167
-
168
- <ResponseField name="tabs" type="Tabs[]">
169
- An array of navigational tabs.
170
- <Expandable title="Tabs">
171
- <ResponseField name="name" type="string">
172
- The name of the tab label.
173
- </ResponseField>
174
- <ResponseField name="url" type="string">
175
- The start of the URL that marks what pages go in the tab. Generally, this
176
- is the name of the folder you put your pages in.
177
- </ResponseField>
178
- </Expandable>
179
- </ResponseField>
180
-
181
- <ResponseField name="api" type="API">
182
- Configuration for API settings. Learn more about API pages at [API Components](/api-playground/demo).
183
- <Expandable title="API">
184
- <ResponseField name="baseUrl" type="string">
185
- The base url for all API endpoints. If `baseUrl` is an array, it will enable for multiple base url
186
- options that the user can toggle.
187
- </ResponseField>
188
-
189
- <ResponseField name="auth" type="Auth">
190
- <Expandable title="Auth">
191
- <ResponseField name="method" type='"bearer" | "basic" | "key"'>
192
- The authentication strategy used for all API endpoints.
193
- </ResponseField>
194
- <ResponseField name="name" type="string">
195
- The name of the authentication parameter used in the API playground.
196
-
197
- If method is `basic`, the format should be `[usernameName]:[passwordName]`
198
- </ResponseField>
199
- <ResponseField name="inputPrefix" type="string">
200
- The default value that's designed to be a prefix for the authentication input field.
201
-
202
- E.g. If an `inputPrefix` of `AuthKey` would inherit the default input result of the authentication field as `AuthKey`.
203
- </ResponseField>
204
- </Expandable>
205
- </ResponseField>
206
-
207
- <ResponseField name="playground" type="Playground">
208
- Configurations for the API playground
209
-
210
- <Expandable title="Playground">
211
- <ResponseField name="mode" default="show" type='"show" | "simple" | "hide"'>
212
- Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity `simple`
213
-
214
- Learn more at the [playground guides](/api-playground/demo)
215
- </ResponseField>
216
- </Expandable>
217
- </ResponseField>
218
-
219
- <ResponseField name="maintainOrder" type="boolean">
220
- Enabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file.
221
-
222
- <Warning>This behavior will soon be enabled by default, at which point this field will be deprecated.</Warning>
223
- </ResponseField>
224
-
225
- </Expandable>
226
- </ResponseField>
227
-
228
- <ResponseField name="openapi" type="string | string[]">
229
- A string or an array of strings of URL(s) or relative path(s) pointing to your
230
- OpenAPI file.
231
-
232
- Examples:
233
- <CodeGroup>
234
- ```json Absolute
235
- "openapi": "https://example.com/openapi.json"
236
- ```
237
- ```json Relative
238
- "openapi": "/openapi.json"
239
- ```
240
- ```json Multiple
241
- "openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]
242
- ```
243
- </CodeGroup>
244
-
245
- </ResponseField>
246
-
247
- <ResponseField name="footerSocials" type="FooterSocials">
248
- An object of social media accounts where the key:property pair represents the social media platform and the account url.
249
-
250
- Example:
251
- ```json
252
- {
253
- "x": "https://x.com/mintlify",
254
- "website": "https://mintlify.com"
255
- }
256
- ```
257
- <Expandable title="FooterSocials">
258
- <ResponseField name="[key]" type="string">
259
- One of the following values `website`, `facebook`, `x`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`
260
-
261
- Example: `x`
262
- </ResponseField>
263
- <ResponseField name="property" type="string">
264
- The URL to the social platform.
265
-
266
- Example: `https://x.com/mintlify`
267
- </ResponseField>
268
- </Expandable>
269
- </ResponseField>
270
-
271
- <ResponseField name="feedback" type="Feedback">
272
- Configurations to enable feedback buttons
273
-
274
- <Expandable title="Feedback">
275
- <ResponseField name="suggestEdit" type="boolean" default="false">
276
- Enables a button to allow users to suggest edits via pull requests
277
- </ResponseField>
278
- <ResponseField name="raiseIssue" type="boolean" default="false">
279
- Enables a button to allow users to raise an issue about the documentation
280
- </ResponseField>
281
- </Expandable>
282
- </ResponseField>
283
-
284
- <ResponseField name="modeToggle" type="ModeToggle">
285
- Customize the dark mode toggle.
286
- <Expandable title="ModeToggle">
287
- <ResponseField name="default" type={'"light" or "dark"'}>
288
- Set if you always want to show light or dark mode for new users. When not
289
- set, we default to the same mode as the user's operating system.
290
- </ResponseField>
291
- <ResponseField name="isHidden" type="boolean" default="false">
292
- Set to true to hide the dark/light mode toggle. You can combine `isHidden` with `default` to force your docs to only use light or dark mode. For example:
293
-
294
- <CodeGroup>
295
- ```json Only Dark Mode
296
- "modeToggle": {
297
- "default": "dark",
298
- "isHidden": true
299
- }
300
- ```
301
-
302
- ```json Only Light Mode
303
- "modeToggle": {
304
- "default": "light",
305
- "isHidden": true
306
- }
307
- ```
308
- </CodeGroup>
309
-
310
- </ResponseField>
311
-
312
- </Expandable>
313
- </ResponseField>
314
-
315
- <ResponseField name="backgroundImage" type="string">
316
- A background image to be displayed behind every page. See example with
317
- [Infisical](https://infisical.com/docs) and [FRPC](https://frpc.io).
318
- </ResponseField>
@@ -1,3 +0,0 @@
1
- <svg width="53" height="72" viewBox="0 0 53 72" fill="none" xmlns="http://www.w3.org/2000/svg">
2
- <path d="M47.5105 24.2925L31.56 8.17727C29.411 6.01184 28.2036 3.07012 28.2036 0H20.1619C20.1619 5.22388 22.2185 10.2318 25.8754 13.9265L33.686 21.8177C34.2406 22.3781 33.6282 23.3061 32.9003 23.0026L5.84638 11.6852C4.61587 14.0782 3.56444 16.5763 2.70366 19.1678L29.8211 30.5145C30.5491 30.818 30.3353 31.9153 29.5438 31.9153H0.150203C0.0519935 33.2577 0 34.6119 0 35.9777C0 37.3435 0.0519935 38.6976 0.150203 40.04H29.5438C30.3295 40.04 30.5491 41.1373 29.8211 41.4408L2.70366 52.7875C3.56444 55.379 4.61587 57.8771 5.84638 60.2702L32.9003 48.9527C33.6282 48.6492 34.2406 49.5773 33.686 50.1376L25.8754 58.0289C22.2185 61.7235 20.1677 66.7314 20.1677 71.9553H28.2094C28.2094 68.8852 29.4168 65.9435 31.5658 63.7722L47.5163 47.657C50.7052 44.4351 52.2997 40.2035 52.2997 35.9777C52.2997 31.746 50.7052 27.5144 47.5163 24.2983L47.5105 24.2925Z" fill="#B192FF"/>
3
- </svg>
@@ -1,39 +0,0 @@
1
- ---
2
- title: 'Introduction'
3
- description: 'Exulu IMP frontend documentation'
4
- ---
5
-
6
- ## Overview
7
-
8
- The Exulu IMP frontend provides a web interface for managing and interacting with your Exulu IMP backend.
9
-
10
- ## Quick start
11
-
12
- Install and run the frontend:
13
-
14
- ```bash
15
- npx @exulu/frontend
16
- ```
17
-
18
- The frontend will start on `http://localhost:3000` and automatically connect to your Exulu IMP backend.
19
-
20
- ## Features
21
-
22
- The Exulu frontend includes:
23
-
24
- - **GraphQL Playground** - Interactive API explorer at `/explorer`
25
- - **Agent management** - Create and configure agents
26
- - **Context management** - Manage semantic search contexts
27
- - **Workflow builder** - Visual workflow editor
28
- - **Evaluation tools** - Test and evaluate agent performance
29
- - **User management** - Manage users, roles, and permissions
30
-
31
- ## Configuration
32
-
33
- The frontend automatically detects your Exulu IMP backend configuration when run in the same directory as your backend project.
34
-
35
- ## Next steps
36
-
37
- <Info>
38
- Frontend documentation is coming soon. In the meantime, explore the [Backend documentation](/index) and [API reference](/api-reference/introduction).
39
- </Info>