Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
PapaRascal2020 committed Sep 21, 2024
2 parents 0276ecd + c5c6fe0 commit 6019d9e
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ return $sidekick->transcribe()->audioFile(
filePath: 'http://english.voiceoversamples.com/ENG_UK_M_PeterB.mp3'
);
```
#### Example Response
** Example Response **
```json
{
"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."
Expand All @@ -297,7 +297,7 @@ return $sidekick->moderate()->text(
content: 'Have a great day.',
);
```
#### Example Response
** Example Response **

```json
{
Expand Down Expand Up @@ -336,6 +336,32 @@ return $sidekick->moderate()->text(
]}
```

#### Utilities

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

```PHP
// Summarises the content passed. Good for blurbs
$sidekick->utilities()->summarise();


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

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

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

// [OpenAI ONLY] Moderates content and returns a boolean of whether the content is flagged or not
$sidekick->utilities()->isContentFlagged();

// [OpenAI ONLY] this method can store images and audio created by the AI.
$sidekick->utilities()->store();
```


### Ways to Contribute

I want this composer package for Laravel to be as useful as possible, so with that in mind here are the ways you can contribute:
Expand Down

0 comments on commit 6019d9e

Please sign in to comment.