drivers
__all__ = ['AmazonBedrockDriversConfig', 'AnthropicDriversConfig', 'AzureOpenAiDriversConfig', 'BaseDriversConfig', 'CohereDriversConfig', 'DriversConfig', 'GoogleDriversConfig', 'OpenAiDriversConfig']
module-attribute
Bases:
DriversConfig
Source Code in griptape/configs/drivers/amazon_bedrock_drivers_config.py
@define class AmazonBedrockDriversConfig(DriversConfig): session: boto3.Session = field( default=Factory(lambda: import_optional_dependency("boto3").Session()), kw_only=True, metadata={"serializable": False}, ) @lazy_property() def prompt_driver(self) -> AmazonBedrockPromptDriver: return AmazonBedrockPromptDriver(session=self.session, model="anthropic.claude-3-7-sonnet-20250219-v1:0") @lazy_property() def embedding_driver(self) -> AmazonBedrockTitanEmbeddingDriver: return AmazonBedrockTitanEmbeddingDriver(session=self.session, model="amazon.titan-embed-text-v2:0") @lazy_property() def image_generation_driver(self) -> AmazonBedrockImageGenerationDriver: return AmazonBedrockImageGenerationDriver( session=self.session, model="amazon.titan-image-generator-v2:0", image_generation_model_driver=BedrockTitanImageGenerationModelDriver(), ) @lazy_property() def vector_store_driver(self) -> LocalVectorStoreDriver: return LocalVectorStoreDriver( embedding_driver=AmazonBedrockTitanEmbeddingDriver( session=self.session, model="amazon.titan-embed-text-v2:0" ) )
session = field(default=Factory(lambda: import_optional_dependency('boto3').Session()), kw_only=True, metadata={'serializable': False})
class-attribute instance-attribute
embedding_driver()
Source Code in griptape/configs/drivers/amazon_bedrock_drivers_config.py
@lazy_property() def embedding_driver(self) -> AmazonBedrockTitanEmbeddingDriver: return AmazonBedrockTitanEmbeddingDriver(session=self.session, model="amazon.titan-embed-text-v2:0")
image_generation_driver()
Source Code in griptape/configs/drivers/amazon_bedrock_drivers_config.py
@lazy_property() def image_generation_driver(self) -> AmazonBedrockImageGenerationDriver: return AmazonBedrockImageGenerationDriver( session=self.session, model="amazon.titan-image-generator-v2:0", image_generation_model_driver=BedrockTitanImageGenerationModelDriver(), )
prompt_driver()
Source Code in griptape/configs/drivers/amazon_bedrock_drivers_config.py
@lazy_property() def prompt_driver(self) -> AmazonBedrockPromptDriver: return AmazonBedrockPromptDriver(session=self.session, model="anthropic.claude-3-7-sonnet-20250219-v1:0")
vector_store_driver()
Source Code in griptape/configs/drivers/amazon_bedrock_drivers_config.py
@lazy_property() def vector_store_driver(self) -> LocalVectorStoreDriver: return LocalVectorStoreDriver( embedding_driver=AmazonBedrockTitanEmbeddingDriver( session=self.session, model="amazon.titan-embed-text-v2:0" ) )
AnthropicDriversConfig
Bases:
DriversConfig
Source Code in griptape/configs/drivers/anthropic_drivers_config.py
@define class AnthropicDriversConfig(DriversConfig): @lazy_property() def prompt_driver(self) -> AnthropicPromptDriver: return AnthropicPromptDriver(model="claude-3-7-sonnet-latest")
prompt_driver()
Source Code in griptape/configs/drivers/anthropic_drivers_config.py
@lazy_property() def prompt_driver(self) -> AnthropicPromptDriver: return AnthropicPromptDriver(model="claude-3-7-sonnet-latest")
AzureOpenAiDriversConfig
Bases:
DriversConfig
Attributes
Name | Type | Description |
---|---|---|
azure_endpoint | str | The endpoint for the Azure OpenAI instance. |
azure_ad_token | Optional[str] | An optional Azure Active Directory token. |
azure_ad_token_provider | Optional[Callable[[], str]] | An optional Azure Active Directory token provider. |
api_key | Optional[str] | An optional Azure API key. |
prompt_driver | AzureOpenAiChatPromptDriver | An Azure OpenAI Chat Prompt Driver. |
image_generation_driver | AzureOpenAiImageGenerationDriver | An Azure OpenAI Image Generation Driver. |
embedding_driver | AzureOpenAiEmbeddingDriver | An Azure OpenAI Embedding Driver. |
vector_store_driver | LocalVectorStoreDriver | A Local Vector Store Driver. |
Source Code in griptape/configs/drivers/azure_openai_drivers_config.py
@define class AzureOpenAiDriversConfig(DriversConfig): """Azure OpenAI Drivers Configuration. Attributes: azure_endpoint: The endpoint for the Azure OpenAI instance. azure_ad_token: An optional Azure Active Directory token. azure_ad_token_provider: An optional Azure Active Directory token provider. api_key: An optional Azure API key. prompt_driver: An Azure OpenAI Chat Prompt Driver. image_generation_driver: An Azure OpenAI Image Generation Driver. embedding_driver: An Azure OpenAI Embedding Driver. vector_store_driver: A Local Vector Store Driver. """ azure_endpoint: str = field(kw_only=True, metadata={"serializable": True}) azure_ad_token: Optional[str] = field(kw_only=True, default=None, metadata={"serializable": False}) azure_ad_token_provider: Optional[Callable[[], str]] = field( kw_only=True, default=None, metadata={"serializable": False}, ) api_key: Optional[str] = field(kw_only=True, default=None, metadata={"serializable": False}) @lazy_property() def prompt_driver(self) -> AzureOpenAiChatPromptDriver: return AzureOpenAiChatPromptDriver( model="gpt-4.1", azure_endpoint=self.azure_endpoint, api_key=self.api_key, azure_ad_token=self.azure_ad_token, azure_ad_token_provider=self.azure_ad_token_provider, ) @lazy_property() def embedding_driver(self) -> AzureOpenAiEmbeddingDriver: return AzureOpenAiEmbeddingDriver( model="text-embedding-3-small", azure_endpoint=self.azure_endpoint, api_key=self.api_key, azure_ad_token=self.azure_ad_token, azure_ad_token_provider=self.azure_ad_token_provider, ) @lazy_property() def image_generation_driver(self) -> AzureOpenAiImageGenerationDriver: return AzureOpenAiImageGenerationDriver( model="dall-e-2", azure_endpoint=self.azure_endpoint, api_key=self.api_key, azure_ad_token=self.azure_ad_token, azure_ad_token_provider=self.azure_ad_token_provider, image_size="512x512", ) @lazy_property() def vector_store_driver(self) -> LocalVectorStoreDriver: return LocalVectorStoreDriver( embedding_driver=AzureOpenAiEmbeddingDriver( model="text-embedding-3-small", azure_endpoint=self.azure_endpoint, api_key=self.api_key, azure_ad_token=self.azure_ad_token, azure_ad_token_provider=self.azure_ad_token_provider, ) ) @lazy_property() def text_to_speech_driver(self) -> AzureOpenAiTextToSpeechDriver: return AzureOpenAiTextToSpeechDriver( model="tts", azure_endpoint=self.azure_endpoint, api_key=self.api_key, azure_ad_token=self.azure_ad_token, azure_ad_token_provider=self.azure_ad_token_provider, )
api_key = field(kw_only=True, default=None, metadata={'serializable': False})
class-attribute instance-attributeazure_ad_token = field(kw_only=True, default=None, metadata={'serializable': False})
class-attribute instance-attributeazure_ad_token_provider = field(kw_only=True, default=None, metadata={'serializable': False})
class-attribute instance-attributeazure_endpoint = field(kw_only=True, metadata={'serializable': True})
class-attribute instance-attribute
embedding_driver()
Source Code in griptape/configs/drivers/azure_openai_drivers_config.py
@lazy_property() def embedding_driver(self) -> AzureOpenAiEmbeddingDriver: return AzureOpenAiEmbeddingDriver( model="text-embedding-3-small", azure_endpoint=self.azure_endpoint, api_key=self.api_key, azure_ad_token=self.azure_ad_token, azure_ad_token_provider=self.azure_ad_token_provider, )
image_generation_driver()
Source Code in griptape/configs/drivers/azure_openai_drivers_config.py
@lazy_property() def image_generation_driver(self) -> AzureOpenAiImageGenerationDriver: return AzureOpenAiImageGenerationDriver( model="dall-e-2", azure_endpoint=self.azure_endpoint, api_key=self.api_key, azure_ad_token=self.azure_ad_token, azure_ad_token_provider=self.azure_ad_token_provider, image_size="512x512", )
prompt_driver()
Source Code in griptape/configs/drivers/azure_openai_drivers_config.py
@lazy_property() def prompt_driver(self) -> AzureOpenAiChatPromptDriver: return AzureOpenAiChatPromptDriver( model="gpt-4.1", azure_endpoint=self.azure_endpoint, api_key=self.api_key, azure_ad_token=self.azure_ad_token, azure_ad_token_provider=self.azure_ad_token_provider, )
text_to_speech_driver()
Source Code in griptape/configs/drivers/azure_openai_drivers_config.py
@lazy_property() def text_to_speech_driver(self) -> AzureOpenAiTextToSpeechDriver: return AzureOpenAiTextToSpeechDriver( model="tts", azure_endpoint=self.azure_endpoint, api_key=self.api_key, azure_ad_token=self.azure_ad_token, azure_ad_token_provider=self.azure_ad_token_provider, )
vector_store_driver()
Source Code in griptape/configs/drivers/azure_openai_drivers_config.py
@lazy_property() def vector_store_driver(self) -> LocalVectorStoreDriver: return LocalVectorStoreDriver( embedding_driver=AzureOpenAiEmbeddingDriver( model="text-embedding-3-small", azure_endpoint=self.azure_endpoint, api_key=self.api_key, azure_ad_token=self.azure_ad_token, azure_ad_token_provider=self.azure_ad_token_provider, ) )
BaseDriversConfig
Bases:
ABC, [`SerializableMixin`](../../mixins/serializable_mixin.md#griptape.mixins.serializable_mixin.SerializableMixin "SerializableMixin (griptape.mixins.serializable_mixin.SerializableMixin)")Source Code in griptape/configs/drivers/base_drivers_config.py
@define class BaseDriversConfig(ABC, SerializableMixin): _prompt_driver: Optional[BasePromptDriver] = field( kw_only=True, default=None, metadata={"serializable": True}, alias="prompt_driver" ) _image_generation_driver: Optional[BaseImageGenerationDriver] = field( kw_only=True, default=None, metadata={"serializable": True}, alias="image_generation_driver" ) _embedding_driver: Optional[BaseEmbeddingDriver] = field( kw_only=True, default=None, metadata={"serializable": True}, alias="embedding_driver" ) _vector_store_driver: Optional[BaseVectorStoreDriver] = field( default=None, kw_only=True, metadata={"serializable": True}, alias="vector_store_driver" ) _conversation_memory_driver: Optional[BaseConversationMemoryDriver] = field( default=None, kw_only=True, metadata={"serializable": True}, alias="conversation_memory_driver" ) _text_to_speech_driver: Optional[BaseTextToSpeechDriver] = field( default=None, kw_only=True, metadata={"serializable": True}, alias="text_to_speech_driver" ) _audio_transcription_driver: Optional[BaseAudioTranscriptionDriver] = field( default=None, kw_only=True, metadata={"serializable": True}, alias="audio_transcription_driver" ) _ruleset_driver: Optional[BaseRulesetDriver] = field( default=None, kw_only=True, metadata={"serializable": True}, alias="ruleset_driver" ) _last_drivers_config: Optional[BaseDriversConfig] = field(default=None) def __enter__(self) -> Self: from griptape.configs import Defaults self._last_drivers_config = Defaults.drivers_config Defaults.drivers_config = self return self def __exit__(self, type, value, traceback) -> None: # noqa: ANN001, A002 from griptape.configs import Defaults if self._last_drivers_config is not None: Defaults.drivers_config = self._last_drivers_config self._last_drivers_config = None @lazy_property() @abstractmethod def prompt_driver(self) -> BasePromptDriver: ... @lazy_property() @abstractmethod def image_generation_driver(self) -> BaseImageGenerationDriver: ... @lazy_property() @abstractmethod def embedding_driver(self) -> BaseEmbeddingDriver: ... @lazy_property() @abstractmethod def vector_store_driver(self) -> BaseVectorStoreDriver: ... @lazy_property() @abstractmethod def conversation_memory_driver(self) -> BaseConversationMemoryDriver: ... @lazy_property() @abstractmethod def text_to_speech_driver(self) -> BaseTextToSpeechDriver: ... @lazy_property() @abstractmethod def audio_transcription_driver(self) -> BaseAudioTranscriptionDriver: ... @lazy_property() @abstractmethod def ruleset_driver(self) -> BaseRulesetDriver: ...
_audio_transcription_driver = field(default=None, kw_only=True, metadata={'serializable': True}, alias='audio_transcription_driver')
class-attribute instance-attribute_conversation_memory_driver = field(default=None, kw_only=True, metadata={'serializable': True}, alias='conversation_memory_driver')
class-attribute instance-attribute_embedding_driver = field(kw_only=True, default=None, metadata={'serializable': True}, alias='embedding_driver')
class-attribute instance-attribute_image_generation_driver = field(kw_only=True, default=None, metadata={'serializable': True}, alias='image_generation_driver')
class-attribute instance-attribute_last_drivers_config = field(default=None)
class-attribute instance-attribute_prompt_driver = field(kw_only=True, default=None, metadata={'serializable': True}, alias='prompt_driver')
class-attribute instance-attribute_ruleset_driver = field(default=None, kw_only=True, metadata={'serializable': True}, alias='ruleset_driver')
class-attribute instance-attribute_text_to_speech_driver = field(default=None, kw_only=True, metadata={'serializable': True}, alias='text_to_speech_driver')
class-attribute instance-attribute_vector_store_driver = field(default=None, kw_only=True, metadata={'serializable': True}, alias='vector_store_driver')
class-attribute instance-attribute
enter()
Source Code in griptape/configs/drivers/base_drivers_config.py
def __enter__(self) -> Self: from griptape.configs import Defaults self._last_drivers_config = Defaults.drivers_config Defaults.drivers_config = self return self
exit(type, value, traceback)
Source Code in griptape/configs/drivers/base_drivers_config.py
def __exit__(self, type, value, traceback) -> None: # noqa: ANN001, A002 from griptape.configs import Defaults if self._last_drivers_config is not None: Defaults.drivers_config = self._last_drivers_config self._last_drivers_config = None
audio_transcription_driver()abstractmethod
Source Code in griptape/configs/drivers/base_drivers_config.py
@lazy_property() @abstractmethod def audio_transcription_driver(self) -> BaseAudioTranscriptionDriver: ...
conversation_memory_driver()abstractmethod
Source Code in griptape/configs/drivers/base_drivers_config.py
@lazy_property() @abstractmethod def conversation_memory_driver(self) -> BaseConversationMemoryDriver: ...
embedding_driver()abstractmethod
Source Code in griptape/configs/drivers/base_drivers_config.py
@lazy_property() @abstractmethod def embedding_driver(self) -> BaseEmbeddingDriver: ...
image_generation_driver()abstractmethod
Source Code in griptape/configs/drivers/base_drivers_config.py
@lazy_property() @abstractmethod def image_generation_driver(self) -> BaseImageGenerationDriver: ...
prompt_driver()abstractmethod
Source Code in griptape/configs/drivers/base_drivers_config.py
@lazy_property() @abstractmethod def prompt_driver(self) -> BasePromptDriver: ...
ruleset_driver()abstractmethod
Source Code in griptape/configs/drivers/base_drivers_config.py
@lazy_property() @abstractmethod def ruleset_driver(self) -> BaseRulesetDriver: ...
text_to_speech_driver()abstractmethod
Source Code in griptape/configs/drivers/base_drivers_config.py
@lazy_property() @abstractmethod def text_to_speech_driver(self) -> BaseTextToSpeechDriver: ...
vector_store_driver()abstractmethod
Source Code in griptape/configs/drivers/base_drivers_config.py
@lazy_property() @abstractmethod def vector_store_driver(self) -> BaseVectorStoreDriver: ...
CohereDriversConfig
Bases:
DriversConfig
Source Code in griptape/configs/drivers/cohere_drivers_config.py
@define class CohereDriversConfig(DriversConfig): api_key: str = field(metadata={"serializable": False}, kw_only=True) @lazy_property() def prompt_driver(self) -> CoherePromptDriver: return CoherePromptDriver(model="command-r", api_key=self.api_key) @lazy_property() def embedding_driver(self) -> CohereEmbeddingDriver: return CohereEmbeddingDriver( model="embed-english-v3.0", api_key=self.api_key, input_type="search_document", ) @lazy_property() def vector_store_driver(self) -> LocalVectorStoreDriver: return LocalVectorStoreDriver( embedding_driver=CohereEmbeddingDriver( model="embed-english-v3.0", api_key=self.api_key, input_type="search_document", ) )
api_key = field(metadata={'serializable': False}, kw_only=True)
class-attribute instance-attribute
embedding_driver()
Source Code in griptape/configs/drivers/cohere_drivers_config.py
@lazy_property() def embedding_driver(self) -> CohereEmbeddingDriver: return CohereEmbeddingDriver( model="embed-english-v3.0", api_key=self.api_key, input_type="search_document", )
prompt_driver()
Source Code in griptape/configs/drivers/cohere_drivers_config.py
@lazy_property() def prompt_driver(self) -> CoherePromptDriver: return CoherePromptDriver(model="command-r", api_key=self.api_key)
vector_store_driver()
Source Code in griptape/configs/drivers/cohere_drivers_config.py
@lazy_property() def vector_store_driver(self) -> LocalVectorStoreDriver: return LocalVectorStoreDriver( embedding_driver=CohereEmbeddingDriver( model="embed-english-v3.0", api_key=self.api_key, input_type="search_document", ) )
DriversConfig
Bases:
BaseDriversConfig
Source Code in griptape/configs/drivers/drivers_config.py
@define class DriversConfig(BaseDriversConfig): @lazy_property() def prompt_driver(self) -> BasePromptDriver: return DummyPromptDriver() @lazy_property() def image_generation_driver(self) -> BaseImageGenerationDriver: return DummyImageGenerationDriver() @lazy_property() def embedding_driver(self) -> BaseEmbeddingDriver: return DummyEmbeddingDriver() @lazy_property() def vector_store_driver(self) -> BaseVectorStoreDriver: return DummyVectorStoreDriver(embedding_driver=self.embedding_driver) @lazy_property() def conversation_memory_driver(self) -> BaseConversationMemoryDriver: return LocalConversationMemoryDriver() @lazy_property() def text_to_speech_driver(self) -> BaseTextToSpeechDriver: return DummyTextToSpeechDriver() @lazy_property() def audio_transcription_driver(self) -> BaseAudioTranscriptionDriver: return DummyAudioTranscriptionDriver() @lazy_property() def ruleset_driver(self) -> BaseRulesetDriver: return LocalRulesetDriver()
audio_transcription_driver()
Source Code in griptape/configs/drivers/drivers_config.py
@lazy_property() def audio_transcription_driver(self) -> BaseAudioTranscriptionDriver: return DummyAudioTranscriptionDriver()
conversation_memory_driver()
Source Code in griptape/configs/drivers/drivers_config.py
@lazy_property() def conversation_memory_driver(self) -> BaseConversationMemoryDriver: return LocalConversationMemoryDriver()
embedding_driver()
Source Code in griptape/configs/drivers/drivers_config.py
@lazy_property() def embedding_driver(self) -> BaseEmbeddingDriver: return DummyEmbeddingDriver()
image_generation_driver()
Source Code in griptape/configs/drivers/drivers_config.py
@lazy_property() def image_generation_driver(self) -> BaseImageGenerationDriver: return DummyImageGenerationDriver()
prompt_driver()
Source Code in griptape/configs/drivers/drivers_config.py
@lazy_property() def prompt_driver(self) -> BasePromptDriver: return DummyPromptDriver()
ruleset_driver()
Source Code in griptape/configs/drivers/drivers_config.py
@lazy_property() def ruleset_driver(self) -> BaseRulesetDriver: return LocalRulesetDriver()
text_to_speech_driver()
Source Code in griptape/configs/drivers/drivers_config.py
@lazy_property() def text_to_speech_driver(self) -> BaseTextToSpeechDriver: return DummyTextToSpeechDriver()
vector_store_driver()
Source Code in griptape/configs/drivers/drivers_config.py
@lazy_property() def vector_store_driver(self) -> BaseVectorStoreDriver: return DummyVectorStoreDriver(embedding_driver=self.embedding_driver)
GoogleDriversConfig
Bases:
DriversConfig
Source Code in griptape/configs/drivers/google_drivers_config.py
@define class GoogleDriversConfig(DriversConfig): @lazy_property() def prompt_driver(self) -> GooglePromptDriver: return GooglePromptDriver(model="gemini-2.0-flash") @lazy_property() def embedding_driver(self) -> GoogleEmbeddingDriver: return GoogleEmbeddingDriver(model="models/embedding-004") @lazy_property() def vector_store_driver(self) -> LocalVectorStoreDriver: return LocalVectorStoreDriver(embedding_driver=GoogleEmbeddingDriver(model="models/embedding-004"))
embedding_driver()
Source Code in griptape/configs/drivers/google_drivers_config.py
@lazy_property() def embedding_driver(self) -> GoogleEmbeddingDriver: return GoogleEmbeddingDriver(model="models/embedding-004")
prompt_driver()
Source Code in griptape/configs/drivers/google_drivers_config.py
@lazy_property() def prompt_driver(self) -> GooglePromptDriver: return GooglePromptDriver(model="gemini-2.0-flash")
vector_store_driver()
Source Code in griptape/configs/drivers/google_drivers_config.py
@lazy_property() def vector_store_driver(self) -> LocalVectorStoreDriver: return LocalVectorStoreDriver(embedding_driver=GoogleEmbeddingDriver(model="models/embedding-004"))
OpenAiDriversConfig
Bases:
DriversConfig
Source Code in griptape/configs/drivers/openai_drivers_config.py
@define class OpenAiDriversConfig(DriversConfig): @lazy_property() def prompt_driver(self) -> OpenAiChatPromptDriver: return OpenAiChatPromptDriver(model="gpt-4.1") @lazy_property() def image_generation_driver(self) -> OpenAiImageGenerationDriver: return OpenAiImageGenerationDriver(model="dall-e-2", image_size="512x512") @lazy_property() def embedding_driver(self) -> OpenAiEmbeddingDriver: return OpenAiEmbeddingDriver(model="text-embedding-3-small") @lazy_property() def vector_store_driver(self) -> LocalVectorStoreDriver: return LocalVectorStoreDriver(embedding_driver=OpenAiEmbeddingDriver(model="text-embedding-3-small")) @lazy_property() def text_to_speech_driver(self) -> OpenAiTextToSpeechDriver: return OpenAiTextToSpeechDriver(model="tts-1") @lazy_property() def audio_transcription_driver(self) -> OpenAiAudioTranscriptionDriver: return OpenAiAudioTranscriptionDriver(model="whisper-1")
audio_transcription_driver()
Source Code in griptape/configs/drivers/openai_drivers_config.py
@lazy_property() def audio_transcription_driver(self) -> OpenAiAudioTranscriptionDriver: return OpenAiAudioTranscriptionDriver(model="whisper-1")
embedding_driver()
Source Code in griptape/configs/drivers/openai_drivers_config.py
@lazy_property() def embedding_driver(self) -> OpenAiEmbeddingDriver: return OpenAiEmbeddingDriver(model="text-embedding-3-small")
image_generation_driver()
Source Code in griptape/configs/drivers/openai_drivers_config.py
@lazy_property() def image_generation_driver(self) -> OpenAiImageGenerationDriver: return OpenAiImageGenerationDriver(model="dall-e-2", image_size="512x512")
prompt_driver()
Source Code in griptape/configs/drivers/openai_drivers_config.py
@lazy_property() def prompt_driver(self) -> OpenAiChatPromptDriver: return OpenAiChatPromptDriver(model="gpt-4.1")
text_to_speech_driver()
Source Code in griptape/configs/drivers/openai_drivers_config.py
@lazy_property() def text_to_speech_driver(self) -> OpenAiTextToSpeechDriver: return OpenAiTextToSpeechDriver(model="tts-1")
vector_store_driver()
Source Code in griptape/configs/drivers/openai_drivers_config.py
@lazy_property() def vector_store_driver(self) -> LocalVectorStoreDriver: return LocalVectorStoreDriver(embedding_driver=OpenAiEmbeddingDriver(model="text-embedding-3-small"))
Could this page be better? Report a problem or suggest an addition!