steamship.agents.tools.speech_generation package#

Submodules#

steamship.agents.tools.speech_generation.generate_speech module#

Tool for generating images.

class steamship.agents.tools.speech_generation.generate_speech.GenerateSpeechTool(*, name: str = 'GenerateSpokenAudio', agent_description: str = 'Used to generate spoken audio from text prompts. Only use if the user has asked directly for a an audio version of output. When using this tool, the input should be a plain text string containing the content to be spoken.', human_description: str = 'Generates spoken audio from text.', is_final: bool = False, cacheable: bool = True, generator_plugin_handle: str = 'elevenlabs', generator_plugin_instance_handle: str | None = None, generator_plugin_config: dict = {}, merge_blocks: bool = False, make_output_public: bool = True)[source]#

Bases: AudioGeneratorTool

Tool to generate audio from text.

agent_description: str#: Description for use in an agent in order to enable Action selection. It should include a short summary of what the Tool does, what the inputs to the Tool should be, and what the outputs of the tool are.

generator_plugin_handle: str#

human_description: str#: Human-friendly description. Used for logging, tool indices, etc.

name: str#: The short name for the tool. This will be used by Agents to refer to this tool during action selection.

Module contents#

class steamship.agents.tools.speech_generation.GenerateSpeechTool(*, name: str = 'GenerateSpokenAudio', agent_description: str = 'Used to generate spoken audio from text prompts. Only use if the user has asked directly for a an audio version of output. When using this tool, the input should be a plain text string containing the content to be spoken.', human_description: str = 'Generates spoken audio from text.', is_final: bool = False, cacheable: bool = True, generator_plugin_handle: str = 'elevenlabs', generator_plugin_instance_handle: str | None = None, generator_plugin_config: dict = {}, merge_blocks: bool = False, make_output_public: bool = True)[source]#

Bases: AudioGeneratorTool

Tool to generate audio from text.

agent_description: str#: Description for use in an agent in order to enable Action selection. It should include a short summary of what the Tool does, what the inputs to the Tool should be, and what the outputs of the tool are.

cacheable: bool#: Whether runs of this Tool should be cached based on inputs (if caching is enabled in the AgentContext for a run). Setting this to False will make prevent any Actions that involve this tool from being cached, meaning that every Action using this Tool will result in a call to run. By default, Tools are considered cacheable.

generator_plugin_config: dict#

generator_plugin_handle: str#

generator_plugin_instance_handle: str | None#

human_description: str#: Human-friendly description. Used for logging, tool indices, etc.

is_final: bool#

Whether actions performed by this tool should have their is_final bit marked.

Setting this to True means that the output of this tool will halt the reasoning loop. Its output will be returned directly to the user.

make_output_public: bool#

merge_blocks: bool#

name: str#: The short name for the tool. This will be used by Agents to refer to this tool during action selection.