Cloud Tool docs #1383

vachillo · 2024-11-25T20:08:47Z

I have read and agree to the contributing guidelines for submitting new pull requests.

Describe your changes

add cloud docs for tools

Issue ticket number and link

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

codecov · 2024-11-25T20:18:01Z

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

collindutter · 2024-11-26T18:31:11Z

docs/griptape-cloud/index.md

@@ -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.


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

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

collindutter · 2024-11-26T18:34:18Z

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

@@ -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.


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.

collindutter · 2024-11-26T18:34:48Z

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

@@ -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.


no matter how you created them,

Feels unneeded.

i copied that wording from the structures tab

collindutter · 2024-11-26T18:35:56Z

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.


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

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

Maybe provide a simple example? For instance, what would the url for a hosted calculator tool look like?

collindutter · 2024-11-26T18:37:44Z

docs/griptape-cloud/index.md

@@ -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.


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

collindutter · 2024-12-16T17:34:30Z

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

SavagePencil · 2024-12-20T14:47:47Z

docs/griptape-cloud/index.md

@@ -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


"Empower any LLM" feels like sales material.

SavagePencil · 2024-12-20T14:48:10Z

docs/griptape-cloud/index.md

@@ -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.


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

SavagePencil · 2024-12-20T14:50:08Z

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

@@ -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.


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

SavagePencil · 2025-01-07T23:27:27Z

docs/griptape-cloud/index.md

@@ -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.

+## Augment LLM requests with Tools
+
+Create custom actions that LLMs can perform with [Tools](tools/create-tool.md). Tools in the cloud are instances of [Griptape Framework Tools](/griptape-tools/index.md) and can be run from anywhere with a simple API call or through Griptape Framework's [GriptapeCloudToolTool](/griptpe-tools/official-tools/griptape-cloud-tool-tool.md).


Something here still feels clunky. How about something like "Expand the capabilities of your agents with custom Tools they can call as part of their jobs. These Tools allow them to call services or perform custom logic. Tools in the cloud are instances of Griptape Framework Tools and can be run from anywhere with a simple API call or through Griptape Framework's GriptapeCloudToolTool." ?

Maybe add something like "Tools can bridge the gap between the model and your application". Explain why you'd want to create custom actions.

SavagePencil · 2025-01-07T23:28:11Z

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

@@ -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 metadata of the Tool.


Are we giving them to an LLM, or an agent? Is there another term?

SavagePencil · 2025-01-07T23:29:11Z

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

@@ -0,0 +1,62 @@
+## Overview
+
+Tool repositories require a configuration file which informs Griptape Cloud of your Managed Tool's dependencies and how it needs to build and run.


Here we say "Managed Tool" with a capital "M". Is that a term we are/should be using throughout to make it distinct from framework tool?

collindutter · 2025-01-07T23:26:21Z

docs/griptape-cloud/index.md

@@ -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.

+## Augment LLM requests with Tools
+
+Create custom actions that LLMs can perform with [Tools](tools/create-tool.md). Tools in the cloud are instances of [Griptape Framework Tools](/griptape-tools/index.md) and can be run from anywhere with a simple API call or through Griptape Framework's [GriptapeCloudToolTool](/griptpe-tools/official-tools/griptape-cloud-tool-tool.md).


can be run from anywhere with a simple API call

We already mention this below, can probably drop.

All of our features can be called via API

collindutter · 2025-01-07T23:32:55Z

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

@@ -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 metadata of the Tool.


Tools can be used to execute arbitrary actions in a request/response format

This sounds a bit technical.

They can be given to an LLM so the LLM can take appropriate action based on the metadata of the Tool.

I don't fully understand what this means. What metadata?

I would explain that this is just hosted Griptape Tools and then link out to Griptape docs for explanations on how Tools work.

collindutter · 2025-01-07T23:33:29Z

docs/griptape-cloud/index.md

@@ -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.

+## Augment LLM requests with Tools
+
+Create custom actions that LLMs can perform with [Tools](tools/create-tool.md). Tools in the cloud are instances of [Griptape Framework Tools](/griptape-tools/index.md) and can be run from anywhere with a simple API call or through Griptape Framework's [GriptapeCloudToolTool](/griptpe-tools/official-tools/griptape-cloud-tool-tool.md).


Maybe add something like "Tools can bridge the gap between the model and your application". Explain why you'd want to create custom actions.

collindutter · 2025-01-07T23:35:30Z

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.


Maybe provide a simple example? For instance, what would the url for a hosted calculator tool look like?

vachillo requested review from SavagePencil and collindutter November 25, 2024 20:08

collindutter force-pushed the tool_docs branch from 97bede4 to 95f909b Compare November 26, 2024 18:00

vachillo force-pushed the tool_docs branch from 95f909b to 2d722c8 Compare November 26, 2024 18:02

vachillo changed the title ~~Tool docs~~ Cloud Tool docs Nov 26, 2024

collindutter requested changes Nov 26, 2024

View reviewed changes

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

collindutter added type:documentation Related to documentation. help wanted Extra attention is needed labels Dec 19, 2024

SavagePencil requested changes Dec 20, 2024

View reviewed changes

vachillo force-pushed the tool_docs branch 2 times, most recently from a5b385b to d6e4b54 Compare December 20, 2024 15:47

vachillo requested review from collindutter and SavagePencil December 20, 2024 15:47

collindutter assigned vachillo Dec 24, 2024

tool docs

5ce2ea9

vachillo force-pushed the tool_docs branch from d6e4b54 to 5ce2ea9 Compare January 7, 2025 21:46

SavagePencil requested changes Jan 7, 2025

View reviewed changes

collindutter reviewed Jan 7, 2025

View reviewed changes

collindutter removed the help wanted Extra attention is needed label Jan 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cloud Tool docs #1383

Cloud Tool docs #1383

vachillo commented Nov 25, 2024 •

edited

Loading

codecov bot commented Nov 25, 2024

collindutter Nov 26, 2024

collindutter Nov 26, 2024

collindutter Nov 26, 2024

vachillo Dec 20, 2024

collindutter Nov 26, 2024

vachillo Nov 27, 2024

collindutter Jan 7, 2025

collindutter Nov 26, 2024

collindutter commented Dec 16, 2024

SavagePencil Dec 20, 2024

SavagePencil Dec 20, 2024

SavagePencil Dec 20, 2024

SavagePencil Jan 7, 2025

collindutter Jan 7, 2025

SavagePencil Jan 7, 2025

SavagePencil Jan 7, 2025

collindutter Jan 7, 2025

collindutter Jan 7, 2025

collindutter Jan 7, 2025

collindutter Jan 7, 2025

		@@ -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.

		@@ -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.


		## 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.

		@@ -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

		@@ -0,0 +1,62 @@
		## Overview

		Tool repositories require a configuration file which informs Griptape Cloud of your Managed Tool's dependencies and how it needs to build and run.

Cloud Tool docs #1383

Are you sure you want to change the base?

Cloud Tool docs #1383

Conversation

vachillo commented Nov 25, 2024 • edited Loading

Describe your changes

Issue ticket number and link

codecov bot commented Nov 25, 2024

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

collindutter commented Dec 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vachillo commented Nov 25, 2024 •

edited

Loading