Skip to content

Latest commit

 

History

History
195 lines (155 loc) · 8.31 KB

conversation_custom.md

File metadata and controls

195 lines (155 loc) · 8.31 KB
Raw

Podcastfy Conversation Configuration

Podcastfy offers a range of customization options to tailor your AI-generated podcasts. This document outlines how you can adjust parameters such as conversation style, word count, and dialogue structure to suit your specific needs.

Table of Contents

  1. Parameters
  2. Customization Examples
    1. Academic Debate
    2. Storytelling Adventure
  3. Customization Scenarios
    1. Using the Python Package
    2. Using the CLI
  4. Notes of Caution

Conversation Parameters

Podcastfy uses the default conversation configuration stored in podcastfy/conversation_config.yaml.

Parameter Default Value Type Description
conversation_style ["engaging", "fast-paced", "enthusiastic"] list[str] Styles to apply to the conversation
roles_person1 "main summarizer" str Role of the first speaker
roles_person2 "questioner/clarifier" str Role of the second speaker
dialogue_structure ["Introduction", "Main Content Summary", "Conclusion"] list[str] Structure of the dialogue
podcast_name "PODCASTIFY" str Name of the podcast
podcast_tagline "Your Personal Generative AI Podcast" str Tagline for the podcast
output_language "English" str Language of the output
engagement_techniques ["rhetorical questions", "anecdotes", "analogies", "humor"] list[str] Techniques to engage the audience
creativity 1 float Level of creativity/temperature (0-1)
user_instructions "" str Custom instructions to guide the conversation focus and topics
max_num_chunks 7 int Maximum number of rounds of discussions in longform
min_chunk_size 600 int Minimum number of characters to generate a round of discussion in longform

Text-to-Speech (TTS) Settings

Podcastfy uses the default TTS configuration stored in podcastfy/conversation_config.yaml.

ElevenLabs TTS

  • default_voices:
    • question: "Chris"
      • Default voice for questions in the podcast.
    • answer: "Jessica"
      • Default voice for answers in the podcast.
  • model: "eleven_multilingual_v2"
    • The ElevenLabs TTS model to use.

OpenAI TTS

  • default_voices:
    • question: "echo"
      • Default voice for questions using OpenAI TTS.
    • answer: "shimmer"
      • Default voice for answers using OpenAI TTS.
  • model: "tts-1-hd"
    • The OpenAI TTS model to use.

Edge TTS

  • default_voices:
    • question: "en-US-JennyNeural"
      • Default voice for questions using Edge TTS.
    • answer: "en-US-EricNeural"
      • Default voice for answers using Edge TTS.

General TTS Settings

  • default_tts_model: "openai"
    • Default text-to-speech model to use.
  • output_directories:
    • transcripts: "./data/transcripts"
      • Directory for storing generated transcripts.
    • audio: "./data/audio"
      • Directory for storing generated audio files.
  • audio_format: "mp3"
    • Format of the generated audio files.
  • temp_audio_dir: "data/audio/tmp/"
    • Temporary directory for audio processing.
  • ending_message: "Bye Bye!"
    • Message to be appended at the end of the podcast.

Customization Examples

These examples demonstrate how conversations can be altered to suit different purposes, from academic rigor to creative storytelling. The comments explain the rationale behind each choice, helping users understand how to tailor the configuration to their specific needs.

Academic Debate

This configuration transforms the podcast into a formal academic debate, encouraging deep analysis and critical thinking. It's designed for educational content or in-depth discussions on complex topics.

{
    "word_count": 3000,  # Longer to allow for detailed arguments
    "conversation_style": ["formal", "analytical", "critical"],  # Appropriate for academic discourse
    "roles_person1": "thesis presenter",  # Presents the main argument
    "roles_person2": "counterargument provider",  # Challenges the thesis
    "dialogue_structure": [
        "Opening Statements",
        "Thesis Presentation",
        "Counterarguments",
        "Rebuttals",
        "Closing Remarks"
    ],  # Mimics a structured debate format
    "podcast_name": "Scholarly Showdown",
    "podcast_tagline": "Where Ideas Clash and Knowledge Emerges",
    "engagement_techniques": [
        "socratic questioning",
        "historical references",
        "thought experiments"
    ],  # Techniques to stimulate critical thinking
    "creativity": 0  # Low creativity to maintain focus on facts and logic
}

Storytelling Adventure

This configuration turns the podcast into an interactive storytelling experience, engaging the audience in a narrative journey. It's ideal for fiction podcasts or creative content marketing.

word_count: 1000  # Shorter to maintain pace and suspense
conversation_style: 
  - narrative
  - suspenseful
  - descriptive  # Creates an immersive story experience
roles_person1: storyteller
roles_person2: audience participator  # Allows for interactive elements
dialogue_structure: 
  - Scene Setting
  - Character Introduction
  - Rising Action
  - Climax
  - Resolution  # Follows classic storytelling structure
podcast_name: Tale Spinners
podcast_tagline: Where Every Episode is an Adventure
engagement_techniques: 
  - cliffhangers
  - vivid imagery
  - audience prompts  # Keeps the audience engaged and coming back
creativity: 0.9 # High creativity for unique and captivating stories

Customization Scenarios

Using the Python Package

When using the Podcastfy Python package, you can customize the conversation by passing a dictionary to the conversation_config parameter:

from podcastfy.client import generate_podcast

custom_config = {
    "word_count": 200,
    "conversation_style": ["casual", "humorous"],
    "podcast_name": "Tech Chuckles",
    "creativity": 0.7
}

generate_podcast(
    urls=["https://example.com/tech-news"],
    conversation_config=custom_config
)

Using the CLI

When using the Podcastfy CLI, you can specify a path to a YAML file containing your custom configuration:

podcastfy --url https://example.com/tech-news --conversation-config path/to/custom_config.yaml

The custom_config.yaml file should contain your configuration in YAML format:

word_count: 200
conversation_style: 
  - casual
  - humorous
podcast_name: Tech Chuckles
creativity: 0.7

Notes of Caution

  • The word_count is a target, and the AI may generate more or less than the specified word count. Low word counts are more likely to generate high-level discussions, while high word counts are more likely to generate detailed discussions.
  • The output_language defines both the language of the transcript and the language of the audio. Here's some relevant information:
    • Bottom-line: non-English transcripts are good enough but non-English audio is work-in-progress.
    • Transcripts are generated using Google's Gemini 1.5 Pro by default, which supports 100+ languages. Other user-defined models may or may not support non-English languages.
    • Audio is generated using openai (default), elevenlabs, gemini,or edge TTS models.
      • The gemini(Google) TTS model is English only.
      • The openai TTS model supports multiple languages automatically, however non-English voices still present sub-par quality in my experience.
      • The elevenlabs TTS model has English voices by default, in order to use a non-English voice you would need to download a custom voice for the target language in your elevenlabs account settings and then set the text_to_speech.elevenlabs.default_voices parameters to the voice you want to use in the config.yaml file (this config file is only available in the source code of the project, not in the pip package, hence if you are using the pip package you will not be able to change the ElevenLabs voice). For more information on ElevenLabs voices, visit ElevenLabs Voice Library