wehub-resource-sync
e768098d0e
tools_continuous_delivery / Private PyPI non-main branch release (push) Has been skipped
tools_continuous_delivery / Private PyPI main branch release (push) Failing after 2m42s
Publish Promptflow Doc / Build (push) Has been cancelled
Publish Promptflow Doc / Deploy (push) Has been cancelled
Flake8 Lint / flake8 (push) Has been cancelled
Spell check CI / Spell_Check (push) Has been cancelled
112 lines
4.6 KiB
Markdown
112 lines
4.6 KiB
Markdown
---
|
|
myst:
|
|
html_meta:
|
|
"description lang=en": "Prompt flow Doc"
|
|
"google-site-verification": "rEZN-2h5TVqEco07aaMpqNcDx4bjr2czx1Hwfoxydrg"
|
|
html_theme.sidebar_secondary.remove: true
|
|
---
|
|
|
|
:::{admonition} Prompt Flow Retirement Notice
|
|
:class: warning
|
|
Prompt Flow feature development ended on April 20, 2026. The feature will be fully retired on April 20, 2027. On the retirement date, Prompt Flow enters read-only mode. Your existing flows will continue to operate until that date.
|
|
|
|
**Recommended action:** [Migrate your Prompt Flow workloads to Microsoft Agent Framework](https://github.com/microsoft/promptflow/tree/main/migration-guide/PromptFlow-to-MAF) before April 20, 2027.
|
|
:::
|
|
|
|
# Prompt flow
|
|
|
|
[**Prompt flow**](https://github.com/microsoft/promptflow) is a suite of development tools designed to streamline the end-to-end development cycle of LLM-based AI applications, from ideation, prototyping, testing, evaluation to production deployment and monitoring. It makes prompt engineering much easier and enables you to build LLM apps with production quality.
|
|
|
|
With prompt flow, you will be able to:
|
|
|
|
- **Create [flows](./concepts/concept-flows.md)** that link [LLMs](./reference/tools-reference/llm-tool.md), [prompts](./reference/tools-reference/prompt-tool.md), [Python](./reference/tools-reference/python-tool.md) code and other [tools](./concepts/concept-tools.md) together in a executable workflow.
|
|
- **Debug and iterate your flows**, especially [tracing interaction with LLMs](how-to-guides/tracing/index.md) with ease.
|
|
- **Evaluate your flows**, calculate quality and performance metrics with larger datasets.
|
|
- **Integrate the testing and evaluation into your CI/CD system** to ensure quality of your flow.
|
|
- **Deploy your flows** to the serving platform you choose or integrate into your app's code base easily.
|
|
- (Optional but highly recommended) **Collaborate with your team** by leveraging the cloud version of [Prompt flow in Azure AI](https://learn.microsoft.com/en-us/azure/machine-learning/prompt-flow/overview-what-is-prompt-flow?view=azureml-api-2).
|
|
|
|
> Welcome to join us to make prompt flow better by
|
|
> participating [discussions](https://github.com/microsoft/promptflow/discussions),
|
|
> opening [issues](https://github.com/microsoft/promptflow/issues/new/choose),
|
|
> submitting [PRs](https://github.com/microsoft/promptflow/pulls).
|
|
|
|
This documentation site contains guides for prompt flow [sdk, cli](https://pypi.org/project/promptflow/) and [vscode extension](https://marketplace.visualstudio.com/items?itemName=prompt-flow.prompt-flow) users.
|
|
|
|
```{gallery-grid}
|
|
:grid-columns: 1 2 2 2
|
|
- header: "🚀 Quick Start"
|
|
content: "
|
|
Quick start and end-to-end tutorials.<br/><br/>
|
|
- [Getting started with prompt flow](how-to-guides/quick-start.md)<br/>
|
|
- [E2E development tutorial: chat with PDF](https://github.com/microsoft/promptflow/blob/main/examples/tutorials/e2e-development/chat-with-pdf.md)<br/>
|
|
- Find more: [tutorials & samples](tutorials/index.md)<br/>
|
|
"
|
|
|
|
- header: "📒 How-to Guides"
|
|
content: "
|
|
Articles guide user to complete a specific task in prompt flow.<br/><br/>
|
|
- [Tracing](how-to-guides/tracing/index.md)<br/>
|
|
- [Develop a flow](how-to-guides/develop-a-flex-flow/index.md)<br/>
|
|
- [Run and evaluate a flow](how-to-guides/run-and-evaluate-a-flow/index.md)<br/>
|
|
- [Deploy a flow](how-to-guides/deploy-a-flow/index.md)<br/>
|
|
"
|
|
```
|
|
|
|
```{gallery-grid}
|
|
:grid-columns: 1 2 2 2
|
|
- header: "📑 Concepts"
|
|
content: "
|
|
Introduction of key concepts of prompt flow.<br/><br/>
|
|
- [Flows](concepts/concept-flows.md)<br/>
|
|
- [Tools](concepts/concept-tools.md)<br/>
|
|
- [Connections](concepts/concept-connections.md)<br/>
|
|
- [Design principles](concepts/design-principles.md)<br/>
|
|
"
|
|
|
|
|
|
- header: "🔍 Reference"
|
|
content: "
|
|
Reference provides technical information about prompt flow API.<br/><br/>
|
|
- Command line Interface reference: [pf](reference/pf-command-reference.md)<br/>
|
|
- Python library reference: [promptflow](reference/python-library-reference/promptflow-core/promptflow.rst)<br/>
|
|
- Tool reference: [LLM Tool](reference/tools-reference/llm-tool.md), [Python Tool](reference/tools-reference/python-tool.md), [Prompt Tool](reference/tools-reference/prompt-tool.md)<br/>
|
|
- ChangeLog: [ChangeLog](reference/changelog/promptflow.md)<br/>
|
|
"
|
|
```
|
|
|
|
```{toctree}
|
|
:hidden:
|
|
:maxdepth: 1
|
|
how-to-guides/index
|
|
```
|
|
|
|
```{toctree}
|
|
:hidden:
|
|
:maxdepth: 1
|
|
tutorials/index
|
|
```
|
|
|
|
```{toctree}
|
|
:hidden:
|
|
:maxdepth: 2
|
|
concepts/index
|
|
```
|
|
|
|
```{toctree}
|
|
:hidden:
|
|
:maxdepth: 1
|
|
reference/index
|
|
```
|
|
|
|
```{toctree}
|
|
:hidden:
|
|
:maxdepth: 1
|
|
cloud/index
|
|
```
|
|
|
|
```{toctree}
|
|
:hidden:
|
|
:maxdepth: 1
|
|
integrations/index
|
|
``` |