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.

Sign up for GitHub

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

Jump to bottom

Cloud Tool docs #1383

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

Cloud Tool docs #1383

wants to merge 1 commit into from

Conversation

vachillo
Copy link
Member

@vachillo vachillo commented Nov 25, 2024 •
edited
Loading

Describe your changes

add cloud docs for tools

Issue ticket number and link

📚 Documentation preview 📚: https://griptape--1383.org.readthedocs.build//1383/

@codecov Codecov
Copy link

codecov bot commented Nov 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@vachillo vachillo changed the title Tool docs Cloud Tool docs Nov 26, 2024
collindutter
collindutter requested changes Nov 26, 2024
View reviewed changes
docs/griptape-cloud/index.md Outdated
@@ -10,6 +10,10 @@ Connect to your data with our [Data Sources](data-sources/create-data-source.md)

Have Griptape code? Have existing code with another LLM framework? You can host your Python code using [Structures](structures/create-structure.md) whether it uses the Griptape Framework or not.

## Empower any LLM With Custom Tools

Create custom actions that LLMs can perform with [Tools](tools/create-tool.md). These Tools can be created, shared, and given to any LLM integration.
Copy link
Member

Choose a reason for hiding this comment

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

"any LLM" is a big claim, can we back it up?

docs/griptape-cloud/tools/create-tool.md
Copy link
Member

Choose a reason for hiding this comment

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

Should we link out to Griptape Tools anywhere?

docs/griptape-cloud/tools/create-tool.md Outdated
@@ -0,0 +1,17 @@
# Tools

Tools can be used to execute arbitrary actions in a request/response format. They can be given to an LLM so the LLM can take appropriate action based on the input, Tool description, and the description of each Tool activity.
Copy link
Member

Choose a reason for hiding this comment

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

Same here, as a developer I'm not learning anything that tells me what a Tool does or why I'd want to use one.

docs/griptape-cloud/tools/run-tool.md Outdated
@@ -0,0 +1,26 @@
# Running a Tool

Once your Tool is created and deployed, you can run your Tool one of three ways outlined below. You may view the details of any of your runs, no matter how you created them, in the `Runs` tab of your Tool.
Copy link
Member

Choose a reason for hiding this comment

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

no matter how you created them,

Feels unneeded.

Copy link
Member Author

Choose a reason for hiding this comment

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

i copied that wording from the structures tab

docs/griptape-cloud/tools/run-tool.md

## From the API

The API route for Tool activities is in the form of `https://cloud.griptape.ai/api/tools/{tool_id}/activities/{activity_name}`, where `tool_id` is the resource UUID of your created Tool, and `activity_name` is the name of the activity as defined in your `BaseTool` class. The activity routes will only accept an http POST method.
Copy link
Member

Choose a reason for hiding this comment

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

We reference the concept of "Activities" without explaining at all what they are.

Copy link
Member Author

Choose a reason for hiding this comment

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

I am referencing the framework tool below, should that be pulled to the top?

docs/griptape-cloud/index.md Outdated
@@ -10,6 +10,10 @@ Connect to your data with our [Data Sources](data-sources/create-data-source.md)

Have Griptape code? Have existing code with another LLM framework? You can host your Python code using [Structures](structures/create-structure.md) whether it uses the Griptape Framework or not.

## Empower any LLM With Custom Tools

Create custom actions that LLMs can perform with [Tools](tools/create-tool.md). These Tools can be created, shared, and given to any LLM integration.
Copy link
Member

Choose a reason for hiding this comment

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

This doesn't really tell me when/why I'd want to create a Tool on Griptape Cloud.

@collindutter collindutter changed the base branch from dev to main December 10, 2024 18:56
@collindutter
Copy link
Member

@vachillo are you still iterating on these? @SavagePencil have you gotten a chance to review?

@collindutter collindutter added type:documentation Related to documentation. help wanted Extra attention is needed labels Dec 19, 2024
SavagePencil
SavagePencil requested changes Dec 20, 2024
View reviewed changes
docs/griptape-cloud/index.md Outdated
@@ -10,6 +10,10 @@ Connect to your data with our [Data Sources](data-sources/create-data-source.md)

Have Griptape code? Have existing code with another LLM framework? You can host your Python code using [Structures](structures/create-structure.md) whether it uses the Griptape Framework or not.

## Empower any LLM With Custom Tools
Copy link
Member

Choose a reason for hiding this comment

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

"Empower any LLM" feels like sales material.

docs/griptape-cloud/index.md Outdated
@@ -10,6 +10,10 @@ Connect to your data with our [Data Sources](data-sources/create-data-source.md)

Have Griptape code? Have existing code with another LLM framework? You can host your Python code using [Structures](structures/create-structure.md) whether it uses the Griptape Framework or not.

## Empower any LLM With Custom Tools

Create custom actions that LLMs can perform with [Tools](tools/create-tool.md). These Tools can be created, shared, and given to any LLM integration.
Copy link
Member

Choose a reason for hiding this comment

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

Give examples of why this is good/why user would care.

docs/griptape-cloud/tools/create-tool.md Outdated
@@ -0,0 +1,17 @@
# Tools

Tools can be used to execute arbitrary actions in a request/response format. They can be given to an LLM so the LLM can take appropriate action based on the input, Tool description, and the description of each Tool activity.
Copy link
Member

Choose a reason for hiding this comment

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

"Tool description, and the description of each Tool activity" is a confusing read.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@collindutter collindutter Awaiting requested review from collindutter

@SavagePencil SavagePencil Awaiting requested review from SavagePencil

Requested changes must be addressed to merge this pull request.

Assignees

@vachillo vachillo

Labels
help wanted Extra attention is needed type:documentation Related to documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@vachillo @collindutter @SavagePencil