API References

Welcome to the API references for the project. Below is a list of available modules:

• core package
  • Submodules
  • core.basics module
    • DesignGoal
      • DesignGoal.text
      • DesignGoal.images
      • DesignGoal.extra
      • DesignGoal.from_dict()
      • DesignGoal.from_json()
      • DesignGoal.to_dict()
      • DesignGoal.to_json()
    • PromptBuilder
      • PromptBuilder.messages
      • PromptBuilder.add_images()
      • PromptBuilder.add_system_message()
      • PromptBuilder.add_text()
      • PromptBuilder.add_user_message()
  • core.embeddings module
    • Embeddings
      • Embeddings.embed()
      • Embeddings.embed_documents()
      • Embeddings.embed_query()
  • core.model module
    • MultiModalModel
      • MultiModalModel.api_key
      • MultiModalModel.api_base_url
      • MultiModalModel.model_name
      • MultiModalModel.org_id
      • MultiModalModel.model_kwargs
      • MultiModalModel.stream
      • MultiModalModel.client
      • MultiModalModel.StreamState
        • MultiModalModel.StreamState.content
        • MultiModalModel.StreamState.reasoning_content
        • MultiModalModel.StreamState.stream_tool_calls
        • MultiModalModel.StreamState.tool_responses
      • MultiModalModel.get_response_with_tools()
      • MultiModalModel.query()
  • core.rerank module
    • Reranker
      • Reranker.rerank()
  • core.types module
    • SupportStr
  • core.utils module
    • ANSIStrippingFormatter
      • ANSIStrippingFormatter.ansi_escape
      • ANSIStrippingFormatter.format()
    • colorstring()
    • cprint()
    • extract_section_markdown()
    • find_files_with_extensions()
    • get_image_paths()
    • image_to_base64()
    • is_base64_encoded()
    • load_config()
    • load_prompts()
    • make_http_request()
    • parse_design_goal()
    • parse_json_response()
    • recover_stream_tool_calls()
    • setup_logging()
  • Module contents
• geometry_pipeline package
  • Submodules
  • geometry_pipeline.angles module
  • geometry_pipeline.convert module
    • obj2pc()
    • obj2stl()
    • recenter_and_reaxis_mesh()
    • step2mesh()
    • step2obj()
    • step2stl()
    • stl2obj()
    • stl2pc()
    • write_ply()
  • geometry_pipeline.snapshots module
    • capture_snapshots()
    • enhance_color_contrast()
    • generate_snapshots()
    • get_adaptive_camera_distance()
    • get_camera_pose()
    • preview_mesh_interactively()
    • preview_scene_interactive()
    • rgba_to_rgb()
  • Module contents
• describe package
  • Submodules
  • describe.describer_v2 module
    • Describer
      • Describer.decompose_design()
      • Describer.design_feedback_loop()
      • Describer.featurize_design_goal_with_confidence()
  • describe.utils module
    • get_images_from_folder()
    • load_object_metadata()
    • save_descriptions()
  • Module contents
• retrieval package
  • Submodules
  • retrieval.basics module
    • Document
      • Document.pretty_print()
    • VectorStore
      • VectorStore.add_texts()
      • VectorStore.similarity_search()
      • VectorStore.similarity_search_by_vector()
  • retrieval.pgvector_store module
    • CollectionStore
      • CollectionStore.uuid
      • CollectionStore.name
      • CollectionStore.cmetadata
      • CollectionStore.embeddings
      • CollectionStore.cmetadata
      • CollectionStore.embeddings
      • CollectionStore.name
      • CollectionStore.uuid
    • EmbeddingStore
      • EmbeddingStore.uuid
      • EmbeddingStore.collection_id
      • EmbeddingStore.collection
      • EmbeddingStore.embedding
      • EmbeddingStore.document
      • EmbeddingStore.cmetadata
      • EmbeddingStore.custom_id
      • EmbeddingStore.cmetadata
      • EmbeddingStore.collection
      • EmbeddingStore.collection_id
      • EmbeddingStore.custom_id
      • EmbeddingStore.document
      • EmbeddingStore.embedding
      • EmbeddingStore.uuid
    • PGVector
      • PGVector._engine
      • PGVector._Session
      • PGVector._embedding
      • PGVector._collection_name
      • PGVector._collection
      • PGVector.add_texts()
      • PGVector.add_texts_with_embeddings()
      • PGVector.create_collection()
      • PGVector.create_tables_if_not_exists()
      • PGVector.delete_by_ids()
      • PGVector.get_all_collection_metadata()
      • PGVector.get_collection_metadata()
      • PGVector.set_collection_metadata()
      • PGVector.similarity_search()
      • PGVector.similarity_search_by_vector()
  • retrieval.sqlitevec_store module
    • SQLiteVec
      • SQLiteVec.add_texts()
      • SQLiteVec.add_texts_with_embeddings()
      • SQLiteVec.create_metadata_table()
      • SQLiteVec.create_table()
      • SQLiteVec.create_table_if_not_exists()
      • SQLiteVec.delete_by_ids()
      • SQLiteVec.drop_table()
      • SQLiteVec.get_dimensionality()
      • SQLiteVec.get_metadata()
      • SQLiteVec.serialize_f32()
      • SQLiteVec.set_metadata()
      • SQLiteVec.similarity_search()
      • SQLiteVec.similarity_search_by_vector()
  • Module contents
• coding package
  • Submodules
  • coding.code_cache module
    • CodeCache
      • CodeCache.close()
      • CodeCache.get_errors()
      • CodeCache.get_iteration()
      • CodeCache.get_iterations()
      • CodeCache.get_session()
      • CodeCache.get_session_history()
      • CodeCache.get_session_id()
      • CodeCache.initialize_database()
      • CodeCache.insert_error()
      • CodeCache.insert_iteration()
      • CodeCache.insert_session()
      • CodeCache.update_error()
      • CodeCache.update_iteration()
      • CodeCache.update_session()
  • coding.code_executor module
    • CodeExecutor
      • CodeExecutor.check_grammar()
      • CodeExecutor.check_imports()
      • CodeExecutor.check_syntax()
      • CodeExecutor.execute_and_save()
      • CodeExecutor.execute_code()
      • CodeExecutor.validate_code()
  • coding.code_generator module
    • CodeGenerator
      • CodeGenerator.fix_code()
      • CodeGenerator.generate_code()
      • CodeGenerator.generate_or_fix_code()
      • CodeGenerator.patch_code_to_export()
      • CodeGenerator.plan_code()
      • CodeGenerator.save_code_to_file()
    • test_code_generator()
  • coding.coder module
    • Coder
      • Coder.generate_executable_code()
      • Coder.render_from_code()
    • parse_args()
  • Module contents
• feedback package
  • Submodules
  • feedback.feedback_judge module
    • FeedbackJudge
      • FeedbackJudge.is_design_goal_achieved()
    • parse_args()
  • feedback.visual_feedback module
    • VisualFeedback
      • VisualFeedback.generate_feedback_paragraph()
    • parse_args()
  • feedback.visual_qa module
    • VisualQA
      • VisualQA.automated_qa()
      • VisualQA.generate_answers()
      • VisualQA.generate_questions()
    • load_images()
  • Module contents
• tools package
  • Submodules
  • tools.build123d_retriever module
    • Build123dRetriever
      • Build123dRetriever.extract_all_objects()
      • Build123dRetriever.generate_embedding_pairs()
      • Build123dRetriever.get_complete_info()
      • Build123dRetriever.query()
  • tools.code_dochelper module
    • CodeDocHelper
      • CodeDocHelper.dict_to_markdown()
      • CodeDocHelper.get_class_info()
      • CodeDocHelper.get_function_info()
      • CodeDocHelper.get_info()
      • CodeDocHelper.get_module_info()
    • doc_helper()
  • tools.web_reader module
    • fetch_content()
  • Module contents
• workflow package
  • Submodules
  • workflow.codecad_agent module
    • CodeExecutionLoop
      • CodeExecutionLoop.run()
    • init_models()
    • main()
    • parse_args()
  • Module contents