Skip to content

[AI] [Agents] correct convenience doc string for Bing Grounding #41150

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

Merged
merged 3 commits into from
May 20, 2025

Conversation

glharper
Copy link
Member

Description

Please add an informative description that covers that changes made by the pull request and link all relevant issues.

If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@Copilot Copilot AI review requested due to automatic review settings May 17, 2025 13:57
@glharper glharper requested review from howieleung and removed request for Copilot May 17, 2025 13:57
@glharper
Copy link
Member Author

@anushree1808 FYI

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR corrects and enriches the convenience docstring for the BingGroundingTool initializer by replacing generic Custom Search references with accurate Bing Grounding descriptions and adding detailed parameter explanations.

  • Updated the class docstring to reference “Bing Grounding” instead of “Bing Custom Search”
  • Expanded each :param block with clearer descriptions and valid-value references
Comments suppressed due to low confidence (1)

sdk/ai/azure-ai-agents/azure/ai/agents/models/_patch.py:853

  • The description refers to "tools allow" but the class is singular (BingGroundingTool); consider changing "tools allow only one connection" to "tool allows only one connection" for consistency.
:param connection_id: Connection ID used by tool. Bing Grounding tools allow only one connection.

@glharper glharper changed the title [AI] [Agents] correct convenience doc string for BIng Grounding [AI] [Agents] correct convenience doc string for Bing Grounding May 19, 2025
@glharper glharper merged commit e370eea into main May 20, 2025
20 checks passed
@glharper glharper deleted the glharper/bing-grounding-doc-string branch May 20, 2025 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants