Add JSON Schema Definition for gen_ai.tool.definitions #2942
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Cirilla-zmh
moved this from Untriaged
to Awaiting codeowners approval
in Semantic Conventions Triage
Change-Id: Ib6133b3019195e4fa9a54d329ff4b891a281d208 Co-developed-by: Cursor <noreply@cursor.com>
Cirilla-zmh
force-pushed
the
minghui/tool_definitions
branch
from
76f99f0 to
2a15973
Compare
Member
Author
|
This is the continued PR of #2793 |
3 tasks
lmolkova
reviewed
Oct 20, 2025
lmolkova
reviewed
Oct 20, 2025
Cirilla-zmh
commented
Oct 21, 2025
alexmojaki
reviewed
Oct 21, 2025
gyliu513
reviewed
Oct 28, 2025
Change-Id: Ic5480fbdb1058a2e1ace084c8ce3735484f91c06 Co-developed-by: Cursor <noreply@cursor.com>
6 tasks
gyliu513
approved these changes
Nov 15, 2025
Cirilla-zmh
moved this from Awaiting codeowners approval
to Needs More Approval
in Semantic Conventions Triage
lmolkova
reviewed
Nov 18, 2025
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "class FunctionToolDefinition(BaseModel):\n", |
Member
There was a problem hiding this comment.
could it extend GenericToolDefinition? then it would reuse type, name and description.
Comment on lines
+306
to
+309
| It's expected to be an array of objects, each representing a tool definition, | ||
| and the structure of the array is expected to match the [Tool Definitions JSON Schema](/docs/gen-ai/gen-ai-tool-definitions.json). | ||
| In case a serialized string is available to the instrumentation, the instrumentation | ||
| SHOULD do the best effort to deserialize it to an array. |
Member
There was a problem hiding this comment.
Suggested change
| It's expected to be an array of objects, each representing a tool definition, | |
| and the structure of the array is expected to match the [Tool Definitions JSON Schema](/docs/gen-ai/gen-ai-tool-definitions.json). | |
| In case a serialized string is available to the instrumentation, the instrumentation | |
| SHOULD do the best effort to deserialize it to an array. | |
| Instrumentations MUST follow [Tool Definitions JSON Schema](/docs/gen-ai/gen-ai-tool-definitions.json) |
There is no need to mention array - it's already in the definition. Also no need to mention deserialization - it's already explicitly required by a MUST.
This is also consistent with how we define input and output messages.
| " \"\"\"\n", | ||
| " type: str = Field(description=\"The type of the tool.\")\n", | ||
| " name: str = Field(description=\"The name of the tool.\")\n", | ||
| " description: str = Field(None, description=\"The description of the tool.\")\n", |
Member
There was a problem hiding this comment.
is it a generic property? I don't see it being used on most tools - https://platform.openai.com/docs/api-reference/responses/create#responses_create-tools, let's not add it as generic?
Comment on lines
+315
to
+318
| If instrumentations can reliably deserialize and extract the tool definitions, | ||
| it's RECOMMENDED to only populate required fields (`name`, `type`) of the definition | ||
| objects by default. Otherwise, it's NOT RECOMMENDED to populate it by default. | ||
| Instrumentations MAY provide a way to enable populating this attribute. |
Member
There was a problem hiding this comment.
nit, just more concise rephrasing:
Suggested change
| If instrumentations can reliably deserialize and extract the tool definitions, | |
| it's RECOMMENDED to only populate required fields (`name`, `type`) of the definition | |
| objects by default. Otherwise, it's NOT RECOMMENDED to populate it by default. | |
| Instrumentations MAY provide a way to enable populating this attribute. | |
| It’s RECOMMENDED to populate all required attributes on each tool | |
| definition by default. Instrumentations MAY allow to enable populating | |
| non-required properties. |
(instrumentations that can't "reliably deserialize and extract the tool definitions" would not populate the attribute at all)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #2721 #1835
Changes
Add JSON schema definition for gen_ai.tool.definitions.
Important
Pull requests acceptance are subject to the triage process as described in Issue and PR Triage Management.
PRs that do not follow the guidance above, may be automatically rejected and closed.
Merge requirement checklist
[chore]