Skip to content

docs: update README memory search API example for v1 search endpoint#185

Closed
CZH-THU wants to merge 657 commits into
EverMind-AI:mainfrom
CZH-THU:main
Closed

docs: update README memory search API example for v1 search endpoint#185
CZH-THU wants to merge 657 commits into
EverMind-AI:mainfrom
CZH-THU:main

Conversation

@CZH-THU
Copy link
Copy Markdown

@CZH-THU CZH-THU commented Apr 16, 2026

Description

Update the README documentation to reflect the current v1 memory search API request format.

Type of Change

  • Documentation update

Related Issues

Fixes #
Relates to #

Changes Made

  • Replaced the outdated /api/v1/memories/search example that used GET/query-string style syntax
  • Updated the README example to use POST with JSON body matching SearchMemoriesRequest
  • Included current fields such as method, memory_types, and structured filters

Testing

  • Tested locally with manual verification
  • Added/updated unit tests
  • Added/updated integration tests
  • All existing tests pass

Test Configuration:

  • OS: Windows
  • Python version: N/A for docs change
  • Database versions (if relevant): N/A

Test Results:

Verified README example against current endpoint schema and local code comment/reference

Checklist

  • My code follows the project's code style guidelines
  • I have performed a self-review of my code
  • I have commented my code where necessary, particularly in complex areas
  • I have updated the documentation accordingly
  • My changes generate no new warnings or errors
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have used Gitmoji in my commit messages
  • Any dependent changes have been merged and published

Additional Notes

This PR only updates documentation and does not modify runtime code or API behavior.

Breaking Changes

None.
closes #191

hui zhang and others added 30 commits December 26, 2025 03:50
Feat/update demo

See merge request npc-work/aic/ai/evermemos-opensource!62
Use self-deployed embedding and rerank APIs by default

See merge request npc-work/aic/ai/evermemos-opensource!64
vLLM Rerank API adopts an instruction-tuned approach

See merge request npc-work/aic/ai/evermemos-opensource!65
feat: metrics client and rerank/vectorize/retrieve metrics

See merge request npc-work/aic/ai/evermemos-opensource!66
cyfyifanchen and others added 2 commits April 19, 2026 14:43
Update the banner image URL in the README file to point to the new asset location.
…erMind-AI#192)

server.ts used 8001 but the EverMemOS server default is 1995.
This broke local demo runs unless EVERMEMOS_URL was manually set.

Fixes EverMind-AI#28

Co-authored-by: pazyork <pazyorkcc@gmail.com>
@Fearvox
Copy link
Copy Markdown
Collaborator

Fearvox commented Apr 19, 2026

LGTM on the top-level README fix — matches the current /v1 shape exactly.

Heads-up for follow-up: running grep -rn "retrieve_method" methods/ shows 10 files still on the old parameter name, including some that need attention more than README:

  • methods/evermemos/demo/tools/test_v1api_search.py ← filename says v1 but sends retrieve_method
  • methods/evermemos/demo/chat/session.py ← production session manager
  • methods/evermemos/docs/advanced/RETRIEVAL_STRATEGIES.md ← curl examples still target /api/v0
  • methods/evermemos/docs/advanced/METADATA_CONTROL.md
  • methods/evermemos/tests/test_memory_controller.py
  • methods/evermemos/tests/test_llm_switching_e2e.py
  • methods/evermemos/demo/{search_agent_demo.py, agent_clustering_test_demo.py, coding_agent_demo.py, utils/agent_demo_helpers.py}

Happy to send a follow-up PR that completes the v0→v1 migration across these 10 files once this one lands. I've been running a related hybrid retrieval benchmark (BM25 stage 1 → LLM rerank stage 2, 648 trials cross-LLM, +2.5pp top-1 at -63% p90 latency vs single-pipeline baselines) and wouldn't mind contributing findings if useful to the EverOS roadmap.

Repo: https://github.com/Fearvox/Evensong

Skip tool call/response msg in profile generation
Fearvox added a commit to Fearvox/EverOS that referenced this pull request Apr 20, 2026
Follow-up to EverMind-AI#185, which migrated the top-level README. Same v0→v1
migration now extended to the 10 files called out in the EverMind-AI#185 review:

Docs (2):
- docs/advanced/RETRIEVAL_STRATEGIES.md — `retrieve_method` → `method`,
  curl examples `GET /api/v0/memories/search` → `POST /api/v1/memories/search`
  with filters:{user_id}
- docs/advanced/METADATA_CONTROL.md — store payload flattened → nested
  {user_id, messages:[{message_id, timestamp(ms), sender_id, role, ...}]};
  search + delete paths updated to v1

Demo (5):
- demo/tools/test_v1api_search.py — filename said v1 but sent
  retrieve_method; renamed kwarg to `method`
- demo/chat/session.py — _search() kwarg `retrieve_method` → `method`
- demo/utils/agent_demo_helpers.py — search_memories() kwarg renamed
  (body already uses `method`)
- demo/search_agent_demo.py — 2 callers + docstring
- demo/agent_clustering_test_demo.py — 1 caller
- demo/coding_agent_demo.py — 1 caller + docstring

Tests (2):
- tests/test_memory_controller.py — 2704-line integration harness:
  all endpoint URLs v0→v1, all retrieve_method→method, and
  test_memorize_single_message refactored to the v1 nested shape
  (sender_id + ms-epoch timestamp, per-entry wrapper). Boundary
  detection loop structure retained
- tests/test_llm_switching_e2e.py — send_message() now wraps in
  {user_id, group_id, messages:[...]} and POSTs to /api/v1/memories

Verification:
- ast.parse clean on all 8 modified .py files
- grep for `retrieve_method|api/v0|\"sender\":|\"create_time\":` = 0
  across all 10 target files

Closes the review checklist in EverMind-AI#185.
Refs EverMind-AI#191.
@CZH-THU
Copy link
Copy Markdown
Author

CZH-THU commented Apr 20, 2026

@cyfyifanchen can u please review this PR

@Fearvox
Copy link
Copy Markdown
Collaborator

Fearvox commented Apr 20, 2026

@cyfyifanchen can u please review this PR

I think he's working on it, thanks for the call out! 🤌

kellyvv and others added 3 commits April 21, 2026 02:23
* feat(use-cases): add OpenHer persona engine with EverMemOS integration

OpenHer is an AI Being engine that creates personas with emergent
personality, emotional thermodynamics, and long-term memory.

EverMemOS integration:
- 4D relationship vector (depth, valence, trust, foresight)
  expands neural network perception from 8D to 12D
- Async two-stage memory retrieval (fire on Turn N,
  collect on Turn N+1) with 500ms timeout + graceful fallback
- Semi-emergent relationship EMA blending EverMemOS priors
  with LLM-judged deltas per turn
- Fire-and-forget turn storage via asyncio.create_task

Includes:
- README with architecture diagrams and integration walkthrough
- Runnable demo with simulation mode (no EverMemOS needed)
- Core integration code: mixin, types, context features
- .env.example with placeholder values

Repo: https://github.com/kellyvv/OpenHer

* docs: rewrite README — storytelling style, emotion-first

* docs: English README, storytelling style, no emoji

* rename: openher-persona-engine → openher

---------

Co-authored-by: kellyzxiaowei <129767595+kellyzxiaowei@users.noreply.github.com>
* chore: rename project from evermemos to EverCore

This commit renames the project directory and updates all internal references from "evermemos" to "EverCore". The changes include:
- Renaming the main directory from `methods/evermemos` to `methods/EverCore`
- Updating all import paths and module references
- Maintaining the same code structure and functionality
- Adding new configuration files (.vscode/settings.json, .pylintrc, pyrightconfig.json)
- Updating Dockerfile and project metadata

* docs: update references from evermemos to EverCore

Update documentation files to reflect the renaming of the 'evermemos' directory to 'EverCore'. This includes fixing clone commands, directory paths, and documentation links across multiple files to ensure consistency and correct navigation for users.

* chore: rename EverMemOS to EverCore across codebase

This is a project-wide rebranding from EverMemOS to EverCore. The changes include:
- Update project name in source files, documentation, and configuration
- Rename API references, environment variables, and service names
- Modify demo descriptions and benchmark configurations
- Update URLs and citations to reflect new project identity

All functionality remains identical; only naming has changed to align with the new project branding.

* docs: update README with EverCore focus and restructured TOC

- Add line break before Table of Contents for better visual separation
- Rewrite project description to highlight EverCore as the central component
- Reorder directory tree to prioritize benchmarks and methods over use-cases
- Update use-cases list with more examples and clarify they are templates
- Improve flow from Quick Start to use-cases to benchmarks

* docs: update README with clearer methods description and benchmarks

Add benchmark numbers directly in the method summaries for better visibility.
Clarify introductory text to emphasize choice and composition of methods.

* docs: fix markdown formatting in README table of contents

Adjust whitespace and line breaks to ensure proper rendering of the collapsible table of contents section.
…d-AI#204)

- Replace specific EverMemBench-Dynamic badge with general EverMind-AI HuggingFace badge
- Remove redundant License badge
- Change "Methods" section heading to "Architecture Methods"
- Update sub-section headings from h4 (####) to h3 (###) for better hierarchy
…rMind-AI#208)

* docs: restructure README and add AGENTS.md for better navigation

- Reorder sections to emphasize architecture methods and use cases
- Move use cases section before quick start for better flow
- Rename "Methods" to "Architecture Methods" for clarity
- Add AGENTS.md with quick commands and key entry points
- Update section headers to improve document hierarchy
- Maintain all existing content while improving organization

* docs: add community and contribution files

* docs: reorder README directory tree for logical grouping

* docs: move community files to .github/ and update references

* ci: change deploy workflow trigger from feature branch to main
* docs: restructure README and add subdirectory guides

Move the directory tree from the main README to new dedicated README files for each top-level folder (use-cases, methods, benchmarks). Add detailed introductions and tables to guide users to the appropriate subprojects. This improves navigation and provides clear entry points for different use cases.

* docs: expand showcase section with new projects and links

Add six new project entries to the README showcase, each with a banner image, description, and code/plugin link. Also update an existing benchmark entry to include a dataset link. This enhances the repository's demonstration of real-world applications and available resources.
* docs(readme): update project links and formatting

* docs(use-cases): enhance README with visual catalogue of demos

Expand the use cases section from a simple table to a detailed visual catalogue with project banners, descriptions, and links. This improves user engagement and provides a better showcase of community integrations and demos.

* docs: update READMEs and add validation for use-case links
Fearvox added a commit to Fearvox/EverOS that referenced this pull request May 15, 2026
…#78 slice scope

Captures the targeted upstream recheck: issues EverMind-AI#191/#93/#78 still open;
PRs EverMind-AI#185/EverMind-AI#211 BLOCKED; #89/#109/EverMind-AI#138 DIRTY. Marks local current-tree
slice as superseding EverMind-AI#185/EverMind-AI#211/EverMind-AI#138/#109 in PR_MATRIX. Narrows the
return-slice scope in goal.md and updates owner-brief priorities.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
github-actions Bot pushed a commit to Fearvox/EverOS that referenced this pull request May 17, 2026
…#78 slice scope

Captures the targeted upstream recheck: issues EverMind-AI#191/#93/#78 still open;
PRs EverMind-AI#185/EverMind-AI#211 BLOCKED; #89/#109/EverMind-AI#138 DIRTY. Marks local current-tree
slice as superseding EverMind-AI#185/EverMind-AI#211/EverMind-AI#138/#109 in PR_MATRIX. Narrows the
return-slice scope in goal.md and updates owner-brief priorities.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: update plugin repository link in README

* docs(readme): update banner gif link
github-actions Bot pushed a commit to Fearvox/EverOS that referenced this pull request May 19, 2026
…#78 slice scope

Captures the targeted upstream recheck: issues EverMind-AI#191/#93/#78 still open;
PRs EverMind-AI#185/EverMind-AI#211 BLOCKED; #89/#109/EverMind-AI#138 DIRTY. Marks local current-tree
slice as superseding EverMind-AI#185/EverMind-AI#211/EverMind-AI#138/#109 in PR_MATRIX. Narrows the
return-slice scope in goal.md and updates owner-brief priorities.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
cyfyifanchen and others added 2 commits May 21, 2026 17:24
)

* docs(readme): update code example link to pinned commit

pin the reference to the voice assistant example code to a specific commit hash and fix folder name capitalization

* docs: update voice assistant demo link in README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README memory search API example is outdated