You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
topic (docs): [general] rebrand Azure AI Agent service to Azure AI Foundry Agent Service (#50)
* rebrand Azure AI Agent service to Azure AI Foundry Agent Service
* fix: include bicep files
* Address PR Feedback: shorten texts and caps fixes
Co-authored-by: Chad Kittel <[email protected]>
---------
Co-authored-by: Chad Kittel <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+12-12Lines changed: 12 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -1,30 +1,30 @@
1
-
# Azure OpenAI and AI Agent service chat basic reference implementation
1
+
# Azure AI Foundry Agent service chat basic reference implementation
2
2
3
-
This reference implementation illustrates an approach running a chat application and an AI orchestration layer in a single region. It uses Azure AI Agent service as the orchestrator and Azure OpenAI foundation models. This repository directly supports the [Basic end-to-end chat reference architecture](https://learn.microsoft.com/azure/architecture/ai-ml/architecture/basic-openai-e2e-chat) on Microsoft Learn.
3
+
This reference implementation illustrates an approach running a chat application and an AI orchestration layer in a single region. It uses Azure AI Foundry Agent service as the orchestrator and Azure OpenAI foundation models. This repository directly supports the [Basic end-to-end chat reference architecture](https://learn.microsoft.com/azure/architecture/ai-ml/architecture/basic-openai-e2e-chat) on Microsoft Learn.
4
4
5
-
The reference implementation illustrates a basic example of a chat application. For a reference implementation that implements more enterprise requirements, please see the [OpenAI end-to-end baseline reference implementation](https://github.com/Azure-Samples/openai-end-to-end-baseline). That implementation addresses many of the [production readiness changes](https://github.com/search?q=repo%3AAzure-Samples%2Fopenai-end-to-end-basic+%22Production+readiness+change%22&type=code) identified in this code.
5
+
The reference implementation illustrates a basic example of a chat application. For a reference implementation that implements more enterprise requirements, please see the [Azure AI Foundry Agent service end-to-end baseline reference implementation](https://github.com/Azure-Samples/openai-end-to-end-baseline). That implementation addresses many of the [production readiness changes](https://github.com/search?q=repo%3AAzure-Samples%2Fopenai-end-to-end-basic+%22Production+readiness+change%22&type=code) identified in this code.
6
6
7
7
## Architecture
8
8
9
9
The implementation covers the following scenarios:
10
10
11
11
-[Setting up Azure AI Foundry to host agents](#setting-up-azure-ai-foundry-to-host-agents)
12
-
-[Deploying an agent into Azure AI Agent service](#deploying-an-agent-into-azure-ai-agent-service)
12
+
-[Deploying an agent into Azure AI Foundry Agent service](#deploying-an-agent-into-azure-ai-agent-service)
13
13
-[Invoking the agent from .NET code hosted in an Azure Web App](#invoking-the-agent-from-net-code-hosted-in-an-azure-web-app)
14
14
15
15
### Setting up Azure AI Foundry to host agents
16
16
17
-
Azure AI Foundry hosts Azure AI Agent service as a capability. Azure AI Agent service's REST APIs are exposed as a AI Foundry internet facing endpoing. This architecture deploys the Azure AI Agent service your own Azure subscription.
17
+
Azure AI Foundry hosts Azure AI Foundry Agent service as a capability. Foundry Agent Service's REST APIs are exposed as an internet facing endpoint.
18
18
19
-
### Deploying an agent into Azure AI Agent service
19
+
### Deploying an agent into Azure AI Foundry Agent service
20
20
21
-
Agents can be created via the Azure AI Foundry portal, [Azure AI Agents SDK](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/ai/Azure.AI.Agents.Persistent), or the [REST API](https://learn.microsoft.com/rest/api/aifoundry/aiagents/). The creation and invocation of agents are a data plane operation.
21
+
Agents can be created via the Azure AI Foundry portal, [Azure AI Persistent Agents client library](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/ai/Azure.AI.Agents.Persistent), or the [REST API](https://learn.microsoft.com/rest/api/aifoundry/aiagents/). The creation and invocation of agents are a data plane operation.
22
22
23
23
Ideally agents should be source-controlled and a versioned asset. You then can deploy agents in a coordinated way with the rest of your workload's code. In this deployment guide, you'll create an agent through the REST API to simulate a deployment pipeline which could have created the agent.
24
24
25
25
### Invoking the agent from .NET code hosted in an Azure Web App
26
26
27
-
A chat UI application is deployed into Azure App Service. The .NET code uses the [Azure AI Agents SDK](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/ai/Azure.AI.Agents.Persistent) to connect to the workload's agent. The endpoint for the agent is exposed over internet through the Azure AI Foundry.
27
+
A chat UI application is deployed into Azure App Service. The .NET code uses the [Azure AI Persistent Agents client library](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/ai/Azure.AI.Agents.Persistent) to connect to the workload's agent. The endpoint for the agent is exposed over internet through the Azure AI Foundry.
28
28
29
29
## Deployment guide
30
30
@@ -105,7 +105,7 @@ The following steps are required to deploy the infrastructure from the command l
105
105
-p yourPrincipalId=$PRINCIPAL_ID
106
106
```
107
107
108
-
### 2. Deploy an agent in the Azure AI Agent service
108
+
### 2. Deploy an agent in the Azure AI Foundry Agent service
109
109
110
110
To test this scenario, you'll be deploying an AI agent. The agent uses a GPT model combined with a Bing search for grounding data. Deploying an AI agent requires data plane access to Azure AI Foundry. In this architecture, you will interact with the Azure AI Foundry portal and its resources over internet.
111
111
@@ -123,7 +123,7 @@ To test this scenario, you'll be deploying an AI agent. The agent uses a GPT mod
123
123
124
124
1. Click **+ Add** button in the Knowledge section.
125
125
126
-
1. From the popup window select the knowledge type 'Grounding with Bing Search'.
126
+
1. From the popup window select the knowledge type 'Grounding with Bing Search'.
127
127
128
128
1. Then choose the existing connection named 'bingaiagent' and click the **Connect** button.
129
129
@@ -177,7 +177,7 @@ Workloads build chat functionality into an application. Those interfaces usually
177
177
178
178
> Sometimes the prior command will fail with a `GatewayTimeout`. If you receive that error, you're safe to simply execute the command again.
179
179
180
-
### 5. Try it out! Test the deployed application that calls into the Azure AI Agent service
180
+
### 5. Try it out! Test the deployed application that calls into the Azure AI Foundry Agent service
181
181
182
182
After the deployment is complete, you can try the deployed application by navigating to the Web App's URL in a web browser.
183
183
@@ -209,4 +209,4 @@ Please see our [Contributor guide](./CONTRIBUTING.md).
209
209
210
210
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact <[email protected]> with any additional questions or comments.
211
211
212
-
With :heart: from Azure Patterns & Practices, [Azure Architecture Center](https://azure.com/architecture).
212
+
With :heart: from Azure Patterns & Practices, [Azure Architecture Center](https://azure.com/architecture).
@description('The name of the existing Azure AI Foundry instance that the the Azure Web App code will be calling for Azure AI Agent Service agents.')
24
+
@description('The name of the existing Azure AI Foundry instance that the Azure Web App code will be calling for Foundry Agent Service agents.')
25
25
@minLength(2)
26
26
paramexistingAzureAiFoundryResourceNamestring
27
27
@@ -49,7 +49,7 @@ resource azureAiUserRole 'Microsoft.Authorization/roleDefinitions@2022-04-01' ex
49
49
scope: subscription()
50
50
}
51
51
52
-
@description('Existing Azure AI Foundry account. This account is where the agents hosted in Azure AI Agent Service will be deployed. The web app code calls to these agents.')
52
+
@description('Existing Azure AI Foundry account. This account is where the agents hosted in Foundry Agent Service will be deployed. The web app code calls to these agents.')
0 commit comments