Add JSON Schema Definition for gen_ai.tool.definitions #3378
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # Use this changelog template to create an entry for release notes. | ||
| # | ||
| # If your change doesn't affect end users you should instead start | ||
| # your pull request title with [chore] or use the "Skip Changelog" label. | ||
|
|
||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: enhancement | ||
|
|
||
| # The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) | ||
| component: gen-ai | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Enhance the definition of `gen_ai.tool.definitions` attribute. | ||
|
|
||
| # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
| # The values here must be integers. | ||
| issues: [2721, 1835] | ||
|
|
||
| # (Optional) One or more lines of additional information to render under the primary note. | ||
| # These lines will be padded with 2 spaces and then inserted directly into the document. | ||
| # Use pipe (|) for multiline entries. | ||
| subtext: | | ||
| The schema of `gen_ai.tool.definitions` attribute is now enhanced to: | ||
| - Add JSON schema of `gen_ai.tool.definitions` attribute. | ||
| - Document the behavior of capturing tool definitions. | ||
| - Capture the tool definitions in a simplified format if the content capturing is disabled. |
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| { | ||
| "$defs": { | ||
| "FunctionToolDefinition": { | ||
| "additionalProperties": true, | ||
| "description": "Represents a tool definition in the form of a function.", | ||
| "properties": { | ||
| "type": { | ||
| "const": "function", | ||
| "description": "The type of the tool.", | ||
| "title": "Type", | ||
| "type": "string" | ||
| }, | ||
| "name": { | ||
| "description": "The name of the tool.", | ||
| "title": "Name", | ||
| "type": "string" | ||
| }, | ||
| "description": { | ||
| "anyOf": [ | ||
| { | ||
| "type": "string" | ||
| }, | ||
| { | ||
| "type": "null" | ||
| } | ||
| ], | ||
| "default": null, | ||
| "description": "The description of the tool.Since this attribute could be large, it's NOT RECOMMENDED to be populated by default.Instrumentations MAY provide a way to enable populating this property.", | ||
| "title": "Description" | ||
| }, | ||
| "parameters": { | ||
| "anyOf": [ | ||
| {}, | ||
|
There was a problem hiding this comment. What's the reason for the If it is
Member
There was a problem hiding this comment. Following on from that
Member
There was a problem hiding this comment. And I think there should be a way to make pydantic reference the external schema http://json-schema.org/draft-07/schema# so that the generated schema is fully defined |
||
| { | ||
| "type": "null" | ||
| } | ||
| ], | ||
Cirilla-zmh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "default": null, | ||
| "description": "Schema that defines the parameters accepted by the tool. The RECOMMENDED format is JSON Schema.Since this attribute could be large, it's NOT RECOMMENDED to be populated by default.Instrumentations MAY provide a way to enable populating this property.", | ||
| "title": "Parameters" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "type", | ||
| "name" | ||
| ], | ||
| "title": "FunctionToolDefinition", | ||
| "type": "object" | ||
| }, | ||
| "GenericToolDefinition": { | ||
| "additionalProperties": true, | ||
| "description": "Represents a tool definition in any forms.", | ||
| "properties": { | ||
| "type": { | ||
| "description": "The type of the tool.", | ||
| "title": "Type", | ||
| "type": "string" | ||
| }, | ||
| "name": { | ||
| "description": "The name of the tool.", | ||
| "title": "Name", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "type", | ||
| "name" | ||
| ], | ||
| "title": "GenericToolDefinition", | ||
| "type": "object" | ||
| } | ||
| }, | ||
| "description": "Represents the list of tool definitions available to the GenAI agent or model.", | ||
| "items": { | ||
| "anyOf": [ | ||
| { | ||
| "$ref": "#/$defs/FunctionToolDefinition" | ||
| }, | ||
| { | ||
| "$ref": "#/$defs/GenericToolDefinition" | ||
| } | ||
| ] | ||
| }, | ||
| "title": "ToolDefinitions", | ||
| "type": "array" | ||
| } | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.