Skip to content
Griptape Docs
structured_output
Initializing search
Home
Cloud
Framework
Tools
Recipes
Reference Guide
Trade School
Griptape Docs
Home
Home
Overview
Contributing
Cloud
Cloud
Overview
Data Sources
Data Sources
Create a Data Source
Refreshing Your Data
Knowledge Bases
Knowledge Bases
Create a Knowledge Base
Accessing Your Data
Structures
Structures
Create a Structure
Structure Config YAML
Running Your Structure
Structure Run Events
Tools
Tools
Create a Tool
Tool Config YAML
Running Your Tool
Rules
Rules
Create a Ruleset
Threads
Threads
Create a Thread
Cloud API
Cloud API
API Reference
Framework
Framework
Overview
Structures
Structures
Agents
Pipelines
Workflows
Tasks
Task Memory and Off Prompt
Conversation Memory
Rulesets
Configs
Observability
Tools
Tools
Overview
Building Custom Tools
Engines
Engines
RAG Engine
Extraction Engines
Summary Engine
Eval Engine
Drivers
Drivers
Prompt Drivers
Embedding Drivers
Vector Store Drivers
Image Generation Drivers
SQL Drivers
Web Scraper Drivers
Conversation Memory Drivers
Event Listener Drivers
Structure Run Drivers
Assistant Drivers
Text to Speech Drivers
Audio Transcription Drivers
Web Search Drivers
Observability Drivers
Ruleset Drivers
File Manager Drivers
Data
Data
Overview
Artifacts
Loaders
Chunkers
Misc
Misc
Events
Tokenizers
Tools
Tools
Overview
Official Tools
Official Tools
Calculator
Computer
Date Time
Email
File Manager
Structure Run Client
Rest Api Client
Sql
Vector Store Tool
Web Scraper
Web Search
Prompt Image Generation
Variation ImageGeneration
Inpainting ImageGeneration
Outpainting ImageGeneration
Image Query
Text To Speech
Audio Transcription
Griptape Cloud Tool
Rag
Extraction
Query
Prompt Summary
Custom Tools
Custom Tools
Building Custom Tools
Recipes
Recipes
Overview
Agents
Agents
Talk to Redshift
Talk to a Webpage
Talk to a PDF
Talk to a Video
Talk to an Image
Talk to a Document
Multi Agent Workflows
Shared Memory Between Agents
Chat Sessions with Amazon DynamoDB
Data
Data
Load and Query Pinecone
Load and Query Marqo
Query a Webpage
RAG with Astra DB vector store
Reference Guide
Reference Guide
griptape
griptape
artifacts
artifacts
action_artifact
audio_artifact
base_artifact
blob_artifact
boolean_artifact
error_artifact
generic_artifact
image_artifact
info_artifact
json_artifact
list_artifact
text_artifact
chunkers
chunkers
base_chunker
chunk_separator
markdown_chunker
pdf_chunker
text_chunker
common
common
actions
actions
base_action
tool_action
decorators
observable
prompt_stack
prompt_stack
contents
contents
action_call_delta_message_content
action_call_message_content
action_result_message_content
base_delta_message_content
base_message_content
generic_message_content
image_message_content
text_delta_message_content
text_message_content
messages
messages
base_message
delta_message
message
prompt_stack
reference
configs
configs
base_config
defaults_config
drivers
drivers
amazon_bedrock_drivers_config
anthropic_drivers_config
azure_openai_drivers_config
base_drivers_config
cohere_drivers_config
drivers_config
google_drivers_config
openai_drivers_config
logging
logging
json_formatter
logging_config
newline_logging_filter
truncate_logging_filter
drivers
drivers
assistant
assistant
base_assistant_driver
griptape_cloud_assistant_driver
openai_assistant_driver
audio_transcription
audio_transcription
base_audio_transcription_driver
dummy_audio_transcription_driver
openai_audio_transcription_driver
embedding
embedding
amazon_bedrock_cohere_embedding_driver
amazon_bedrock_titan_embedding_driver
amazon_sagemaker_jumpstart_embedding_driver
azure_openai_embedding_driver
base_embedding_driver
cohere_embedding_driver
dummy_embedding_driver
google_embedding_driver
huggingface_hub_embedding_driver
ollama_embedding_driver
openai_embedding_driver
voyageai_embedding_driver
event_listener
event_listener
amazon_sqs_event_listener_driver
aws_iot_core_event_listener_driver
base_event_listener_driver
griptape_cloud_event_listener_driver
pusher_event_listener_driver
webhook_event_listener_driver
file_manager
file_manager
amazon_s3_file_manager_driver
base_file_manager_driver
griptape_cloud_file_manager_driver
local_file_manager_driver
image_generation
image_generation
amazon_bedrock_image_generation_driver
azure_openai_image_generation_driver
base_image_generation_driver
base_multi_model_image_generation_driver
dummy_image_generation_driver
huggingface_pipeline_image_generation_driver
leonardo_image_generation_driver
openai_image_generation_driver
image_generation_model
image_generation_model
base_image_generation_model_driver
bedrock_stable_diffusion_image_generation_model_driver
bedrock_titan_image_generation_model_driver
image_generation_pipeline
image_generation_pipeline
base_image_generation_pipeline_driver
stable_diffusion_3_controlnet_image_generation_pipeline_driver
stable_diffusion_3_image_generation_pipeline_driver
stable_diffusion_3_img_2_img_image_generation_pipeline_driver
memory
memory
conversation
conversation
amazon_dynamodb_conversation_memory_driver
base_conversation_memory_driver
griptape_cloud_conversation_memory_driver
local_conversation_memory_driver
redis_conversation_memory_driver
observability
observability
base_observability_driver
datadog_observability_driver
griptape_cloud_observability_driver
no_op_observability_driver
open_telemetry_observability_driver
prompt
prompt
amazon_bedrock_prompt_driver
amazon_sagemaker_jumpstart_prompt_driver
anthropic_prompt_driver
azure_openai_chat_prompt_driver
base_prompt_driver
cohere_prompt_driver
dummy_prompt_driver
google_prompt_driver
huggingface_hub_prompt_driver
huggingface_pipeline_prompt_driver
ollama_prompt_driver
openai_chat_prompt_driver
rerank
rerank
base_rerank_driver
cohere_rerank_driver
ruleset
ruleset
base_ruleset_driver
griptape_cloud_ruleset_driver
local_ruleset_driver
sql
sql
amazon_redshift_sql_driver
base_sql_driver
snowflake_sql_driver
sql_driver
structure_run
structure_run
base_structure_run_driver
griptape_cloud_structure_run_driver
local_structure_run_driver
text_to_speech
text_to_speech
azure_openai_text_to_speech_driver
base_text_to_speech_driver
dummy_text_to_speech_driver
elevenlabs_text_to_speech_driver
openai_text_to_speech_driver
vector
vector
amazon_opensearch_vector_store_driver
astradb_vector_store_driver
azure_mongodb_vector_store_driver
base_vector_store_driver
dummy_vector_store_driver
griptape_cloud_vector_store_driver
local_vector_store_driver
marqo_vector_store_driver
mongodb_atlas_vector_store_driver
opensearch_vector_store_driver
pgvector_vector_store_driver
pinecone_vector_store_driver
qdrant_vector_store_driver
redis_vector_store_driver
web_scraper
web_scraper
base_web_scraper_driver
markdownify_web_scraper_driver
proxy_web_scraper_driver
trafilatura_web_scraper_driver
web_search
web_search
base_web_search_driver
duck_duck_go_web_search_driver
exa_web_search_driver
google_web_search_driver
tavily_web_search_driver
engines
engines
eval
eval
base_eval_engine
eval_engine
extraction
extraction
base_extraction_engine
csv_extraction_engine
json_extraction_engine
rag
rag
modules
modules
base_rag_module
query
query
base_query_rag_module
translate_query_rag_module
response
response
base_after_response_rag_module
base_before_response_rag_module
base_response_rag_module
footnote_prompt_response_rag_module
prompt_response_rag_module
text_chunks_response_rag_module
retrieval
retrieval
base_rerank_rag_module
base_retrieval_rag_module
text_chunks_rerank_rag_module
text_loader_retrieval_rag_module
vector_store_retrieval_rag_module
rag_context
rag_engine
stages
stages
base_rag_stage
query_rag_stage
response_rag_stage
retrieval_rag_stage
summary
summary
base_summary_engine
prompt_summary_engine
events
events
action_chunk_event
base_actions_subtask_event
base_audio_transcription_event
base_chunk_event
base_event
base_image_generation_event
base_image_query_event
base_media_generation_event
base_prompt_event
base_task_event
base_text_to_speech_event
event_bus
event_listener
finish_actions_subtask_event
finish_audio_transcription_event
finish_image_generation_event
finish_image_query_event
finish_prompt_event
finish_structure_run_event
finish_task_event
finish_text_to_speech_event
start_actions_subtask_event
start_audio_transcription_event
start_image_generation_event
start_image_query_event
start_prompt_event
start_structure_run_event
start_task_event
start_text_to_speech_event
text_chunk_event
exceptions
exceptions
dummy_exception
loaders
loaders
audio_loader
base_file_loader
base_loader
blob_loader
csv_loader
email_loader
image_loader
json_loader
pdf_loader
sql_loader
text_loader
web_loader
memory
memory
meta
meta
action_subtask_meta_entry
base_meta_entry
meta_memory
structure
structure
base_conversation_memory
conversation_memory
run
summary_conversation_memory
task
task
storage
storage
base_artifact_storage
blob_artifact_storage
text_artifact_storage
task_memory
mixins
mixins
actions_subtask_origin_mixin
activity_mixin
artifact_file_output_mixin
exponential_backoff_mixin
futures_executor_mixin
rule_mixin
runnable_mixin
serializable_mixin
singleton_mixin
observability
observability
observability
rules
rules
base_rule
json_schema_rule
rule
ruleset
schemas
schemas
base_schema
bytes_field
polymorphic_schema
union_field
structures
structures
agent
pipeline
structure
workflow
tasks
tasks
actions_subtask
assistant_task
audio_transcription_task
base_audio_generation_task
base_audio_input_task
base_image_generation_task
base_task
base_text_input_task
branch_task
code_execution_task
extraction_task
inpainting_image_generation_task
outpainting_image_generation_task
prompt_image_generation_task
prompt_task
rag_task
structure_run_task
text_summary_task
text_to_speech_task
tool_task
toolkit_task
variation_image_generation_task
tokenizers
tokenizers
amazon_bedrock_tokenizer
anthropic_tokenizer
base_tokenizer
cohere_tokenizer
dummy_tokenizer
google_tokenizer
huggingface_tokenizer
openai_tokenizer
simple_tokenizer
voyageai_tokenizer
tools
tools
audio_transcription
audio_transcription
tool
base_griptape_cloud_tool
base_image_generation_tool
base_tool
calculator
calculator
tool
computer
computer
tool
date_time
date_time
tool
email
email
tool
extraction
extraction
tool
file_manager
file_manager
tool
griptape_cloud_tool
griptape_cloud_tool
tool
image_query
image_query
tool
inpainting_image_generation
inpainting_image_generation
tool
outpainting_image_generation
outpainting_image_generation
tool
prompt_image_generation
prompt_image_generation
tool
prompt_summary
prompt_summary
tool
query
query
tool
rag
rag
tool
rest_api
rest_api
tool
sql
sql
tool
structure_run
structure_run
tool
structured_output
structured_output
tool
text_to_speech
text_to_speech
tool
variation_image_generation
variation_image_generation
tool
vector_store
vector_store
tool
web_scraper
web_scraper
tool
web_search
web_search
tool
utils
utils
chat
command_runner
constants
contextvars_utils
conversation
decorators
deprecation
dict_utils
file_utils
futures
hash
import_utils
j2
load_artifact_from_memory
manifest_validator
paths
python_runner
reference_utils
stream
structure_visualizer
token_counter
Trade School
Table of contents
structured_output
structured_output
Back to top