Merge pull request #145 from griptape-ai:dev

Dev
griptape-ai · Oct 30, 2024 · 203854d · 203854d
2 parents 65e55c7 + 474f1bc
commit 203854d
Show file tree

Hide file tree

Showing 50 changed files with 909 additions and 176 deletions.
diff --git a/README.md b/README.md
@@ -103,6 +103,10 @@ You can previous and download more examples [here](examples/README.md).
 
 ## Recent Changelog
 
+### Oct 31, 2024
+* Added tooltips for all drivers to help clarify properties
+* Added fix for Ollama Driver Config so it wouldn't fail if no embedding driver was specified.
+
 ### Oct 30, 2024
 * Updated to Griptape Framework v0.34.0
 * **Breaking Changes**

diff --git a/js/versions.js b/js/versions.js
@@ -1,11 +1,18 @@
 export const versions = {
-  "version": "0.34.0",
+  "version": "0.34.0a",
   "releaseDate": "2024-10-30",
   "name": "ComfyUI-Griptape",
   "description": "Griptape integration for ComfyUI",
   "author": "Jason Schleifer",
   "repository": "https://github.com/griptape-ai/ComfyUI-Griptape",
   "changelog": [
+    {
+      "version": "0.34.0a",
+      "date": "2024-10-31",
+      "changes": [
+        "fix for ollama driver to not break if no embedding driver specified",
+      ]
+    }, 
     {
       "version": "0.34.0",
       "date": "2024-10-30",

diff --git a/nodes/config/gtUIOllamaDriversConfig.py b/nodes/config/gtUIOllamaDriversConfig.py
@@ -5,6 +5,7 @@
 
 # StructureGlobalDriversConfig,
 from griptape.drivers import (
+    DummyEmbeddingDriver,
     LocalVectorStoreDriver,
     OllamaEmbeddingDriver,
     OllamaPromptDriver,
@@ -59,11 +60,14 @@ def create(self, **kwargs):
         drivers_config_params["prompt_driver"] = OllamaPromptDriver(
             **prompt_driver_params
         )
-        drivers_config_params["embedding_driver"] = OllamaEmbeddingDriver(
-            **embedding_driver_params
-        )
+        if "model" not in embedding_driver_params:
+            drivers_config_params["embedding_driver"] = DummyEmbeddingDriver()
+        else:
+            drivers_config_params["embedding_driver"] = OllamaEmbeddingDriver(
+                **embedding_driver_params
+            )
         drivers_config_params["vector_store_driver"] = LocalVectorStoreDriver(
-            embedding_driver=OllamaEmbeddingDriver(**embedding_driver_params)
+            embedding_driver=drivers_config_params["embedding_driver"]
         )
 
         try:

diff --git a/nodes/drivers/gtUIAmazonBedrockPromptDriver.py b/nodes/drivers/gtUIAmazonBedrockPromptDriver.py
@@ -39,15 +39,24 @@ def INPUT_TYPES(s):
             {
                 "aws_access_key_id_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_ACCESS_KEY_ID},
+                    {
+                        "default": DEFAULT_AWS_ACCESS_KEY_ID,
+                        "tooltip": "Enter the name of the environment variable for your AWS_ACCESS_KEY_ID, not your actual key.",
+                    },
                 ),
                 "aws_secret_access_key_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_SECRET_ACCESS_KEY},
+                    {
+                        "default": DEFAULT_AWS_SECRET_ACCESS_KEY,
+                        "tooltip": "Enter the name of the environment variable for your AWS_SECRET_ACCESS_KEY, not your actual key.",
+                    },
                 ),
                 "aws_default_region_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_DEFAULT_REGION},
+                    {
+                        "default": DEFAULT_AWS_DEFAULT_REGION,
+                        "tooltip": "Enter the name of the environment variable for your AWS_DEFAULT_REGION, not your actual region.",
+                    },
                 ),
             }
         )

diff --git a/nodes/drivers/gtUIAmazonBedrockStableDiffusionImageGenerationDriver.py b/nodes/drivers/gtUIAmazonBedrockStableDiffusionImageGenerationDriver.py
@@ -52,27 +52,60 @@ def INPUT_TYPES(s):
 
         inputs["optional"].update(
             {
-                "style_preset": (style_presets, {"default": style_presets[4]}),
+                "style_preset": (
+                    style_presets,
+                    {
+                        "default": style_presets[4],
+                        "tooltip": "Select a style preset for the image generation.",
+                    },
+                ),
                 "width": (
                     "INT",
-                    {"default": 512, "min": 64, "max": 2048, "step": 64},
+                    {
+                        "default": 512,
+                        "min": 64,
+                        "max": 2048,
+                        "step": 64,
+                        "tooltip": "Specify the width of the generated image.",
+                    },
                 ),
                 "height": (
                     "INT",
-                    {"default": 512, "min": 64, "max": 2048, "step": 64},
+                    {
+                        "default": 512,
+                        "min": 64,
+                        "max": 2048,
+                        "step": 64,
+                        "tooltip": "Specify the height of the generated image.",
+                    },
+                ),
+                "seed": (
+                    "INT",
+                    {
+                        "default": 12345,
+                        "tooltip": "Set the seed for random number generation to ensure reproducibility.",
+                    },
                 ),
-                "seed": ("INT", {"default": 12345}),
                 "aws_access_key_id_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_ACCESS_KEY_ID},
+                    {
+                        "default": DEFAULT_AWS_ACCESS_KEY_ID,
+                        "tooltip": "Enter the name of the environment variable for your AWS_ACCESS_KEY_ID, not your actual key.",
+                    },
                 ),
                 "aws_secret_access_key_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_SECRET_ACCESS_KEY},
+                    {
+                        "default": DEFAULT_AWS_SECRET_ACCESS_KEY,
+                        "tooltip": "Enter the name of the environment variable for your AWS_SECRET_ACCESS_KEY, not your actual key.",
+                    },
                 ),
                 "aws_default_region_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_DEFAULT_REGION},
+                    {
+                        "default": DEFAULT_AWS_DEFAULT_REGION,
+                        "tooltip": "Enter the name of the environment variable for your AWS_DEFAULT_REGION, not your actual region.",
+                    },
                 ),
             }
         )

diff --git a/nodes/drivers/gtUIAmazonBedrockTitanEmbeddingDriver.py b/nodes/drivers/gtUIAmazonBedrockTitanEmbeddingDriver.py
@@ -34,19 +34,31 @@ def INPUT_TYPES(s):
             {
                 "embedding_model": (
                     models,
-                    {"default": models[0]},
+                    {
+                        "default": models[0],
+                        "tooltip": "Select the embedding model to use.",
+                    },
                 ),
                 "aws_access_key_id_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_ACCESS_KEY_ID},
+                    {
+                        "default": DEFAULT_AWS_ACCESS_KEY_ID,
+                        "tooltip": "Enter the name of the environment variable for your AWS_ACCESS_KEY_ID, not your actual key.",
+                    },
                 ),
                 "aws_secret_access_key_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_SECRET_ACCESS_KEY},
+                    {
+                        "default": DEFAULT_AWS_SECRET_ACCESS_KEY,
+                        "tooltip": "Enter the name of the environment variable for your AWS_SECRET_ACCESS_KEY, not your actual key.",
+                    },
                 ),
                 "aws_default_region_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_DEFAULT_REGION},
+                    {
+                        "default": DEFAULT_AWS_DEFAULT_REGION,
+                        "tooltip": "Enter the name of the environment variable for your AWS_DEFAULT_REGION, not your actual region.",
+                    },
                 ),
             }
         )

diff --git a/nodes/drivers/gtUIAmazonBedrockTitanImageGenerationDriver.py b/nodes/drivers/gtUIAmazonBedrockTitanImageGenerationDriver.py
@@ -35,21 +35,45 @@ def INPUT_TYPES(s):
             {
                 "image_generation_model": (
                     "STRING",
-                    {"default": "amazon.titan-image-generator-v1"},
+                    {
+                        "default": "amazon.titan-image-generator-v1",
+                        "tooltip": "Select the image generation model to use.",
+                    },
+                ),
+                "size": (
+                    sizes,
+                    {
+                        "default": sizes[0],
+                        "tooltip": "Choose the size of the generated image.",
+                    },
+                ),
+                "seed": (
+                    "INT",
+                    {
+                        "default": 10342349342,
+                        "tooltip": "Set the seed for random number generation.",
+                    },
                 ),
-                "size": (sizes, {"default": sizes[0]}),
-                "seed": ("INT", {"default": 10342349342}),
                 "aws_access_key_id_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_ACCESS_KEY_ID},
+                    {
+                        "default": DEFAULT_AWS_ACCESS_KEY_ID,
+                        "tooltip": "Enter the name of the environment variable for your AWS_ACCESS_KEY_ID, not your actual key.",
+                    },
                 ),
                 "aws_secret_access_key_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_SECRET_ACCESS_KEY},
+                    {
+                        "default": DEFAULT_AWS_SECRET_ACCESS_KEY,
+                        "tooltip": "Enter the name of the environment variable for your AWS_SECRET_ACCESS_KEY, not your actual key.",
+                    },
                 ),
                 "aws_default_region_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_DEFAULT_REGION},
+                    {
+                        "default": DEFAULT_AWS_DEFAULT_REGION,
+                        "tooltip": "Enter the name of the environment variable for your AWS_DEFAULT_REGION, not your actual region.",
+                    },
                 ),
             }
         )

diff --git a/nodes/drivers/gtUIAmazonOpenSearchVectorStoreDriver.py b/nodes/drivers/gtUIAmazonOpenSearchVectorStoreDriver.py
@@ -31,19 +31,40 @@ def INPUT_TYPES(s):
 
         inputs["optional"].update(
             {
-                "host_env": ("STRING", {"default": DEFAULT_HOST_ENV}),
-                "index_env": ("STRING", {"default": DEFAULT_INDEX_ENV}),
+                "host_env": (
+                    "STRING",
+                    {
+                        "default": DEFAULT_HOST_ENV,
+                        "tooltip": "Enter the name of the environment variable for your AMAZON_OPENSEARCH_HOST, not your actual host.",
+                    },
+                ),
+                "index_env": (
+                    "STRING",
+                    {
+                        "default": DEFAULT_INDEX_ENV,
+                        "tooltip": "Enter the name of the environment variable for your AMAZON_OPENSEARCH_INDEX_NAME, not your actual index name.",
+                    },
+                ),
                 "aws_access_key_id_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_ACCESS_KEY_ID},
+                    {
+                        "default": DEFAULT_AWS_ACCESS_KEY_ID,
+                        "tooltip": "Enter the name of the environment variable for your AWS_ACCESS_KEY_ID, not your actual key.",
+                    },
                 ),
                 "aws_secret_access_key_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_SECRET_ACCESS_KEY},
+                    {
+                        "default": DEFAULT_AWS_SECRET_ACCESS_KEY,
+                        "tooltip": "Enter the name of the environment variable for your AWS_SECRET_ACCESS_KEY, not your actual key.",
+                    },
                 ),
                 "aws_default_region_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_DEFAULT_REGION},
+                    {
+                        "default": DEFAULT_AWS_DEFAULT_REGION,
+                        "tooltip": "Enter the name of the environment variable for your AWS_DEFAULT_REGION, not your actual region.",
+                    },
                 ),
             }
         )

diff --git a/nodes/drivers/gtUIAmazonSageMakerJumpstartEmbeddingDriver.py b/nodes/drivers/gtUIAmazonSageMakerJumpstartEmbeddingDriver.py
@@ -27,19 +27,40 @@ def INPUT_TYPES(s):
         inputs["optional"].update(base_optional_inputs)
         inputs["optional"].update(
             {
-                "embedding_model": ("STRING", {"default": default_model}),
-                "endpoint": ("STRING", {"default": default_endpoint}),
+                "embedding_model": (
+                    "STRING",
+                    {
+                        "default": default_model,
+                        "tooltip": "Specify the embedding model to use.",
+                    },
+                ),
+                "endpoint": (
+                    "STRING",
+                    {
+                        "default": default_endpoint,
+                        "tooltip": "Specify the SageMaker endpoint to use.",
+                    },
+                ),
                 "aws_access_key_id_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_ACCESS_KEY_ID},
+                    {
+                        "default": DEFAULT_AWS_ACCESS_KEY_ID,
+                        "tooltip": "Enter the name of the environment variable for your AWS_ACCESS_KEY_ID, not your actual key.",
+                    },
                 ),
                 "aws_secret_access_key_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_SECRET_ACCESS_KEY},
+                    {
+                        "default": DEFAULT_AWS_SECRET_ACCESS_KEY,
+                        "tooltip": "Enter the name of the environment variable for your AWS_SECRET_ACCESS_KEY, not your actual key.",
+                    },
                 ),
                 "aws_default_region_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_DEFAULT_REGION},
+                    {
+                        "default": DEFAULT_AWS_DEFAULT_REGION,
+                        "tooltip": "Enter the name of the environment variable for your AWS_DEFAULT_REGION, not your actual region.",
+                    },
                 ),
             }
         )

diff --git a/nodes/drivers/gtUIAmazonSageMakerJumpstartPromptDriver.py b/nodes/drivers/gtUIAmazonSageMakerJumpstartPromptDriver.py
@@ -18,19 +18,40 @@ def INPUT_TYPES(s):
         inputs["required"].update()
         inputs["optional"].update(
             {
-                "model": ("STRING", {"default": default_model}),
-                "endpoint": ("STRING", {"default": default_endpoint}),
+                "model": (
+                    "STRING",
+                    {
+                        "default": default_model,
+                        "tooltip": "Specify the model to use. Default is Meta-Llama-3-8B-Instruct.",
+                    },
+                ),
+                "endpoint": (
+                    "STRING",
+                    {
+                        "default": default_endpoint,
+                        "tooltip": "Specify the SageMaker endpoint to use.",
+                    },
+                ),
                 "aws_access_key_id_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_ACCESS_KEY_ID},
+                    {
+                        "default": DEFAULT_AWS_ACCESS_KEY_ID,
+                        "tooltip": "Enter the name of the environment variable for your AWS_ACCESS_KEY_ID, not your actual key.",
+                    },
                 ),
                 "aws_secret_access_key_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_SECRET_ACCESS_KEY},
+                    {
+                        "default": DEFAULT_AWS_SECRET_ACCESS_KEY,
+                        "tooltip": "Enter the name of the environment variable for your AWS_SECRET_ACCESS_KEY, not your actual key.",
+                    },
                 ),
                 "aws_default_region_env_var": (
                     "STRING",
-                    {"default": DEFAULT_AWS_DEFAULT_REGION},
+                    {
+                        "default": DEFAULT_AWS_DEFAULT_REGION,
+                        "tooltip": "Enter the name of the environment variable for your AWS_DEFAULT_REGION, not your actual region.",
+                    },
                 ),
             }
         )