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

Add more explanations to the tool use doc #1324

Open
wants to merge 1 commit into
base: canary
Choose a base branch
from

Conversation

Ben-Epstein
Copy link
Contributor

@Ben-Epstein Ben-Epstein commented Jan 14, 2025

PoC, just to start the discussion. I also wanted to add a little screenshot like this in the control flow placeholder. I assume there's a better diagraming tool more consistent with your other diagrams, but this was the idea

image


Important

Enhances tools.mdx with detailed explanations, dynamic tool signature generation, and updated code examples.

  • Documentation Enhancements:
    • Added explanation on treating "function calling" and "tool use" equivalently in tools.mdx.
    • Included a placeholder for a control flow image to illustrate concepts.
    • Expanded on dynamically generating tool signatures with code examples in Python.
  • Code Examples:
    • Updated Python example to include get_weather() function and corrected time_of_day attribute access.
    • Added dynamic type generation example using TypeBuilder and inspect in Python.
  • Misc:
    • Minor text adjustments for clarity in tools.mdx.

This description was created by Ellipsis for 042f36f. It will automatically update as commits are pushed.

Copy link

vercel bot commented Jan 14, 2025

@Ben-Epstein is attempting to deploy a commit to the Gloo Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

❌ Changes requested. Reviewed everything up to 042f36f in 1 minute and 47 seconds

More details
  • Looked at 96 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. fern/01-guide/06-prompt-engineering/tools.mdx:292
  • Draft comment:
    Ensure that model_dump() is a valid method for the tool object and returns the expected dictionary format for unpacking into get_weather.
  • Reason this comment was not posted:
    Comment did not seem useful.

Workflow ID: wflow_oTy6h7jBvnMIRKmW


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

fern/01-guide/06-prompt-engineering/tools.mdx Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant