- {iconMap[groupLabel] ? React.createElement(iconMap[groupLabel]) : null}
- {groupLabel}
-
- ),
+ label:
- {iconMap[groupLabel] ? React.createElement(iconMap[groupLabel]) : null}
- {choice}
-
- ),
+ label: = ({
Tokens:{" "}
{additionalData.usage !== null
- ? JSON.stringify(additionalData.usage.total_tokens)
+ ? formatTokenUsage(additionalData.usage.total_tokens)
: 0}
Cost:{" "}
{additionalData.cost !== null
- ? `$${additionalData.cost.toFixed(4)}`
+ ? formatCurrency(additionalData.cost)
: "$0.00"}
diff --git a/agenta-web/src/components/ServerTable/components.tsx b/agenta-web/src/components/ServerTable/components.tsx
index de3d5bd30d..a1e5454f2c 100644
--- a/agenta-web/src/components/ServerTable/components.tsx
+++ b/agenta-web/src/components/ServerTable/components.tsx
@@ -1,9 +1,9 @@
import {GenericObject, JSSTheme, PaginationQuery} from "@/lib/Types"
-import {Button, Dropdown, Input, Space} from "antd"
+import {Button, Dropdown, DropdownProps, Input, Space} from "antd"
import {ColumnsType} from "antd/es/table"
import {FilterDropdownProps} from "antd/es/table/interface"
import dayjs from "dayjs"
-import React, {ReactNode, useMemo} from "react"
+import React, {ReactNode, useMemo, useState} from "react"
import {createUseStyles} from "react-jss"
import {Resizable} from "react-resizable"
import EnforceAntdStyles from "../EnforceAntdStyles/EnforceAntdStyles"
@@ -100,6 +100,13 @@ interface ColsDropdownProps {
export const ColsDropdown = ({columns, hiddenCols, setHiddenCols}: ColsDropdownProps) => {
const classes = useStyles()
+ const [isFilterColsDropdownOpen, setIsFilterColsDropdownOpen] = useState(false)
+
+ const handleOpenChangeFilterCols: DropdownProps["onOpenChange"] = (nextOpen, info) => {
+ if (info.source === "trigger" || nextOpen) {
+ setIsFilterColsDropdownOpen(nextOpen)
+ }
+ }
const shownCols = useMemo(
() =>
columns
@@ -119,6 +126,8 @@ export const ColsDropdown = ({columns, hiddenCols, setHiddenCols}: ColsDropd
return (
({
@@ -130,7 +139,10 @@ export const ColsDropdown = ({columns, hiddenCols, setHiddenCols}: ColsDropd
),
})) as any,
- onClick: ({key}) => onColToggle(key),
+ onClick: ({key}) => {
+ onColToggle(key)
+ setIsFilterColsDropdownOpen(true)
+ },
className: classes.dropdownMenu,
}}
>
diff --git a/agenta-web/src/components/ServerTable/index.tsx b/agenta-web/src/components/ServerTable/index.tsx
index 628472f71a..061558ece4 100644
--- a/agenta-web/src/components/ServerTable/index.tsx
+++ b/agenta-web/src/components/ServerTable/index.tsx
@@ -65,7 +65,7 @@ const ServerTable = (
"tableParams",
props.defaultTableParams && JSON.stringify(props.defaultTableParams),
)
- const [_hiddenCols, _setHiddenCols] = useQueryParam("hiddenCols", "")
+ const [_hiddenCols, _setHiddenCols] = useQueryParam("hiddenCols")
const [data, setData] = useState([])
const [loading, setLoading] = useState(false)
@@ -78,6 +78,10 @@ const ServerTable = (
setColumns(
(props.columns || []).map((item) => ({...item, width: item.width})) as DataCol[],
)
+ setHiddenCols([
+ ...hiddenCols,
+ ...props.columns.filter((col) => col.hidden).map((col) => col.key as string),
+ ])
}, [props.columns])
useEffect(() => {
diff --git a/agenta-web/src/lib/helpers/fileManipulations.ts b/agenta-web/src/lib/helpers/fileManipulations.ts
index d4434e6200..e3b6890e92 100644
--- a/agenta-web/src/lib/helpers/fileManipulations.ts
+++ b/agenta-web/src/lib/helpers/fileManipulations.ts
@@ -5,6 +5,8 @@ export const convertToCsv = (rows: GenericObject[], header: string[]) => {
return Papa.unparse({fields: header.filter((item) => !!item), data: rows})
}
+export const escapeNewlines = (value: string) => value.replace(/\n/g, "\\n")
+
export const downloadCsv = (csvContent: string, filename: string): void => {
if (typeof window === "undefined") return
diff --git a/agenta-web/src/lib/helpers/formatters.ts b/agenta-web/src/lib/helpers/formatters.ts
index f6e2bae571..5d5de3f7d6 100644
--- a/agenta-web/src/lib/helpers/formatters.ts
+++ b/agenta-web/src/lib/helpers/formatters.ts
@@ -5,17 +5,29 @@ const intlNumber = new Intl.NumberFormat("en-US", {
const intlCurrency = new Intl.NumberFormat("en-US", {
style: "currency",
currency: "USD",
- maximumFractionDigits: 4,
+ maximumFractionDigits: 6,
})
export const formatNumber = (value = 0) => {
return intlNumber.format(value)
}
-export const formatCurrency = (value = 0) => {
- return intlCurrency.format(value)
+export const formatCurrency = (value: number) => {
+ if (value === null) {
+ return "-"
+ } else {
+ return intlCurrency.format(value)
+ }
}
export const formatLatency = (value = 0) => {
return `${Math.round(value * 1000)}ms`
}
+
+export const formatTokenUsage = (value: number) => {
+ if (value === null) {
+ return "-"
+ } else {
+ return value
+ }
+}
diff --git a/agenta-web/src/lib/helpers/variantHelper.ts b/agenta-web/src/lib/helpers/variantHelper.ts
index ff3e36109d..dcfdc205e0 100644
--- a/agenta-web/src/lib/helpers/variantHelper.ts
+++ b/agenta-web/src/lib/helpers/variantHelper.ts
@@ -85,7 +85,7 @@ export const variantNameWithRev = (variant: {
}) => {
let name = variant.variant_name
if (![undefined, null].includes(variant.revision as any)) {
- name += `v${variant.revision}`
+ name += ` v${variant.revision}`
}
return name
}
diff --git a/agenta-web/src/lib/services/api.ts b/agenta-web/src/lib/services/api.ts
index 6da01e0cbf..9bdcc66189 100644
--- a/agenta-web/src/lib/services/api.ts
+++ b/agenta-web/src/lib/services/api.ts
@@ -60,6 +60,13 @@ export async function fetchVariants(
return []
}
+export const fetchVariantLogs = async (variantId: string, ignoreAxiosError: boolean = false) => {
+ const response = await axios.get(`${getAgentaApiUrl()}/api/variants/${variantId}/logs`, {
+ _ignoreError: ignoreAxiosError,
+ } as any)
+ return response.data
+}
+
export function restartAppVariantContainer(variantId: string) {
return axios.post(`${getAgentaApiUrl()}/api/containers/restart_container/`, {
variant_id: variantId,
diff --git a/docs/advanced_guides/using_custom_evaluators.mdx b/docs/advanced_guides/using_custom_evaluators.mdx
deleted file mode 100644
index 03cc648344..0000000000
--- a/docs/advanced_guides/using_custom_evaluators.mdx
+++ /dev/null
@@ -1,5 +0,0 @@
----
-title: 'Custom Evaluation'
----
-
- This page is under construction. Please reach out to us on [Slack](https://join.slack.com/t/agenta-hq/shared_invite/zt-1zsafop5i-Y7~ZySbhRZvKVPV5DO_7IA) **#support** channel, [Book a call](https://cal.com/mahmoud-mabrouk-ogzgey/demo), through [email](mailto:team@agenta.ai) if you need help with using custom evaluation.
\ No newline at end of file
diff --git a/docs/depractated/quickstart/installation.mdx b/docs/depractated/quickstart/installation.mdx
index 3cc8db76f0..5f1ac9838b 100644
--- a/docs/depractated/quickstart/installation.mdx
+++ b/docs/depractated/quickstart/installation.mdx
@@ -28,7 +28,7 @@ Use pip to install the SDK and CLI easily:
pip install agenta
```
-Please see [contributing](/developer_guides/contributing/development-mode) for more information on how to install the SDK and CLI in developement mode.
+Please see [contributing](/misc/contributing/development-mode) for more information on how to install the SDK and CLI in developement mode.
Agenta is under continuous developement, don't forget to always upgrade to the latest version of agenta using `pip install -U agenta`.
@@ -57,6 +57,6 @@ Open your browser and go to [http://localhost](http://localhost). If you see the
## What's next?
You're all set to start using Agenta!
-
+
Click here to build your first LLM app in just 1 minute.
\ No newline at end of file
diff --git a/docs/basic_guides/automatic_evaluation.mdx b/docs/evaluation/automatic_evaluation.mdx
similarity index 100%
rename from docs/basic_guides/automatic_evaluation.mdx
rename to docs/evaluation/automatic_evaluation.mdx
diff --git a/docs/basic_guides/custom_evaluator.mdx b/docs/evaluation/custom_evaluator.mdx
similarity index 100%
rename from docs/basic_guides/custom_evaluator.mdx
rename to docs/evaluation/custom_evaluator.mdx
diff --git a/docs/basic_guides/human_evaluation.mdx b/docs/evaluation/human_evaluation.mdx
similarity index 100%
rename from docs/basic_guides/human_evaluation.mdx
rename to docs/evaluation/human_evaluation.mdx
diff --git a/docs/evaluation/overview.mdx b/docs/evaluation/overview.mdx
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/docs/basic_guides/test_sets.mdx b/docs/evaluation/test_sets.mdx
similarity index 100%
rename from docs/basic_guides/test_sets.mdx
rename to docs/evaluation/test_sets.mdx
diff --git a/docs/getting_started/introduction.mdx b/docs/getting_started/introduction.mdx
index 650ad4c104..a678819b13 100644
--- a/docs/getting_started/introduction.mdx
+++ b/docs/getting_started/introduction.mdx
@@ -9,12 +9,12 @@ Agenta is an open-source platform that helps **developers** and **product teams*
### With Agenta, you can:
-1. Rapidly [**experiment** and **compare** prompts](/basic_guides/prompt_engineering) on [any LLM workflow](/advanced_guides/custom_applications) (chain-of-prompts, Retrieval Augmented Generation (RAG), LLM agents...)
-2. Rapidly [**create test sets**](/basic_guides/test_sets) and **golden datasets** for evaluation
+1. Rapidly [**experiment** and **compare** prompts](/prompt_management/prompt_engineering) on [any LLM workflow](/prompt_management/custom_applications) (chain-of-prompts, Retrieval Augmented Generation (RAG), LLM agents...)
+2. Rapidly [**create test sets**](/evaluation/test_sets) and **golden datasets** for evaluation
3. **Evaluate** your application with pre-existing or **custom evaluators**
4. **Annotate** and **A/B test** your applications with **human feedback**
-5. [**Collaborate with product teams**](/basic_guides/team_management) for prompt engineering and evaluation
-6. [**Deploy your application**](/basic_guides/deployment) in one-click in the UI, through CLI, or through github workflows.
+5. [**Collaborate with product teams**](/misc/team_management) for prompt engineering and evaluation
+6. [**Deploy your application**](/prompt_management/deployment) in one-click in the UI, through CLI, or through github workflows.
Agenta focuses on increasing the speed of the development cycle of LLM applications by increasing the speed of experimentation.
@@ -23,7 +23,7 @@ Agenta focuses on increasing the speed of the development cycle of LLM applicati
### Works with any LLM app workflow
Agenta enables prompt engineering and evaluation on any LLM app architecture, such as **Chain of Prompts**, **RAG**, or **LLM agents**. It is compatible with any framework like **Langchain** or **LlamaIndex**, and works with any model provider, such as **OpenAI**, **Cohere**, or **local models**.
-[Jump here](/advanced_guides/custom_applications) to see how to use your own custom application with Agenta and [here](/developer_guides/how_does_agenta_work) to understand more how Agenta works.
+[Jump here](/prompt_management/custom_applications) to see how to use your own custom application with Agenta and [here](/guides/how_does_agenta_work) to understand more how Agenta works.
### Enable collaboration between developers and product teams
@@ -39,7 +39,7 @@ By **adding a few lines to your application code**, you can create a prompt play
Create and deploy your first app from the UI in under 2 minutes.
@@ -48,7 +48,7 @@ By **adding a few lines to your application code**, you can create a prompt play
title="Create a Custom App"
icon="code"
color="#337BFF"
- href="/advanced_guides/custom_applications">
+ href="/prompt_management/custom_applications">
Write a custom LLM app and evaluate it in 10 minutes.
diff --git a/docs/getting_started/getting-started-ui.mdx b/docs/getting_started/quick-start.mdx
similarity index 94%
rename from docs/getting_started/getting-started-ui.mdx
rename to docs/getting_started/quick-start.mdx
index 7d0f5dfd59..fa3a3a5bd7 100644
--- a/docs/getting_started/getting-started-ui.mdx
+++ b/docs/getting_started/quick-start.mdx
@@ -3,7 +3,7 @@ title: 'Quick Start'
description: 'Create and deploy your first LLM app in one minute'
---
-This tutorial helps users create LLM apps using templates within the UI. For more complex applications involving code in Agenta, please refer to Using code in Agenta [Using code in agenta](/advanced_guides/custom_applications)
+This tutorial helps users create LLM apps using templates within the UI. For more complex applications involving code in Agenta, please refer to Using code in Agenta [Using code in agenta](/prompt_management/custom_applications)
Want a video tutorial instead? We have a 4-minute video for you. [Watch it here](https://youtu.be/plPVrHXQ-DU).
@@ -57,4 +57,4 @@ You can now find the API endpoint in the "Endpoints" menu. Copy and paste the co
- Congratulations! You've created your first LLM application. Feel free to modify it, explore its parameters, and discover Agenta's features. Your next steps could include [building an application using your own code](/advanced_guides/custom_applications), or following one of our UI-based tutorials.
+ Congratulations! You've created your first LLM application. Feel free to modify it, explore its parameters, and discover Agenta's features. Your next steps could include [building an application using your own code](/prompt_management/custom_applications), or following one of our UI-based tutorials.
diff --git a/docs/cookbook/extract_job_information.mdx b/docs/guides/extract_job_information.mdx
similarity index 100%
rename from docs/cookbook/extract_job_information.mdx
rename to docs/guides/extract_job_information.mdx
diff --git a/docs/developer_guides/how_does_agenta_work.mdx b/docs/guides/how_does_agenta_work.mdx
similarity index 100%
rename from docs/developer_guides/how_does_agenta_work.mdx
rename to docs/guides/how_does_agenta_work.mdx
diff --git a/docs/cookbook/list_templates.mdx b/docs/guides/list_templates.mdx
similarity index 83%
rename from docs/cookbook/list_templates.mdx
rename to docs/guides/list_templates.mdx
index b86a6e9309..32ce4471bf 100644
--- a/docs/cookbook/list_templates.mdx
+++ b/docs/guides/list_templates.mdx
@@ -1,21 +1,21 @@
---
-title: "Templates by Architecture"
+title: "Overview"
description: "A collection of templates and tutorials indexed by architecture."
---
# Tutorials
## 📝 Text Generation
-### [Single Prompt Application using OpenAI and Langchain](/developer_guides/tutorials/first-app-with-langchain)
+### [Single Prompt Application using OpenAI and Langchain](/guides/tutorials/first-app-with-langchain)
Text Generation OpenAI Langchain
Learn how to use our SDK to deploy an application with agenta. The application we will create uses OpenAI and Langchain. The application generates outreach messages in Linkedin to investors based on a startup name and idea.
-### [Use Mistral from Huggingface for a Summarization Task](/developer_guides/tutorials/deploy-mistral-model)
+### [Use Mistral from Huggingface for a Summarization Task](/guides/tutorials/deploy-mistral-model)
Text Generation Mistral Hugging Face
Learn how to use a custom model with agenta.
## Retrieval Augmented Generation (RAG)
-### [RAG Application with LlamaIndex](/developer_guides/tutorials/build-rag-application)
+### [RAG Application with LlamaIndex](/guides/tutorials/build-rag-application)
Sales OpenAI RAG LlamaIndex
Learn how to create a RAG application with LlamaIndex and use it in agenta. You will create a playground in agenta where you can experiment with the parameters of the RAG application, test it and compare different versions.
@@ -24,7 +24,7 @@ Learn how to create a RAG application with LlamaIndex and use it in agenta. You
## ⛏️ Extraction
These templates extract data in a structured format from an unstructured source.
-### [Extraction using OpenAI Functions and Langchain](/cookbook/extract_job_information)
+### [Extraction using OpenAI Functions and Langchain](/guides/extract_job_information)
HR OpenAI Functions Langchain
diff --git a/docs/developer_guides/tutorials/a-more-complicated-tutorial-draft.mdx b/docs/guides/tutorials/a-more-complicated-tutorial-draft.mdx
similarity index 100%
rename from docs/developer_guides/tutorials/a-more-complicated-tutorial-draft.mdx
rename to docs/guides/tutorials/a-more-complicated-tutorial-draft.mdx
diff --git a/docs/developer_guides/tutorials/build-rag-application.mdx b/docs/guides/tutorials/build-rag-application.mdx
similarity index 100%
rename from docs/developer_guides/tutorials/build-rag-application.mdx
rename to docs/guides/tutorials/build-rag-application.mdx
diff --git a/docs/developer_guides/tutorials/deploy-mistral-model.mdx b/docs/guides/tutorials/deploy-mistral-model.mdx
similarity index 100%
rename from docs/developer_guides/tutorials/deploy-mistral-model.mdx
rename to docs/guides/tutorials/deploy-mistral-model.mdx
diff --git a/docs/developer_guides/tutorials/first-app-with-langchain.mdx b/docs/guides/tutorials/first-app-with-langchain.mdx
similarity index 100%
rename from docs/developer_guides/tutorials/first-app-with-langchain.mdx
rename to docs/guides/tutorials/first-app-with-langchain.mdx
diff --git a/docs/images/prompt_management/asapromptmanagement.png b/docs/images/prompt_management/asapromptmanagement.png
new file mode 100644
index 0000000000..f49eb908c2
Binary files /dev/null and b/docs/images/prompt_management/asapromptmanagement.png differ
diff --git a/docs/images/prompt_management/asaproxy.png b/docs/images/prompt_management/asaproxy.png
new file mode 100644
index 0000000000..cbf8d1d51b
Binary files /dev/null and b/docs/images/prompt_management/asaproxy.png differ
diff --git a/docs/mint.json b/docs/mint.json
index d8b78f8318..aa834a6b52 100644
--- a/docs/mint.json
+++ b/docs/mint.json
@@ -33,17 +33,7 @@
},
"anchors": [
{
- "name": "Start for Free",
- "icon": "rocket",
- "url": "https://cloud.agenta.ai"
- },
- {
- "name": "Join our Slack",
- "icon": "slack",
- "url": "https://join.slack.com/t/agenta-hq/shared_invite/zt-1zsafop5i-Y7~ZySbhRZvKVPV5DO_7IA"
- },
- {
- "name": "Star us on GitHub",
+ "name": "Github",
"icon": "github",
"url": "https://github.com/agenta-ai/agenta"
},
@@ -55,12 +45,12 @@
],
"tabs": [
{
- "name": "For Developers",
- "url": "developer_guides"
+ "name": "Guides",
+ "url": "guides"
},
{
- "name": "Cookbook",
- "url": "cookbook"
+ "name": "Reference",
+ "url": "reference"
},
{
"name": "Changelog",
@@ -76,28 +66,32 @@
"group": "Getting Started",
"pages": [
"getting_started/introduction",
- "getting_started/getting-started-ui"
+ "getting_started/quick-start"
]
},
{
- "group": "Basic Guides",
+ "group": "Prompt Management and Engineering",
"pages": [
- "basic_guides/creating_an_app",
- "basic_guides/prompt_engineering",
- "basic_guides/test_sets",
- "basic_guides/automatic_evaluation",
- "basic_guides/human_evaluation",
- "basic_guides/deployment",
- "basic_guides/team_management",
- "basic_guides/integrating"
+ {
+ "group": "Setting up",
+ "pages": [
+ "prompt_management/creating_an_app",
+ "prompt_management/custom_applications",
+ "prompt_management/using_agenta_from_cli"
+ ]
+ },
+ "prompt_management/prompt_engineering",
+ "prompt_management/deployment",
+ "prompt_management/integrating"
]
},
{
- "group": "Advanced Guides",
+ "group": "Evaluation",
"pages": [
- "advanced_guides/custom_applications",
- "basic_guides/custom_evaluator",
- "advanced_guides/using_agenta_from_cli"
+ "evaluation/test_sets",
+ "evaluation/automatic_evaluation",
+ "evaluation/custom_evaluator",
+ "evaluation/human_evaluation"
]
},
{
@@ -117,32 +111,33 @@
]
},
{
- "group": "Introduction",
- "pages": [
- "developer_guides/how_does_agenta_work"
- ]
- },
- {
- "group": "Tutorials",
+ "group": "Misc",
"pages": [
- "developer_guides/tutorials/first-app-with-langchain",
- "developer_guides/tutorials/build-rag-application",
- "developer_guides/tutorials/deploy-mistral-model"
+ "misc/team_management",
+ "misc/getting_support",
+ {
+ "group": "Contributing",
+ "pages": [
+ "misc/contributing/getting-started",
+ "misc/contributing/development-mode",
+ "misc/contributing/file-issue"
+ ]
+ }
]
},
{
"group": "Python SDK",
"pages": [
- "developer_guides/sdk/quick_start",
+ "reference/sdk/quick_start",
{
"group": "Core Functions",
"pages": [
- "developer_guides/sdk/init",
- "developer_guides/sdk/config_object",
- "developer_guides/sdk/config_default",
- "developer_guides/sdk/config_pull",
- "developer_guides/sdk/config_push",
- "developer_guides/sdk/config_datatypes"
+ "reference/sdk/init",
+ "reference/sdk/config_object",
+ "reference/sdk/config_default",
+ "reference/sdk/config_pull",
+ "reference/sdk/config_push",
+ "reference/sdk/config_datatypes"
]
}
]
@@ -150,98 +145,90 @@
{
"group": "Command Line",
"pages": [
- "developer_guides/cli/install",
- "developer_guides/cli/quick-usage",
+ "reference/cli/install",
+ "reference/cli/quick-usage",
{
"group": "Core commands",
"pages": [
- "developer_guides/cli/init",
- "developer_guides/cli/variant_serve",
- "developer_guides/cli/variant_list",
- "developer_guides/cli/variant_remove"
+ "reference/cli/init",
+ "reference/cli/variant_serve",
+ "reference/cli/variant_list",
+ "reference/cli/variant_remove"
]
}
]
},
- {
- "group": "Contributing",
- "pages": [
- "developer_guides/contributing/getting-started",
- "developer_guides/contributing/development-mode",
- "developer_guides/contributing/file-issue"
- ]
- },
{
"group": "Reference",
"pages": [
{
"group": "Backend API",
"pages": [
- "developer_guides/reference/backend_api/user-profile",
- "developer_guides/reference/backend_api/list-app-variants",
- "developer_guides/reference/backend_api/get-variant-by-env",
- "developer_guides/reference/backend_api/list-apps",
- "developer_guides/reference/backend_api/create-app",
- "developer_guides/reference/backend_api/add-variant-from-image",
- "developer_guides/reference/backend_api/remove-app",
- "developer_guides/reference/backend_api/create-app-and-variant-from-template",
- "developer_guides/reference/backend_api/list-environments",
- "developer_guides/reference/backend_api/add-variant-from-base-and-config",
- "developer_guides/reference/backend_api/start-variant",
- "developer_guides/reference/backend_api/remove-variant",
- "developer_guides/reference/backend_api/update-variant-parameters",
- "developer_guides/reference/backend_api/update-variant-image",
- "developer_guides/reference/backend_api/fetch-list-evaluations",
- "developer_guides/reference/backend_api/create-evaluation",
- "developer_guides/reference/backend_api/delete-evaluations",
- "developer_guides/reference/backend_api/fetch-evaluation",
- "developer_guides/reference/backend_api/update-evaluation-router",
- "developer_guides/reference/backend_api/fetch-evaluation-scenarios",
- "developer_guides/reference/backend_api/create-evaluation-scenario",
- "developer_guides/reference/backend_api/update-evaluation-scenario-router",
- "developer_guides/reference/backend_api/evaluate-ai-critique",
- "developer_guides/reference/backend_api/get-evaluation-scenario-score-router",
- "developer_guides/reference/backend_api/update-evaluation-scenario-score-router",
- "developer_guides/reference/backend_api/fetch-results",
- "developer_guides/reference/backend_api/create-custom-evaluation",
- "developer_guides/reference/backend_api/update-custom-evaluation",
- "developer_guides/reference/backend_api/list-custom-evaluations",
- "developer_guides/reference/backend_api/get-custom-evaluation",
- "developer_guides/reference/backend_api/get-custom-evaluation-names",
- "developer_guides/reference/backend_api/execute-custom-evaluation",
- "developer_guides/reference/backend_api/webhook-example-fake",
- "developer_guides/reference/backend_api/upload-file",
- "developer_guides/reference/backend_api/import-testset",
- "developer_guides/reference/backend_api/create-testset",
+ "reference/reference/backend_api/user-profile",
+ "reference/reference/backend_api/list-app-variants",
+ "reference/reference/backend_api/get-variant-by-env",
+ "reference/reference/backend_api/list-apps",
+ "reference/reference/backend_api/create-app",
+ "reference/reference/backend_api/add-variant-from-image",
+ "reference/reference/backend_api/remove-app",
+ "reference/reference/backend_api/create-app-and-variant-from-template",
+ "reference/reference/backend_api/list-environments",
+ "reference/reference/backend_api/add-variant-from-base-and-config",
+ "reference/reference/backend_api/start-variant",
+ "reference/reference/backend_api/remove-variant",
+ "reference/reference/backend_api/update-variant-parameters",
+ "reference/reference/backend_api/update-variant-image",
+ "reference/reference/backend_api/fetch-list-evaluations",
+ "reference/reference/backend_api/create-evaluation",
+ "reference/reference/backend_api/delete-evaluations",
+ "reference/reference/backend_api/fetch-evaluation",
+ "reference/reference/backend_api/update-evaluation-router",
+ "reference/reference/backend_api/fetch-evaluation-scenarios",
+ "reference/reference/backend_api/create-evaluation-scenario",
+ "reference/reference/backend_api/update-evaluation-scenario-router",
+ "reference/reference/backend_api/evaluate-ai-critique",
+ "reference/reference/backend_api/get-evaluation-scenario-score-router",
+ "reference/reference/backend_api/update-evaluation-scenario-score-router",
+ "reference/reference/backend_api/fetch-results",
+ "reference/reference/backend_api/create-custom-evaluation",
+ "reference/reference/backend_api/update-custom-evaluation",
+ "reference/reference/backend_api/list-custom-evaluations",
+ "reference/reference/backend_api/get-custom-evaluation",
+ "reference/reference/backend_api/get-custom-evaluation-names",
+ "reference/reference/backend_api/execute-custom-evaluation",
+ "reference/reference/backend_api/webhook-example-fake",
+ "reference/reference/backend_api/upload-file",
+ "reference/reference/backend_api/import-testset",
+ "reference/reference/backend_api/create-testset",
{
"group": "testsets",
"pages": [
- "developer_guides/reference/backend_api/testsets/get-testset",
- "developer_guides/reference/backend_api/testsets/get-testsets"
+ "reference/reference/backend_api/testsets/get-testset",
+ "reference/reference/backend_api/testsets/get-testsets"
]
},
- "developer_guides/reference/backend_api/update-testset",
- "developer_guides/reference/backend_api/delete-testsets",
- "developer_guides/reference/backend_api/build-image",
- "developer_guides/reference/backend_api/restart-docker-container",
- "developer_guides/reference/backend_api/container-templates",
- "developer_guides/reference/backend_api/construct-app-container-url",
- "developer_guides/reference/backend_api/deploy-to-environment",
- "developer_guides/reference/backend_api/create-trace",
- "developer_guides/reference/backend_api/get-traces",
- "developer_guides/reference/backend_api/get-trace",
- "developer_guides/reference/backend_api/update-trace-status",
- "developer_guides/reference/backend_api/create-span",
- "developer_guides/reference/backend_api/get-spans-of-trace",
- "developer_guides/reference/backend_api/get-feedbacks",
- "developer_guides/reference/backend_api/create-feedback",
- "developer_guides/reference/backend_api/get-feedback",
- "developer_guides/reference/backend_api/update-feedback",
- "developer_guides/reference/backend_api/list-organizations",
- "developer_guides/reference/backend_api/get-user-organization",
- "developer_guides/reference/backend_api/list-bases",
- "developer_guides/reference/backend_api/get-config",
- "developer_guides/reference/backend_api/save-config"
+ "reference/reference/backend_api/update-testset",
+ "reference/reference/backend_api/delete-testsets",
+ "reference/reference/backend_api/build-image",
+ "reference/reference/backend_api/restart-docker-container",
+ "reference/reference/backend_api/container-templates",
+ "reference/reference/backend_api/construct-app-container-url",
+ "reference/reference/backend_api/deploy-to-environment",
+ "reference/reference/backend_api/create-trace",
+ "reference/reference/backend_api/get-traces",
+ "reference/reference/backend_api/get-trace",
+ "reference/reference/backend_api/update-trace-status",
+ "reference/reference/backend_api/create-span",
+ "reference/reference/backend_api/get-spans-of-trace",
+ "reference/reference/backend_api/get-feedbacks",
+ "reference/reference/backend_api/create-feedback",
+ "reference/reference/backend_api/get-feedback",
+ "reference/reference/backend_api/update-feedback",
+ "reference/reference/backend_api/list-organizations",
+ "reference/reference/backend_api/get-user-organization",
+ "reference/reference/backend_api/list-bases",
+ "reference/reference/backend_api/get-config",
+ "reference/reference/backend_api/save-config"
]
}
]
@@ -253,10 +240,19 @@
]
},
{
- "group": "Cookbook",
+ "group": "Introduction",
+ "pages": [
+ "guides/how_does_agenta_work"
+ ]
+ },
+ {
+ "group": "Guides",
"pages": [
- "cookbook/list_templates",
- "cookbook/extract_job_information"
+ "guides/list_templates",
+ "guides/tutorials/first-app-with-langchain",
+ "guides/tutorials/build-rag-application",
+ "guides/tutorials/deploy-mistral-model",
+ "guides/extract_job_information"
]
}
],
@@ -282,4 +278,4 @@
"measurementId": "G-LTF78FZS33"
}
}
-}
\ No newline at end of file
+}
diff --git a/docs/developer_guides/contributing/development-mode.mdx b/docs/misc/contributing/development-mode.mdx
similarity index 100%
rename from docs/developer_guides/contributing/development-mode.mdx
rename to docs/misc/contributing/development-mode.mdx
diff --git a/docs/developer_guides/contributing/file-issue.mdx b/docs/misc/contributing/file-issue.mdx
similarity index 100%
rename from docs/developer_guides/contributing/file-issue.mdx
rename to docs/misc/contributing/file-issue.mdx
diff --git a/docs/developer_guides/contributing/getting-started.mdx b/docs/misc/contributing/getting-started.mdx
similarity index 97%
rename from docs/developer_guides/contributing/getting-started.mdx
rename to docs/misc/contributing/getting-started.mdx
index 1915744559..ed9d40a4a6 100644
--- a/docs/developer_guides/contributing/getting-started.mdx
+++ b/docs/misc/contributing/getting-started.mdx
@@ -28,7 +28,7 @@ To maintain code quality, we adhere to certain formatting and linting rules:
## Contribution Steps
-1. **Pick an Issue:** Start by selecting an issue from our issue tracker. Choose one that matches your skill set and begin coding. For more on this, read our [Creating an Issue Guide](/developer_guides/contributing/file-issue).
+1. **Pick an Issue:** Start by selecting an issue from our issue tracker. Choose one that matches your skill set and begin coding. For more on this, read our [Creating an Issue Guide](/misc/contributing/file-issue).
2. **Fork & Pull Request:** Fork our repository, create a new branch, add your changes, and submit a pull request. Ensure your code aligns with our standards and includes appropriate unit tests.
diff --git a/docs/misc/getting_support.mdx b/docs/misc/getting_support.mdx
new file mode 100644
index 0000000000..c132e4b477
--- /dev/null
+++ b/docs/misc/getting_support.mdx
@@ -0,0 +1,31 @@
+---
+title: Getting Support
+---
+
+We offer multiple channels to get support for Agenta.
+
+
+
+ Use the #support channel on Slack for any inquiries or assistance with Agenta. Paying customers have a private Slack channel for support.
+
+
+ Book a call with a founder for one-on-one guidance on using Agenta.
+
+
+ File a bug report or start a discussion in our Github repository.
+
+
+ Use the chat widget on the bottom right of the screen in the documentation or in the cloud version to ask questions or report issues.
+
+
diff --git a/docs/basic_guides/team_management.mdx b/docs/misc/team_management.mdx
similarity index 100%
rename from docs/basic_guides/team_management.mdx
rename to docs/misc/team_management.mdx
diff --git a/docs/monitoring/overview.mdx b/docs/monitoring/overview.mdx
new file mode 100644
index 0000000000..f9f810ff3d
--- /dev/null
+++ b/docs/monitoring/overview.mdx
@@ -0,0 +1,75 @@
+---
+title: Overview
+---
+
+What isn't measured cannot be improved. If you want to enhance your application's quality, cost, and performance, you first need to monitor it. Agenta offers a comprehensive monitoring system that lets you track application performance metrics over time.
+
+For every request made through your LLM application, Agenta captures the input variables, configuration (like prompt templates), outputs, and crucial metadata such as cost, latency, and model name.
+
+Agenta also provides tools to visualize and analyze this data on a dashboard. You can view request count, average latency, operational costs, and more. Additionally, you can filter requests to identify problematic ones and add them to your test sets.
+
+## Setting up tracing
+
+### Applications created from the UI
+When creating an application from the UI, tracing is enabled by default. There's no need for setup; simply go to the observability view to see all the requests in the dashboard and in the traces view.
+
+### Application created from code
+If you're creating your own template from code or hosting your own code base and want to use Agenta for prompt management and tracing, you'll need to set up tracing yourself.
+
+
+ These are instructions or content that only pertain to the first step.
+
+
+ These are instructions or content that only pertain to the second step.
+
+
+ These are instructions or content that only pertain to the third step.
+
+
+
+Here's a quick guide on how to do it. You can find more details in the rest of the documentation.
+
+
+
+ Install our Python SDK using pip:
+ ```bash
+ pip install agenta
+ ```
+ or add it to your `requirements.txt`/`pyproject.toml`.. file.
+
+
+ ```python
+ import os
+ os.environment["AGENTA_API_KEY"] = "your_api_key"
+ os.envivonment["AGENTA_APP_ID"] = "your_app_id"
+ os.environment["AGENTA_HOST"] = "https://cloud.agenta.ai"
+ ```
+ You can find your API key in the configuration menu. As for the app ID, you can find it in the deployment menu.
+
+
+ Decorate your functions with the `@ag.span` decorator to trace the function and the `@ag.trace` decorator to trace the entire application. Note here that we provide integrations for many client such as OpenAI. Here's an example:
+ ```python
+ import agenta as ag
+ import openai
+
+ client = openai.Client()
+ ag.instrument_openai(client)
+
+ @ag.span
+ def myllmcall(country:str):
+ prompt = f"What is the capital of {country}"
+ response = client.chat.completions.create(
+ model='gpt-4',
+ messages=[
+ {'role': 'user', 'content': prompt},
+ ],
+ )
+ return response.choices[0].text
+
+ #@ag.entrypoint # in case you are hosting the app in agenta
+ @ag.trace
+ def generate(country:str):
+ return myllmcall(country)
+ ```
+
+
diff --git a/docs/basic_guides/creating_an_app.mdx b/docs/prompt_management/creating_an_app.mdx
similarity index 93%
rename from docs/basic_guides/creating_an_app.mdx
rename to docs/prompt_management/creating_an_app.mdx
index b04ef6df6f..df994ce8c0 100644
--- a/docs/basic_guides/creating_an_app.mdx
+++ b/docs/prompt_management/creating_an_app.mdx
@@ -2,7 +2,7 @@
title: 'Creating an LLM App'
---
-You can create applications in Agenta either from the web interface or from code. This guide will focus on creating an application using a template from the UI. You can read more about creating a custom application using code [here](/advanced_guides/custom_applications)
+You can create applications in Agenta either from the web interface or from code. This guide will focus on creating an application using a template from the UI. You can read more about creating a custom application using code [here](/prompt_management/custom_applications)
## Step-by-step Guide
@@ -39,4 +39,4 @@ Like the single prompt application, the chat application is based on the OpenAI
## Next steps
-Now that you've created an application, you can learn how to do [prompt engineering in the playground](/basic_guides/prompt_engineering).
\ No newline at end of file
+Now that you've created an application, you can learn how to do [prompt engineering in the playground](/prompt_management/prompt_engineering).
\ No newline at end of file
diff --git a/docs/advanced_guides/custom_applications.mdx b/docs/prompt_management/custom_applications.mdx
similarity index 91%
rename from docs/advanced_guides/custom_applications.mdx
rename to docs/prompt_management/custom_applications.mdx
index 6f00f5a7c3..b31b0338b3 100644
--- a/docs/advanced_guides/custom_applications.mdx
+++ b/docs/prompt_management/custom_applications.mdx
@@ -7,13 +7,13 @@ Agenta comes with several pre-built template LLM applications for common use cas
This guide will show you how to create a custom application and use it with Agenta.
- We recommend reading ["How does Agenta work"](/developer_guides/how_does_agenta_work) beforehand to familiarize yourself with the main concepts of Agenta.
+ We recommend reading ["How does Agenta work"](/guides/how_does_agenta_work) beforehand to familiarize yourself with the main concepts of Agenta.
## How to create a custom application in Agenta ?
To add your custom application in Agenta, you need to write the application code using the Agenta SDK, then add the application to Agenta using the CLI.
-The [Agenta SDK](/developer_guides/sdk/quick_start) takes care of specifying the configuration of your application (prompts, model parameters, chunk size, etc.), and integrates it with Agenta. The [Agenta CLI](/developer_guides/cli/quick-usage) takes care of building the application image, deploying it, and exposing it to Agenta.
+The [Agenta SDK](/reference/sdk/quick_start) takes care of specifying the configuration of your application (prompts, model parameters, chunk size, etc.), and integrates it with Agenta. The [Agenta CLI](/reference/cli/quick-usage) takes care of building the application image, deploying it, and exposing it to Agenta.
## Converting an existing application to Agenta
@@ -141,7 +141,7 @@ The application should now be visible in Agenta. A new application variant is al
## Adding other parameters
-We are not limited to one configuration parameter in the playground. We can add as many as we'd like. These parameters can be prompts (TextParam), numbers (FloatParam, IntParam), or dropdowns (MultipleChoiceParam). You can read more about the types of parameters in the [parameters](/developer_guides/sdk/config_datatypes) section.
+We are not limited to one configuration parameter in the playground. We can add as many as we'd like. These parameters can be prompts (TextParam), numbers (FloatParam, IntParam), or dropdowns (MultipleChoiceParam). You can read more about the types of parameters in the [parameters](/reference/sdk/config_datatypes) section.
Here is a modified version of the application that adds a new parameter `temperature` to the playground.
@@ -173,7 +173,7 @@ Agenta provides the flexibility to add any LLM application to the platform, so t
We've merely touched on what Agenta can do. You're not limited to apps that consist of a single file or function. You can create chains of prompts, or even agents. You can use the SDK allows you to track costs and log traces of your application.
-More information about the SDK can be found in the [SDK section in the developer guide](/developer_guides/sdk/quick_start). You can also explore a growing list of templates and tutorials in the [cookbook section](/cookbook/list_templates).
+More information about the SDK can be found in the [SDK section in the developer guide](/reference/sdk/quick_start). You can also explore a growing list of templates and tutorials in the [cookbook section](/guides/list_templates).
Finally, our team is always ready to assist you with any custom application. Simply reach out to us on Slack, or book a call to discuss your use case in detail.
You can read more about the SDK in the . You can also check the growing list of templates and tutorials in the . Last please note, that our team is always available to help you with any custom applicatoin, just reach out to use on [Slack](https://join.slack.com/t/agenta-hq/shared_invite/zt-1zsafop5i-Y7~ZySbhRZvKVPV5DO_7IA) Or [book a call](https://cal.com/mahmoud-mabrouk-ogzgey/demo) to discuss your use case in details.
@@ -186,7 +186,7 @@ You can read more about the SDK in the . You can also check the growing list of
Learn how to use the SDK to create custom applications.
@@ -195,7 +195,7 @@ You can read more about the SDK in the . You can also check the growing list of
title="Cookbook"
icon="code"
color="#337BFF"
- href="/cookbook/list_templates">
+ href="/guides/list_templates">
diff --git a/docs/basic_guides/deployment.mdx b/docs/prompt_management/deployment.mdx
similarity index 100%
rename from docs/basic_guides/deployment.mdx
rename to docs/prompt_management/deployment.mdx
diff --git a/docs/basic_guides/integrating.mdx b/docs/prompt_management/integrating.mdx
similarity index 85%
rename from docs/basic_guides/integrating.mdx
rename to docs/prompt_management/integrating.mdx
index 6d23b3bd85..78f4588855 100644
--- a/docs/basic_guides/integrating.mdx
+++ b/docs/prompt_management/integrating.mdx
@@ -7,8 +7,17 @@ description: 'Integrate applications and prompts created in agenta into your pro
Applications and prompts created in agenta can be integrated into your projects in two primary ways:
-1. **As a Middleware:** Use the applications hosted on agenta directly.
-2. **As a Prompt Management System:** Fetch the latest version of prompts/configurations from agenta.
+1. **As a Prompt Management System:** Fetch the latest version of prompts/configurations from agenta.
+
+
+
+
+
+2. **As a Middleware:** Use the applications hosted on agenta directly.
+
+
+
+
## Using agenta as Middleware
@@ -54,4 +63,4 @@ The response object is an instance of `GetConfigResponse` from `agenta.client.ba
'frequence_penalty': 0.0,
'presence_penalty': 0.0,
'force_json': 0}
-```
\ No newline at end of file
+```
diff --git a/docs/basic_guides/prompt_engineering.mdx b/docs/prompt_management/prompt_engineering.mdx
similarity index 100%
rename from docs/basic_guides/prompt_engineering.mdx
rename to docs/prompt_management/prompt_engineering.mdx
diff --git a/docs/advanced_guides/using_agenta_from_cli.mdx b/docs/prompt_management/using_agenta_from_cli.mdx
similarity index 90%
rename from docs/advanced_guides/using_agenta_from_cli.mdx
rename to docs/prompt_management/using_agenta_from_cli.mdx
index ec090fb9cf..7ee7cdd2da 100644
--- a/docs/advanced_guides/using_agenta_from_cli.mdx
+++ b/docs/prompt_management/using_agenta_from_cli.mdx
@@ -3,7 +3,7 @@ title: 'Using Agenta from CLI'
description: 'Create, experiment, and evaluate your applications all from the CLI'
---
-Agenta was designed for use both from the CLI and from the web interface. This guide explains the basics of using Agenta from the CLI. For more details, refer to the [CLI developer guide](/developer_guides/cli/quick-usage).
+Agenta was designed for use both from the CLI and from the web interface. This guide explains the basics of using Agenta from the CLI. For more details, refer to the [CLI developer guide](/reference/cli/quick-usage).
## Installation
The agenta CLI can be easily installed through pip:
@@ -36,7 +36,7 @@ This can be done by running the following command:
This will create a new app variant in Agenta under the name filename.default. Here, filename is the name of the codebase containing the app logic, while default is a default configuration created for that codebase. Each new app variant created from the web interface or from the CLI will always have the name format `.`.
- Running this comand will [create a container for the application](developer_guides/how_does_agenta_work) with a REST API endpoint. This endpoint is what is used by the agenta web interface to communicate with the application.
+ Running this comand will [create a container for the application](guides/how_does_agenta_work) with a REST API endpoint. This endpoint is what is used by the agenta web interface to communicate with the application.
The CLI will also display the URL of the endpoint, which can be used to test the application.
diff --git a/docs/developer_guides/cli/init.mdx b/docs/reference/cli/init.mdx
similarity index 100%
rename from docs/developer_guides/cli/init.mdx
rename to docs/reference/cli/init.mdx
diff --git a/docs/developer_guides/cli/install.mdx b/docs/reference/cli/install.mdx
similarity index 73%
rename from docs/developer_guides/cli/install.mdx
rename to docs/reference/cli/install.mdx
index 2e4ad384e9..cca0b9e948 100644
--- a/docs/developer_guides/cli/install.mdx
+++ b/docs/reference/cli/install.mdx
@@ -14,10 +14,10 @@ pip install -U agenta
# Quick usage guide
-
+
Get an overview of the main commands and capabilities of agenta CLI
-
+
Jump into a tutorial deploying an LLM app from code using agenta CLI
diff --git a/docs/developer_guides/cli/quick-usage.mdx b/docs/reference/cli/quick-usage.mdx
similarity index 93%
rename from docs/developer_guides/cli/quick-usage.mdx
rename to docs/reference/cli/quick-usage.mdx
index 0c48f77afa..9abd0219f7 100644
--- a/docs/developer_guides/cli/quick-usage.mdx
+++ b/docs/reference/cli/quick-usage.mdx
@@ -44,3 +44,10 @@ agenta variant serve myapp.py
```
This command deploys a new variant to the Agenta platform. It processes the code in the specified folder, with `myapp.py` as the entrypoint. This command builds a Docker image and deploys a container based on it. As a result, the variant becomes accessible in the web UI, allowing for prediction generation and API calls. The variant is named as `myapp.default` in the UI.
+
+
+## Overwrite an application
+
+```bash
+agenta variant serve --file_name myapp.py --overwrite
+```
\ No newline at end of file
diff --git a/docs/developer_guides/cli/variant_list.mdx b/docs/reference/cli/variant_list.mdx
similarity index 100%
rename from docs/developer_guides/cli/variant_list.mdx
rename to docs/reference/cli/variant_list.mdx
diff --git a/docs/developer_guides/cli/variant_remove.mdx b/docs/reference/cli/variant_remove.mdx
similarity index 100%
rename from docs/developer_guides/cli/variant_remove.mdx
rename to docs/reference/cli/variant_remove.mdx
diff --git a/docs/developer_guides/cli/variant_serve.mdx b/docs/reference/cli/variant_serve.mdx
similarity index 100%
rename from docs/developer_guides/cli/variant_serve.mdx
rename to docs/reference/cli/variant_serve.mdx
diff --git a/docs/developer_guides/reference/backend_api/add-variant-from-base-and-config.mdx b/docs/reference/reference/backend_api/add-variant-from-base-and-config.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/add-variant-from-base-and-config.mdx
rename to docs/reference/reference/backend_api/add-variant-from-base-and-config.mdx
diff --git a/docs/developer_guides/reference/backend_api/add-variant-from-image.mdx b/docs/reference/reference/backend_api/add-variant-from-image.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/add-variant-from-image.mdx
rename to docs/reference/reference/backend_api/add-variant-from-image.mdx
diff --git a/docs/developer_guides/reference/backend_api/build-image.mdx b/docs/reference/reference/backend_api/build-image.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/build-image.mdx
rename to docs/reference/reference/backend_api/build-image.mdx
diff --git a/docs/developer_guides/reference/backend_api/construct-app-container-url.mdx b/docs/reference/reference/backend_api/construct-app-container-url.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/construct-app-container-url.mdx
rename to docs/reference/reference/backend_api/construct-app-container-url.mdx
diff --git a/docs/developer_guides/reference/backend_api/container-templates.mdx b/docs/reference/reference/backend_api/container-templates.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/container-templates.mdx
rename to docs/reference/reference/backend_api/container-templates.mdx
diff --git a/docs/developer_guides/reference/backend_api/create-app-and-variant-from-template.mdx b/docs/reference/reference/backend_api/create-app-and-variant-from-template.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/create-app-and-variant-from-template.mdx
rename to docs/reference/reference/backend_api/create-app-and-variant-from-template.mdx
diff --git a/docs/developer_guides/reference/backend_api/create-app.mdx b/docs/reference/reference/backend_api/create-app.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/create-app.mdx
rename to docs/reference/reference/backend_api/create-app.mdx
diff --git a/docs/developer_guides/reference/backend_api/create-custom-evaluation.mdx b/docs/reference/reference/backend_api/create-custom-evaluation.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/create-custom-evaluation.mdx
rename to docs/reference/reference/backend_api/create-custom-evaluation.mdx
diff --git a/docs/developer_guides/reference/backend_api/create-evaluation-scenario.mdx b/docs/reference/reference/backend_api/create-evaluation-scenario.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/create-evaluation-scenario.mdx
rename to docs/reference/reference/backend_api/create-evaluation-scenario.mdx
diff --git a/docs/developer_guides/reference/backend_api/create-evaluation.mdx b/docs/reference/reference/backend_api/create-evaluation.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/create-evaluation.mdx
rename to docs/reference/reference/backend_api/create-evaluation.mdx
diff --git a/docs/developer_guides/reference/backend_api/create-feedback.mdx b/docs/reference/reference/backend_api/create-feedback.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/create-feedback.mdx
rename to docs/reference/reference/backend_api/create-feedback.mdx
diff --git a/docs/developer_guides/reference/backend_api/create-span.mdx b/docs/reference/reference/backend_api/create-span.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/create-span.mdx
rename to docs/reference/reference/backend_api/create-span.mdx
diff --git a/docs/developer_guides/reference/backend_api/create-testset.mdx b/docs/reference/reference/backend_api/create-testset.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/create-testset.mdx
rename to docs/reference/reference/backend_api/create-testset.mdx
diff --git a/docs/developer_guides/reference/backend_api/create-trace.mdx b/docs/reference/reference/backend_api/create-trace.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/create-trace.mdx
rename to docs/reference/reference/backend_api/create-trace.mdx
diff --git a/docs/developer_guides/reference/backend_api/create_doc_from_openai.sh b/docs/reference/reference/backend_api/create_doc_from_openai.sh
similarity index 100%
rename from docs/developer_guides/reference/backend_api/create_doc_from_openai.sh
rename to docs/reference/reference/backend_api/create_doc_from_openai.sh
diff --git a/docs/developer_guides/reference/backend_api/delete-evaluations.mdx b/docs/reference/reference/backend_api/delete-evaluations.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/delete-evaluations.mdx
rename to docs/reference/reference/backend_api/delete-evaluations.mdx
diff --git a/docs/developer_guides/reference/backend_api/delete-testsets.mdx b/docs/reference/reference/backend_api/delete-testsets.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/delete-testsets.mdx
rename to docs/reference/reference/backend_api/delete-testsets.mdx
diff --git a/docs/developer_guides/reference/backend_api/deploy-to-environment.mdx b/docs/reference/reference/backend_api/deploy-to-environment.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/deploy-to-environment.mdx
rename to docs/reference/reference/backend_api/deploy-to-environment.mdx
diff --git a/docs/developer_guides/reference/backend_api/evaluate-ai-critique.mdx b/docs/reference/reference/backend_api/evaluate-ai-critique.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/evaluate-ai-critique.mdx
rename to docs/reference/reference/backend_api/evaluate-ai-critique.mdx
diff --git a/docs/developer_guides/reference/backend_api/execute-custom-evaluation.mdx b/docs/reference/reference/backend_api/execute-custom-evaluation.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/execute-custom-evaluation.mdx
rename to docs/reference/reference/backend_api/execute-custom-evaluation.mdx
diff --git a/docs/developer_guides/reference/backend_api/fetch-evaluation-scenarios.mdx b/docs/reference/reference/backend_api/fetch-evaluation-scenarios.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/fetch-evaluation-scenarios.mdx
rename to docs/reference/reference/backend_api/fetch-evaluation-scenarios.mdx
diff --git a/docs/developer_guides/reference/backend_api/fetch-evaluation.mdx b/docs/reference/reference/backend_api/fetch-evaluation.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/fetch-evaluation.mdx
rename to docs/reference/reference/backend_api/fetch-evaluation.mdx
diff --git a/docs/developer_guides/reference/backend_api/fetch-list-evaluations.mdx b/docs/reference/reference/backend_api/fetch-list-evaluations.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/fetch-list-evaluations.mdx
rename to docs/reference/reference/backend_api/fetch-list-evaluations.mdx
diff --git a/docs/developer_guides/reference/backend_api/fetch-results.mdx b/docs/reference/reference/backend_api/fetch-results.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/fetch-results.mdx
rename to docs/reference/reference/backend_api/fetch-results.mdx
diff --git a/docs/developer_guides/reference/backend_api/get-config.mdx b/docs/reference/reference/backend_api/get-config.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/get-config.mdx
rename to docs/reference/reference/backend_api/get-config.mdx
diff --git a/docs/developer_guides/reference/backend_api/get-custom-evaluation-names.mdx b/docs/reference/reference/backend_api/get-custom-evaluation-names.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/get-custom-evaluation-names.mdx
rename to docs/reference/reference/backend_api/get-custom-evaluation-names.mdx
diff --git a/docs/developer_guides/reference/backend_api/get-custom-evaluation.mdx b/docs/reference/reference/backend_api/get-custom-evaluation.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/get-custom-evaluation.mdx
rename to docs/reference/reference/backend_api/get-custom-evaluation.mdx
diff --git a/docs/developer_guides/reference/backend_api/get-evaluation-scenario-score-router.mdx b/docs/reference/reference/backend_api/get-evaluation-scenario-score-router.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/get-evaluation-scenario-score-router.mdx
rename to docs/reference/reference/backend_api/get-evaluation-scenario-score-router.mdx
diff --git a/docs/developer_guides/reference/backend_api/get-feedback.mdx b/docs/reference/reference/backend_api/get-feedback.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/get-feedback.mdx
rename to docs/reference/reference/backend_api/get-feedback.mdx
diff --git a/docs/developer_guides/reference/backend_api/get-feedbacks.mdx b/docs/reference/reference/backend_api/get-feedbacks.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/get-feedbacks.mdx
rename to docs/reference/reference/backend_api/get-feedbacks.mdx
diff --git a/docs/developer_guides/reference/backend_api/get-spans-of-trace.mdx b/docs/reference/reference/backend_api/get-spans-of-trace.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/get-spans-of-trace.mdx
rename to docs/reference/reference/backend_api/get-spans-of-trace.mdx
diff --git a/docs/developer_guides/reference/backend_api/get-trace.mdx b/docs/reference/reference/backend_api/get-trace.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/get-trace.mdx
rename to docs/reference/reference/backend_api/get-trace.mdx
diff --git a/docs/developer_guides/reference/backend_api/get-traces.mdx b/docs/reference/reference/backend_api/get-traces.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/get-traces.mdx
rename to docs/reference/reference/backend_api/get-traces.mdx
diff --git a/docs/developer_guides/reference/backend_api/get-user-organization.mdx b/docs/reference/reference/backend_api/get-user-organization.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/get-user-organization.mdx
rename to docs/reference/reference/backend_api/get-user-organization.mdx
diff --git a/docs/developer_guides/reference/backend_api/get-variant-by-env.mdx b/docs/reference/reference/backend_api/get-variant-by-env.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/get-variant-by-env.mdx
rename to docs/reference/reference/backend_api/get-variant-by-env.mdx
diff --git a/docs/developer_guides/reference/backend_api/import-testset.mdx b/docs/reference/reference/backend_api/import-testset.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/import-testset.mdx
rename to docs/reference/reference/backend_api/import-testset.mdx
diff --git a/docs/developer_guides/reference/backend_api/list-app-variants.mdx b/docs/reference/reference/backend_api/list-app-variants.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/list-app-variants.mdx
rename to docs/reference/reference/backend_api/list-app-variants.mdx
diff --git a/docs/developer_guides/reference/backend_api/list-apps.mdx b/docs/reference/reference/backend_api/list-apps.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/list-apps.mdx
rename to docs/reference/reference/backend_api/list-apps.mdx
diff --git a/docs/developer_guides/reference/backend_api/list-bases.mdx b/docs/reference/reference/backend_api/list-bases.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/list-bases.mdx
rename to docs/reference/reference/backend_api/list-bases.mdx
diff --git a/docs/developer_guides/reference/backend_api/list-custom-evaluations.mdx b/docs/reference/reference/backend_api/list-custom-evaluations.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/list-custom-evaluations.mdx
rename to docs/reference/reference/backend_api/list-custom-evaluations.mdx
diff --git a/docs/developer_guides/reference/backend_api/list-environments.mdx b/docs/reference/reference/backend_api/list-environments.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/list-environments.mdx
rename to docs/reference/reference/backend_api/list-environments.mdx
diff --git a/docs/developer_guides/reference/backend_api/list-organizations.mdx b/docs/reference/reference/backend_api/list-organizations.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/list-organizations.mdx
rename to docs/reference/reference/backend_api/list-organizations.mdx
diff --git a/docs/developer_guides/reference/backend_api/openapi.json b/docs/reference/reference/backend_api/openapi.json
similarity index 100%
rename from docs/developer_guides/reference/backend_api/openapi.json
rename to docs/reference/reference/backend_api/openapi.json
diff --git a/docs/developer_guides/reference/backend_api/remove-app.mdx b/docs/reference/reference/backend_api/remove-app.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/remove-app.mdx
rename to docs/reference/reference/backend_api/remove-app.mdx
diff --git a/docs/developer_guides/reference/backend_api/remove-variant.mdx b/docs/reference/reference/backend_api/remove-variant.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/remove-variant.mdx
rename to docs/reference/reference/backend_api/remove-variant.mdx
diff --git a/docs/developer_guides/reference/backend_api/restart-docker-container.mdx b/docs/reference/reference/backend_api/restart-docker-container.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/restart-docker-container.mdx
rename to docs/reference/reference/backend_api/restart-docker-container.mdx
diff --git a/docs/developer_guides/reference/backend_api/save-config.mdx b/docs/reference/reference/backend_api/save-config.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/save-config.mdx
rename to docs/reference/reference/backend_api/save-config.mdx
diff --git a/docs/developer_guides/reference/backend_api/start-variant.mdx b/docs/reference/reference/backend_api/start-variant.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/start-variant.mdx
rename to docs/reference/reference/backend_api/start-variant.mdx
diff --git a/docs/developer_guides/reference/backend_api/testsets/get-testset.mdx b/docs/reference/reference/backend_api/testsets/get-testset.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/testsets/get-testset.mdx
rename to docs/reference/reference/backend_api/testsets/get-testset.mdx
diff --git a/docs/developer_guides/reference/backend_api/testsets/get-testsets.mdx b/docs/reference/reference/backend_api/testsets/get-testsets.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/testsets/get-testsets.mdx
rename to docs/reference/reference/backend_api/testsets/get-testsets.mdx
diff --git a/docs/developer_guides/reference/backend_api/update-custom-evaluation.mdx b/docs/reference/reference/backend_api/update-custom-evaluation.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/update-custom-evaluation.mdx
rename to docs/reference/reference/backend_api/update-custom-evaluation.mdx
diff --git a/docs/developer_guides/reference/backend_api/update-evaluation-router.mdx b/docs/reference/reference/backend_api/update-evaluation-router.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/update-evaluation-router.mdx
rename to docs/reference/reference/backend_api/update-evaluation-router.mdx
diff --git a/docs/developer_guides/reference/backend_api/update-evaluation-scenario-router.mdx b/docs/reference/reference/backend_api/update-evaluation-scenario-router.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/update-evaluation-scenario-router.mdx
rename to docs/reference/reference/backend_api/update-evaluation-scenario-router.mdx
diff --git a/docs/developer_guides/reference/backend_api/update-evaluation-scenario-score-router.mdx b/docs/reference/reference/backend_api/update-evaluation-scenario-score-router.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/update-evaluation-scenario-score-router.mdx
rename to docs/reference/reference/backend_api/update-evaluation-scenario-score-router.mdx
diff --git a/docs/developer_guides/reference/backend_api/update-feedback.mdx b/docs/reference/reference/backend_api/update-feedback.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/update-feedback.mdx
rename to docs/reference/reference/backend_api/update-feedback.mdx
diff --git a/docs/developer_guides/reference/backend_api/update-testset.mdx b/docs/reference/reference/backend_api/update-testset.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/update-testset.mdx
rename to docs/reference/reference/backend_api/update-testset.mdx
diff --git a/docs/developer_guides/reference/backend_api/update-trace-status.mdx b/docs/reference/reference/backend_api/update-trace-status.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/update-trace-status.mdx
rename to docs/reference/reference/backend_api/update-trace-status.mdx
diff --git a/docs/developer_guides/reference/backend_api/update-variant-image.mdx b/docs/reference/reference/backend_api/update-variant-image.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/update-variant-image.mdx
rename to docs/reference/reference/backend_api/update-variant-image.mdx
diff --git a/docs/developer_guides/reference/backend_api/update-variant-parameters.mdx b/docs/reference/reference/backend_api/update-variant-parameters.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/update-variant-parameters.mdx
rename to docs/reference/reference/backend_api/update-variant-parameters.mdx
diff --git a/docs/developer_guides/reference/backend_api/upload-file.mdx b/docs/reference/reference/backend_api/upload-file.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/upload-file.mdx
rename to docs/reference/reference/backend_api/upload-file.mdx
diff --git a/docs/developer_guides/reference/backend_api/user-profile.mdx b/docs/reference/reference/backend_api/user-profile.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/user-profile.mdx
rename to docs/reference/reference/backend_api/user-profile.mdx
diff --git a/docs/developer_guides/reference/backend_api/webhook-example-fake.mdx b/docs/reference/reference/backend_api/webhook-example-fake.mdx
similarity index 100%
rename from docs/developer_guides/reference/backend_api/webhook-example-fake.mdx
rename to docs/reference/reference/backend_api/webhook-example-fake.mdx
diff --git a/docs/developer_guides/sdk/config_datatypes.mdx b/docs/reference/sdk/config_datatypes.mdx
similarity index 100%
rename from docs/developer_guides/sdk/config_datatypes.mdx
rename to docs/reference/sdk/config_datatypes.mdx
diff --git a/docs/developer_guides/sdk/config_default.mdx b/docs/reference/sdk/config_default.mdx
similarity index 100%
rename from docs/developer_guides/sdk/config_default.mdx
rename to docs/reference/sdk/config_default.mdx
diff --git a/docs/developer_guides/sdk/config_object.mdx b/docs/reference/sdk/config_object.mdx
similarity index 100%
rename from docs/developer_guides/sdk/config_object.mdx
rename to docs/reference/sdk/config_object.mdx
diff --git a/docs/developer_guides/sdk/config_pull.mdx b/docs/reference/sdk/config_pull.mdx
similarity index 100%
rename from docs/developer_guides/sdk/config_pull.mdx
rename to docs/reference/sdk/config_pull.mdx
diff --git a/docs/developer_guides/sdk/config_push.mdx b/docs/reference/sdk/config_push.mdx
similarity index 100%
rename from docs/developer_guides/sdk/config_push.mdx
rename to docs/reference/sdk/config_push.mdx
diff --git a/docs/developer_guides/sdk/init.mdx b/docs/reference/sdk/init.mdx
similarity index 100%
rename from docs/developer_guides/sdk/init.mdx
rename to docs/reference/sdk/init.mdx
diff --git a/docs/developer_guides/sdk/quick_start.mdx b/docs/reference/sdk/quick_start.mdx
similarity index 100%
rename from docs/developer_guides/sdk/quick_start.mdx
rename to docs/reference/sdk/quick_start.mdx
diff --git a/docs/self-host/host-locally.mdx b/docs/self-host/host-locally.mdx
index 208eedeb93..dcd092b6b4 100644
--- a/docs/self-host/host-locally.mdx
+++ b/docs/self-host/host-locally.mdx
@@ -50,6 +50,6 @@ Open your browser and go to [http://localhost](http://localhost). If you see the
## What's next?
You're all set to start using Agenta!
-
+
Click here to build your first LLM app in just 1 minute.
+
+ 
