update conversation > tools page with more information / examples #8113
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
dbanksdesign
previously approved these changes
Nov 20, 2024
cwomack
approved these changes
Nov 20, 2024
dbanksdesign
approved these changes
Nov 20, 2024
salihgueler
approved these changes
Nov 20, 2024
|
|
||
| Tools allow LLMs to take action or query information so it can respond with up to date information. There are a few different ways to define LLM tools in the Amplify AI kit. | ||
| There are a few different ways to define LLM tools in the Amplify AI kit. |
There was a problem hiding this comment.
Suggested change
| There are a few different ways to define LLM tools in the Amplify AI kit. | |
| There are three ways to define LLM tools in the Amplify AI kit. |
a few feels too vague for documentation.
There was a problem hiding this comment.
There are actually four 🙈
The last one is client tools. Let's update this to four when we add the client tool docs.
|
|
||
| 1. Model tools | ||
| 2. Query tools | ||
| 3. Lambda tools | ||
|
|
||
| The easiest way you can define tools for the LLM to use is with data models and custom queries in your data schema. When you define tools in your data schema, Amplify will take care of all of the heavy lifting required to properly implement such as: | ||
| The easiest way to define tools for your conversation route is with `a.ai.dataTool()` for data models and custom queries in your data schema. When you define a tool for a conversation route, Amplify takes care of the heavy lifting: |
There was a problem hiding this comment.
Suggested change
| The easiest way to define tools for your conversation route is with `a.ai.dataTool()` for data models and custom queries in your data schema. When you define a tool for a conversation route, Amplify takes care of the heavy lifting: | |
| The easiest way to define tools for your conversation route is by using `a.ai.dataTool()` data tool. Data tools can use a model generated list query or a custom query. | |
| Data tools are used with data models and custom queries in your data schema alongside with Amplify automatically handling the complex operations such as generating appropriate prompts, executing necessary database queries, and formatting results for the AI to utilize. |
IMO this stil needed to be deeper. I rewrote but I am not sure about it.
|
|
||
| ## Model tools | ||
|
|
||
| You can give the LLM access to your data models by referencing them in an `a.ai.dataTool()` with a reference to a model in your data schema. | ||
| You can give the LLM access to your data models by referencing them in an `a.ai.dataTool()` with a reference to a model in your data schema. This requires that the model uses at least one of the following authorization strategies: |
There was a problem hiding this comment.
We are missing a sentence about "Model tools". What I look for is something around "Model tools are xxxxx"
dindjarinjs
approved these changes
Nov 21, 2024
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.
Description of changes:
Adds explanations and updates examples in Conversation > Tools page.
Related GitHub issue #, if available:
Instructions
If this PR should not be merged upon approval for any reason, please submit as a DRAFT
Which product(s) are affected by this PR (if applicable)?
Which platform(s) are affected by this PR (if applicable)?
Please add the product(s)/platform(s) affected to the PR title
Checks
Does this PR conform to the styleguide?
Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.Are any files being deleted with this PR? If so, have the needed redirects been created?Are all links in MDX files using the MDX link syntax rather than HTML link syntax?
ref: MDX:
[link](https://docs.amplify.aws/)HTML:
<a href="https://docs.amplify.aws/">link</a>When this PR is ready to merge, please check the box below
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.