Skip to content

Commit 1ae2a39

Browse files
authored
Python: docs(python): fix broken sample links in agents READMEs (#14703)
### Motivation and Context Four links in the Python agent sample READMEs point to files or folders that were renamed, so they 404 on GitHub. ### Description - `python/samples/getting_started_with_agents/README.md` - `step1a_concurrent_structure_output.py` -> `step1a_concurrent_structured_outputs.py` - `step4a_handoff_structure_input.py` -> `step4a_handoff_structured_inputs.py` - The link text is updated to match the file names. - `python/samples/getting_started_with_agents/azure_ai_agent/README.md`: `step7_azure_ai_agent_retrieval.py` -> `step07_azure_ai_agent_retrieval.py` - `python/samples/getting_started_with_agents/multi_agent_orchestration/README.md`: `concepts/structured_output/` -> `concepts/structured_outputs/` Every relative link in the `getting_started_with_agents` READMEs now resolves against `main`. ### Contribution Checklist - [x] The code builds clean without any errors or warnings - [x] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [ ] All unit tests pass, and I have added new tests where possible - [x] I didn't break anyone 😄 Markdown only, so no code or tests are affected.
1 parent cbb8059 commit 1ae2a39

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

‎python/samples/getting_started_with_agents/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,14 @@ Example|Description
7979
Example|Description
8080
---|---
8181
[step1_concurrent](../getting_started_with_agents/multi_agent_orchestration/step1_concurrent.py)|How to run agents in parallel on the same task.
82-
[step1a_concurrent_structure_output](../getting_started_with_agents/multi_agent_orchestration/step1a_concurrent_structure_output.py)|How to run agents in parallel on the same task and return structured output.
82+
[step1a_concurrent_structured_outputs](../getting_started_with_agents/multi_agent_orchestration/step1a_concurrent_structured_outputs.py)|How to run agents in parallel on the same task and return structured output.
8383
[step2_sequential](../getting_started_with_agents/multi_agent_orchestration/step2_sequential.py)|How to run agents in sequence to complete a task.
8484
[step2a_sequential_cancellation_token](../getting_started_with_agents/multi_agent_orchestration/step2a_sequential_cancellation_token.py)|How to cancel an invocation while it is in progress.
8585
[step3_group_chat](../getting_started_with_agents/multi_agent_orchestration/step3_group_chat.py)|How to run agents in a group chat to complete a task.
8686
[step3a_group_chat_human_in_the_loop](../getting_started_with_agents/multi_agent_orchestration/step3a_group_chat_human_in_the_loop.py)|How to run agents in a group chat with human in the loop.
8787
[step3b_group_chat_with_chat_completion_manager](../getting_started_with_agents/multi_agent_orchestration/step3b_group_chat_with_chat_completion_manager.py)|How to run agents in a group chat with a more dynamic manager.
8888
[step4_handoff](../getting_started_with_agents/multi_agent_orchestration/step4_handoff.py)|How to run agents in a handoff orchestration to complete a task.
89-
[step4a_handoff_structure_input](../getting_started_with_agents/multi_agent_orchestration/step4a_handoff_structure_input.py)|How to run agents in a handoff orchestration to complete a task with structured input.
89+
[step4a_handoff_structured_inputs](../getting_started_with_agents/multi_agent_orchestration/step4a_handoff_structured_inputs.py)|How to run agents in a handoff orchestration to complete a task with structured input.
9090
[step5_magentic](../getting_started_with_agents/multi_agent_orchestration/step5_magentic.py)|How to run agents in a Magentic orchestration to complete a task.
9191

9292
## Configuring the Kernel

‎python/samples/getting_started_with_agents/azure_ai_agent/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Now, you can create a thread, add chat messages to the agent, and invoke it with
9494

9595
In certain scenarios, you may prefer to reuse an existing agent definition rather than creating a new one. This can be done by calling `await client.agents.get_agent(...)` instead of `await client.agents.create_agent(...)`.
9696

97-
For a practical example, refer to the [`step7_azure_ai_agent_retrieval`](./step7_azure_ai_agent_retrieval.py) sample.
97+
For a practical example, refer to the [`step07_azure_ai_agent_retrieval`](./step07_azure_ai_agent_retrieval.py) sample.
9898

9999
## Requests and Rate Limits
100100

‎python/samples/getting_started_with_agents/multi_agent_orchestration/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The following samples are beneficial if you are just getting started with Semant
88

99
- [Chat Completion](../../concepts/chat_completion/)
1010
- [Auto Function Calling](../../concepts/auto_function_calling/)
11-
- [Structured Output](../../concepts/structured_output/)
11+
- [Structured Output](../../concepts/structured_outputs/)
1212
- [Getting Started with Agents](../../getting_started_with_agents/)
1313
- [More advanced agent samples](../../concepts/agents/)
1414

0 commit comments

Comments
 (0)