docs: add guide for using custom model names with acts_as helpers #171
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Extend the Rails guide to explain how to customize model names when using the acts_as_chat, acts_as_message, and acts_as_tool_call helpers.
|
closes #183 |
crmne
requested changes
Jun 11, 2025
There was a problem hiding this comment.
Thanks @matheuscumpian. Only a couple changes needed before merging.
| @@ -474,6 +474,46 @@ This setup allows for: | |||
|
|
|||
| Your `Chat`, `Message`, and `ToolCall` models are standard ActiveRecord models. You can add any other associations, validations, scopes, callbacks, or methods as needed for your application logic. The `acts_as` helpers provide the core persistence bridge to RubyLLM without interfering with other model behavior. | |||
|
|
|||
| {: .note } | |||
| You can use custom model names by passing parameters to the `acts_as` helpers. For example, if you prefer `Conversation` over `Chat`, you could use `acts_as_chat` in your `Conversation` model and then specify `chat_class: 'Conversation'` in your `Message` model's `acts_as_message` call. | |||
There was a problem hiding this comment.
No need for a note when the content is right below.
| {: .note } | ||
| You can use custom model names by passing parameters to the `acts_as` helpers. For example, if you prefer `Conversation` over `Chat`, you could use `acts_as_chat` in your `Conversation` model and then specify `chat_class: 'Conversation'` in your `Message` model's `acts_as_message` call. | ||
|
|
||
| #### Using Custom Model Names |
There was a problem hiding this comment.
Why <h4>? it's right after an h2 so I'd say h3
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While integrating RubyLLM with an existing Rails application that already had a
Chatmodel, I discovered that the framework supports using custom model names with theacts_ashelpers. This isn't explicitly documented, but is a valuable feature for real-world Rails applications where naming conflicts or existing conventions might exist.Let me know if I'm missing something on this behaviour