Skip to content

Commit 24fba6c

Browse files
committed
update doc
1 parent 37f35c6 commit 24fba6c

File tree

1 file changed

+8
-2
lines changed
  • convokit/convo_similarity

1 file changed

+8
-2
lines changed

convokit/convo_similarity/scd.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,17 @@ class SCD(Transformer):
2222
This transformer takes a corpus and generates SCD and/or SoP for selected conversations,
2323
storing the results as metadata on the conversations.
2424
25+
Prompt Templates:
26+
- SCD prompt: Uses {formatted_output} placeholder for the conversation transcript
27+
- SoP prompt: Uses {formatted_output} placeholder for the SCD summary
28+
2529
:param model_provider: The LLM provider to use (e.g., "gpt", "gemini")
2630
:param config: The GenAIConfigManager instance to use for LLM configuration
2731
:param model: Optional specific model name
28-
:param custom_scd_prompt: Custom text for the SCD prompt template
29-
:param custom_sop_prompt: Custom text for the SoP prompt template
32+
:param custom_scd_prompt: Custom text for the SCD prompt template. Should include {formatted_output}
33+
placeholder for the conversation transcript.
34+
:param custom_sop_prompt: Custom text for the SoP prompt template. Should include {formatted_output}
35+
placeholder for the SCD summary.
3036
:param custom_prompt_dir: Directory to save custom prompts
3137
:param generate_scd: Whether to generate SCD summaries (default: True)
3238
:param generate_sop: Whether to generate SoP patterns (default: True)

0 commit comments

Comments
 (0)