Skip to content

Commit 9d7aea0

Browse files
howieleunghowieleung
authored
Made response_format option type public and update docstr (#41991)
* Made response_format option type public and update docstr * resolved comment * update * Update CHANGELOG.md
1 parent 8ffc583 commit 9d7aea0

File tree

8 files changed

+153
-108
lines changed

8 files changed

+153
-108
lines changed

‎sdk/ai/azure-ai-agents/CHANGELOG.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
# Release History
44

5+
## 1.1.0b5 (Unreleased)
6+
7+
### Bugs Fixed
8+
9+
- `AgentsResponseFormatOption`, `MessageInputContent`, `MessageAttachmentToolDefinition`, `AgentsToolChoiceOption` are now public.
10+
511
## 1.1.0b4 (2025-07-11)
612

713
### Features Added
@@ -12,7 +18,7 @@ the thread. Default value is None.
1218

1319
### Bugs Fixed
1420

15-
- `_AgentsClientOperationsMixin` now it is private.
21+
- `_AgentsClientOperationsMixin` is now private.
1622

1723
### Sample updates
1824

‎sdk/ai/azure-ai-agents/azure/ai/agents/_patch.py‎

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
from . import models as _models
3131
from ._client import AgentsClient as AgentsClientGenerated
3232
from .operations._patch import _has_errors_in_toolcalls_output
33-
from . import _types
33+
from . import types as _types
3434

3535
if sys.version_info >= (3, 9):
3636
from collections.abc import MutableMapping
@@ -140,10 +140,10 @@ def create_agent( # pylint: disable=arguments-differ
140140
:keyword response_format: Specifies the format for the responses, particularly for tool calls.
141141
Can be a string, response format mode, or structured response format object that defines how
142142
the agent should structure its outputs.
143-
:type response_format: str or
144-
~azure.ai.agents.models.AgentsApiResponseFormatMode or
145-
~azure.ai.agents.models.AgentsApiResponseFormat or
146-
~azure.ai.agents.models.ResponseFormatJsonSchemaType
143+
:type response_format: Optional[Union[str,
144+
~azure.ai.agents.models.AgentsApiResponseFormatMode,
145+
~azure.ai.agents.models.AgentsApiResponseFormat,
146+
~azure.ai.agents.models.ResponseFormatJsonSchemaType]]
147147
:keyword metadata: Custom key-value pairs for storing additional information about the agent.
148148
Useful for categorization, tracking, or storing application-specific data. Limited to 16 pairs,
149149
with keys up to 64 characters and values up to 512 characters each.
@@ -205,10 +205,10 @@ def create_agent( # pylint: disable=arguments-differ
205205
:keyword response_format: Specifies the format for the responses, particularly for tool calls.
206206
Can be a string, response format mode, or structured response format object that defines how
207207
the agent should structure its outputs.
208-
:type response_format: str or
209-
~azure.ai.agents.models.AgentsApiResponseFormatMode or
210-
~azure.ai.agents.models.AgentsApiResponseFormat or
211-
~azure.ai.agents.models.ResponseFormatJsonSchemaType
208+
:type response_format: Optional[Union[str,
209+
~azure.ai.agents.models.AgentsApiResponseFormatMode,
210+
~azure.ai.agents.models.AgentsApiResponseFormat,
211+
~azure.ai.agents.models.ResponseFormatJsonSchemaType]]
212212
:keyword metadata: Custom key-value pairs for storing additional information about the agent.
213213
Useful for categorization, tracking, or storing application-specific data. Limited to 16 pairs,
214214
with keys up to 64 characters and values up to 512 characters each.
@@ -295,10 +295,10 @@ def create_agent(
295295
:keyword response_format: Specifies the format for the responses, particularly for tool calls.
296296
Can be a string, response format mode, or structured response format object that defines how
297297
the agent should structure its outputs.
298-
:type response_format: str or
299-
~azure.ai.agents.models.AgentsApiResponseFormatMode or
300-
~azure.ai.agents.models.AgentsApiResponseFormat or
301-
~azure.ai.agents.models.ResponseFormatJsonSchemaType
298+
:type response_format: Optional[Union[str,
299+
~azure.ai.agents.models.AgentsApiResponseFormatMode,
300+
~azure.ai.agents.models.AgentsApiResponseFormat,
301+
~azure.ai.agents.models.ResponseFormatJsonSchemaType]]
302302
:keyword metadata: Custom key-value pairs for storing additional information about the agent.
303303
:paramtype metadata: Optional[Dict[str, str]]
304304
:keyword content_type: The MIME type of the request body when using body parameter.
@@ -392,10 +392,10 @@ def update_agent( # pylint: disable=arguments-differ
392392
:keyword response_format: Specifies the format for the responses, particularly for tool calls.
393393
Can be a string, response format mode, or structured response format object that defines how
394394
the agent should structure its outputs.
395-
:type response_format: str or
396-
~azure.ai.agents.models.AgentsApiResponseFormatMode or
397-
~azure.ai.agents.models.AgentsApiResponseFormat or
398-
~azure.ai.agents.models.ResponseFormatJsonSchemaType
395+
:type response_format: Optional[Union[str,
396+
~azure.ai.agents.models.AgentsApiResponseFormatMode,
397+
~azure.ai.agents.models.AgentsApiResponseFormat,
398+
~azure.ai.agents.models.ResponseFormatJsonSchemaType]]
399399
:keyword metadata: A set of up to 16 key/value pairs that can be attached to an object, used
400400
for storing additional information about that object in a structured format. Keys may be up to
401401
64 characters in length and values may be up to 512 characters in length. Default value is
@@ -458,10 +458,10 @@ def update_agent( # pylint: disable=arguments-differ
458458
:keyword response_format: Specifies the format for the responses, particularly for tool calls.
459459
Can be a string, response format mode, or structured response format object that defines how
460460
the agent should structure its outputs.
461-
:type response_format: str or
462-
~azure.ai.agents.models.AgentsApiResponseFormatMode or
463-
~azure.ai.agents.models.AgentsApiResponseFormat or
464-
~azure.ai.agents.models.ResponseFormatJsonSchemaType
461+
:type response_format: Optional[Union[str,
462+
~azure.ai.agents.models.AgentsApiResponseFormatMode,
463+
~azure.ai.agents.models.AgentsApiResponseFormat,
464+
~azure.ai.agents.models.ResponseFormatJsonSchemaType]]
465465
:keyword metadata: A set of up to 16 key/value pairs that can be attached to an object, used
466466
for storing additional information about that object in a structured format. Keys may be up to
467467
64 characters in length and values may be up to 512 characters in length. Default value is
@@ -569,10 +569,10 @@ def update_agent(
569569
:keyword response_format: Specifies the format for the responses, particularly for tool calls.
570570
Can be a string, response format mode, or structured response format object that defines how
571571
the agent should structure its outputs.
572-
:type response_format: str or
573-
~azure.ai.agents.models.AgentsApiResponseFormatMode or
574-
~azure.ai.agents.models.AgentsApiResponseFormat or
575-
~azure.ai.agents.models.ResponseFormatJsonSchemaType
572+
:type response_format: Optional[Union[str,
573+
~azure.ai.agents.models.AgentsApiResponseFormatMode,
574+
~azure.ai.agents.models.AgentsApiResponseFormat,
575+
~azure.ai.agents.models.ResponseFormatJsonSchemaType]]
576576
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
577577
Default value is "application/json".
578578
:paramtype content_type: str
@@ -732,10 +732,10 @@ def create_thread_and_run(
732732
:keyword response_format: Specifies the format for the responses, particularly for tool calls.
733733
Can be a string, response format mode, or structured response format object that defines how
734734
the agent should structure its outputs.
735-
:type response_format: str or
736-
~azure.ai.agents.models.AgentsApiResponseFormatMode or
737-
~azure.ai.agents.models.AgentsApiResponseFormat or
738-
~azure.ai.agents.models.ResponseFormatJsonSchemaType
735+
:type response_format: Optional[Union[str,
736+
~azure.ai.agents.models.AgentsApiResponseFormatMode,
737+
~azure.ai.agents.models.AgentsApiResponseFormat,
738+
~azure.ai.agents.models.ResponseFormatJsonSchemaType]]
739739
:keyword parallel_tool_calls: If True, tools will be invoked in parallel.
740740
:type parallel_tool_calls: bool
741741
:keyword metadata: Up to 16 key/value pairs for structured metadata on the run.
@@ -836,10 +836,10 @@ def create_thread_and_run( # type: ignore
836836
:keyword response_format: Specifies the format for the responses, particularly for tool calls.
837837
Can be a string, response format mode, or structured response format object that defines how
838838
the agent should structure its outputs.
839-
:type response_format: str or
840-
~azure.ai.agents.models.AgentsApiResponseFormatMode or
841-
~azure.ai.agents.models.AgentsApiResponseFormat or
842-
~azure.ai.agents.models.ResponseFormatJsonSchemaType
839+
:type response_format: Optional[Union[str,
840+
~azure.ai.agents.models.AgentsApiResponseFormatMode,
841+
~azure.ai.agents.models.AgentsApiResponseFormat,
842+
~azure.ai.agents.models.ResponseFormatJsonSchemaType]]
843843
:keyword parallel_tool_calls: If True, tools will be invoked in parallel.
844844
:type parallel_tool_calls: bool
845845
:keyword metadata: Up to 16 key/value pairs for structured metadata on the run.
@@ -938,10 +938,10 @@ def create_thread_and_process_run(
938938
:keyword response_format: Specifies the format for the responses, particularly for tool calls.
939939
Can be a string, response format mode, or structured response format object that defines how
940940
the agent should structure its outputs.
941-
:type response_format: str or
942-
~azure.ai.agents.models.AgentsApiResponseFormatMode or
943-
~azure.ai.agents.models.AgentsApiResponseFormat or
944-
~azure.ai.agents.models.ResponseFormatJsonSchemaType
941+
:type response_format: Optional[Union[str,
942+
~azure.ai.agents.models.AgentsApiResponseFormatMode,
943+
~azure.ai.agents.models.AgentsApiResponseFormat,
944+
~azure.ai.agents.models.ResponseFormatJsonSchemaType]]
945945
:keyword parallel_tool_calls: If True, allows tool calls to be executed in parallel.
946946
:type parallel_tool_calls: bool, optional
947947
:keyword metadata: Optional metadata (up to 16 key/value pairs) to attach to the run.

‎sdk/ai/azure-ai-agents/azure/ai/agents/_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
77
# --------------------------------------------------------------------------
88

9-
VERSION = "1.1.0b4"
9+
VERSION = "1.1.0b5"

0 commit comments

Comments
 (0)