DSPy: The framework for programming—not prompting—language models
Python
update api reference (#9135)
Chen Qian6cb77ffbbccd
diff --git a/docs/docs/api/adapters/Adapter.md b/docs/docs/api/adapters/Adapter.mdindex 7fa2fd960..00cc4151b 100644--- a/docs/docs/api/adapters/Adapter.md+++ b/docs/docs/api/adapters/Adapter.md@@ -13,6 +13,7 @@- format_demos- format_field_description- format_field_structure+ - format_system_message- format_task_description- format_user_message_content- parsediff --git a/docs/docs/api/adapters/ChatAdapter.md b/docs/docs/api/adapters/ChatAdapter.mdindex fa5e6a4d2..2bd2b06b5 100644--- a/docs/docs/api/adapters/ChatAdapter.md+++ b/docs/docs/api/adapters/ChatAdapter.md@@ -15,6 +15,7 @@- format_field_structure- format_field_with_value- format_finetune_data+ - format_system_message- format_task_description- format_user_message_content- parsediff --git a/docs/docs/api/adapters/JSONAdapter.md b/docs/docs/api/adapters/JSONAdapter.mdindex 718264b6e..65c274107 100644--- a/docs/docs/api/adapters/JSONAdapter.md+++ b/docs/docs/api/adapters/JSONAdapter.md@@ -15,6 +15,7 @@- format_field_structure- format_field_with_value- format_finetune_data+ - format_system_message- format_task_description- format_user_message_content- parsediff --git a/docs/docs/api/adapters/TwoStepAdapter.md b/docs/docs/api/adapters/TwoStepAdapter.mdindex ec14b4711..3594c4f55 100644--- a/docs/docs/api/adapters/TwoStepAdapter.md+++ b/docs/docs/api/adapters/TwoStepAdapter.md@@ -13,6 +13,7 @@- format_demos- format_field_description- format_field_structure+ - format_system_message- format_task_description- format_user_message_content- parsediff --git a/docs/docs/api/evaluation/EvaluationResult.md b/docs/docs/api/evaluation/EvaluationResult.mdindex f0b4ff714..3483670e2 100644--- a/docs/docs/api/evaluation/EvaluationResult.md+++ b/docs/docs/api/evaluation/EvaluationResult.md@@ -1,6 +1,5 @@# dspy.evaluate.EvaluationResult-<!-- START_API_REF -->::: dspy.evaluate.EvaluationResulthandler: pythondiff --git a/docs/docs/api/experimental/Citations.md b/docs/docs/api/experimental/Citations.mdindex 663372d29..9650eee1e 100644--- a/docs/docs/api/experimental/Citations.md+++ b/docs/docs/api/experimental/Citations.md@@ -5,6 +5,7 @@handler: pythonoptions:members:+ - adapt_to_native_lm_feature- description- extract_custom_type_from_annotation- formatdiff --git a/docs/docs/api/experimental/Document.md b/docs/docs/api/experimental/Document.mdindex 40c8f9c38..885dd3d09 100644--- a/docs/docs/api/experimental/Document.md+++ b/docs/docs/api/experimental/Document.md@@ -5,6 +5,7 @@handler: pythonoptions:members:+ - adapt_to_native_lm_feature- description- extract_custom_type_from_annotation- formatdiff --git a/docs/docs/api/primitives/Audio.md b/docs/docs/api/primitives/Audio.mdindex 21e0cdf3b..6c766e8dc 100644--- a/docs/docs/api/primitives/Audio.md+++ b/docs/docs/api/primitives/Audio.md@@ -5,6 +5,7 @@handler: pythonoptions:members:+ - adapt_to_native_lm_feature- description- extract_custom_type_from_annotation- formatdiff --git a/docs/docs/api/primitives/Code.md b/docs/docs/api/primitives/Code.mdindex 5c07c6787..3b2ec341e 100644--- a/docs/docs/api/primitives/Code.md+++ b/docs/docs/api/primitives/Code.md@@ -5,6 +5,7 @@handler: pythonoptions:members:+ - adapt_to_native_lm_feature- description- extract_custom_type_from_annotation- formatdiff --git a/docs/docs/api/primitives/Image.md b/docs/docs/api/primitives/Image.mdindex abc161c08..07a8eab87 100644--- a/docs/docs/api/primitives/Image.md+++ b/docs/docs/api/primitives/Image.md@@ -5,6 +5,7 @@handler: pythonoptions:members:+ - adapt_to_native_lm_feature- description- extract_custom_type_from_annotation- formatdiff --git a/docs/docs/api/primitives/Tool.md b/docs/docs/api/primitives/Tool.mdindex 6e32d40c7..22ba090a0 100644--- a/docs/docs/api/primitives/Tool.md+++ b/docs/docs/api/primitives/Tool.md@@ -7,6 +7,7 @@members:- __call__- acall+ - adapt_to_native_lm_feature- description- extract_custom_type_from_annotation- formatdiff --git a/docs/docs/api/primitives/ToolCalls.md b/docs/docs/api/primitives/ToolCalls.mdindex 492de64ff..7f4c31db0 100644--- a/docs/docs/api/primitives/ToolCalls.md+++ b/docs/docs/api/primitives/ToolCalls.md@@ -5,6 +5,7 @@handler: pythonoptions:members:+ - adapt_to_native_lm_feature- description- extract_custom_type_from_annotation- formatdiff --git a/docs/docs/api/tools/Embeddings.md b/docs/docs/api/tools/Embeddings.mdindex 36b5553e7..1b8a7bdf2 100644--- a/docs/docs/api/tools/Embeddings.md+++ b/docs/docs/api/tools/Embeddings.md@@ -7,6 +7,9 @@members:- __call__- forward+ - from_saved+ - load+ - saveshow_source: trueshow_root_heading: trueheading_level: 2diff --git a/docs/docs/api/utils/StreamListener.md b/docs/docs/api/utils/StreamListener.mdindex 517c398fd..66c2db8a1 100644--- a/docs/docs/api/utils/StreamListener.md+++ b/docs/docs/api/utils/StreamListener.md@@ -5,6 +5,7 @@handler: pythonoptions:members:+ - finalize- flush- receiveshow_source: true