Skip to content

Commit 491ff23

Browse files
Merge pull request #686 from markwallace-microsoft/users/markwallace/fix_nightly_builds_instructions
Update the instructions to get the nightly builds to use the new package name and version
2 parents e92be8c + 279ed88 commit 491ff23

1 file changed

Lines changed: 11 additions & 7 deletions

File tree

agent-framework/tutorials/quick-start.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,22 @@ Before you begin, ensure you have the following:
3030
**Note**: This demo uses Azure CLI credentials for authentication. Make sure you're logged in with `az login` and have access to the Azure OpenAI resource. For more information, see the [Azure CLI documentation](/cli/azure/authenticate-azure-cli-interactively). It is also possible to replace the `AzureCliCredential` with an `ApiKeyCredential` if you
3131
have an api key and do not wish to use role based authentication, in which case `az login` is not required.
3232

33-
## Running a Basic Agent Sample
33+
## Installing Packages
3434

35-
This sample demonstrates how to create and use a simple AI agent with Azure OpenAI Chat Completion as the backend. It will create a basic agent using `AzureOpenAIClient` with `gpt-4o-mini` and custom instructions.
35+
Packages will be published to [NuGet Gallery | Microsoft.Agent.AI](https://www.nuget.org/packages/Microsoft.Agent.AI).
3636

37-
First, install the following nuget packages into your application.
37+
First, add the following Microsoft Agent Framework NuGet packages into your application, using the following commands:
3838

3939
```powershell
4040
dotnet add package Azure.AI.OpenAI
4141
dotnet add package Azure.Identity
4242
dotnet add package Microsoft.Agents.AI.OpenAI
4343
```
4444

45+
## Running a Basic Agent Sample
46+
47+
This sample demonstrates how to create and use a simple AI agent with Azure OpenAI Chat Completion as the backend. It will create a basic agent using `AzureOpenAIClient` with `gpt-4o-mini` and custom instructions.
48+
4549
### Sample Code
4650

4751
Make sure to replace `https://your-resource.openai.azure.com/` with the endpoint of your Azure OpenAI resource.
@@ -62,10 +66,9 @@ AIAgent agent = new AzureOpenAIClient(
6266
Console.WriteLine(await agent.RunAsync("Tell me a joke about a pirate."));
6367
```
6468

65-
## (Optional) Installing Packages
69+
## (Optional) Installing Nightly Packages
6670

67-
Packages will be published to [NuGet](https://www.nuget.org/) when the Agent Framework public preview is released.
68-
In the meantime nightly builds of the Agent Framework are available [here](https://github.com/orgs/microsoft/packages?repo_name=agent-framework).
71+
If you need to get a package containing the latest enhancements or fixes nightly builds of the Agent Framework are available [here](https://github.com/orgs/microsoft/packages?repo_name=agent-framework).
6972

7073
To download nightly builds follow the following steps:
7174

@@ -95,6 +98,7 @@ To download nightly builds follow the following steps:
9598
</packageSource>
9699
<packageSource key="github">
97100
<package pattern="*nightly"/>
101+
<package pattern="Microsoft.Agents.AI" />
98102
</packageSource>
99103
</packageSourceMapping>
100104
@@ -110,7 +114,7 @@ To download nightly builds follow the following steps:
110114
* If you place this file in your project folder make sure to have Git (or whatever source control you use) ignore it.
111115
* For more information on where to store this file go [here](/nuget/reference/nuget-config-file).
112116
1. You can now add packages from the nightly build to your project.
113-
* E.g. use this command `dotnet add package Microsoft.Agents.AI --version 0.0.1-nightly-250731.6-alpha`
117+
* E.g. use this command `dotnet add package Microsoft.Agents.AI`
114118
1. And the latest package release can be referenced in the project like this:
115119
* `<PackageReference Include="Microsoft.Agents.AI" Version="*-*" />`
116120

0 commit comments

Comments
 (0)