docs(indexing): document the default prompt templates and their conte…

…xt (#206)
bosun-ai · Jul 28, 2024 · 573aff6 · 573aff6
1 parent 2114aa4
commit 573aff6
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 0 deletions.
diff --git a/swiftide-indexing/src/transformers/metadata_keywords.rs b/swiftide-indexing/src/transformers/metadata_keywords.rs
@@ -21,6 +21,8 @@ pub const NAME: &str = "Keywords";
 pub struct MetadataKeywords {
     #[builder(setter(custom))]
     client: Arc<dyn SimplePrompt>,
+    /// The prompt templated used. Can be overwritten via the builder. Has the `node` available as
+    /// context.
     #[builder(default = "default_prompt()")]
     prompt_template: PromptTemplate,
     #[builder(default)]

diff --git a/swiftide-indexing/src/transformers/metadata_qa_code.rs b/swiftide-indexing/src/transformers/metadata_qa_code.rs
@@ -17,6 +17,8 @@ pub struct MetadataQACode {
     #[builder(setter(custom))]
     client: Arc<dyn SimplePrompt>,
     #[builder(default = "default_prompt()")]
+    /// The prompt templated used. Can be overwritten via the builder. Has the `node` and
+    /// `num_questions` available as context.
     prompt_template: PromptTemplate,
     #[builder(default = "5")]
     num_questions: usize,

diff --git a/swiftide-indexing/src/transformers/metadata_qa_text.rs b/swiftide-indexing/src/transformers/metadata_qa_text.rs
@@ -22,6 +22,8 @@ pub struct MetadataQAText {
     #[builder(setter(custom))]
     client: Arc<dyn SimplePrompt>,
     #[builder(default = "default_prompt()")]
+    /// The prompt templated used. Can be overwritten via the builder. Has the `node` and
+    /// `num_questions` available as context.
     prompt_template: PromptTemplate,
     #[builder(default = "5")]
     num_questions: usize,

diff --git a/swiftide-indexing/src/transformers/metadata_summary.rs b/swiftide-indexing/src/transformers/metadata_summary.rs
@@ -22,6 +22,8 @@ pub struct MetadataSummary {
     #[builder(setter(custom))]
     client: Arc<dyn SimplePrompt>,
     #[builder(default = "default_prompt()")]
+    /// The prompt templated used. Can be overwritten via the builder. Has the `node` available as
+    /// context.
     prompt_template: PromptTemplate,
     #[builder(default)]
     concurrency: Option<usize>,

diff --git a/swiftide-indexing/src/transformers/metadata_title.rs b/swiftide-indexing/src/transformers/metadata_title.rs
@@ -22,6 +22,8 @@ pub struct MetadataTitle {
     #[builder(setter(custom))]
     client: Arc<dyn SimplePrompt>,
     #[builder(default = "default_prompt()")]
+    /// The prompt templated used. Can be overwritten via the builder. Has the `node` available as
+    /// context.
     prompt_template: PromptTemplate,
     #[builder(default)]
     concurrency: Option<usize>,