-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Fix broken link. Grab the doc from the release/azure-ai-projects/1.0.0 branch instead. #43952
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -10068,7 +10068,6 @@ class Response(_Model): | |||||
| :ivar metadata: Set of 16 key-value pairs that can be attached to an object. This can be | ||||||
| useful for storing additional information about the object in a structured | ||||||
| format, and querying for objects via API or the dashboard. | ||||||
|
|
||||||
| Keys are strings with a maximum length of 64 characters. Values are strings | ||||||
| with a maximum length of 512 characters. Required. | ||||||
| :vartype metadata: dict[str, str] | ||||||
|
|
@@ -10081,7 +10080,6 @@ class Response(_Model): | |||||
| where the model considers the results of the tokens with top_p probability | ||||||
| mass. So 0.1 means only the tokens comprising the top 10% probability mass | ||||||
| are considered. | ||||||
|
|
||||||
| We generally recommend altering this or ``temperature`` but not both. Required. | ||||||
| :vartype top_p: float | ||||||
| :ivar user: A unique identifier representing your end-user, which can help OpenAI to monitor | ||||||
|
|
@@ -10119,38 +10117,29 @@ class Response(_Model): | |||||
| and `Structured Outputs <https://platform.openai.com/docs/guides/structured-outputs>`_. | ||||||
| :vartype text: ~azure.ai.projects.models.ResponseText | ||||||
| :ivar tools: An array of tools the model may call while generating a response. You | ||||||
| can specify which tool to use by setting the ``tool_choice`` parameter. | ||||||
|
|
||||||
| The two categories of tools you can provide the model are: | ||||||
|
|
||||||
| can specify which tool to use by setting the _tool_choice_ parameter. | ||||||
| The two categories of tools you can provide the model are: | ||||||
|
|
||||||
|
|
||||||
| * **Built-in tools**: Tools that are provided by OpenAI that extend the | ||||||
| model's capabilities, like [web | ||||||
| search](https://platform.openai.com/docs/guides/tools-web-search) | ||||||
| or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about | ||||||
| [built-in tools](https://platform.openai.com/docs/guides/tools). | ||||||
| * **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). | ||||||
| * Built-in tools: Tools that are provided by OpenAI that extend the | ||||||
| model's capabilities, like web search or file search. | ||||||
| * Function calls (custom tools): Functions that are defined by you, | ||||||
| enabling the model to call your own code. | ||||||
| :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 | ||||||
|
||||||
| 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 |
Copilot
AI
Nov 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
Copilot
AI
Nov 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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_.