diff --git a/docs/docs/prompt-management/01-overview.mdx b/docs/docs/prompt-management/01-overview.mdx index c67dc6cfd3..bc112418ce 100644 --- a/docs/docs/prompt-management/01-overview.mdx +++ b/docs/docs/prompt-management/01-overview.mdx @@ -13,8 +13,10 @@ import clsx from 'clsx'; Building LLM-powered applications is an iterative process. In each iteration, you aim to improve the application's performance by refining prompts, adjusting configurations, and evaluating outputs. Illustration of the LLMOPs process A prompt management system provides you the tools to do this process systematically by: diff --git a/docs/docs/prompt-management/07-concepts.mdx b/docs/docs/prompt-management/07-concepts.mdx index 7e4b273297..13e994ec6e 100644 --- a/docs/docs/prompt-management/07-concepts.mdx +++ b/docs/docs/prompt-management/07-concepts.mdx @@ -5,8 +5,10 @@ title: "Core Concepts" Below are the description to the main terms and concepts used in agenta. Taxonomy of concepts in Agenta ### Templates @@ -22,7 +24,7 @@ Agenta also allows you to create custom templates for your workflows using our S - Chains of Multiple Prompts - Agents Interacting with External APIs -After creating a template, you can interact with it in the playground, run no-code evaluations, and publish versions all from the webUI. +After creating a template, you can interact with it in the playground, run no-code evaluations, and deploy versions all from the web UI. ### Applications @@ -43,16 +45,18 @@ Within each application, you can create **variants**. **Variants** are different Every **variant** is **versioned** and immutable. When you make changes to a **variant**, a new **version** is created. Each **version** has a **commit id** that uniquely identifies it. -### Endpoints +### Environments -**Endpoints** are the interfaces where your published variants are accessible. You can publish a **version** of a **variant** to an **endpoint**. Each **endpoint** has a user-defined environment name (e.g. development, staging, production) that specifies its context or stage. +**Environments** are the interfaces where your deployed variants are accessible. You can deploy a **version** of a **variant** to an **environment**. Each **environment** has a user-defined environment name (e.g. development, staging, production) that specifies its context or stage. -You can then integrate the **endpoint** into your codebase to fetch the configuration published on that **endpoint**. Additionally, you can directly call the **endpoint** containing the application running with that configuration. +You can then integrate the **environment** into your codebase to fetch the configuration deployed on that **environment**. Additionally, you can directly invoke the endpoints relating to the **environment** containing the application running with that configuration. -By default, applications come with three predefined environment names for **endpoints**: +By default, applications come with three predefined **environments**: - **Development:** For initial testing and experimentation. - **Staging:** For pre-production testing and quality assurance. - **Production:** For live use with real users. -When publishing a **variant** to an **endpoint**, the latest **version** of that **variant** gets published. Each **endpoint** points to a specific **version** of a **variant** (a certain **commit**). Updating the **variant** after publishing does not automatically update the **endpoint**. +:::warning +When deploying a **variant** to an **environment**, the latest **version** of that **variant** gets deployed. Each **environment** points to a specific **version** of a **variant** (a certain **commit**). Updating the **variant** after deploying does not automatically update the **environment**. +::: diff --git a/docs/static/images/prompt_management/illustration-llmops.png b/docs/static/images/prompt_management/illustration-llmops.png new file mode 100644 index 0000000000..58ab72cc3f Binary files /dev/null and b/docs/static/images/prompt_management/illustration-llmops.png differ diff --git a/docs/static/images/prompt_management/llm_lifecycle.png b/docs/static/images/prompt_management/llm_lifecycle.png deleted file mode 100644 index 0316057bb0..0000000000 Binary files a/docs/static/images/prompt_management/llm_lifecycle.png and /dev/null differ diff --git a/docs/static/images/prompt_management/taxonomy-concepts.png b/docs/static/images/prompt_management/taxonomy-concepts.png new file mode 100644 index 0000000000..082535ffed Binary files /dev/null and b/docs/static/images/prompt_management/taxonomy-concepts.png differ