CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Changed

• Default behavior of OpenAiStructureConfig to utilize gpt-4o for prompt_driver.

[0.25.1] - 2024-05-09

Added

• Optional event batching on Event Listener Drivers.
• id field to all events.

Changed

• Default behavior of Event Listener Drivers to batch events.

[0.25.0] - 2024-05-06

Added

• list_files_from_disk activity to FileManager Tool.
• Support for Drivers in EventListener.
• AmazonSqsEventListenerDriver for sending events to an Amazon SQS queue.
• AwsIotCoreEventListenerDriver for sending events to a topic on AWS IoT Core.
• GriptapeCloudEventListenerDriver for sending events to Griptape Cloud.
• WebhookEventListenerDriver for sending events to a webhook.
• BaseFileManagerDriver to abstract file management operations.
• LocalFileManagerDriver for managing files on the local file system.
• Optional BaseLoader.encoding field.
• BlobLoader for loading arbitrary binary data as a BlobArtifact.
• model field to StartPromptEvent and FinishPromptEvent.
• input_task_input and input_task_output fields to StartStructureRunEvent.
• output_task_input and output_task_output fields to FinishStructureRunEvent.
• AmazonS3FileManagerDriver for managing files on Amazon S3.
• MediaArtifact as a base class for ImageArtifact and future media Artifacts.
• Optional exception field to ErrorArtifact.
• StructureRunClient for running other Structures via a Tool.
• StructureRunTask for running Structures as a Task from within another Structure.
• GriptapeCloudStructureRunDriver for running Structures in Griptape Cloud.
• LocalStructureRunDriver for running Structures in the same run-time environment as the code that is running the Structure.

Changed

• BREAKING: Secret fields (ex: api_key) removed from serialized Drivers.
• BREAKING: Remove FileLoader.
• BREAKING: CsvLoader no longer accepts str file paths as a source. It will now accept the content of the CSV file as a str or bytes object.
• BREAKING: PdfLoader no longer accepts str file content, Path file paths or IO objects as sources. Instead, it will only accept the content of the PDF file as a bytes object.
• BREAKING: TextLoader no longer accepts Path file paths as a source. It will now accept the content of the text file as a str or bytes object.
• BREAKING: FileManager.default_loader is now None by default.
• BREAKING Bumped pinecone from ^2 to ^3.
• BREAKING: Removed workdir, loaders, default_loader, and save_file_encoding fields from FileManager and added file_manager_driver.
• BREAKING: Removed mime_type field from ImageArtifact. mime_type is now a property constructed using the Artifact type and format field.
• Improved RAG performance in VectorQueryEngine.
• Moved Griptape Docs to this repository.
• Updated EventListener.handler's behavior so that the return value will be passed to the EventListenerDriver.try_publish_event_payload's event_payload parameter.

Fixed

• Type hint for parameter azure_ad_token_provider on Azure OpenAI drivers to Optional[Callable[[], str]].
• Missing parameters azure_ad_token and azure_ad_token_provider on the default client for AzureOpenAiCompletionPromptDriver.

[0.24.2] - 2024-04-04

• Fixed FileManager.load_files_from_disk schema.

[0.24.1] - 2024-03-28

Fixed

• Fixed boto3 type-checking stub dependency.

Changed

• Use schema instead of jsonschema for JSON validation.

[0.24.0] - 2024-03-27

Added

• Every subtask in ToolkitTask can now execute multiple actions in parallel.
• Added BaseActionSubtaskEvent.subtask_actions.
• Support for text-embedding-3-small and text-embedding-3-large models.
• GooglePromptDriver and GoogleTokenizer for use with gemini-pro.
• GoogleEmbeddingDriver for use with embedding-001.
• GoogleStructureConfig for providing Structures with Google Prompt and Embedding Driver configuration.
• Support for claude-3-opus, claude-3-sonnet, and claude-3-haiku in AnthropicPromptDriver.
• Support for anthropic.claude-3-sonnet-20240229-v1:0 and anthropic.claude-3-haiku-20240307-v1:0 in BedrockClaudePromptModelDriver.
• top_k and top_p parameters in AnthropicPromptDriver.
• Added AnthropicImageQueryDriver for Claude-3 multi-modal models
• Added AmazonBedrockImageQueryDriver along with BedrockClaudeImageQueryDriverModel for Claude-3 in Bedrock support
• BaseWebScraperDriver allowing multiple web scraping implementations.
• TrafilaturaWebScraperDriver for scraping text from web pages using trafilatura.
• MarkdownifyWebScraperDriver for scraping text from web pages using playwright and converting to markdown using markdownify.
• VoyageAiEmbeddingDriver for use with VoyageAi's embedding models.
• AnthropicStructureConfig for providing Structures with Anthropic Prompt and VoyageAi Embedding Driver configuration.

Fixed

• Improved system prompt in ToolTask to support more use cases.

Changed

• BREAKING: ActionSubtask was renamed to ActionsSubtask.
• BREAKING: Removed subtask_action_name, subtask_action_path, and subtask_action_input in BaseActionSubtaskEvent.
• BREAKING: OpenAiVisionImageQueryDriver field model no longer defaults to gpt-4-vision-preview and must be specified
• Default model of OpenAiEmbeddingDriver to text-embedding-3-small.
• Default model of OpenAiStructureConfig to text-embedding-3-small.
• BaseTextLoader to accept a BaseChunker.
• Default model of AmazonBedrockStructureConfig to anthropic.claude-3-sonnet-20240229-v1:0.
• AnthropicPromptDriver and BedrockClaudePromptModelDriver to use Anthropic's Messages API.
• OpenAiVisionImageQueryDriver now has a required field max_tokens that defaults to 256

[0.23.2] - 2024-03-15

Fixed

• Deprecation warnings not displaying for Structure.prompt_driver, Structure.embedding_driver, and Structure.stream.
• DummyException error message not fully displaying.
• StructureConfig.task_memory not defaulting to using StructureConfig.global_drivers by default.

[0.23.1] - 2024-03-07

Fixed

• Action Subtask incorrectly raising an exception for actions without an input.
• Incorrect GriptapeCloudKnowledgeBaseClient's API URLs.
• Issue with Tool Task system prompt causing the LLM to generate an invalid action.

[0.23.0] - 2024-02-26

Added

• Image-to-image generation support for OpenAi Dall-E 2 model.
• Image tools support loading artifacts from memory.
• AzureMongoDbVectorStoreDriver for using CosmosDB with MongoDB vCore API.
• vector_path field on MongoDbAtlasVectorStoreDriver.
• LeonardoImageGenerationDriver supports image to image generation.
• OpenAiStructureConfig for providing Structures with all OpenAi Driver configuration.
• AmazonBedrockStructureConfig for providing Structures with all Amazon Bedrock Driver configuration.
• StructureConfig for building your own Structure configuration.
• JsonExtractionTask for convenience over using ExtractionTask with a JsonExtractionEngine.
• CsvExtractionTask for convenience over using ExtractionTask with a CsvExtractionEngine.
• OpenAiVisionImageQueryDriver to support queries on images using OpenAI's Vision model.
• ImageQueryClient allowing an Agent to make queries on images on disk or in Task Memory.
• ImageQueryTask and ImageQueryEngine.

Fixed

• BedrockStableDiffusionImageGenerationModelDriver request parameters for SDXLv1 (stability.stable-diffusion-xl-v1).
• BedrockStableDiffusionImageGenerationModelDriver correctly handles the CONTENT_FILTERED response case.

Changed

• BREAKING: Make index_name on MongoDbAtlasVectorStoreDriver a required field.
• BREAKING: Remove create_index() from MarqoVectorStoreDriver, OpenSearchVectorStoreDriver, PineconeVectorStoreDriver, RedisVectorStoreDriver.
• BREAKING: ImageLoader().load() now accepts image bytes instead of a file path.
• BREAKING: Request parameters for BedrockStableDiffusionImageGenerationModelDriver have been updated for stability.stable-diffusion-xl-v1. Use this over the now deprecated stability.stable-diffusion-xl-v0.
• Deprecated Structure.prompt_driver in favor of Structure.config.global_drivers.prompt_driver.
• Deprecated Structure.embedding_driver in favor of Structure.config.global_drivers.embedding_driver.
• Deprecated Structure.stream in favor of Structure.config.global_drivers.prompt_driver.stream.
• TextSummaryTask.summary_engine now defaults to a PromptSummaryEngine with a Prompt Driver default of Structure.config.global_drivers.prompt_driver.
• TextQueryTask.query_engine now defaults to a VectorQueryEngine with a Prompt Driver default of Structure.config.global_drivers.prompt_driver and Vector Store Driver default of Structure.config.global_drivers.vector_store_driver.
• PromptImageGenerationTask.image_generation_engine now defaults to a PromptImageGenerationEngine with an Image Generation Driver default of Structure.config.global_drivers.image_generation_driver.
• VariationImageGenerationTask.image_generation_engine now defaults to a VariationImageGenerationEngine with an Image Generation Driver default of Structure.config.global_drivers.image_generation_driver.
• InpaintingImageGenerationTask.image_generation_engine now defaults to an InpaintingImageGenerationEngine with an Image Generation Driver default of Structure.config.global_drivers.image_generation_driver.
• OutpaintingImageGenerationTask.image_generation_engine now defaults to an OutpaintingImageGenerationEngine with an Image Generation Driver default of Structure.config.global_drivers.image_generation_driver.

[0.22.3] - 2024-01-22

Fixed

• ToolkitTask's user subtask prompt occasionally causing the Task to end prematurely.

[0.22.2] - 2024-01-18

Fixed

• ToolkitTask's user subtask prompt occasionally causing a loop with Chain of Thought.

Security

• Updated stale dependencies [CVE-2023-50447, CVE-2024-22195, and CVE-2023-36464]

[0.22.1] - 2024-01-12

Fixed

• Action Subtasks incorrectly outputting the Task input after failing to follow the ReAct prompt.

[0.22.0] - 2024-01-11

Added

• PromptImageGenerationEngine for generating images from text prompts.

• VariationImageGenerationEngine for generating variations of an input image according to a text prompt.

• InpaintingImageGenerationEngine for modifying an input image according to a text prompt within the bounds of a mask defined by a mask image.

• OutpaintingImageGenerationEngine for modifying an input image according to a text prompt outside the bounds of a mask defined by a mask image.

• PromptImageGenerationClient for enabling an LLM to use the PromptImageGenerationEngine.

• VariationImageGenerationClient for enabling an LLM to use the VariationImageGenerationEngine.

• InpaintingImageGenerationClient for enabling an LLM to use the InpaintingImageGenerationEngine.

• OutpaintingImageGenerationClient for enabling an LLM to use the OutpaintingImageGenerationEngine.

• OpenAiImageGenerationDriver for use with OpenAI's image generation models.

• LeonardoImageGenerationDriver for use with Leonoaro AI's image generation models.

• AmazonBedrockImageGenerationDriver for use with Amazon Bedrock's image generation models; requires a Image Generation Model Driver.

• BedrockTitanImageGenerationModelDriver for use with Amazon Bedrock's Titan image generation.

• ImageArtifact for storing image data; used heavily by the image Engines, Tasks, and Drivers.

• ImageLoader for loading images files into ImageArtifacts.

• Support for all Tokenizers in OpenAiChatPromptDriver, enabling OpenAI drop-in clients such as Together AI.

• AmazonSageMakerEmbeddingDriver for using Amazon SageMaker to generate embeddings. Thanks @KaushikIyer16!

• Claude 2.1 support in AnthropicPromptDriver and AmazonBedrockPromptDriver via BedrockClaudePromptModelDriver.

• CodeExecutionTask for executing code as a Task without the need for an LLM.

• BedrockLlamaPromptModelDriver for using Llama models on Amazon Bedrock.

Fixed

• MongoDbAtlasVectorStore namespace not being used properly when querying.
• Miscellaneous type errors throughout the codebase.
• Remove unused section from ToolTask system prompt template.
• Structure execution args being cleared after run, preventing inspection of the Structure's input_task's input.
• Unhandled SqlClient exception. Thanks @michal-repo!

Changed

• BREAKING: Rename input_template field to input in Tasks that take a text input.
• BREAKING: Rename BedrockTitanEmbeddingDriver to AmazonBedrockTitanEmbeddingDriver.
• BREAKING: Rename AmazonBedrockStableDiffusionImageGenerationModelDriver to BedrockStableDiffusionImageGenerationModelDriver.
• BREAKING: Rename AmazonBedrockTitanImageGenerationModelDriver to BedrockTitanImageGenerationModelDriver.
• BREAKING: Rename ImageGenerationTask to PromptImageGenerationTask.
• BREAKING: Rename ImageGenerationEngine to PromptImageGenerationEngine.
• BREAKING: Rename ImageGenerationTool to PromptImageGenerationClient.
• Improve system prompt generation with Claude 2.0.
• Improve integration test coverage.
• BaseTextInputTask to accept a str, TextArtifact or callable returning a TextArtifact.