Add role "documents" to support Granite RAG
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
Research direction
Start by inspecting org.springframework.ai.chat.messages.AbstractMessage#messageType and org.springframework.ai.ollama.api.OllamaApi.Message#role, which the issue identifies as enum-based entry points. Check how these roles are serialized for Ollama, then define completion as allowing the documents role to be sent through ChatModel or OllamaApi for Granite RAG use cases.
Written by the indexing model from the issue text.
Description
Granite 3.1 introduced the role documents to support RAG use cases (https://www.ibm.com/granite/docs/models/granite/#retrieval-augmented-generation-(rag))
We did some explanatory testing with Ollama and the results are very promising.
Currently org.springframework.ai.chat.messages.AbstractMessage#messageType and org.springframework.ai.ollama.api.OllamaApi.Message#role are enumerations, which makes it impossible to use ChatModel or OllamaApi to sent this type of message to the LLM.
The use of enumerations in the context of Ollama might be a bit restrictive (every open-source model could decide to use an currently unknown role).
For now, extending the enum would give us the opportunity to create a custom advisor to use the new RAG approach from Granite.
For the long term, I feel OllamaChatModel and OllamaApi should not be restricted by enumerations.
- Dominant language
- Java
- Stars
- 9.5k
- Forks
- 2.9k
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 5
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from spring-projects/spring-ai
-
status: waiting-for-triage
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
spring-projects/spring-ai#7000 ·
-
status: waiting-for-triage
Difficulty 1/5 Under an hour Newbie friendliness 90/100
spring-projects/spring-ai#6998 ·
-
[Bug - MCP server] @McpTool error messages are emitted twice when the thrown exception has no cause Openstatus: waiting-for-triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
spring-projects/spring-ai#6948 · 1 comment · 1 reaction ·
-
status: waiting-for-triage
Difficulty 1/5 Under an hour Newbie friendliness 90/100
spring-projects/spring-ai#6940 · 1 comment ·
-
status: waiting-for-triage
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
spring-projects/spring-ai#6928 · 1 comment ·
All issues in spring-projects/spring-ai
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
bug needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 1/5 Under an hour Newbie friendliness 94/100
objectionary/hone-maven-plugin#1061 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
spring-projects/spring-modulith#1895 ·