Fix broken link. Grab the doc from the release/azure-ai-projects/1.0.0 branch instead. #43952
Conversation
dargilco
requested review from
glharper,
howieleung,
kingernupur,
nick863,
trangevi and
trrwilson
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a broken documentation link by updating the agents migration guide reference to point to the release/azure-ai-projects/1.0.0 branch instead of the main branch. Additionally, it enables Sphinx documentation generation and performs extensive documentation formatting improvements across the codebase.
Key Changes:
- Enables Sphinx documentation by removing
sphinx = falsefrom pyproject.toml - Updates migration guide link in CHANGELOG.md to use the release/azure-ai-projects/1.0.0 branch
- Standardizes documentation formatting by removing extraneous blank lines, converting markdown links to plain URLs, and improving indentation consistency
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| sdk/ai/azure-ai-projects/pyproject.toml | Removes sphinx = false to enable Sphinx documentation generation |
| sdk/ai/azure-ai-agents/CHANGELOG.md | Updates migration guide link from main branch to release/azure-ai-projects/1.0.0 branch |
| sdk/ai/azure-ai-projects/azure/ai/projects/models/_models.py | Cleans up docstring formatting by removing extra blank lines, converting parameter references, and standardizing link formats |
| sdk/ai/azure-ai-projects/azure/ai/projects/models/_enums.py | Improves docstring indentation consistency for multi-line bullet points |
|
|
||
| The two categories of tools you can provide the model are: | ||
|
|
||
| can specify which tool to use by setting the _tool_choice_ parameter. |
There was a problem hiding this comment.
The parameter reference _tool_choice_ should use backticks for consistency with the rest of the codebase. It should be `tool_choice` instead of _tool_choice_.
| can specify which tool to use by setting the _tool_choice_ parameter. | |
| can specify which tool to use by setting the `tool_choice` parameter. |
| * **Function calls (custom tools)**: Functions that are defined by you, | ||
| enabling the model to call your own code. Learn more about | ||
| [function calling](https://platform.openai.com/docs/guides/function-calling).""" | ||
| can specify which tool to use by setting the tool_choice parameter. |
There was a problem hiding this comment.
The parameter name should use backticks for consistency: `tool_choice` instead of tool_choice.
| can specify which tool to use by setting the tool_choice parameter. | |
| can specify which tool to use by setting the `tool_choice` parameter. |
| :vartype tools: list[~azure.ai.projects.models.Tool] | ||
| :ivar tool_choice: How the model should select which tool (or tools) to use when generating | ||
| a response. See the ``tools`` parameter to see how to specify which tools | ||
| a response. See the tools parameter to see how to specify which tools |
There was a problem hiding this comment.
The parameter reference should use backticks for consistency with the rest of the codebase: `tools` instead of tools.
| a response. See the tools parameter to see how to specify which tools | |
| a response. See the `tools` parameter to see how to specify which tools |
| ) | ||
| """How the model should select which tool (or tools) to use when generating | ||
| a response. See the ``tools`` parameter to see how to specify which tools | ||
| a response. See the tools parameter to see how to specify which tools |
There was a problem hiding this comment.
The parameter reference should use backticks for consistency with the rest of the codebase: `tools` instead of tools.
| a response. See the tools parameter to see how to specify which tools | |
| a response. See the `tools` parameter to see how to specify which tools |
No description provided.