Feature #896: Support custom-type tool parameter #941
Conversation
This file contains 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
…gchain4j#896) This commit adds the JsonSchemaService concept to: - Create JsonSchemas for types of tool parameters, which will form ToolSpecification - Convert String arguments in ToolExecutionRequest to the specified type instance. JSON Schema defines JSON data structure for validation and documentation. When using OpenAI tools/functions, you need to define the tool specifications in JSON Schema, and to parse the response from the language model with respect to that JSON Schema. By using JsonSchemaService instead of the old method, we can utilize an existing open-source JsonSchema generator and validator for tool/function calls.
The DefaultJsonSchemaService is implemented to be consistent with the old behavior. It: - Support only Java Built-in types as tool parameters - Sanitize the tool execution arguments before deserialization
hotfix: Make jsonschema-module-jackson dependency required hotfix: Throw exception if meet custom type
|
Issue: #896 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Context
Langchain4j currently only supports Java built-in types as tool parameters.
While it's advisable to maintain a flat and simple tool interface,
there are situations where using custom-type tool parameters is preferred.
Change
This PR delegates the generation of
ToolSpecificationand the deserialization ofToolExecutionRequest's arguments toToolJsonSchemasusingJsonSchemaService.JsonSchemaServiceis a separate pluggable dependency via SPI. This PR created two implementations forJsonSchemaService:DefaultJsonSchemaService(in modulelangchain4j-core) is consistent with the old behavior of Langchain4j. It supports only Java Built-in types as tool parameters, and sanitizes the tool execution arguments before deserializationVictoolsJsonSchemaService(in a separated modellangchain4j-jsonschema-service-victools) adopts victools/jsonschema-generator for JSON Schema generation and arguments deserialization.Besides SPI, the user can override the default by customizing an implementation of
JsonSchemaServiceviaAiServices#jsonSchemaServiceThe original
ToolSpecificationis kept for now to stay compatible with the current codebase. It might be replaced byToolJsonSchemain the future if needed.Checklist
Before submitting this PR, please check the following points: