Skip to content
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

core[minor]: Allow for simple tool schema to be passed to bindTools #14

Open
wants to merge 2 commits into
base: cloned_main_12963
Choose a base branch
from

Conversation

local-dev-korbit-ai-mentor[bot]
Copy link

@local-dev-korbit-ai-mentor local-dev-korbit-ai-mentor bot commented Aug 15, 2024

Allows for a more concise schema to be passed to models. This is not intended to be used in Agents or similar since it has no function attached, and is more similar to .withStructuredOutput.

TODO:

  • after releasing, bump min core version for all.

Description by Korbit AI

Note

This feature is in early access. You can enable or disable it in the Korbit Console.

What change is being made?

Allow for simple tool schema to be passed to bindTools by adding ToolSchema interface and updating BaseChatModel to accept ToolSchema.

Why are these changes being made?

This change enhances the flexibility of the bindTools function by allowing it to accept a simpler tool schema, making it easier to define and use tools with minimal configuration. This approach simplifies the integration process and improves code maintainability.

Summary by CodeRabbit

  • New Features

    • Introduced a ToolSchema interface, enhancing tool definitions with name, description, and schema properties.
    • Expanded the BaseChatModel class to accept ToolSchema, improving flexibility in handling tools within chat interactions.
  • Bug Fixes

    • Improved type definitions to ensure compatibility with new tool structures, enhancing overall functionality.

Copy link
Author

Clone of the PR langchain-ai/langchainjs#6253

Copy link

korbit-ai bot commented Aug 15, 2024

My review is in progress 📖 - I will have feedback for you in a few minutes!

Copy link

coderabbitai bot commented Aug 15, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This update introduces significant enhancements to the BaseChatModel class and the ToolSchema interface. The BaseChatModel now accommodates a new type, ToolSchema, improving its flexibility for tool interactions. Additionally, the ToolSchema interface defines a structured format for tools, including mandatory and optional properties, thereby enriching the overall integration and functionality within the chat model framework.

Changes

Files Change Summary
langchain-core/src/language_models/chat_models.ts
langchain-core/src/tools/index.ts
- Added ToolSchema type to BaseChatModel for enhanced flexibility.
- Introduced a new ToolSchema interface defining properties: name, description, and schema.

Poem

🐰 In a world of code, I hop and play,
New tools sprout forth, brightening the way.
With schemas that structure, the models now blend,
A dance of data, where joys never end!
So here’s to the changes, both clever and spry,
A leap into futures, oh my, oh my! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@korbit-ai korbit-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have reviewed your code and did not find any issues!


Please note that I can make mistakes, and you should still encourage your team to review your code as well.

@kavitaganeshan
Copy link

@coderabbitai review

@kavitaganeshan
Copy link

/review

Copy link

coderabbitai bot commented Aug 15, 2024

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Key issues to review

Type Compatibility
Ensure that the newly added ToolSchema type is fully compatible with existing tool definitions and doesn't introduce any breaking changes in the BaseChatModel class.

Documentation
The new ToolSchema interface lacks JSDoc comments for the interface itself. Consider adding a description to improve code documentation.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1296334 and 19321ca.

Files selected for processing (2)
  • langchain-core/src/language_models/chat_models.ts (2 hunks)
  • langchain-core/src/tools/index.ts (1 hunks)
Additional comments not posted (3)
langchain-core/src/tools/index.ts (1)

50-63: Introduce ToolSchema interface.

The ToolSchema interface is well-defined, providing a clear structure for tool definitions. The use of ZodObjectAny for the schema property allows for flexible parameter validation. This addition enhances the flexibility and maintainability of tool-related code.

langchain-core/src/language_models/chat_models.ts (2)

36-36: Add ToolSchema to imports.

The addition of ToolSchema to the imports reflects its integration into the BaseChatModel class, enabling the use of the new tool schema within chat models.


187-187: Expand bindTools method to include ToolSchema.

The inclusion of ToolSchema in the bindTools method enhances the method's capability to handle diverse tool configurations. This change supports the PR's goal of improving flexibility and maintainability in tool integration.

@furwellness
Copy link
Owner

Zero comments from coderabbit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants