Made response_format option type public and update docstr

[howieleung]

Made response_format option type public and update docstr

[Copilot]

Pull Request Overview

This PR makes the response_format option types publicly available by creating a new types/__init__.py module and updating import statements throughout the codebase. The changes also standardize the documentation format for the response_format parameter across all method signatures.

• Creates public API for response format types through a new types module
• Updates all imports to use the public types module instead of private _types
• Standardizes docstring formatting for response_format parameter documentation

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
sdk/ai/azure-ai-agents/azure/ai/agents/types/init.py	Creates new public types module exposing AgentsResponseFormatOption and related types
sdk/ai/azure-ai-agents/azure/ai/agents/operations/_patch.py	Updates import path and standardizes response_format parameter documentation
sdk/ai/azure-ai-agents/azure/ai/agents/models/_patch.py	Updates import path from private _types to public types module
sdk/ai/azure-ai-agents/azure/ai/agents/aio/operations/_patch.py	Updates import path and standardizes response_format parameter documentation
sdk/ai/azure-ai-agents/azure/ai/agents/aio/_patch.py	Updates import path and standardizes response_format parameter documentation
sdk/ai/azure-ai-agents/azure/ai/agents/_patch.py	Updates import path and standardizes response_format parameter documentation

Comments suppressed due to low confidence (30)

sdk/ai/azure-ai-agents/azure/ai/agents/operations/_patch.py:203

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/operations/_patch.py:373

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/operations/_patch.py:518

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/operations/_patch.py:700

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/operations/_patch.py:816

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/operations/_patch.py:1003

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/aio/operations/_patch.py:200

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/aio/operations/_patch.py:366

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/aio/operations/_patch.py:510

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/aio/operations/_patch.py:688

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/aio/operations/_patch.py:800

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/aio/operations/_patch.py:982

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/aio/_patch.py:148

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/aio/_patch.py:214

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/aio/_patch.py:306

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/aio/_patch.py:402

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/aio/_patch.py:468

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/aio/_patch.py:579

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/aio/_patch.py:743

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/aio/_patch.py:848

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/aio/_patch.py:952

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/_patch.py:147

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/_patch.py:213

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/_patch.py:304

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/_patch.py:402

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/_patch.py:469

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/_patch.py:581

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/_patch.py:745

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/_patch.py:850

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]

sdk/ai/azure-ai-agents/azure/ai/agents/_patch.py:953

• The type reference 'agentsApiResponseFormat' uses inconsistent casing. It should be 'AgentsApiResponseFormat' to match Python naming conventions for class names.

                               ~azure.ai.agents.models.agentsApiResponseFormat]]