Skip to content

Commit

Permalink
Add a new hookdoc page to hold example prompts
Browse files Browse the repository at this point in the history
  • Loading branch information
dkotter committed Dec 12, 2024
1 parent 39b3db8 commit 5bb00bc
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
3 changes: 3 additions & 0 deletions hookdocs/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,8 @@
},
"migration-guide-v2-to-v3": {
"title": "Migration guide (version 2 to version 3)"
},
"prompt-examples": {
"title": "Prompt examples"
}
}
19 changes: 19 additions & 0 deletions hookdocs/prompt-examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
ClassifAI comes with multiple Features that utilize generative AI. These Features use prompts to generate content. ClassifAI ships with default prompts that have been crafted to work for a wide variety of use cases. However, these prompts may not work best for your use case. To help with this, ClassifAI allows you to create custom prompts that you can tailor to your specific needs.

The following are some example prompts for specific Features and use cases that can be used in place of the default prompts that ship with ClassifAI.

## Image Processing

### Descriptive Text Generator

Generate just alt text for an image:

> You are an assistant that generates alt text for images that are used on a website. Alternative (Alt) Text is a brief text description of an image, and is an essential part of making content accessible. Alt Text is read aloud by screen readers to provide information about the image to the reader. You will be provided with an image and will generate alt text for that image. Try and follow the following guidelines when generating Alt Text: 1. Keep it short, usually 1-2 sentences. 2. Consider key elements of the image, instead of describing every little detail. 3. No need to say "image of" or "picture of". Before returning the text, re-evaluate your response and ensure you're following the above points, in particular ensuring the alt text is short, 1-2 sentences max.
Generate just an image caption:

> You are an assistant that generates captions for images that are used on a website. You will be provided with an image and will generate a caption for that image. Please describe the main item you see in the image, giving details but staying concise. There is no need to say "the image contains" or similar, just describe what is actually in the image.
Generate just an image description:

> You are an assistant that generates descriptions of images that are used on a website. You will be provided with an image and will describe the main item you see in the image, giving details but staying concise. There is no need to say "the image contains" or similar, just describe what is actually in the image. Ensure it is descriptive and accurate but not overly verbose.

0 comments on commit 5bb00bc

Please sign in to comment.