3. Documentation (pre v0.2.2)

For the documentation we will be using the OpenAi model as it supports all endpoints, where Claude and Mistral are supported you can just hot-swap OpenAi when initialising the Sidekick/SidekickConversation class.

Conversations

This allows you to create a chatbot that remembers previos interactions.

To start a new conversation:

$sidekick = new SidekickConversation();

$conversation = $sidekick->begin(
    driver: new OpenAi(),
    model: 'gtp-3.5-turbo',
    systemPrompt: 'You can instruct the chatbot using this parameter'
);

$response = $conversation->sendMessage($user_input);

return response()->json($response);

This will create a new conversation in the Database and make the call to the AI for a response.

An example of the formatted response can be found below:

{
    "conversation_id": "9ce7af51-d0b9-491f-9e57-f54e30ef0b95",
    "messages": [
        {
            "role": "user",
            "content": "How is fudge made?"
        },
        {
            "role": "assistant",
            "content": "Fudge is a delicious, dense dessert made using a combination of sugar, milk, butter, and sometimes cream. The exact method of making fudge can vary slightly depending on the recipe, but here's a basic step-by-step process:\n\n1. Combine sugar, corn syrup, and water in a heavy-bottomed saucepan. Bring the mixture to a boil over medium heat, stirring occasionally to dissolve the sugar.\n2. Once the sugar has dissolved, stop stirring and attach a candy thermometer to the side of the pan. Continue cooking the mixture without stirring until it reaches the soft-ball stage (around 235-240°F/118-115°C).\n3. Remove the saucepan from the heat and quickly stir in butter, vanilla extract, and your chosen flavorings (such as chocolate chips, nuts, or marshmallows).\n4. Pour the fudge mixture into a lightly greased 8-inch square baking pan. Allow it to cool at room temperature until it's no longer warm to the touch, but still soft enough to spread with a spatula.\n5. Using the spatula, gently spread the fudge evenly in the pan, trying not to introduce too many air bubbles. Allow the fudge to cool completely at room temperature.\n6. Once the fudge is completely hardened, cut it into squares and enjoy!\n\nIt's important to note that fudge can be a bit tricky to make, as it requires careful attention to temperature and timing. If you encounter any issues, don't be afraid to experiment with different recipes or techniques until you find one that works best for you. Happy fudging!"
        }
    ]
}

Once you have this response, to continue the conversation you can write the following in your controller making sure to pass the conversation_id in the request:

$sidekick = new SidekickConversation();

$conversation = $sidekick->resume(
    conversationId: $conversation_id
);

$response = $conversation->sendMessage($user_input);

return response()->json($response);

An example of the formatted response can be found below:

{
  "conversation_id": "9ce79f44-de39-4ac3-9819-f1c042a4c02b",
  "messages": [
    {
      "role": "user",
      "content": "How is fudge made?"
    },
    {
      "role": "assistant",
      "content": "Fudge is a sweet treat that is typically made with sugar, butter, milk, and chocolate, although there are many variations and recipes that may include additional ingredients such as nuts, marshmallows, or fruit. Here's a basic step-by-step guide for making traditional fudge:\n\n1. Grease a 9-inch square baking pan and line it with parchment paper, allowing the excess to hang over the edges for easy removal.\n2. In a heavy-bottomed saucepan, combine 3 cups of granulated sugar, 1 can (12 ounces) of evaporated milk, and 1/2 cup of butter over medium heat. Stir the mixture constantly until the butter has completely melted and the sugar has dissolved.\n3. Once the sugar has dissolved, stop stirring and bring the mixture to a boil. Clip a candy thermometer to the side of the saucepan and cook the mixture without stirring until it reaches the soft-ball stage (235-240°F/113-115°C). This can take 10-15 minutes.\n4. Remove the saucepan from the heat and stir in 12 ounces of semi-sweet chocolate chips and 1 teaspoon of vanilla extract. Continue stirring until the chocolate is completely melted and the mixture is smooth.\n5. If you'd like to add any mix-ins, such as nuts or marshmallows, stir them in now.\n6. Pour the fudge mixture into the prepared baking pan and spread it evenly with a spatula. Let it cool at room temperature for at least 3 hours, or until it is completely set.\n7. Once the fudge is set, lift it out of the pan using the parchment paper overhang. Use a sharp knife to cut it into squares. Store the fudge in an airtight container at room temperature for up to 2 weeks, or in the refrigerator for up to 1 month."
    },
    {
      "role": "user",
      "content": "What are the traditional flavours?"
    },
    {
      "role": "assistant",
      "content": "While there are many variations of fudge, there are several traditional flavors that are popular around the world. Here are some of the most common traditional flavors of fudge:\n\n1. Chocolate: This is the most classic and popular flavor of fudge. It is made with chocolate chips or cocoa powder and can be flavored with vanilla, mint, or other extracts.\n2. Vanilla: Vanilla fudge is made with vanilla extract and can be flavored with nuts, such as walnuts or pecans, or with marshmallows.\n3. Butterscotch: Butterscotch fudge is made with brown sugar and butter and can be flavored with vanilla or salt.\n4. Peanut Butter: Peanut butter fudge is made with peanut butter and can be flavored with chocolate or honey.\n5. Maple: Maple fudge is made with maple syrup and can be flavored with nuts, such as pecans or walnuts.\n6. Rocky Road: Rocky road fudge is made with chocolate, marshmallows, and nuts, such as almonds or cashews.\n7. Fudge with Fruit: Some people make fudge with dried fruits, such as cherries, cranberries, or raisins, or with fresh fruit, such as strawberries or raspberries.\n8. Fudge with Nuts: Fudge can also be made with a variety of nuts, such as walnuts, pecans, almonds, or cashews, and can be flavored with chocolate or caramel."
    }
  ]
}

Streamed Conversations

The difference in non streamed and streamed responses is a flag. This flag is passed in the sendMessage function like so:

// Send a new message
return $conversation->sendMessage($request->get('message'));

// Send a new message (streamed)
return $conversation->sendMessage($request->get('message'), true);

Managing Conversations

There is very basic functionality to list, show and delete conversations. This will be updated in the near future. However, currently you do this by calling an instance of SidekickChatManager. Examples of each are below:

public function index() {
    // List Conversations
    $sidekick = new SidekickChatManager();
    return $sidekick->showAll();
}

public function show(Conversation $conversation) {
    // show Conversation
    $sidekick = new SidekickManager();
    $sidekick->show($conversation);
}

public function delete(Conversation $conversation) {
    // Delete Conversation
    $sidekick = new SidekickManager();
    return $sidekick->delete($conversation);
}

Common AI utilities

Completion

$sidekick = Sidekick::create(new OpenAi());

return $sidekick->complete()->sendMessage(
    model: 'gpt-3.5-turbo',
    systemPrompt: 'You an expert on fudge, answer user questions about fudge.',
    message:"How is fudge made?"
);

Embedding

$sidekick = Sidekick::create(new Mistral());

return $sidekick->embedding()->make(
    model: 'mistral-embed',
    input: 'This is sample content to embed'
);

Image (Image From Text)

$sidekick = Sidekick::create(new OpenAi());
 
$image =  $sidekick->image()->make(
    model:'dall-e-3',
    prompt: $request->get('text_to_convert'),
    width:'1024',
    height:'1024'
);

// This is just a basic example of printing to screen.
// In a real world situation you may save it and then render out.
return "<img src='{$image['data'][0]['url']}' />";

Audio (Text To Speech)

$sidekick = Sidekick::create(new OpenAi());

$audio = $sidekick->audio()->fromText(
    model: 'tts-1',
    text: 'Have a nice day!'
);

// This is just a basic example of streaming it to the browser.
// In a real world situation you may save it and then reference the file
// instead.
header('Content-Type: audio/mpeg');
echo $audio

Transcription (Speech To Text)

$sidekick = Sidekick::create(new OpenAi());

return $sidekick->transcribe()->audioFile(
    model: 'whisper-1',
    filePath: 'http://english.voiceoversamples.com/ENG_UK_M_PeterB.mp3'
);

Example Response

{
  "text":"The stale smell of old beer lingers. It takes heat to bring out the odor. A cold dip restores health and zest. A salt pickle tastes fine with ham. Tacos al pastor are my favorite. A zestful food is the hot cross bun."
}

Moderation

This is a service where you feed it text from a comment for example and it will return with an array of boolean values for certain moderation points.

$sidekick = Sidekick::create(new OpenAi());

return $sidekick->moderate()->text(
    model: 'text-moderation-latest',
    content: 'Have a great day.',
);

Example Response

{
  "id":"modr-94DxgkEGhw7yJDlq8oCrLOVXnqli5",
  "model":"text-moderation-007",
  "results":[
    {
      "flagged":true,
      "categories":{
        "sexual":false,
        "hate":false,
        "harassment":true,
        "self-harm":false,
        "sexual\/minors":false,
        "hate\/threatening":false,
        "violence\/graphic":false,
        "self-harm\/intent":false,
        "self-harm\/instructions":false,
        "harassment\/threatening":false,
        "violence":false
      },
      "category_scores":{
        "sexual":0.02169245481491089,
        "hate":0.024598680436611176,
        "harassment":0.9903337359428406,
        "self-harm":5.543852603295818e-5,
        "sexual\/minors":2.5174302209052257e-5,
        "hate\/threatening":2.9870452635805123e-6,
        "violence\/graphic":6.8601830207626335e-6,
        "self-harm\/intent":0.0002317160106031224,
        "self-harm\/instructions":0.00011696072033373639,
        "harassment\/threatening":1.837775380408857e-5,
        "violence":0.00020553809008561075
      }
    }
  ]}

Utilities

Utilities are quick ways of performing some actions using AI. The functions and there descriptions are below:

$sidekick = Sidekick::create(new OpenAi());

// Summarises the content passed. Good for blurbs
$sidekick->utilities()->summarize($content, $maxCharLength);  


// Extracts a number of keywords from a given string and returns a string of keywords (comma separated)       
$sidekick->utilities()->extractKeywords($text);

// Translates the given text to the language specified
$sidekick->utilities()->translateText($text, $targetLanguage);

// Generates content from a short description of what it should be about      
$sidekick->utilities()->generateContent($prompt, $maxTokens);

// Moderates content and returns a boolean of whether the content is flagged or not
$sidekick->utilities()->isContentFlagged($content, $model, $exclusions);  

// This method can store images/audio created by the AI.  
$sidekick->utilities()->store($data, $mimeType);