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

Added More Indepth Tool Documentation For Anthropic API #503

Merged
merged 7 commits into from
Nov 19, 2024

Conversation

TKTSWalker
Copy link
Contributor

@TKTSWalker TKTSWalker commented Nov 11, 2024

📥 Pull Request

📘 Description

  1. Made an example showcasing simple tool calling while showing a second which showcased both using multiple calls at once and requesting an input
  2. Left code blocks which could be used for listening for a singular tool or multiple
  3. Showed how to initialize the tools and give the data to the LLM as context
  4. Reflected as such within the Anthropic general guide journal

This also handles the problem high lighted by #499!

🧪 Testing

The major outputs are still visible with their results intact within the journal!

Also on the journal for the barebones reference, it might be a good idea to remove the tool segment and point to the document! Finally, it might be good to make a third link on the readme page with a link to the journal itself although you may already have plans here!

@TKTSWalker
Copy link
Contributor Author

@the-praxs All done! The main file referenced is here!

@TKTSWalker
Copy link
Contributor Author

TKTSWalker commented Nov 12, 2024

Realized the problem didn't properly link issue

Fix bug #499

Copy link
Contributor

@areibman areibman left a comment

Choose a reason for hiding this comment

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

Handful of changes. Also can we rename the notebook or combine it with another one? We have several example notebooks in this examples directory that more or less do the same things

Copy link

Files selected (3)
  • CONTRIBUTING.md
    - docs/v1/integrations/rest.mdx
    - pyproject.toml
Files ignored (2)
  • docs/mint.json
    - tox.ini
Instructions

Emoji Descriptions:

  • ⚠️ Potential Issue - May require further investigation.
  • 🔒 Security Vulnerability - Fix to ensure system safety.
  • 💻 Code Improvement - Suggestions to enhance code quality.
  • 🔨 Refactor Suggestion - Recommendations for restructuring code.
  • ℹ️ Others - General comments and information.

Interact with the Bot:

  • Send a message or request using the format:

    @Entelligence.AI + *your message*

    • Example: @Entelligence.AI Can you suggest improvements for this code?
  • Execute a command using the format:

    @Entelligence.AI + *"/command"*

Available Commands:

  • /updateCommit: Apply the suggested changes and commit them.
  • /updateGuideline: Modify an existing guideline.
  • /addGuideline: Introduce a new guideline.

Tips for Using @Entelligence.AI Effectively:

  • Specific Queries: For the best results, be specific with your requests. Example: @Entelligence.AI summarize the changes in this PR.
  • Focused Discussions: Tag @Entelligence.AI directly on specific code lines or files for detailed feedback.
  • Managing Reviews: Use review comments for targeted discussions on code snippets, and PR comments for broader queries about the entire PR.

Need More Help?

  • Visit our documentation for detailed guides on using Entelligence.AI.
  • Join our community to connect with others, request features, and share feedback.
  • Follow us for updates on new features and improvements.

Added more context to certain areas and implemented fix requests
Copy link
Contributor Author

@TKTSWalker TKTSWalker left a comment

Choose a reason for hiding this comment

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

Good to go!

@TKTSWalker
Copy link
Contributor Author

Sorry for the small time gap, was preoccupied with my own project for a little! I've updated the journal, if there are any more problems please feel free to let me know!

@areibman areibman enabled auto-merge (squash) November 19, 2024 08:25
@areibman areibman merged commit 580867c into AgentOps-AI:main Nov 19, 2024
2 checks passed
@areibman
Copy link
Contributor

Thanks for the PR @TKTSWalker !

@TKTSWalker
Copy link
Contributor Author

No problem, looking forward to doing more!

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.

3 participants