Streaming chat completion
The Streaming chat completion action streams the response from an Azure OpenAI chat model one message at a time, until the response is complete.
You will typically use this action to build backends for chat clients.
Example
The example above shows a Flow that provides chat completions to a chat client. We're using PostgreSQL vector search to enable RAG, and SQL Server to store and retrieve the chat history so that users can ask follow-up questions.
Properties
Name | Type | Description |
---|---|---|
Title | Optional | The title of the action. |
Connection | Required | Defines the connection to Azure OpenAI. |
Deployment Name | Required | Specifies the model deployment name, which corresponds to the custom name chosen during model deployment in the Azure portal or in Azure AI Foundry (see below). In the Azure Portal, the deployment name can be found under Resource Management > Model Deployments. |
User Prompt | Required | The input message from the user, which the model processes to generate a response. |
System Prompt | Optional | A system-level instruction that guides the model’s behavior and response style. |
History | Optional | A record of past interactions that provides context to the conversation, helping the model maintain continuity. |
Context | Optional | Typically used for RAG, and provides additional information or domain-specific knowledge to the chat model so it can make more accurate responses. The input can be a string (text) or a vector search result, such as the result from the PostgreSQL Vector Search action. |
Temperature | Optional | Temperature in models controls the randomness and creativity of the generated responses. Lower temperatures (e.g., 0.2) produce more focused, predictable text, ideal for tasks that require precision. Higher temperatures (e.g., 1.5) increase creativity and variability, but may risk generating less coherent or relevant content, making it important to adjust based on your desired outcome. The default is 0.7 if nothing is defined by the user. |
Max Completion Tokens | Optional | Sets a limit on the number of tokens (words, characters, or pieces of text) in the model’s response. |
Result Variable Name | Optional | Stores the generated AI response. Default: "response". |
Description | Optional | Additional details or notes regarding the chat completion setup. |
Deployment name
To find the Deployment name, look in the Deployments
screen in Azure AI Foundry.