microsoft--promptflow/examples/flex-flows/README.md

Flex Flow

You can learn more on flex flow with examples in this folder.

SDK examples

path	status	description
flex-flow-quickstart.ipynb		A quickstart tutorial to run a flex flow and evaluate it.
flex-flow-quickstart-azure.ipynb		A quickstart tutorial to run a flex flow and evaluate it in azure.
chat-with-class-based-flow-azure.ipynb		A quickstart tutorial to run a class based flex flow and evaluate it in azure.
chat-with-class-based-flow.ipynb		A quickstart tutorial to run a class based flex flow and evaluate it.
chat-stream-with-flex-flow.ipynb		A quickstart tutorial to run a class based flex flow in stream mode and evaluate it.
chat-stream-with-async-flex-flow.ipynb		A quickstart tutorial to run a class based flex flow in stream mode and evaluate it.
langchain-eval.ipynb		A tutorial to converting LangChain criteria evaluator application to flex flow.

CLI examples

path	status	description
basic		A basic standard flow define using function entry that calls Azure OpenAI with connection info stored in environment variables
chat-async-stream		A chat flow defined using async class entry that return output in stream mode
chat-basic		A basic chat flow defined using class entry
chat-minimal		A chat flow defined using function with minimal code
chat-stream		A chat flow defined using class entry that return output in stream mode
chat-with-functions		This flow covers how to use the LLM chat API in combination with external functions to extend the capabilities of GPT models
eval-checklist		A example flow defined using class entry which demos how to evaluate the answer pass user specified check list
eval-code-quality		A example flow defined using class based entry which leverages model config to evaluate the quality of code snippet
eval-criteria-with-langchain		A example flow of converting LangChain criteria evaluator application to flex flow