-
Notifications
You must be signed in to change notification settings - Fork 4.6k
.Net: fix up the links so they point to the right spot #12517
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
srini85
wants to merge
3
commits into
microsoft:main
Choose a base branch
from
srini85:fix_doco_links
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+75
−75
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -1,6 +1,6 @@ | ||||||||
| # Semantic Kernel Agents - Getting Started | ||||||||
|
|
||||||||
| This project contains a step by step guide to get started with _Semantic Kernel Agents_. | ||||||||
| This project contains a step by step guide to get started with _Semantic Kernel Agents_. | ||||||||
|
|
||||||||
| ## NuGet | ||||||||
|
|
||||||||
|
|
@@ -20,69 +20,69 @@ The getting started with agents examples include: | |||||||
|
|
||||||||
| ### ChatCompletion | ||||||||
|
|
||||||||
| Example|Description | ||||||||
| ---|--- | ||||||||
| [Step01_Agent](./dotnet/samples/GettingStartedWithAgents/Step01_Agent.cs)|How to create and use an agent. | ||||||||
| [Step02_Plugins](./dotnet/samples/GettingStartedWithAgents/Step02_Plugins.cs)|How to associate plug-ins with an agent. | ||||||||
| [Step03_Chat](./dotnet/samples/GettingStartedWithAgents/Step03_Chat.cs)|How to create a conversation between agents. | ||||||||
| [Step04_KernelFunctionStrategies](./dotnet/samples/GettingStartedWithAgents/Step04_KernelFunctionStrategies.cs)|How to utilize a `KernelFunction` as a _chat strategy_. | ||||||||
| [Step05_JsonResult](./dotnet/samples/GettingStartedWithAgents/Step05_JsonResult.cs)|How to have an agent produce JSON. | ||||||||
| [Step06_DependencyInjection](./dotnet/samples/GettingStartedWithAgents/Step06_DependencyInjection.cs)|How to define dependency injection patterns for agents. | ||||||||
| [Step07_Telemetry](./dotnet/samples/GettingStartedWithAgents/Step07_Telemetry.cs)|How to enable logging for agents. | ||||||||
| | Example | Description | | ||||||||
| | --------------------------------------------------------------------- | ------------------------------------------------------- | | ||||||||
| | [Step01_Agent](Step01_Agent.cs) | How to create and use an agent. | | ||||||||
| | [Step02_Plugins](Step02_Plugins.cs) | How to associate plug-ins with an agent. | | ||||||||
| | [Step03_Chat](Step03_Chat.cs) | How to create a conversation between agents. | | ||||||||
| | [Step04_KernelFunctionStrategies](Step04_KernelFunctionStrategies.cs) | How to utilize a `KernelFunction` as a _chat strategy_. | | ||||||||
| | [Step05_JsonResult](Step05_JsonResult.cs) | How to have an agent produce JSON. | | ||||||||
| | [Step06_DependencyInjection](Step06_DependencyInjection.cs) | How to define dependency injection patterns for agents. | | ||||||||
| | [Step07_Telemetry](Step07_Telemetry.cs) | How to enable logging for agents. | | ||||||||
|
|
||||||||
| ### Open AI Assistant | ||||||||
|
|
||||||||
| Example|Description | ||||||||
| ---|--- | ||||||||
| [Step01_Assistant](./dotnet/samples/GettingStartedWithAgents/OpenAIAssistant/Step01_Assistant.cs)|How to create an Open AI Assistant agent. | ||||||||
| [Step02_Assistant_Plugins](./dotnet/samples/GettingStartedWithAgents/OpenAIAssistant/Step02_Assistant_Plugins.cs)|How to associate plug-ins with an Open AI Assistant agent. | ||||||||
| [Step03_Assistant_Vision](./dotnet/samples/GettingStartedWithAgents/OpenAIAssistant/Step03_Assistant_Vision.cs)|How to provide an image as input to an Open AI Assistant agent. | ||||||||
| [Step04_AssistantTool_CodeInterpreter_](./dotnet/samples/GettingStartedWithAgents/OpenAIAssistant/Step04_AssistantTool_CodeInterpreter.cs)|How to use the code-interpreter tool for an Open AI Assistant agent. | ||||||||
| [Step05_AssistantTool_FileSearch](./dotnet/samples/GettingStartedWithAgents/OpenAIAssistant/Step05_AssistantTool_FileSearch.cs)|How to use the file-search tool for an Open AI Assistant agent. | ||||||||
| | Example | Description | | ||||||||
| | ----------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | | ||||||||
| | [Step01_Assistant](OpenAIAssistant/Step01_Assistant.cs) | How to create an Open AI Assistant agent. | | ||||||||
| | [Step02_Assistant_Plugins](OpenAIAssistant/Step02_Assistant_Plugins.cs) | How to create an Open AI Assistant agent. | | ||||||||
| | [Step03_Assistant_Vision](OpenAIAssistant/Step03_Assistant_Vision.cs) | How to provide an image as input to an Open AI Assistant agent. | | ||||||||
| | [Step04_AssistantTool_CodeInterpreter](OpenAIAssistant/Step04_AssistantTool_CodeInterpreter.cs) | How to use the code-interpreter tool for an Open AI Assistant agent. | | ||||||||
| | [Step05_AssistantTool_FileSearch](OpenAIAssistant/Step05_AssistantTool_FileSearch.cs) | How to use the file-search tool for an Open AI Assistant agent. | | ||||||||
|
|
||||||||
| ### Azure AI Agent | ||||||||
|
|
||||||||
| Example|Description | ||||||||
| ---|--- | ||||||||
| [Step01_AzureAIAgent](./dotnet/samples/GettingStartedWithAgents/AzureAIAgent/Step01_AzureAIAgent.cs)|How to create an `AzureAIAgent`. | ||||||||
| [Step02_AzureAIAgent_Plugins](./dotnet/samples/GettingStartedWithAgents/AzureAIAgent/Step02_AzureAIAgent_Plugins.cs)|How to associate plug-ins with an `AzureAIAgent`. | ||||||||
| [Step03_AzureAIAgent_Chat](./dotnet/samples/GettingStartedWithAgents/AzureAIAgent/Step03_AzureAIAgent_Chat.cs)|How create a conversation with `AzureAIAgent`s. | ||||||||
| [Step04_AzureAIAgent_CodeInterpreter](./dotnet/samples/GettingStartedWithAgents/AzureAIAgent/Step04_AzureAIAgent_CodeInterpreter.cs)|How to use the code-interpreter tool for an `AzureAIAgent`. | ||||||||
| [Step05_AzureAIAgent_FileSearch](./dotnet/samples/GettingStartedWithAgents/AzureAIAgent/Step05_AzureAIAgent_FileSearch.cs)|How to use the file-search tool for an `AzureAIAgent`. | ||||||||
| [Step06_AzureAIAgent_OpenAPI](./dotnet/samples/GettingStartedWithAgents/AzureAIAgent/Step06_AzureAIAgent_OpenAPI.cs)|How to use the Open API tool for an `AzureAIAgent`. | ||||||||
| | Example | Description | | ||||||||
| | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------- | | ||||||||
| | [Step01_AzureAIAgent](AzureAIAgent/Step01_AzureAIAgent.cs) | How to create an `AzureAIAgent`. | | ||||||||
| | [Step02_AzureAIAgent_Plugins](AzureAIAgent/Step02_AzureAIAgent_Plugins.cs) | How to create an `AzureAIAgent`. | | ||||||||
| | [Step03_AzureAIAgent_Chat](AzureAIAgent/Step03_AzureAIAgent_Chat.cs) | How create a conversation with `AzureAIAgent`s. | | ||||||||
| | [Step04_AzureAIAgent_CodeInterpreter](AzureAIAgent/Step04_AzureAIAgent_CodeInterpreter.cs) | How to use the code-interpreter tool for an `AzureAIAgent`. | | ||||||||
| | [Step05_AzureAIAgent_FileSearch](AzureAIAgent/Step05_AzureAIAgent_FileSearch.cs) | How to use the file-search tool for an `AzureAIAgent`. | | ||||||||
| | [Step06_AzureAIAgent_OpenAPI](AzureAIAgent/Step06_AzureAIAgent_OpenAPI.cs) | How to use the Open API tool for an `AzureAIAgent`. | | ||||||||
|
|
||||||||
| ### Bedrock Agent | ||||||||
|
|
||||||||
| Example|Description | ||||||||
| ---|--- | ||||||||
| [Step01_BedrockAgent](./BedrockAgent/Step01_BedrockAgent.cs)|How to create a `BedrockAgent` and interact with it in the most basic way. | ||||||||
| [Step02_BedrockAgent_CodeInterpreter](./BedrockAgent/Step02_BedrockAgent_CodeInterpreter.cs)|How to use the code-interpreter tool with a `BedrockAgent`. | ||||||||
| [Step03_BedrockAgent_Functions](./BedrockAgent/Step03_BedrockAgent_Functions.cs)|How to use kernel functions with a `BedrockAgent`. | ||||||||
| [Step04_BedrockAgent_Trace](./BedrockAgent/Step04_BedrockAgent_Trace.cs)|How to enable tracing for a `BedrockAgent` to inspect the chain of thoughts. | ||||||||
| [Step05_BedrockAgent_FileSearch](./BedrockAgent/Step05_BedrockAgent_FileSearch.cs)|How to use file search with a `BedrockAgent` (i.e. Bedrock knowledge base). | ||||||||
| [Step06_BedrockAgent_AgentChat](./BedrockAgent/Step06_BedrockAgent_AgentChat.cs)|How to create a conversation between two agents and one of them in a `BedrockAgent`. | ||||||||
| | Example | Description | | ||||||||
| | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | ||||||||
| | [Step01_BedrockAgent](BedrockAgent/Step01_BedrockAgent.cs) | How to create a `BedrockAgent` and interact with it in the most basic way. | | ||||||||
| | [Step02_BedrockAgent_CodeInterpreter](BedrockAgent/Step02_BedrockAgent_CodeInterpreter.cs) | How to use the code-interpreter tool with a `BedrockAgent`. | | ||||||||
| | [Step03_BedrockAgent_Functions](BedrockAgent/Step03_BedrockAgent_Functions.cs) | How to use kernel functions with a `BedrockAgent`. | | ||||||||
| | [Step04_BedrockAgent_Trace](BedrockAgent/Step04_BedrockAgent_Trace.cs) | How to enable tracing for a `BedrockAgent` to inspect the chain of thoughts. | | ||||||||
| | [Step05_BedrockAgent_FileSearch](BedrockAgent/Step05_BedrockAgent_FileSearch.cs) | How to use file search with a `BedrockAgent` (i.e. Bedrock knowledge base). | | ||||||||
| | [Step06_BedrockAgent_AgentChat](BedrockAgent/Step06_BedrockAgent_AgentChat.cs) | How to create a conversation between two agents and one of them in a `BedrockAgent`. | | ||||||||
|
|
||||||||
| ### CopilotStudio Agent | ||||||||
|
|
||||||||
| Example|Description | ||||||||
| ---|--- | ||||||||
| [Step01_CopilotStudioAgent](./CopilotStudioAgent/Step01_CopilotStudioAgent.cs)|How to create a `CopilotStudioAgent` and interact with it in the most basic way. | ||||||||
| [Step02_CopilotStudioAgent_Thread](./CopilotStudioAgent/Step02_CopilotStudioAgent_Thread.cs)|How to use `CopilotStudioAgent` with an `AgentThread`. | ||||||||
| [Step03_CopilotStudioAgent_WebSearch](./CopilotStudioAgent/Step03_CopilotStudioAgent_WebSearch.cs)|How to use `CopilotStudioAgent` with web-search enabled. | ||||||||
| | Example | Description | | ||||||||
| | ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | | ||||||||
| | [Step01_CopilotStudioAgent](CopilotStudioAgent/Step01_CopilotStudioAgent.cs) | How to create a `CopilotStudioAgent` and interact with it in the most basic way. | | ||||||||
| | [Step02_CopilotStudioAgent_Thread](CopilotStudioAgent/Step02_CopilotStudioAgent_Thread.cs) | How to use `CopilotStudioAgent` with an `AgentThread`. | | ||||||||
| | [Step03_CopilotStudioAgent_WebSearch](CopilotStudioAgent/Step03_CopilotStudioAgent_WebSearch.cs) | How to use `CopilotStudioAgent` with web-search enabled. | | ||||||||
|
|
||||||||
| ### Orchestration | ||||||||
|
|
||||||||
| Example|Description | ||||||||
| ---|--- | ||||||||
| [Step01_Concurrent](./Orchestration/Step01_Concurrent.cs)|How to use a concurrent orchestration.. | ||||||||
| [Step01a_ConcurrentWithStructuredOutput](./Orchestration/Step01a_ConcurrentWithStructuredOutput.cs)|How to use structured output (with concurrent orchestration). | ||||||||
| [Step02_Sequential](./Orchestration/Step02_Sequential.cs)|How to use sequential orchestration. | ||||||||
| [Step02a_Sequential](./Orchestration/Step02a_Sequential.cs)|How to cancel an orchestration (with sequential orchestration). | ||||||||
| [Step03_GroupChat](./Orchestration/Step03_GroupChat.cs)|How to use group-chat orchestration. | ||||||||
| [Step03a_GroupChatWithHumanInTheLoop](./Orchestration/Step03a_GroupChatWithHumanInTheLoop.cs)|How to use group-chat orchestration with human in the loop. | ||||||||
| [Step03b_GroupChatWithAIManager](./Orchestration/Step03b_GroupChatWithAIManager.cs)|How to use group-chat orchestration with a AI powered group-manager. | ||||||||
| [Step04_Handoff](./Orchestration/Step04_Handoff.cs)|How to use handoff orchestration. | ||||||||
| [Step04b_HandoffWithStructuredInput](./Orchestration/Step04b_HandoffWithStructuredInput.cs)|How to use structured input (with handoff orchestration). | ||||||||
| | Example | Description | | ||||||||
| | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | ||||||||
| | [Step01_Concurrent](Orchestration/Step01_Concurrent.cs) | How to use a concurrent orchestration. | | ||||||||
| | [Step01a_ConcurrentWithStructuredOutput](Orchestration/Step01a_ConcurrentWithStructuredOutput.cs) | How to use structured output (with concurrent orchestration). | | ||||||||
| | [Step02_Sequential](Orchestration/Step02_Sequential.cs) | How to use sequential orchestration. | | ||||||||
| | [Step02a_Sequential](Orchestration/Step02a_Sequential.cs) | How to cancel an orchestration (with sequential orchestration). | | ||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||
| | [Step03_GroupChat](Orchestration/Step03_GroupChat.cs) | How to use group-chat orchestration. | | ||||||||
| | [Step03a_GroupChatWithHumanInTheLoop](Orchestration/Step03a_GroupChatWithHumanInTheLoop.cs) | How to use group-chat orchestration with human in the loop. | | ||||||||
| | [Step03b_GroupChatWithAIManager](Orchestration/Step03b_GroupChatWithAIManager.cs) | How to use group-chat orchestration with an AI-powered group-manager. | | ||||||||
| | [Step04_Handoff](Orchestration/Step04_Handoff.cs) | How to use handoff orchestration. | | ||||||||
| | [Step04b_HandoffWithStructuredInput](Orchestration/Step04b_HandoffWithStructuredInput.cs) | How to use structured input (with handoff orchestration). | | ||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||
|
|
||||||||
| ## Legacy Agents | ||||||||
|
|
||||||||
|
|
@@ -113,50 +113,50 @@ To set your secrets with .NET Secret Manager: | |||||||
|
|
||||||||
| 1. Navigate the console to the project folder: | ||||||||
|
|
||||||||
| ``` | ||||||||
| cd dotnet/samples/GettingStartedWithAgents | ||||||||
| ``` | ||||||||
| ``` | ||||||||
| cd dotnet/samples/GettingStartedWithAgents | ||||||||
| ``` | ||||||||
|
|
||||||||
| 2. Examine existing secret definitions: | ||||||||
|
|
||||||||
| ``` | ||||||||
| dotnet user-secrets list | ||||||||
| ``` | ||||||||
| ``` | ||||||||
| dotnet user-secrets list | ||||||||
| ``` | ||||||||
|
|
||||||||
| 3. If needed, perform first time initialization: | ||||||||
|
|
||||||||
| ``` | ||||||||
| dotnet user-secrets init | ||||||||
| ``` | ||||||||
| ``` | ||||||||
| dotnet user-secrets init | ||||||||
| ``` | ||||||||
|
|
||||||||
| 4. Define secrets for either Open AI: | ||||||||
|
|
||||||||
| ``` | ||||||||
| dotnet user-secrets set "OpenAI:ChatModelId" "..." | ||||||||
| dotnet user-secrets set "OpenAI:ApiKey" "..." | ||||||||
| ``` | ||||||||
| ``` | ||||||||
| dotnet user-secrets set "OpenAI:ChatModelId" "..." | ||||||||
| dotnet user-secrets set "OpenAI:ApiKey" "..." | ||||||||
| ``` | ||||||||
|
|
||||||||
| 5. Or Azure OpenAI: | ||||||||
|
|
||||||||
| ``` | ||||||||
| dotnet user-secrets set "AzureOpenAI:ChatDeploymentName" "gpt-4o" | ||||||||
| dotnet user-secrets set "AzureOpenAI:Endpoint" "https://... .openai.azure.com/" | ||||||||
| dotnet user-secrets set "AzureOpenAI:ApiKey" "..." | ||||||||
| ``` | ||||||||
| ``` | ||||||||
| dotnet user-secrets set "AzureOpenAI:ChatDeploymentName" "gpt-4o" | ||||||||
| dotnet user-secrets set "AzureOpenAI:Endpoint" "https://... .openai.azure.com/" | ||||||||
| dotnet user-secrets set "AzureOpenAI:ApiKey" "..." | ||||||||
| ``` | ||||||||
|
|
||||||||
| 6. Or Azure AI: | ||||||||
|
|
||||||||
| ``` | ||||||||
| dotnet user-secrets set "AzureAI:Endpoint" "..." | ||||||||
| dotnet user-secrets set "AzureAI:ChatModelId" "gpt-4o" | ||||||||
| ``` | ||||||||
| ``` | ||||||||
| dotnet user-secrets set "AzureAI:Endpoint" "..." | ||||||||
| dotnet user-secrets set "AzureAI:ChatModelId" "gpt-4o" | ||||||||
| ``` | ||||||||
|
|
||||||||
| 7. Or Bedrock: | ||||||||
|
|
||||||||
| ``` | ||||||||
| dotnet user-secrets set "BedrockAgent:AgentResourceRoleArn" "arn:aws:iam::...:role/..." | ||||||||
| dotnet user-secrets set "BedrockAgent:FoundationModel" "..." | ||||||||
| ``` | ||||||||
| ``` | ||||||||
| dotnet user-secrets set "BedrockAgent:AgentResourceRoleArn" "arn:aws:iam::...:role/..." | ||||||||
| dotnet user-secrets set "BedrockAgent:FoundationModel" "..." | ||||||||
| ``` | ||||||||
|
|
||||||||
| > NOTE: Azure secrets will take precedence, if both Open AI and Azure OpenAI secrets are defined, unless `ForceOpenAI` is set: | ||||||||
|
|
||||||||
|
|
||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.