Skip to content

Fix prompts dir in readme #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix prompts dir in readme #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 19 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,13 @@
Organize prompts into easy-to-use templates for [RubyLLM](https://github.com/crmne/ruby_llm).

```ruby
# prompts/
# extract_metadata/
# ├── system.txt.erb # System message
# ├── user.txt.erb # User prompt
# ├── assistant.txt.erb # Assistant message (optional)
# └── schema.rb # RubyLLM::Schema definition (optional)
# app/
# prompts/
# extract_metadata/
# ├── system.txt.erb # System message
# ├── user.txt.erb # User prompt
# ├── assistant.txt.erb # Assistant message (optional)
# └── schema.rb # RubyLLM::Schema definition (optional)

chat = RubyLLM.chat
chat.with_template(:extract_metadata, document: @document).complete
Expand Down Expand Up @@ -63,22 +64,23 @@ This will:
Create a directory structure like this:

```
prompts/
extract_metadata/
├── system.txt.erb # System message
├── user.txt.erb # User prompt
├── assistant.txt.erb # Assistant message (optional)
└── schema.rb # RubyLLM::Schema definition (optional)
app/
prompts/
extract_metadata/
├── system.txt.erb # System message
├── user.txt.erb # User prompt
├── assistant.txt.erb # Assistant message (optional)
└── schema.rb # RubyLLM::Schema definition (optional)
```

### 2. Write Your Templates

**`prompts/extract_metadata/system.txt.erb`**:
**`app/prompts/extract_metadata/system.txt.erb`**:
```erb
You are an expert document analyzer. Extract metadata from documents in a structured format.
```

**`prompts/extract_metadata/user.txt.erb`**:
**`app/prompts/extract_metadata/user.txt.erb`**:
```erb
Please analyze this document: <%= document %>

Expand All @@ -87,7 +89,7 @@ Additional context: <%= additional_context %>
<% end %>
```

**`prompts/extract_metadata/schema.rb`**:
**`app/prompts/extract_metadata/schema.rb`**:
```ruby
# Using RubyLLM::Schema DSL for clean, type-safe schemas
RubyLLM::Schema.create do
Expand Down Expand Up @@ -164,7 +166,7 @@ chat.with_template(:message, name: "Alice", urgent: true, documents: @documents)
```

```erb
<!-- /prompts/message/user.txt.erb -->
<!-- app/prompts/message/user.txt.erb -->
Hello <%= name %>!

<% if urgent %>
Expand Down Expand Up @@ -209,7 +211,7 @@ chat.ask("What should we focus on first?")
The gem integrates with [RubyLLM::Schema](https://github.com/danielfriis/ruby_llm-schema) to provide a clean Ruby DSL for defining JSON schemas. Use `schema.rb` files instead of JSON:

```ruby
# prompts/analyze_results/schema.rb
# app/prompts/analyze_results/schema.rb
RubyLLM::Schema.create do
number :confidence, minimum: 0, maximum: 1, description: "Analysis confidence"

Expand Down