VeeFriends.Character.Quotes 5.0.12

VeeFriends.Character.Quotes

Generate quotes and quizzes for VeeFriends characters using AI.

Installation

$ dotnet add package VeeFriends.Character.Quotes

Usage

This package provides services for generating character-specific quotes and quizzes for VeeFriends characters using AI. It's designed to be used with your own OpenAI API key.

1. Add the necessary services to your dependency injection container
2. Configure the OpenAI API key
3. Inject and use the CharacterQuoteService and CharacterQuizService

Setting up services

In your Startup.cs or Program.cs, add the following:

services.AddVeeFriendsCharacters();
services.AddCharacterQuoteService(options => options.ApiKey = "your-openai-api-key");
services.AddCharacterQuizService(options => options.ApiKey = "your-openai-api-key");

Generating a Quote

public class QuoteGenerator
{
    private readonly CharacterQuoteService _quoteService;

    public QuoteGenerator(CharacterQuoteService quoteService)
    {
        _quoteService = quoteService;
    }

    public async Task<string> GetQuoteOfTheDay(string characterName)
    {
        var quote = await _quoteService.GenerateMessageOfTheDay(characterName, CancellationToken.None);
        return quote;
    }
}

Generating a Quiz

public class QuizGenerator
{
    private readonly CharacterQuizService _quizService;

    public QuizGenerator(CharacterQuizService quizService)
    {
        _quizService = quizService;
    }

    public async Task<QuizAiResult> GenerateQuiz()
    {
        var quiz = await _quizService.GenerateQuestions(CancellationToken.None);
        return quiz;
    }
}

Models

The package uses the following main models:

public class QuizAiResult
{
    public List<QuizQuestion> Quiz { get; set; }
}

public class QuizQuestion
{
    public string Question { get; set; }
    public List<QuizAnswer> Answers { get; set; }
}

public class QuizAnswer
{
    public string Answer { get; set; }
    public string Trait { get; set; }
}

Notes

• Ensure you have a valid OpenAI API key to use this package.
• The generated quotes and quizzes are based on AI and may require review for appropriateness and accuracy.
• This package depends on VeeFriends.Characters for character information.

Feel free to explore the other methods available in CharacterQuoteService and CharacterQuizService.

License

This project is licensed under the MIT License - see the LICENSE file for details.