Shekharrajak opened a new pull request, #402: URL: https://github.com/apache/flink-agents/pull/402
Linked issue: #351 ### Purpose of change This PR adds comprehensive documentation for the Long-Term Memory feature in Flink Agents. The documentation covers: - Overview and key characteristics of Long-Term Memory - Configuration and setup requirements - Memory set operations (create, add, get, search, delete) - Compaction strategies (summarization) and async compaction - Practical usage examples (conversation history, knowledge bases, RAG applications) - Comparison with other memory types (Sensory Memory, Short-Term Memory) - Best practices for capacity planning and optimization - Current limitations and future enhancements The documentation follows the existing documentation style and provides clear guidance for developers using Long-Term Memory in their agents. ### Tests Documentation changes do not require code tests. The documentation was verified by: - Reviewing existing documentation style and format - Ensuring code examples match the actual API implementation in `python/flink_agents/api/memory/long_term_memory.py` - Validating that all referenced concepts align with the codebase - Referencing the e2e test file `long_term_memory_test.py` for usage patterns ### API This change does not touch any public APIs. It is documentation-only. ### Documentation <!-- Do not remove this section. Check the proper box only. --> - [x] `doc-needed` <!-- Your PR changes impact docs --> - [ ] `doc-not-needed` <!-- Your PR changes do not impact docs --> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
