griptape-ai / griptape-docs Goto Github PK

I was going through the quick start documentation for skatepark (https://griptape.readthedocs.io/en/latest/skatepark/quick_start/) and when I tried to use the "gpt-4" model in the following code it returned an error:

pipeline = Pipeline(
    memory = PipelineMemory(),
    prompt_driver = OpenAiPromptDriver(
        model="gpt-4"
    ),
    tool_loader = ToolLoader(
        tools=[scraper]
    )
)

The error was: ERROR:root:PromptDriver.run attempt 0 failed: The model: gpt-4 does not exist

If I commented out the prompt_driver section of the code so it uses the default, then I'm getting the following error:

Invalid JSON: {'value': 'https://en.wikipedia.org/wiki/Large_language_model'} is not of type 'string'

Failed validating 'type' in schema['properties']['value']:
    {'description': 'Valid HTTP URL', 'type': 'string'}

On instance['value']:
    {'value': 'https://en.wikipedia.org/wiki/Large_language_model'}

I thought that perhaps there was an issue with the WebScraper tool, as in visual studio code it is showing an error in the line `openai_api_key=config("OPENAI_API_KEY)

do you have any ideas or suggestions?

Thanks!
-Jason

I see it mentioned in the https://github.com/griptape-ai/griptape#quick-start, but not sure what it is. I haven't built anything with this, but I was perusing the docs to understand it and saw the gap

We need a section in the documentation explaining the purpose of the PromptStack abstraction and how it's used in prompt drivers.

Currently griptape tools contain a reference to PdfReader (https://docs.griptape.ai/en/latest/griptape-tools/official-tools/pdf-reader/), but it's not a tool anymore.

Now that we have the ability to stream results back to the user, it would be great to include a stream parameter to the Chat utility.

The CSV (and other loader) docs should probably have 1 example of how to use the loaded info as well. I think ideally, you'd have 1 (or small number of) end to end example... then you could swap out the loader to adjust the code snippet to load from some other source type.

The current docs make reference to griptape.memory.tool.storage which doesn't exist:

from griptape.memory.tool.storage import TextArtifactStorage, BlobArtifactStorage

Pipeline and Workflow documentation still reference input and inputs instead of parent_output and parent_outputs.

They should be updated to match the latest names.

Text in center panel runs over to the right. Safari

I found a few decorator description bugs while browsing https://github.com/griptape-ai/griptape-tools/blob/main/griptape/tools/rest_api_client/tool.py.

https://github.com/griptape-ai/griptape-tools/blob/main/griptape/tools/rest_api_client/tool.py#L71 : s/post/patch/
https://github.com/griptape-ai/griptape-tools/blob/main/griptape/tools/rest_api_client/tool.py#L110 : s/patch/post/
https://github.com/griptape-ai/griptape-tools/blob/main/griptape/tools/rest_api_client/tool.py#L189 : s/get/delete/

Happy to open a PR.

Add a "Data" section in the main framework section with the following topics covered:

• Artifacts
• Vector storage

Relates to unable to stream#258

Adding a custom tool allows for the user to include dependencies, but it's unclear how to use it other than add the dependency to requirements.txt.

We could improve the docs by explaining

• Where import statements should go
• What the dependencies_install_directory does

Similarities on the front page:

Explain the similaritiies about these movies:

It would be great to add namespace="griptape" to Text Query Task example by the same way it was done for VectorStoreClient tool.

In the quickstart documentation the instructions say to install Skatepark, Griptape Tools, and Decouple, but then the code only shows:

pip install skatepark-lib griptape-tools

In Visual Studio Code I was getting a Pylance error:

so thought maybe I had to install decouple.

I did a pip install decouple which completely broke things. :)

I then had to pip uninstall decouple, and make sure python-decouple was up to date.

Probably best to call out python-decouple at the top of the QuickStart docs.

cheers,
Jason

Needs an example code using Griptape Agent and output.

need to add example of GoogleDocsClient in Griptape Docs.

Documentation is missing for the following tasks:

• ExtractionTask
• TextQueryTask
• TextSummaryTask
• ToolTask

Need to add example of GoogleDriveClient tool to Griptape Docs.

The Custom Tools documentation could use a little more step-by-step instruction.

For this custom tool, is it recommended to create a tools folder in the current project, or add their custom tools to the griptape/tools folder?

Let's say they've got a project called learning_griptape, and they want to use the random_number_generator in a file called random_test.py.

If they create a tools directory, what is the recommended structure to get this to work correctly? I'm assuming something like:

learning_griptape/
  random_test.py
  tools/
    random_number_generator/
      __init__.py
      manifest.yaml
      requirements.txt
      tool.py

do you also need an init.py in the tools/ directory?

if that's the case, and the user wants to use the LocalExecutor() command specified in the docs, could you specify exactly the import calls in the random_test.py, and how you'd call RandomNumberGenerator?

I tried a number of things & couldn't get it working. I'm sure it's a simple thing, but since this is getting started documentation, it'd be good to include all of the steps.

thanks!
-Jason

It needs an example using the optional attachment parameter for drafting emails.

Add docs for the following extraction engines:

• CsvExtractionEngine
• JsonExtractionEngine

https://github.com/griptape-ai/griptape/blob/main/griptape/tools/openweather_client/tool.py

Should use a Titan model.

Need to update documentation for user versions of GoogleCalenderClient and GoogleGmailClient after PR for normalizing them in the Griptape Framework is merged.

on https://docs.griptape.ai/latest/griptape-tools/custom-tools/, one of the code snippets isn't rendering correctly.

Under Tool Implementation:

Hello!

Just wanted to let you know that I noticed the "learn more" links are broken on the main docs page.

If you go to https://griptape.readthedocs.io/en/latest/ and click on the "Learn more about Griptape" or "Learn more about Skatepark" the links are missing "en/language" in the url.

They point to: https://griptape.readthedocs.io/griptape and https://griptape.readthedocs.io/skatepark, but should point to https://griptape.readthedocs.io/en/latest/griptape/ and https://griptape.readthedocs.io/en/latest/skatepark/ respectively.

Cheers!
-Jason

There is currently no documentation for the ImageGenerationTask.