Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/apostrophecms/ai-helper

AI helpers for content creation
https://github.com/apostrophecms/ai-helper

Last synced: about 2 months ago
JSON representation

AI helpers for content creation

Host: GitHub
URL: https://github.com/apostrophecms/ai-helper
Owner: apostrophecms
License: mit
Created: 2023-03-04T17:33:31.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-09-05T21:03:21.000Z (4 months ago)
Last Synced: 2024-10-05T21:36:53.961Z (3 months ago)
Language: JavaScript
Size: 127 KB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

# ai-helper: AI for content creation in Apostrophe 3

## Purpose

This module enhances Apostrophe with AI-driven helpers. Currently this module offers:

* A button to generate an image from a text prompt via OpenAI.
* An insert menu option to generate rich text from a prompt via OpenAI.

You will need to [obtain your own API key from OpenAI](https://openai.com/product). As of this writing you can also
[obtain a free API key for limited usage](https://platform.openai.com/account/api-keys).

## Caveats

This is a beta module where we are experimenting with simple ways to integrate generative AI in the
content creation process. AI systems can generate surprising and sometimes inappropriate results.
The OpenAI API itself is subject to change.

## Install

```bash
npm install @apostrophecms/ai-helper
```

```javascript
// in app.js
modules: {
'@apostrophecms/ai-helper': {
// Optional: specify a particular GPT model name.
// This is the default:
textModel: 'gpt-4o',
// Optional: specify a particular Dall-E image
// generation model name. This is the default.
// Note: dall-e-3 currently lacks features needed
// by this module
imageModel: 'dall-e-2',
// Optional: override the maximum number of tokens,
// up to GPT's limit for the model. This is the default:
textMaxTokens: 1000
}
}
```

```javascript
// Anywhere you have a rich text widget that should support
// AI-generated rich text
someAreaName: {
widgets: {
'@apostrophecms/rich-text': {
toolbar: [
'styles',
'bold'
],
insert: [
'ai'
],
// Generated text includes headings if asked for
styles: [
{
name: 'Heading',
tag: 'h2'
},
{
name: 'Subheading',
tag: 'h3'
},
{
name: 'Paragraph',
tag: 'p'
}
]
}
}
}
```

```javascript
// in modules/@apostrophecms/security-headers/index.js,
// only if you are using that module in your project
module.exports = {
options: {
policies: {
ai: {
// Images served by OpenAI, for editing purposes only
'img-src': '*.blob.core.windows.net'
}
}
}
};
```

## Run

```bash
export APOS_OPENAI_KEY=get-your-own-key-from-openai
node app
```

## Usage

### Image Generation

Add an image widget to the page. Click the edit pencil, then "Browse" as you normally would.

When the media manager appears, click the "🤖" (robot) button in the upper right corner.

When the "Generate Image" dialog appears, follow the instructions to enter a plain English
description of the image you want. Then click "Generate." After a pause, four images
will appear. You can do this as many times as you wish.

When you are happy with the results, click on the best of the four images to review it
and click "Select" to bring it into the media library, "Variants" to generate
variants of it, or "Delete" to discard it.

The image helper generates 1024x1024 images. This is the maximum size supported by OpenAI.
As of this writing, smaller images are not much cheaper, and are unlikely to look good
in various placements on a website.

Note that generated images not selected for use in the media library after one hour will
be discarded by OpenAI. Those you select are permanently imported to the media library.

### Text Generation

Configure a rich text widget with the `insert` subproperty configured as shown above.

Now press the "/" (slash) key at the start of any line to bring up the insert menu.
Choose "Generate Text" to generate text.

Enter a prompt as suggested and click "Generate." After a pause, the generated text
is inserted into the rich text widget.

Note that the generated text can include headings and links if you so request.
It is also a good idea to specify a word count. You can make your request using
ordinary conversational language.