SDK reference

• artifacts
  • Attributes
  • to_text()
    • AudioArtifact
  • Attributes
  • attrs_post_init()
  • make_name()
  • to_bytes(**kwargs)
  • to_text()
    • BaseArtifact
  • Attributes
  • bool()
  • len()
  • str()
  • to_bytes(**kwargs)
  • to_text()abstractmethod
    • BlobArtifact
  • Attributes
  • to_bytes(**kwargs)
  • to_text()
    • BooleanArtifact
  • Attributes
  • add(other)
  • eq(value)
  • parse_bool(value)classmethod
  • to_text()
    • ErrorArtifact
  • Attributes
  • to_text()
    • GenericArtifact
  • Attributes
  • to_text()
    • ImageArtifact
  • Attributes
  • attrs_post_init()
  • make_name()
  • to_bytes(**kwargs)
  • to_text()
    • ImageUrlArtifact
  • Attributes
    • InfoArtifact
  • Attributes
  • to_text()
    • JsonArtifact
  • Attributes
  • to_text()
  • value_to_json(value)classmethod
    • ListArtifact
  • add(other)
  • bool()
  • getitem(key)
  • iter()
  • has_items()
  • is_type(target_type)
  • to_text()
  • validatevalue(, value)
    • ModelArtifact
  • Attributes
  • to_text()
    • TextArtifact
  • add(other)
  • bool()
  • generate_embedding(driver)
  • to_text()
  • token_count(tokenizer)
    • UrlArtifact
  • Attributes
  • to_bytes(*, headers=None, **kwargs)
  • Parameters
  • Returns
  • to_text()
    • action_artifact
    • audio_artifact
    • base_artifact
    • blob_artifact
    • boolean_artifact
    • error_artifact
    • generic_artifact
    • image_artifact
    • image_url_artifact
    • info_artifact
    • json_artifact
    • list_artifact
    • model_artifact
    • text_artifact
    • url_artifact
• chunkers
  • __find_midpoint_index(separator, subchunks, half_token_count)
  • __get_subchunks(separator, subchunks, balance_index)
  • _chunk_recursively(chunk, current_separator=None)
  • chunk(text)
  • validatemax_tokens(, max_tokens)
    • ChunkSeparatordataclass
  • init(value, is_prefix=False)
    • MarkdownChunker
    • PdfChunker
    • TextChunker
• common
  • str()
    • ActionCallMessageContent
  • from_deltas(deltas)classmethod
    • ActionResultMessageContent
  • from_deltas(deltas)classmethod
    • AudioDeltaMessageContent
  • Attributes
    • AudioMessageContent
  • from_deltas(deltas)classmethod
    • BaseAction
    • BaseDeltaMessageContent
    • BaseMessage
  • Usage
  • is_assistant()
  • is_system()
  • is_user()
    • BaseMessageContent
  • bool()
  • len()
  • str()
  • from_deltas(deltas)abstractmethodclassmethod
  • to_text()
    • DeltaMessage
    • GenericMessageContent
  • from_deltas(deltas)classmethod
    • ImageMessageContent
  • from_deltas(deltas)classmethod
    • Message
  • init(content, **kwargs)
  • str()
  • get_content_type(content_type)
  • has_all_content_type(content_type)
  • has_any_content_type(content_type)
  • is_text()
  • to_artifact(meta=None)
  • to_text()
    • Observable
  • Call
    • PromptStack
  • __to_message_content(artifact)
  • add_assistant_message(artifact)
  • add_message(artifact, role)
  • add_system_message(artifact)
  • add_user_message(artifact)
  • from_artifact(artifact)classmethod
  • to_output_json_schema(schema_id=‘Output Format’)
    • Reference
• True})
  • from_deltas(deltas)classmethod
    • ToolAction
  • Attributes
  • str()
  • from_native_tool_name(native_tool_name)classmethod
  • to_native_tool_name()
    • actions
    • decorators
    • observable
    • prompt_stack
    • reference
    • True})
• configs
  • base_config
  • defaults_config
    • drivers_config()
    • logging_config()
  • drivers
    • embedding_driver()
    • image_generation_driver()
    • prompt_driver()
    • vector_store_driver()
    • prompt_driver()
    • Attributes
    • embedding_driver()
    • image_generation_driver()
    • prompt_driver()
    • text_to_speech_driver()
    • vector_store_driver()
    • enter()
    • exit(type, value, traceback)
    • audio_transcription_driver()abstractmethod
    • conversation_memory_driver()abstractmethod
    • embedding_driver()abstractmethod
    • image_generation_driver()abstractmethod
    • prompt_driver()abstractmethod
    • ruleset_driver()abstractmethod
    • text_to_speech_driver()abstractmethod
    • vector_store_driver()abstractmethod
    • embedding_driver()
    • prompt_driver()
    • vector_store_driver()
    • audio_transcription_driver()
    • conversation_memory_driver()
    • embedding_driver()
    • image_generation_driver()
    • prompt_driver()
    • ruleset_driver()
    • text_to_speech_driver()
    • vector_store_driver()
    • embedding_driver()
    • prompt_driver()
    • vector_store_driver()
    • audio_transcription_driver()
    • embedding_driver()
    • image_generation_driver()
    • prompt_driver()
    • text_to_speech_driver()
    • vector_store_driver()
  • logging
    • attrs_pre_init()
    • format(record)
    • attrs_post_init()
    • filter(record)
    • filter(record)
• drivers
  • Attributes
  • client()
  • try_embed_chunk(chunk, **kwargs)
    • AmazonBedrockImageGenerationDriver
  • Attributes
  • _make_request(request)
  • client()
  • try_image_inpainting(prompts, image, mask, negative_prompts=None)
  • try_image_outpainting(prompts, image, mask, negative_prompts=None)
  • try_image_variation(prompts, image, negative_prompts=None)
  • try_text_to_image(prompts, negative_prompts=None)
    • AmazonBedrockPromptDriver
  • __to_bedrock_message_content(content)
  • __to_bedrock_messages(messages)
  • __to_bedrock_role(message)
  • __to_bedrock_tool_use_content(artifact)
  • __to_bedrock_tools(tools)
  • __to_prompt_stack_delta_message_content(event)
  • __to_prompt_stack_message_content(content)
  • _base_params(prompt_stack)
  • client()
  • try_run(prompt_stack)
  • try_stream(prompt_stack)
  • validatestructured_output_strategy(, value)
    • AmazonBedrockTitanEmbeddingDriver
  • Attributes
  • _invoke_model(payload)
  • client()
  • try_embed_artifact(artifact, **kwargs)
  • try_embed_chunk(chunk, **kwargs)
    • AmazonDynamoDbConversationMemoryDriver
  • _get_key()
  • load()
  • store(runs, metadata)
  • table()
    • AmazonOpenSearchVectorStoreDriver
  • Attributes
  • upsert_vector(vector, *, vector_id=None, namespace=None, meta=None, **kwargs)
    • AmazonRedshiftSqlDriver
  • _post_process(meta, records)classmethod
  • _process_cells_from_rows_and_columns(columns, rows)classmethod
  • _process_columns_from_column_metadata(meta)classmethod
  • _process_rows_from_records(records)classmethod
  • client()
  • execute_query(query)
  • execute_query_raw(query)
  • get_table_schema(table_name, schema=None)
  • validateparams(, workgroup_name)
    • AmazonS3FileManagerDriver
  • Attributes
  • _is_a_directory(full_key)
  • _list_files_and_dirs(full_key, **kwargs)
  • _normpath(path)
  • _to_dir_full_key(path)
  • _to_full_key(path)
  • client()
  • try_list_files(path)
  • try_load_file(path)
  • try_save_file(path, value)
    • AmazonSageMakerJumpstartEmbeddingDriver
  • client()
  • try_embed_chunk(chunk, **kwargs)
    • AmazonSageMakerJumpstartPromptDriver
  • __prompt_stack_to_tokens(prompt_stack)
  • _base_params(prompt_stack)
  • _prompt_stack_to_messages(prompt_stack)
  • client()
  • prompt_stack_to_string(prompt_stack)
  • try_run(prompt_stack)
  • try_stream(prompt_stack)
  • validatestream(, stream)
  • validatestructured_output_strategy(, value)
    • AmazonSqsEventListenerDriver
  • client()
  • try_publish_event_payload(event_payload)
  • try_publish_event_payload_batch(event_payload_batch)
    • AnthropicPromptDriver
  • Attributes
  • __to_anthropic_content(message)
  • __to_anthropic_message_content(content)
  • __to_anthropic_messages(messages)
  • __to_anthropic_role(message)
  • __to_anthropic_tool_result_content(artifact)
  • __to_anthropic_tools(tools)
  • __to_prompt_stack_delta_message_content(event)
  • __to_prompt_stack_message_content(content)
  • _base_params(prompt_stack)
  • client()
  • try_run(prompt_stack)
  • try_stream(prompt_stack)
  • validatestructured_output_strategy(, value)
    • AstraDbVectorStoreDriver
  • Attributes
  • client()
  • collection()
  • delete_vector(vector_id)
  • Parameters
  • load_entries(*, namespace=None)
  • Parameters
  • Returns
  • load_entry(vector_id, *, namespace=None)
  • Parameters
  • Returns
  • query_vector(vector, *, count=None, namespace=None, include_vectors=False, **kwargs)
  • Parameters
  • Returns
  • upsert_vector(vector, *, vector_id=None, namespace=None, meta=None, **kwargs)
  • Parameters
  • Returns
    • AwsIotCoreEventListenerDriver
  • client()
  • try_publish_event_payload(event_payload)
  • try_publish_event_payload_batch(event_payload_batch)
    • AzureMongoDbVectorStoreDriver
  • query_vector(vector, *, count=None, namespace=None, include_vectors=False, offset=None, **kwargs)
    • AzureOpenAiChatPromptDriver
  • Attributes
  • _base_params(prompt_stack)
  • client()
    • AzureOpenAiEmbeddingDriver
  • Attributes
  • client()
    • AzureOpenAiImageGenerationDriver
  • Attributes
  • client()
    • AzureOpenAiTextToSpeechDriver
  • Attributes
  • client()
    • BaseAssistantDriver
  • run(*args)
  • try_run(*args)abstractmethod
    • BaseAudioTranscriptionDriver
  • after_run()
  • before_run()
  • run(audio, prompts=None)
  • try_run(audio, prompts=None)abstractmethod
    • BaseConversationMemoryDriver
  • _from_params_dict(params_dict)
  • _to_params_dict(runs, metadata)
  • load()abstractmethod
  • store(runs, metadata)abstractmethod
    • BaseDiffusionImageGenerationPipelineDriver
  • make_additional_params(negative_prompts, device)abstractmethod
  • make_image_param(image)abstractmethod
  • prepare_pipeline(model, device)abstractmethod
    • BaseEmbeddingDriver
  • Attributes
  • attrs_post_init()
  • _embed_long_string(string, *, vector_operation=None)
  • embed(value, *, vector_operation=None)
  • embed_string(string, *, vector_operation=None)
  • embed_text_artifact(artifact, *, vector_operation=None)
  • try_embed_artifact(artifact, *, vector_operation=None)
  • try_embed_chunk(chunk, *, vector_operation=None)abstractmethod
    • BaseEventListenerDriver
  • _safe_publish_event_payload(event_payload)
  • _safe_publish_event_payload_batch(event_payload_batch)
  • flush_events()
  • publish_event(event)
  • try_publish_event_payload(event_payload)abstractmethod
  • try_publish_event_payload_batch(event_payload_batch)abstractmethod
    • BaseFileManagerDriver
  • Attributes
  • list_files(path)
  • load_artifact(path)
  • load_file(path)
  • save_artifact(path, artifact)
  • save_file(path, value)
  • try_list_files(path)abstractmethod
  • try_load_file(path)abstractmethod
  • try_save_file(path, value)abstractmethod
    • BaseImageGenerationDriver
  • after_run()
  • before_run(prompts, negative_prompts=None)
  • run_image_inpainting(prompts, image, mask, negative_prompts=None)
  • run_image_outpainting(prompts, image, mask, negative_prompts=None)
  • run_image_variation(prompts, image, negative_prompts=None)
  • run_text_to_image(prompts, negative_prompts=None)
  • try_image_inpainting(prompts, image, mask, negative_prompts=None)abstractmethod
  • try_image_outpainting(prompts, image, mask, negative_prompts=None)abstractmethod
  • try_image_variation(prompts, image, negative_prompts=None)abstractmethod
  • try_text_to_image(prompts, negative_prompts=None)abstractmethod
    • BaseImageGenerationModelDriver
  • get_generated_image(response)abstractmethod
  • image_inpainting_request_parameters(prompts, image, mask, negative_prompts=None, seed=None)abstractmethod
  • image_outpainting_request_parameters(prompts, image, mask, negative_prompts=None, seed=None)abstractmethod
  • image_variation_request_parameters(prompts, image, negative_prompts=None, seed=None)abstractmethod
  • text_to_image_request_parameters(prompts, image_width, image_height, negative_prompts=None, seed=None)abstractmethod
    • BaseMultiModelImageGenerationDriver
  • Attributes
    • BaseObservabilityDriver
  • enter()
  • exit(exc_type, exc_value, exc_traceback)
  • get_span_id()abstractmethod
  • observe(call)abstractmethod
    • BasePromptDriver
  • Attributes
  • __build_message(delta_contents, usage)
  • __process_run(prompt_stack)
  • __process_stream(prompt_stack)
  • _init_structured_output(prompt_stack)
  • after_run(result)
  • before_run(prompt_stack)
  • prompt_stack_to_string(prompt_stack)
  • Parameters
  • Returns
  • run(prompt_input)
  • try_run(prompt_stack)abstractmethod
  • try_stream(prompt_stack)abstractmethod
    • BaseRerankDriver
  • run(query, artifacts)abstractmethod
    • BaseRulesetDriver
  • Attributes
  • _from_ruleset_dict(params_dict)
  • _get_rule(value, meta)
  • load(ruleset_name)abstractmethod
    • BaseSqlDriver
  • RowResultdataclass
  • execute_query(query)abstractmethod
  • execute_query_raw(query)abstractmethod
  • get_table_schema(table_name, schema=None)abstractmethod
    • BaseStructureRunDriver
  • Attributes
  • run(*args)
  • try_run(*args)abstractmethod
    • BaseTextToSpeechDriver
  • after_run()
  • before_run(prompts)
  • run_text_to_audio(prompts)
  • try_text_to_audio(prompts)abstractmethod
    • BaseVectorStoreDriver
  • Entry
  • _get_default_vector_id(value)
  • delete_vector(vector_id)abstractmethod
  • does_entry_exist(vector_id, *, namespace=None)
  • load_artifacts(*, namespace=None)
  • load_entries(*, namespace=None)abstractmethod
  • load_entry(vector_id, *, namespace=None)abstractmethod
  • query(query, *, count=None, namespace=None, include_vectors=False, **kwargs)
  • query_vector(vector, *, count=None, namespace=None, include_vectors=False, **kwargs)
  • upsert(value, *, namespace=None, meta=None, vector_id=None, **kwargs)
  • upsert_collection(artifacts, *, meta=None, **kwargs)
  • upsert_text(string, *, namespace=None, meta=None, vector_id=None, **kwargs)
  • upsert_text_artifact(artifact, *, namespace=None, meta=None, vector_id=None, **kwargs)
  • upsert_text_artifacts(artifacts, *, meta=None, **kwargs)
  • upsert_vector(vector, *, vector_id=None, namespace=None, meta=None, **kwargs)abstractmethod
    • BaseWebScraperDriver
  • extract_page(page)abstractmethod
  • fetch_url(url)abstractmethod
  • scrape_url(url)
    • BaseWebSearchDriver
  • search(query, **kwargs)abstractmethod
    • BedrockStableDiffusionImageGenerationModelDriver
  • Attributes
  • _request_parameters(prompts, width=None, height=None, image=None, mask=None, negative_prompts=None, seed=None, mask_source=None)
  • get_generated_image(response)
  • image_inpainting_request_parameters(prompts, image, mask, negative_prompts=None, seed=None)
  • image_outpainting_request_parameters(prompts, image, mask, negative_prompts=None, seed=None)
  • image_variation_request_parameters(prompts, image, negative_prompts=None, seed=None)
  • text_to_image_request_parameters(prompts, image_width, image_height, negative_prompts=None, seed=None)
    • BedrockTitanImageGenerationModelDriver
  • Attributes
  • _add_common_params(request, width, height, seed=None)
  • get_generated_image(response)
  • image_inpainting_request_parameters(prompts, image, mask, negative_prompts=None, seed=None)
  • image_outpainting_request_parameters(prompts, image, mask, negative_prompts=None, seed=None)
  • image_variation_request_parameters(prompts, image, negative_prompts=None, seed=None)
  • text_to_image_request_parameters(prompts, image_width, image_height, negative_prompts=None, seed=None)
    • CohereEmbeddingDriver
  • Attributes
  • client()
  • try_embed_chunk(chunk, **kwargs)
    • CoherePromptDriver
  • Attributes
  • __to_cohere_message_content(content)
  • __to_cohere_messages(messages)
  • __to_cohere_role(message, message_content=None)
  • __to_cohere_tools(tools)
  • __to_prompt_stack_delta_message_content(event)
  • __to_prompt_stack_message_content(response)
  • _base_params(prompt_stack)
  • client()
  • try_run(prompt_stack)
  • try_stream(prompt_stack)
    • CohereRerankDriver
  • run(query, artifacts)
    • DatadogObservabilityDriver
    • DuckDuckGoWebSearchDriver
  • client()
  • search(query, **kwargs)
    • DummyAudioTranscriptionDriver
  • try_run(audio, prompts=None)
    • DummyEmbeddingDriver
  • try_embed_chunk(chunk, **kwargs)
    • DummyImageGenerationDriver
  • try_image_inpainting(prompts, image, mask, negative_prompts=None)
  • try_image_outpainting(prompts, image, mask, negative_prompts=None)
  • try_image_variation(prompts, image, negative_prompts=None)
  • try_text_to_image(prompts, negative_prompts=None)
    • DummyPromptDriver
  • try_run(prompt_stack)
  • try_stream(prompt_stack)
    • DummyTextToSpeechDriver
  • try_text_to_audio(prompts)
    • DummyVectorStoreDriver
  • delete_vector(vector_id)
  • load_entries(*, namespace=None)
  • load_entry(vector_id, *, namespace=None)
  • query(query, *, count=None, namespace=None, include_vectors=False, **kwargs)
  • query_vector(vector, *, count=None, namespace=None, include_vectors=False, **kwargs)
  • upsert_vector(vector, vector_id=None, namespace=None, meta=None, **kwargs)
    • ElevenLabsTextToSpeechDriver
  • client()
  • try_text_to_audio(prompts)
    • ExaWebSearchDriver
  • client()
  • search(query, **kwargs)
    • GoogleEmbeddingDriver
  • Attributes
• Optional title for the content. Only works with retrieval_document task type.
  • _params(chunk)
  • try_embed_chunk(chunk, **kwargs)
    • GooglePromptDriver
  • Attributes
  • __to_google_message_content(content)
  • __to_google_messages(prompt_stack)
  • __to_google_role(message)
  • __to_google_tools(tools)
  • __to_prompt_stack_delta_message_content(content)
  • __to_prompt_stack_message_content(content)
  • _base_params(prompt_stack)
  • client()
  • try_run(prompt_stack)
  • try_stream(prompt_stack)
  • validatestructured_output_strategy(, value)
    • GoogleWebSearchDriver
  • _search_google(query, **kwargs)
  • search(query, **kwargs)
    • GriptapeCloudAssistantDriver
  • _create_or_find_thread(thread_alias=None)
  • _create_run(*args)
  • _create_thread(thread_alias=None)
  • _find_thread_by_alias(thread_alias)
  • _get_run_events(assistant_run_id)
  • _get_run_result(assistant_run_id)
  • try_run(*args)
    • GriptapeCloudConversationMemoryDriver
  • Attributes
  • Raises
  • _call_api(method, path, json=None, *, raise_for_status=True)
  • _get_url(path)
  • load()
  • store(runs, metadata)
  • validateapi_key(, value)
    • GriptapeCloudEventListenerDriver
  • Attributes
  • _get_event_request(event_payload)
  • _post_event(json)
  • publish_event(event)
  • try_publish_event_payload(event_payload)
  • try_publish_event_payload_batch(event_payload_batch)
  • validateapi_key(, api_key)
  • validaterun_id(, structure_run_id)
    • GriptapeCloudFileManagerDriver
  • Attributes
  • Raises
  • attrs_post_init()
  • _call_api(method, path, json=None, params=None, *, raise_for_status=True)
  • _get_asset_url(full_key)
  • _get_url(path)
  • _is_a_directory(path)
  • _to_full_key(path)
  • try_list_files(path, postfix=’’)
  • try_load_file(path)
  • try_save_file(path, value)
  • validatebucket_id(, value)
    • GriptapeCloudImageGenerationDriver
  • try_image_inpainting(prompts, image, mask, negative_prompts=None)
  • try_image_outpainting(prompts, image, mask, negative_prompts=None)
  • try_image_variation(prompts, image, negative_prompts=None)
  • try_text_to_image(prompts, negative_prompts=None)
    • GriptapeCloudObservabilityDriver
  • build_span_exporter(base_url, api_key, headers, structure_run_id)staticmethod
  • format_span_id(span_id)staticmethod
  • format_trace_id(trace_id)staticmethod
  • get_span_id()
  • validaterun_id(, structure_run_id)
    • GriptapeCloudPromptDriver
  • __to_griptape_tools(tools)
  • _base_params(prompt_stack)
  • try_run(prompt_stack)
  • try_stream(prompt_stack)
    • GriptapeCloudRulesetDriver
  • Attributes
  • Raises
  • _call_api(method, path, *, raise_for_status=True)
  • _get_url(path)
  • load(ruleset_name)
  • validateapi_key(, value)
    • GriptapeCloudStructureRunDriver
  • _create_run(*args)
  • _get_run_events(structure_run_id)
  • _get_run_result(structure_run_id)
  • try_run(*args)
    • GriptapeCloudVectorStoreDriver
  • Attributes
  • delete_vector(vector_id)
  • load_artifacts(*, namespace=None)
  • load_entries(*, namespace=None)
  • load_entry(vector_id, *, namespace=None)
  • query(query, *, count=None, namespace=None, include_vectors=None, distance_metric=None, filter=None, **kwargs)
  • upsert_text(string, vector_id=None, namespace=None, meta=None, **kwargs)
  • upsert_text_artifact(artifact, namespace=None, meta=None, vector_id=None, **kwargs)
  • upsert_vector(vector, vector_id=None, namespace=None, meta=None, **kwargs)
    • GrokPromptDriver
    • HuggingFaceHubEmbeddingDriver
  • Attributes
  • client()
  • try_embed_chunk(chunk, **kwargs)
    • HuggingFaceHubPromptDriver
  • Attributes
  • __prompt_stack_to_tokens(prompt_stack)
  • _base_params(prompt_stack)
  • _prompt_stack_to_messages(prompt_stack)
  • client()
  • prompt_stack_to_string(prompt_stack)
  • try_run(prompt_stack)
  • try_stream(prompt_stack)
  • validatestructured_output_strategy(, value)
    • HuggingFacePipelineImageGenerationDriver
  • Attributes
  • try_image_inpainting(prompts, image, mask, negative_prompts=None)
  • try_image_outpainting(prompts, image, mask, negative_prompts=None)
  • try_image_variation(prompts, image, negative_prompts=None)
  • try_text_to_image(prompts, negative_prompts=None)
    • HuggingFacePipelinePromptDriver
  • Attributes
  • __prompt_stack_to_tokens(prompt_stack)
  • _base_params(prompt_stack)
  • _prompt_stack_to_messages(prompt_stack)
  • pipeline()
  • prompt_stack_to_string(prompt_stack)
  • try_run(prompt_stack)
  • try_stream(prompt_stack)
  • validatestructured_output_strategy(, value)
    • LeonardoImageGenerationDriver
  • Attributes
  • _create_generation(prompts, negative_prompts, init_image_id=None)
  • _download_image(url)
  • _get_image_url(generation_id)
  • _make_api_request(endpoint, request, method=‘POST’)
  • _upload_init_image(image)
  • try_image_inpainting(prompts, image, mask, negative_prompts=None)
  • try_image_outpainting(prompts, image, mask, negative_prompts=None)
  • try_image_variation(prompts, image, negative_prompts=None)
  • try_text_to_image(prompts, negative_prompts=None)
    • LocalConversationMemoryDriver
  • load()
  • store(runs, metadata)
    • LocalFileManagerDriver
  • Attributes
  • _full_path(path)
  • _is_dir(full_path)
  • try_list_files(path)
  • try_load_file(path)
  • try_save_file(path, value)
    • LocalRerankDriver
  • run(query, artifacts)
    • LocalRulesetDriver
  • load(ruleset_name)
    • LocalStructureRunDriver
  • try_run(*args)
    • LocalVectorStoreDriver
  • attrs_post_init()
  • __namespaced_vector_id(vector_id, *, namespace)
  • __save_entries_to_file(json_file)
  • delete_vector(vector_id)
  • load_entries(*, namespace=None)
  • load_entries_from_file(json_file)
  • load_entry(vector_id, *, namespace=None)
  • query_vector(vector, *, count=None, namespace=None, include_vectors=False, **kwargs)
  • upsert_vector(vector, *, vector_id=None, namespace=None, meta=None, **kwargs)
    • MarkdownifyWebScraperDriver
  • Attributes
  • extract_page(page)
  • fetch_url(url)
    • MarqoVectorStoreDriver
  • Attributes
  • __process_results(results, *, include_vectors)
  • client()
  • delete_index(name)
  • Parameters
  • delete_vector(vector_id)
  • get_indexes()
  • Returns
  • load_entries(*, namespace=None)
  • Parameters
  • Returns
  • load_entry(vector_id, *, namespace=None)
  • Parameters
  • Returns
  • query(query, *, count=None, namespace=None, include_vectors=False, include_metadata=True, **kwargs)
  • Parameters
  • Returns
  • query_vector(vector, *, count=None, namespace=None, include_vectors=False, include_metadata=True, **kwargs)
  • Parameters
  • Returns
  • upsert(value, *, namespace=None, meta=None, vector_id=None, **kwargs)
  • Parameters
  • Returns
  • upsert_vector(vector, *, vector_id=None, namespace=None, meta=None, **kwargs)
  • Parameters
  • Raises
  • Returns
    • MongoDbAtlasVectorStoreDriver
  • Attributes
  • client()
  • delete_vector(vector_id)
  • get_collection()
  • load_entries(*, namespace=None)
  • load_entry(vector_id, *, namespace=None)
  • Returns
  • query_vector(vector, *, count=None, namespace=None, include_vectors=False, offset=None, **kwargs)
  • upsert_vector(vector, *, vector_id=None, namespace=None, meta=None, **kwargs)
    • NoOpObservabilityDriver
  • get_span_id()
  • observe(call)
    • OllamaEmbeddingDriver
  • Attributes
  • client()
  • try_embed_chunk(chunk, **kwargs)
    • OllamaPromptDriver
  • Attributes
  • __to_ollama_message_content(content)
  • __to_ollama_role(message, message_content=None)
  • __to_ollama_tools(tools)
  • __to_prompt_stack_delta_message_content(content_delta)
  • __to_prompt_stack_message_content(response)
  • _base_params(prompt_stack)
  • _prompt_stack_to_messages(prompt_stack)
  • client()
  • try_run(prompt_stack)
  • try_stream(prompt_stack)
    • OpenAiAssistantDriver
  • EventHandler
  • _create_run(thread_id, *args)
  • client()
  • try_run(*args)
    • OpenAiAudioTranscriptionDriver
  • client()
  • try_run(audio, prompts=None)
    • OpenAiChatPromptDriver
  • Attributes
  • __to_openai_message_content(content)
  • __to_openai_messages(messages)
  • __to_openai_role(message, message_content=None)
  • __to_openai_tools(tools)
  • __to_prompt_stack_delta_message_content(content_delta)
  • __to_prompt_stack_message_content(response)
  • _base_params(prompt_stack)
  • _to_delta_message_stream(result)
  • _to_message(result)
  • client()
  • try_run(prompt_stack)
  • try_stream(prompt_stack)
    • OpenAiEmbeddingDriver
  • Attributes
  • _params(chunk)
  • client()
  • try_embed_chunk(chunk, **kwargs)
    • OpenAiImageGenerationDriver
  • Attributes
  • _build_model_params(values)
  • Parameters
  • _parse_image_response(response, prompt)
  • client()
  • try_image_inpainting(prompts, image, mask, negative_prompts=None)
  • try_image_outpainting(prompts, image, mask, negative_prompts=None)
  • try_image_variation(prompts, image, negative_prompts=None)
  • try_text_to_image(prompts, negative_prompts=None)
  • validate_image_size(attribute, value)
    • OpenAiTextToSpeechDriver
  • client()
  • try_text_to_audio(prompts)
    • OpenSearchVectorStoreDriver
  • Attributes
  • client()
  • delete_vector(vector_id)
  • load_entries(*, namespace=None)
  • Returns
  • load_entry(vector_id, *, namespace=None)
  • Returns
  • query_vector(vector, *, count=None, namespace=None, include_vectors=False, include_metadata=True, field_name=‘vector’, **kwargs)
  • Returns
  • upsert_vector(vector, *, vector_id=None, namespace=None, meta=None, **kwargs)
    • OpenTelemetryObservabilityDriver
  • attrs_post_init()
  • enter()
  • exit(exc_type, exc_value, exc_traceback)
  • _trace_provider_factory()
  • get_span_id()
  • observe(call)
    • PerplexityPromptDriver
  • _base_params(prompt_stack)
  • _to_message(result)
    • PerplexityWebSearchDriver
  • prompt_driver()
  • search(query, **kwargs)
    • PgAiKnowledgeBaseVectorStoreDriver
  • delete_vector(vector_id)
  • engine()
  • load_artifacts(*, namespace=None)
  • load_entries(*, namespace=None)
  • load_entry(vector_id, *, namespace=None)
  • query(query, *, count=BaseVectorStoreDriver.DEFAULT_QUERY_COUNT, **kwargs)
  • upsert_text(string, vector_id=None, namespace=None, meta=None, **kwargs)
  • upsert_text_artifact(artifact, namespace=None, meta=None, vector_id=None, **kwargs)
  • upsert_vector(vector, vector_id=None, namespace=None, meta=None, **kwargs)
    • PgVectorVectorStoreDriver
  • Attributes
  • default_vector_model()
  • delete_vector(vector_id)
  • engine()
  • load_entries(*, namespace=None)
  • load_entry(vector_id, *, namespace=None)
  • query_vector(vector, *, count=None, namespace=None, include_vectors=False, distance_metric=‘cosine_distance’, **kwargs)
  • setup(*, create_schema=True, install_uuid_extension=True, install_vector_extension=True)
  • upsert_vector(vector, *, vector_id=None, namespace=None, meta=None, **kwargs)
  • validateconnection_string(, connection_string)
    • PineconeVectorStoreDriver
  • client()
  • delete_vector(vector_id)
  • index()
  • load_entries(*, namespace=None)
  • load_entry(vector_id, *, namespace=None)
  • query_vector(vector, *, count=None, namespace=None, include_vectors=False, include_metadata=True, **kwargs)
  • upsert_vector(vector, vector_id=None, namespace=None, meta=None, **kwargs)
    • ProxyWebScraperDriver
  • extract_page(page)
  • fetch_url(url)
    • PusherEventListenerDriver
  • client()
  • try_publish_event_payload(event_payload)
  • try_publish_event_payload_batch(event_payload_batch)
    • QdrantVectorStoreDriver
  • Attributes
  • client()
  • delete_vector(vector_id)
  • Parameters
  • load_entries(*, namespace=None, **kwargs)
  • Parameters
  • Returns
  • load_entry(vector_id, *, namespace=None)
  • Parameters
  • Returns
  • query_vector(vector, *, count=None, namespace=None, include_vectors=False, **kwargs)
  • Parameters
  • Returns
  • upsert_vector(vector, *, vector_id=None, namespace=None, meta=None, content=None, **kwargs)
  • Parameters
  • Returns
    • RedisConversationMemoryDriver
  • Attributes
  • load()
  • store(runs, metadata)
    • RedisVectorStoreDriver
  • Attributes
  • _generate_key(vector_id, namespace=None)
  • _get_doc_prefix(namespace=None)
  • client()
  • delete_vector(vector_id)
  • load_entries(*, namespace=None)
  • Returns
  • load_entry(vector_id, *, namespace=None)
  • Returns
  • query_vector(vector, *, count=None, namespace=None, include_vectors=False, **kwargs)
  • Returns
  • upsert_vector(vector, vector_id=None, namespace=None, meta=None, **kwargs)
    • SnowflakeSqlDriver
  • engine()
  • execute_query(query)
  • execute_query_raw(query)
  • get_table_schema(table_name, schema=None)
  • validateget_connection(, get_connection)
    • SqlDriver
  • _get_table_schema(engine, table_name, schema=None)cachedstaticmethod
  • engine()
  • execute_query(query)
  • execute_query_raw(query)
  • get_table_schema(table_name, schema=None)
    • StableDiffusion3ControlNetImageGenerationPipelineDriver
  • Attributes
  • make_additional_params(negative_prompts, device)
  • make_image_param(image)
  • prepare_pipeline(model, device)
    • StableDiffusion3ImageGenerationPipelineDriver
  • Attributes
  • make_additional_params(negative_prompts, device)
  • make_image_param(image)
  • prepare_pipeline(model, device)
    • StableDiffusion3Img2ImgImageGenerationPipelineDriver
  • Attributes
  • make_additional_params(negative_prompts, device)
  • make_image_param(image)
  • prepare_pipeline(model, device)
    • TavilyWebSearchDriver
  • client()
  • search(query, **kwargs)
    • TrafilaturaWebScraperDriver
  • extract_page(page)
  • fetch_url(url)
    • VoyageAiEmbeddingDriver
  • Attributes
  • client()
  • try_embed_artifact(artifact, **kwargs)
  • try_embed_chunk(chunk, **kwargs)
    • WebhookEventListenerDriver
  • try_publish_event_payload(event_payload)
  • try_publish_event_payload_batch(event_payload_batch)
    • assistant
    • audio_transcription
    • embedding
    • event_listener
    • file_manager
    • image_generation
    • image_generation_model
    • image_generation_pipeline
    • memory
    • observability
    • prompt
    • rerank
    • ruleset
    • sql
    • structure_run
    • text_to_speech
    • vector
    • web_scraper
    • web_search
• engines
  • BaseExtractionEngine
    • extract_artifacts(artifacts, *, rulesets=None, **kwargs)abstractmethod
    • extract_text(text, *, rulesets=None, **kwargs)
    • validatemax_token_multiplier(, max_token_multiplier)
  • BaseSummaryEngine
    • summarize_artifacts(artifacts, *, rulesets=None)abstractmethod
    • summarize_text(text, *, rulesets=None)
  • CsvExtractionEngine
    • _extract_rec(artifacts, rows, *, rulesets=None)
    • extract_artifacts(artifacts, *, rulesets=None, **kwargs)
    • text_to_csv_rows(text)
  • EvalEngine
    • _generate_results(evaluation_params)
    • _generate_steps(evaluation_params)
    • evaluate(input, actual_output, **kwargs)
    • validatecriteria(, value)
    • validateevaluation_steps(, value)
  • JsonExtractionEngine
    • _extract_rec(artifacts, extractions, *, rulesets=None)
    • extract_artifacts(artifacts, *, rulesets=None, **kwargs)
    • json_to_text_artifacts(json_input)
  • PromptSummaryEngine
    • summarize_artifacts(artifacts, *, rulesets=None)
    • summarize_artifacts_rec(artifacts, summary=None, rulesets=None)
    • validateallowlist(, max_token_multiplier)
  • RagEngine
    • attrs_post_init()
    • process(context)
    • process_query(query)
• events
  • str()
    • AudioChunkEvent
  • Attributes
  • str()
    • BaseActionsSubtaskEvent
  • from_task(task)classmethod
    • BaseAudioTranscriptionEvent
    • BaseChunkEvent
  • str()abstractmethod
    • BaseEvent
    • BasePromptEvent
    • BaseTaskEvent
    • BaseTextToSpeechEvent
    • EventListener
  • Attributes
  • enter()
  • exit(type, value, traceback)
  • publish_event(event, *, flush=False)
    • FinishActionsSubtaskEvent
    • FinishAudioTranscriptionEvent
    • FinishImageGenerationEvent
    • FinishImageQueryEvent
    • FinishPromptEvent
    • FinishStructureRunEvent
    • FinishTaskEvent
    • FinishTextToSpeechEvent
    • StartActionsSubtaskEvent
    • StartAudioTranscriptionEvent
    • StartImageGenerationEvent
    • StartImageQueryEvent
    • StartPromptEvent
    • StartStructureRunEvent
    • StartTaskEvent
    • StartTextToSpeechEvent
    • TextChunkEvent
  • str()
    • action_chunk_event
    • audio_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
  • init(dummy_class_name, dummy_method_name)
    • dummy_exception
• loaders
  • try_parse(data)
    • BaseFileLoader
  • fetch(source)
  • save(destination, artifact)
    • BaseLoader
  • Attributes
  • fetch(source)abstractmethod
  • load(source)
  • load_collection(sources)
  • parse(data)
  • to_key(source)
  • try_parse(data)
    • BlobLoader
  • try_parse(data)
    • CsvLoader
  • try_parse(data)
    • EmailLoader
  • EmailQuery
  • Attributes
  • _count_messages(message_numbers)
  • fetch(source)
  • try_parse(data)
    • ImageLoader
  • Attributes
  • try_parse(data)
    • JsonLoader
  • parse(data)
    • PdfLoader
  • try_parse(data, *, password=None)
    • SqlLoader
  • fetch(source)
  • parse(data)
    • TextLoader
  • try_parse(data)
    • WebLoader
  • fetch(source)
  • try_parse(data)
    • 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
  • find_input_memory(memory_name)
  • get_storage_for(artifact)
  • load_artifacts(namespace)
  • process_output(tool_activity, subtask, output_artifact)
  • store_artifact(namespace, artifact)
  • validateartifact_storages(, artifact_storage)
    • meta
    • structure
    • task
• mixins
  • actions_subtask_origin_mixin
    • _actions_schema_for_tools(tools)
    • actions_schema()abstractmethod
    • add_subtask(subtask)abstractmethod
    • find_memory(memory_name)abstractmethod
    • find_subtask(subtask_id)abstractmethod
    • find_tool(tool_name)abstractmethod
  • activity_mixin
    • Attributes
    • _validate_tool_activity(activity_name)
    • activities()
    • activity_description(activity)
    • activity_name(activity)
    • activity_schema(activity)
    • disable_activities()
    • enable_activities()
    • find_activity(name)
    • to_activity_json_schema(activity, schema_id)
    • validate_activity_schema(activity_schema, params)
    • validateallowlist(, allowlist)
    • validatedenylist(, denylist)
  • artifact_file_output_mixin
    • _write_to_file(artifact)
    • validateoutput_dir(, output_dir)
    • validateoutput_file(, output_file)
  • exponential_backoff_mixin
    • retrying()
  • futures_executor_mixin
    • __raise_deprecation_warning()
  • rule_mixin
  • runnable_mixin
    • Attributes
    • after_run(*args, **kwargs)
    • before_run(*args, **kwargs)
    • run(*args, **kwargs)abstractmethod
  • serializable_mixin
    • str()
    • _import_cls_rec(module_name, class_name)classmethod
    • Parameters
    • Returns
    • from_dict(data, *, types_overrides=None, serializable_overrides=None)classmethod
    • from_json(data, *, types_overrides=None, serializable_overrides=None)classmethod
    • get_schema(subclass_name=None, *, module_name=None, types_overrides=None, serializable_overrides=None)classmethod
    • Parameters
    • to_dict(*, types_overrides=None, serializable_overrides=None)
    • to_json(*, types_overrides=None, serializable_overrides=None)
  • singleton_mixin
    • new(*args, **kwargs)
• observability
  • enter()
  • exit(exc_type, exc_value, exc_traceback)
  • get_global_driver()staticmethod
  • get_span_id()staticmethod
  • observe(call)staticmethod
  • set_global_driver(driver)staticmethod
    • observability
• rules
  • str()
  • to_text()abstractmethod
    • JsonSchemaRule
  • to_text()
    • Rule
  • to_text()
    • Ruleset
  • attrs_post_init()
    • base_rule
    • json_schema_rule
    • rule
    • ruleset
• schemas
  • Meta
  • _get_field_for_type(field_type, serialization_key=None, types_overrides=None)classmethod
  • Parameters
  • _get_field_type_info(field_type)classmethod
  • Parameters
  • _handle_list(list_type, *, optional, serialization_key=None)classmethod
  • Parameters
  • Returns
  • _handle_union(union_type, *, optional, serialization_key=None)classmethod
  • Parameters
  • Returns
  • _is_enum(field_type)classmethod
  • _is_list_sequence(field_type)classmethod
  • _is_union(field_type)classmethod
  • _resolve_types(attrs_cls, types_override=None)classmethod
  • Parameters
  • from_attrs_cls(attrs_cls, *, types_overrides=None, serializable_overrides=None)classmethod
  • Parameters
    • Bytes
  • _deserialize(value, attr, data, **kwargs)
  • _serialize(value, attr, obj, **kwargs)
  • _validate(value)
    • PolymorphicSchema
  • init(inner_class, types_overrides=None, **kwargs)
  • _dump(obj, *, update_fields=True, **kwargs)
  • _load(data, *, partial=None, unknown=None, **kwargs)
  • dump(obj, *, many=None, **kwargs)
  • get_data_type(data)
  • get_obj_type(obj)
  • load(data, *, many=None, partial=None, unknown=None, **kwargs)
  • validate(data, *, many=None, partial=None)
    • PydanticModel
  • _deserialize(value, attr, data, **kwargs)
  • _serialize(value, attr, obj, **kwargs)
    • Union
  • Parameters
  • init(fields, *, reverse_serialize_candidates=False, **kwargs)
  • _deserialize(value, attr=None, data=None, **kwargs)
  • Parameters
  • Raises
  • _serialize(value, attr, obj, **kwargs)
  • Parameters
  • Raises
    • base_schema
    • bytes_field
    • polymorphic_schema
    • pydantic_model_field
    • union_field
• structures
  • attrs_post_init()
  • _init_task()
  • add_task(task)
  • add_tasks(*tasks)
  • try_run(*args)
  • validatefail_fast(, fail_fast)
  • validateprompt_driver(, prompt_driver)
  • validatetasks(, tasks)
    • Pipeline
  • __run_from_task(task)
  • add_task(task)
  • context(task)
  • insert_task(parent_task, task)
  • try_run(*args)
    • Structure
  • add(other)
  • attrs_post_init()
  • add_task(task)abstractmethod
  • add_tasks(*tasks)
  • after_run()
  • before_run(args)
  • context(task)
  • find_task(task_id)
  • is_finished()
  • is_running()
  • resolve_relationships()
  • run(*args)
  • run_stream(*args, event_types=None)
  • try_find_task(task_id)
  • try_run(*args)abstractmethod
    • Workflow
  • __link_task_to_children(task, child_tasks)
  • __link_task_to_parents(task, parent_tasks)
  • __remove_old_parent_child_relationships(parent_tasks, child_tasks)
  • add_task(task)
  • context(task)
  • insert_task(parent_tasks, task, child_tasks, *, preserve_relationship=False)
  • insert_tasks(parent_tasks, tasks, child_tasks, *, preserve_relationship=False)
  • Parameters
  • order_tasks()
  • to_graph()
  • try_run(*args)
    • agent
    • pipeline
    • structure
    • workflow
• tasks
  • __init_from_artifact(artifact)
  • Parameters
  • Returns
  • __init_from_prompt(value)
  • __parse_actions(actions_matches)
  • __process_action_object(action_object)
  • __validate_action(action)
  • _process_task_input(task_input)
  • actions_to_dicts()
  • actions_to_json()
  • add_to_prompt_stack(stack)
  • after_run()
  • attach_to(parent_task)
  • before_run()
  • default_generate_assistant_subtask_template(subtask)
  • default_generate_user_subtask_template(subtask)
  • run_action(action)
  • run_actions(actions)
  • try_run()
    • AssistantTask
  • Attributes
  • try_run()
    • AudioTranscriptionTask
  • try_run()
    • BaseAudioGenerationTask
  • after_run()
  • before_run()
    • BaseImageGenerationTask
  • Attributes
  • _get_negative_prompts()
  • _get_prompts(prompt)
  • _read_from_file(path)
    • BaseSubtask
  • add_child(child)
  • add_parent(parent)
  • add_to_prompt_stack(stack)abstractmethod
  • attach_to(parent_task)
    • BaseTask
  • State
  • attrs_post_init()
  • lshift(other)
  • rshift(other)
  • str()
  • add_child(child)
  • add_children(children)
  • add_parent(parent)
  • add_parents(parents)
  • after_run()
  • before_run()
  • can_run()
  • is_finished()
  • is_pending()
  • is_running()
  • is_skipped()
  • preprocess(structure)
  • reset()
  • run(*args)
  • try_run()abstractmethod
    • BaseTextInputTask
  • after_run()
  • before_run()
    • BranchTask
  • try_run()
    • CodeExecutionTask
  • try_run()
    • ExtractionTask
  • try_run()
    • InpaintingImageGenerationTask
  • Attributes
  • try_run()
    • OutpaintingImageGenerationTask
  • Attributes
  • try_run()
    • OutputSchemaValidationSubtask
  • add_to_prompt_stack(stack)
  • after_run()
  • attach_to(parent_task)
  • before_run()
  • default_generate_assistant_subtask_template(subtask)
  • default_generate_user_subtask_template(subtask)
  • try_run()
    • PromptImageGenerationTask
  • Attributes
  • try_run()
    • PromptTask
  • attrs_post_init()
  • _process_task_input(task_input)
  • actions_schema()
  • add_subtask(subtask)
  • after_run()
  • before_run()
  • default_generate_assistant_subtask_template(subtask)
  • defaultgenerate_system_template()
  • default_generate_user_subtask_template(subtask)
  • default_run_actions_subtasks(subtask_input)
  • default_run_output_schema_validation_subtasks(subtask_input)
  • find_memory(memory_name)
  • find_subtask(subtask_id)
  • find_tool(tool_name)
  • preprocess(structure)
  • set_default_tools_memory(memory)
  • try_run()
  • validateoutput_schema(, output_schema)
  • validatetools(, tools)
    • RagTask
  • try_run()
    • StructureRunTask
  • Attributes
  • _process_task_input(task_input)
  • try_run()
    • TextSummaryTask
  • try_run()
    • TextToSpeechTask
  • try_run()
    • ToolTask
  • attrs_post_init()
  • actions_schema()
  • add_subtask(subtask)
  • defaultgenerate_system_template()
  • find_memory(memory_name)
  • find_subtask(subtask_id)
  • find_tool(tool_name)
  • preprocess(structure)
  • set_default_tools_memory(memory)
  • try_run()
    • ToolkitTask
  • try_run()
    • VariationImageGenerationTask
  • Attributes
  • try_run()
    • actions_subtask
    • assistant_task
    • audio_transcription_task
    • base_audio_generation_task
    • base_audio_input_task
    • base_image_generation_task
    • base_subtask
    • base_task
    • base_text_input_task
    • branch_task
    • code_execution_task
    • extraction_task
    • inpainting_image_generation_task
    • outpainting_image_generation_task
    • output_schema_validation_subtask
    • 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
  • count_tokens(text)
    • AnthropicTokenizer
  • count_tokens(text)
    • BaseTokenizer
  • attrs_post_init()
  • _default_max_input_tokens()
  • _default_max_output_tokens()
  • count_input_tokens_left(text)
  • count_output_tokens_left(text)
  • count_tokens(text)abstractmethod
  • max_input_tokens()
  • max_output_tokens()
    • CohereTokenizer
  • count_tokens(text)
    • DummyTokenizer
  • count_tokens(text)
    • GoogleTokenizer
  • client()
  • count_tokens(text)
    • GrokTokenizer
  • count_tokens(text)
    • HuggingFaceTokenizer
  • count_tokens(text)
    • OpenAiTokenizer
  • _default_max_input_tokens()
  • _default_max_output_tokens()
  • count_tokens(text, model=None)
    • SimpleTokenizer
  • count_tokens(text)
    • VoyageAiTokenizer
  • count_tokens(text)
    • amazon_bedrock_tokenizer
    • anthropic_tokenizer
    • base_tokenizer
    • cohere_tokenizer
    • dummy_tokenizer
    • google_tokenizer
    • grok_tokenizer
    • huggingface_tokenizer
    • openai_tokenizer
    • simple_tokenizer
    • voyageai_tokenizer
• tools
  • transcribe_audio_from_disk(params)
  • transcribe_audio_from_memory(params)
    • BaseImageGenerationTool
    • BaseTool
  • Attributes
  • attrs_post_init()
  • activity_schemas()
  • after_run(activity, subtask, action, value)
  • are_requirements_met(requirements_path)
  • before_run(activity, subtask, action)
  • find_input_memory(memory_name)
  • install_dependencies(env=None)
  • run(activity, subtask, action)
  • schema()
  • to_native_tool_name(activity)
  • Parameters
  • Returns
  • tool_dir()
  • try_run(activity, subtask, action, value)
  • validate()
  • validateoutput_memory(, output_memory)
    • CalculatorTool
  • calculate(params)
    • ComputerTool
  • attrs_post_init()
  • del()
  • build_image(tool)
  • container_name(tool)
  • default_docker_client()
  • dependencies()
  • execute_code(params)
  • execute_code_in_container(filename, code)
  • execute_command(params)
  • execute_command_in_container(command)
  • image_name(tool)
  • install_dependencies(env=None)
  • remove_existing_container(name)
  • validatedocker_client(, docker_client)
    • DateTimeTool
  • add_timedelta(timedelta_kwargs, iso_datetime=None)
  • get_current_datetime()
  • get_datetime_diff(start_datetime, end_datetime)
  • get_relative_datetime(params)
    • EmailTool
  • Attributes
  • _create_smtp_client(smtp_host, smtp_port)
  • retrieve(params)
  • send(params)
    • ExtractionTool
  • Attributes
  • extract(params)
    • FileManagerTool
  • Attributes
  • list_files_from_disk(params)
  • load_files_from_disk(params)
  • save_content_to_file(params)
  • save_memory_artifacts_to_disk(params)
    • GriptapeCloudToolTool
  • Attributes
  • attrs_post_init()
  • __extract_schema_from_ref(schema, schema_ref)
  • _create_activity_handler(activity_name, description, activity_schema)
  • _get_schema()
  • _init_activities()
  • _map_openapi_type_to_python(openapi_type, schema_info=None)
  • _parse_schema(schema)
  • _run_activity(activity_name, params)
    • ImageQueryTool
  • query_image_from_disk(params)
  • query_images_from_memory(params)
    • InpaintingImageGenerationTool
  • Attributes
  • _generate_inpainting(prompt, negative_prompt, image_artifact, mask_artifact)
  • image_inpainting_from_file(params)
  • image_inpainting_from_memory(params)
    • OutpaintingImageGenerationTool
  • Attributes
  • _generate_outpainting(prompt, negative_prompt, image_artifact, mask_artifact)
  • image_outpainting_from_file(params)
  • image_outpainting_from_memory(params)
    • PromptImageGenerationTool
  • Attributes
  • generate_image(params)
    • PromptSummaryTool
  • Attributes
  • summarize(params)
    • QueryTool
  • query(params)
    • RagTool
  • Attributes
  • search(params)
    • RestApiTool
  • Attributes
  • _build_url(base_url, path=None, path_params=None)
  • delete(params)
  • get(params)
  • patch(params)
  • post(params)
  • put(params)
    • SqlTool
  • execute_query(params)
    • StructureRunTool
  • Attributes
  • run_structure(params)
    • StructuredOutputTool
  • provide_output(params)
    • TextToSpeechTool
  • Attributes
  • text_to_speech(params)
    • VariationImageGenerationTool
  • Attributes
  • _generate_variation(prompt, negative_prompt, image_artifact)
  • image_variation_from_file(params)
  • image_variation_from_memory(params)
    • VectorStoreTool
  • Attributes
  • search(params)
    • WebScraperTool
  • get_content(params)
    • WebSearchTool
  • search(values)
    • audio_transcription
    • base_griptape_cloud_tool
    • base_image_generation_tool
    • base_tool
    • calculator
    • computer
    • date_time
    • email
    • extraction
    • file_manager
    • griptape_cloud_tool
    • image_query
    • inpainting_image_generation
    • outpainting_image_generation
    • prompt_image_generation
    • prompt_summary
    • query
    • rag
    • rest_api
    • sql
    • structure_run
    • structured_output
    • text_to_speech
    • variation_image_generation
    • vector_store
    • web_scraper
    • web_search
• utils
  • Attributes
  • ChatPrompt
  • _call_handle_output(text, *, stream=False)
  • _has_streaming_tasks()
  • default_handle_input(prompt_prefix)
  • default_handle_output(text, *, stream=False)
  • start()
    • CommandRunner
  • run(command)
    • Conversation
  • str()
  • lines()
  • prompt_stack()
  • validate_memory(attribute, value)
    • GriptapeCloudStructure
  • Attributes
  • enter()
  • exit(exc_type, exc_value, exc_traceback)
  • _to_artifact(value)
  • event_listener()
  • observability()
    • J2
  • render(**kwargs)
  • render_from_string(value, **kwargs)
    • ManifestValidator
  • schema()
  • validate(manifest)
    • PythonRunner
  • run(code)
    • Stream
  • Attributes
  • run(*args)
    • StructureVisualizer
  • __render_task(task)
  • __render_tasks(tasks)
  • to_url()
  • Returns
    • TokenCounter
  • add_tokens(new_tokens)
    • add_key_in_dict_recursively(d, key, value, criteria=None)
  • Parameters
    • build_strict_schema(json_schema, schema_id)
  • Parameters
    • deprecation_warn(message, stacklevel=2)
    • dict_merge(dct, merge_dct, *, add_keys=True)
  • Parameters
  • Returns
    • execute_futures_dict(fs_dict)
    • execute_futures_list(fs_list)
    • execute_futures_list_dict(fs_dict)
    • get_mime_type(file_path_or_bytes)
  • Parameters
    • import_optional_dependency(name)
  • Parameters
  • Returns
    • is_dependency_installed(name)
  • Parameters
  • Returns
    • minify_json(value)
    • references_from_artifacts(artifacts)
    • remove_key_in_dict_recursively(d, key)
    • remove_null_values_in_dict_recursively(d)
    • resolve_refs(schema)
  • Parameters
    • str_to_hash(text, hash_algorithm=‘sha256’)
    • with_contextvars(wrapped)